Version 1.26.0 to 1.27.0

Summary of Changes

9 - New

53 - Updated

607 - Total operations

380 - Total Paths

What's Changed

[ sensor ]

alerts

Deletes a sensor alert profile from a network.

DELETE /networks/{networkId}/sensor/alerts/profiles/{id}

- Response 200 Deleted

What's Updated

[ sensor ]

alerts

Deletes a sensor alert profile from a network.

DELETE /networks/{networkId}/sensor/alerts/profiles/{id}

- Response property 204 value added

[ switch ]

ports

Return the status for all the ports of a switch

GET /devices/{serial}/switch/ports/statuses

- Response property securePort value added

[ appliance ]

vpn

Update the third party VPN peers for an organization

PUT /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers

- Optional property localId Added

Return the third party VPN peers for an organization

GET /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers

- Response property properties value added

- Response property remoteId value added

- Response property localId value added

- Response property ipsecPoliciesPreset value added

vlans

Update a VLAN

PUT /networks/{networkId}/appliance/vlans/{vlanId}

- Optional property id Added

- Optional property interfaceId Added

List the VLANs for an MX network

GET /networks/{networkId}/appliance/vlans

- Optional property id Added

- Optional property interfaceId Added

- Response property id value added

- Response property interfaceId value added

Return a VLAN

GET /networks/{networkId}/appliance/vlans/{vlanId}

- Optional property id Added

- Optional property interfaceId Added

- Response property id value added

- Response property interfaceId value added

Add a VLAN

POST /networks/{networkId}/appliance/vlans

- Optional property interfaceId Added

[ camera ]

qualityRetentionProfiles

Update an existing quality retention profile for this network.

PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Optional property MV63 Added

- Optional property MV93 Added

- Optional property MV63X Added

- Optional property MV93X Added

Creates new quality retention profile for this network.

POST /networks/{networkId}/camera/qualityRetentionProfiles

- Optional property MV63 Added

- Optional property MV93 Added

- Optional property MV63X Added

- Optional property MV93X Added

[ cellularGateway ]

dhcp

List common DHCP settings of MGs

GET /networks/{networkId}/cellularGateway/dhcp

- Response property properties value added

uplink

List the uplink status of every Meraki MG cellular gateway in the organization

GET /organizations/{organizationId}/cellularGateway/uplink/statuses

- Response property properties value added

[ networks ]

events

List the event type to human-readable description

GET /networks/{networkId}/events/eventTypes

- Response property properties value added

merakiAuthUsers

List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network)

GET /networks/{networkId}/merakiAuthUsers

- Response property properties value added

Return the Meraki Auth splash guest, RADIUS, or client VPN user

GET /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}

- Response property properties value added

webhooks

Get the webhook payload template for a network

GET /networks/{networkId}/webhooks/payloadTemplates/{payloadTemplateId}

- Response property properties value added

settings

Update the settings for a network

PUT /networks/{networkId}/settings

- Property secureConnect Deleted

- Optional property securePort Added

Return the settings for a network

GET /networks/{networkId}/settings

- Response property securePort value added

service

Unbind a network from a template.

POST /networks/{networkId}/unbind

- Optional param unbindNetwork added

[ sm ]

trustedAccessConfigs

List Trusted Access Configs

GET /networks/{networkId}/sm/trustedAccessConfigs

- Optional property timeboundType Added

- Response property timeboundType value added

[ organizations ]

adaptivePolicy

Returns adaptive policy aggregate statistics for an organization

GET /organizations/{organizationId}/adaptivePolicy/overview

- Response property properties value added

- Response property customGroups value added

- Response property policyObjects value added

- Response property limits value added

inventory

Return the device inventory for an organization

GET /organizations/{organizationId}/inventory/devices

- Response property properties value added

Return a single device from the inventory of an organization

GET /organizations/{organizationId}/inventory/devices/{serial}

- Response property properties value added

service

Update an organization

PUT /organizations/{organizationId}

- Optional property management Added

List the organizations that the user has privileges on

GET /organizations

- Optional property management Added

- Response property management value added

Return an organization

GET /organizations/{organizationId}

- Optional property management Added

- Response property management value added

Create a new organization

POST /organizations

- Optional property management Added

Create a new organization by cloning the addressed organization

POST /organizations/{organizationId}/clone

- Optional property management Added

What's New

[ devices ]

cellular

PATH /devices/{serial}/cellular/sims

- Path added

- New operation

Return the SIM and APN configurations for a cellular device.

GET /devices/{serial}/cellular/sims

Code Snippet

Copy{
    "sims": [
        {
            "slot": "sim1",
            "isPrimary": true,
            "apns": [
                {
                    "name": "internet",
                    "allowedIpTypes": [
                        "ipv4",
                        "ipv6"
                    ],
                    "authentication": {
                        "type": "pap",
                        "username": "milesmeraki"
                    }
                }
            ]
        }
    ]
}

- New operation

Updates the SIM and APN configurations for a cellular device.

PUT /devices/{serial}/cellular/sims

Code Snippet

Copy{
    "sims": [
        {
            "slot": "sim1",
            "isPrimary": true,
            "apns": [
                {
                    "name": "internet",
                    "allowedIpTypes": [
                        "ipv4",
                        "ipv6"
                    ],
                    "authentication": {
                        "type": "pap",
                        "username": "milesmeraki"
                    }
                }
            ]
        }
    ]
}

[ sensor ]

alerts

PATH /networks/{networkId}/sensor/alerts/overview/byMetric

- Path added

- New operation

Return an overview of alert occurrences over a timespan, by metric

GET /networks/{networkId}/sensor/alerts/overview/byMetric

Code Snippet

Copy[
    {
        "startTs": "2022-08-21T00:00:00Z",
        "endTs": "2022-08-27T23:59:59Z",
        "counts": {
            "door": 0,
            "humidity": 1,
            "indoorAirQuality": 0,
            "noise": {
                "ambient": 2
            },
            "pm25": 0,
            "temperature": 4,
            "tvoc": 0,
            "water": 0
        }
    }
]

[ organizations ]

policyObjects

PATH /organizations/{organizationId}/policyObjects

- Path added

- New operation

Lists Policy Objects belonging to the organization.

GET /organizations/{organizationId}/policyObjects

Code Snippet

Copy[
    {
        "id": "1234",
        "name": "Web Servers - Datacenter 10",
        "category": "network",
        "type": "cidr",
        "cidr": "10.0.0.0/24",
        "created_at": "2018-05-12T00:00:00Z",
        "updated_at": "2018-05-12T00:00:00Z",
        "groupIds": [],
        "networkIds": []
    }
]

- New operation

Creates a new Policy Object.

POST /organizations/{organizationId}/policyObjects

Code Snippet

Copy{
    "id": "1234",
    "name": "Web Servers - Datacenter 10",
    "category": "network",
    "type": "cidr",
    "cidr": "10.0.0.0/24",
    "created_at": "2018-05-12T00:00:00Z",
    "updated_at": "2018-05-12T00:00:00Z",
    "groupIds": [],
    "networkIds": []
}

PATH /organizations/{organizationId}/policyObjects/groups

- Path added

- New operation

Lists Policy Object Groups belonging to the organization.

GET /organizations/{organizationId}/policyObjects/groups
Code Snippet
Copy[
    {
        "id": "1234",
        "name": "Web Servers - Datacenter 10",
        "category": "NetworkObjectGroup",
        "created_at": "2018-05-12T00:00:00Z",
        "updated_at": "2018-05-12T00:00:00Z",
        "objectIds": [],
        "networkIds": []
    }
]
- New operation

Creates a new Policy Object Group.

POST /organizations/{organizationId}/policyObjects/groups
Code Snippet
Copy{
    "id": "1234",
    "name": "Web Servers - Datacenter 10",
    "category": "NetworkObjectGroup",
    "created_at": "2018-05-12T00:00:00Z",
    "updated_at": "2018-05-12T00:00:00Z",
    "objectIds": [],
    "networkIds": []
}

PATH /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}

- Path added

- New operation

Shows details of a Policy Object Group.

GET /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}
Code Snippet
Copy{
    "id": "1234",
    "name": "Web Servers - Datacenter 10",
    "category": "NetworkObjectGroup",
    "created_at": "2018-05-12T00:00:00Z",
    "updated_at": "2018-05-12T00:00:00Z",
    "objectIds": [],
    "networkIds": []
}
- New operation

Updates a Policy Object Group.

PUT /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}
Code Snippet
Copy{
    "id": "1234",
    "name": "Web Servers - Datacenter 10",
    "category": "NetworkObjectGroup",
    "created_at": "2018-05-12T00:00:00Z",
    "updated_at": "2018-05-12T00:00:00Z",
    "objectIds": [],
    "networkIds": []
}
- New operation

Deletes a Policy Object Group.

DELETE /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}

PATH /organizations/{organizationId}/policyObjects/{policyObjectId}

- Path added

- New operation

Shows details of a Policy Object.

GET /organizations/{organizationId}/policyObjects/{policyObjectId}
Code Snippet
Copy{
    "id": "1234",
    "name": "Web Servers - Datacenter 10",
    "category": "network",
    "type": "cidr",
    "cidr": "10.0.0.0/24",
    "created_at": "2018-05-12T00:00:00Z",
    "updated_at": "2018-05-12T00:00:00Z",
    "groupIds": [],
    "networkIds": []
}
- New operation

Updates a Policy Object.

PUT /organizations/{organizationId}/policyObjects/{policyObjectId}
Code Snippet
Copy{
    "id": "1234",
    "name": "Web Servers - Datacenter 10",
    "category": "network",
    "type": "cidr",
    "cidr": "10.0.0.0/24",
    "created_at": "2018-05-12T00:00:00Z",
    "updated_at": "2018-05-12T00:00:00Z",
    "groupIds": [],
    "networkIds": []
}
- New operation

Deletes a Policy Object.

DELETE /organizations/{organizationId}/policyObjects/{policyObjectId}

inventory

PATH /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports

- Path added

- New operation

Check the status of a committed Import operation

GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
Code Snippet
Copy[
    {
        "importId": "0000000000000000",
        "device": {
            "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000",
            "created": true,
            "status": "SUCCESS"
        }
    }
]
- New operation

Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
Code Snippet
Copy[
    {
        "status": "IMPORT JOB SUCCESS",
        "importId": "1234",
        "message": "Import Started"
    }
]

PATH /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare

- Path added

- New operation

Initiates or updates an import session. An import ID will be generated and used when you are ready to commit the import.

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare

Code Snippet

Copy[
    {
        "message": "Existing import found",
        "udi": "PID:C9200L-24P-4G SN:JAE25220R2K",
        "deviceId": "161b2602-a713-4aac-b1eb-d9b55205353d",
        "status": "SUCCESS",
        "configParams": {
            "tunnel": {
                "mode": "443",
                "port": "443",
                "host": "secgw-int3.ciscocloudoffer.com",
                "name": "MERAKI-PRIMARY",
                "rootCertificate": {
                    "content": "",
                    "name": "MERAKI_TLSGW_CA"
                }
            },
            "cloudStaticIp": "1.2.3.4",
            "user": {
                "publicKey": "",
                "username": "MERAKI_USER",
                "secret": {
                    "hash": ""
                }
            }
        }
    }
]

firmware

PATH /organizations/{organizationId}/firmware/upgrades/byDevice

- Path added

- New operation

Get firmware upgrade status for the filtered devices

GET /organizations/{organizationId}/firmware/upgrades/byDevice

Code Snippet

Copy[
    {
        "serial": "Q234-ABCD-5678",
        "name": "My AP",
        "deviceStatus": "completed",
        "upgrade": {
            "time": "2018-02-11T00:00:00.090210Z",
            "fromVersion": {
                "id": "1234",
                "shortName": "MV 10.8.1",
                "releaseType": "stable",
                "releaseDate": "2018-02-11T00:00:00.090210Z"
            },
            "toVersion": {
                "id": "1234",
                "shortName": "MV 11.2.1",
                "releaseType": "stable",
                "releaseDate": "2018-02-11T00:00:00.090210Z"
            },
            "status": "completed",
            "id": "1234",
            "upgradeBatchId": "1234",
            "staged": {
                "group": {
                    "id": "1234"
                }
            }
        }
    }
]