What's Updated
What's New

Version 1.60.0 to 1.61.0

Summary of Changes

12 - New

199 - Updated

852 - Total Endpoints

582 - Total Paths

What's Updated

[ devices ]

cellular

Return the SIM and APN configurations for a cellular device.

GET /devices/{serial}/cellular/sims

- Optional property iccid Added

- Optional property imsi Added

- Optional property msisdn Added

- Optional property status Added

- Response property iccid value added

- Response property imsi value added

- Response property msisdn value added

- Response property status value added

Updates the SIM and APN configurations for a cellular device.

PUT /devices/{serial}/cellular/sims

- Optional property iccid Added

- Optional property imsi Added

- Optional property msisdn Added

- Optional property status Added

[ switch ]

accessPolicies

List the access policies for a switch network

GET /networks/{networkId}/switch/accessPolicies

- Optional property accessPolicyNumber Added

- Response property accessPolicyNumber value added

Return a specific access policy for a switch network

GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

- Optional property accessPolicyNumber Added

- Response property accessPolicyNumber value added

Update an access policy for a switch network

PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

- Optional property accessPolicyNumber Added

Create an access policy for a switch network

POST /networks/{networkId}/switch/accessPolicies

- Optional property accessPolicyNumber Added

stacks

List layer 3 interfaces for a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- Optional param mode added

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Response property networkType value added

- Response property mode value added

- Response property serial value added

- Response property switchPortId value added

- Response property vrf value added

Return a layer 3 interface from a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Response property networkType value added

- Response property mode value added

- Response property serial value added

- Response property switchPortId value added

- Response property vrf value added

List layer 3 static routes for a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes

- Optional property vrf Added

- Response property vrf value added

Return a layer 3 static route for a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}

- Optional property vrf Added

- Response property vrf value added

Update a layer 3 interface for a switch stack

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Optional property networkType Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

Update a layer 3 static route for a switch stack

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}

- Optional property vrf Added

Create a switch stack

POST /networks/{networkId}/switch/stacks

- Property isMonitorOnly Deleted

- Property members Deleted

- Optional property workflowId Added

Create a layer 3 interface for a switch stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- Optional property networkType Added

- Optional property mode Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

Create a layer 3 static route for a switch stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes

- Optional property vrf Added

routing

List layer 3 interfaces for a switch

GET /devices/{serial}/switch/routing/interfaces

- Optional param mode added

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Response property networkType value added

- Response property mode value added

- Response property serial value added

- Response property switchPortId value added

- Response property vrf value added

Return a layer 3 interface for a switch

GET /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Response property networkType value added

- Response property mode value added

- Response property serial value added

- Response property switchPortId value added

- Response property vrf value added

List layer 3 static routes for a switch

GET /devices/{serial}/switch/routing/staticRoutes

- Optional property vrf Added

- Response property vrf value added

Return a layer 3 static route for a switch

GET /devices/{serial}/switch/routing/staticRoutes/{staticRouteId}

- Optional property vrf Added

- Response property vrf value added

Return layer 3 OSPF routing configuration

GET /networks/{networkId}/switch/routing/ospf

- Optional param vrf added

- Optional property vrf Added

- Response property vrf value added

Update a layer 3 interface for a switch

PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Optional property networkType Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

Update a layer 3 static route for a switch

PUT /devices/{serial}/switch/routing/staticRoutes/{staticRouteId}

- Optional property vrf Added

Update layer 3 OSPF routing configuration

PUT /networks/{networkId}/switch/routing/ospf

- Optional param vrf added

- Optional property vrf Added

Create a layer 3 interface for a switch

POST /devices/{serial}/switch/routing/interfaces

- Optional property networkType Added

- Optional property mode Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

- Optional property networkType Added

- Optional property mode Added

- Optional property serial Added

- Optional property switchPortId Added

- Optional property vrf Added

- Optional property loopback Added

Create a layer 3 static route for a switch

POST /devices/{serial}/switch/routing/staticRoutes

- Optional property vrf Added

[ networks ]

firmwareUpgrades

Get firmware upgrade information for a network

GET /networks/{networkId}/firmwareUpgrades

- Optional property isUpgradeAvailable Added

- Response property isUpgradeAvailable value added

Update firmware upgrade information for a network

PUT /networks/{networkId}/firmwareUpgrades

- Optional property isUpgradeAvailable Added

[ wireless ]

ssids

Update the attributes of an MR SSID

PUT /networks/{networkId}/wireless/ssids/{number}

- Optional property localAuthFallback Added

[ organizations ]

firmware

Get firmware upgrade status for the filtered devices

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

- Property releaseType Deleted

- Optional property checkinFinishedAt Added

- Optional property checkinStartedAt Added

- Optional property detailedStatus Added

- Optional property downloadFinishedAt Added

- Optional property downloadStartedAt Added

- Optional property downloadStatus Added

- Optional property installFinishedAt Added

- Optional property installStartedAt Added

- Optional property installStatus Added

- Optional property verifyFinishedAt Added

- Optional property verifyStartedAt Added

- Optional property verifyStatus Added

- Response property checkinFinishedAt value added

- Response property checkinStartedAt value added

- Response property detailedStatus value added

- Response property downloadFinishedAt value added

- Response property downloadStartedAt value added

- Response property downloadStatus value added

- Response property installFinishedAt value added

- Response property installStartedAt value added

- Response property installStatus value added

- Response property verifyFinishedAt value added

- Response property verifyStartedAt value added

- Response property verifyStatus value added

earlyAccess

List the available early access features for organization

GET /organizations/{organizationId}/earlyAccess/features

- Optional property privacyLink Added

- Response property privacyLink value added

[ sensor ]

readings

Return all reported readings from sensors in a given timespan, sorted by timestamp

GET /organizations/{organizationId}/sensor/readings/history

- Optional property rawTemperature Added

- Response property rawTemperature value added

Return the latest available reading for each metric from each sensor, sorted by sensor serial

GET /organizations/{organizationId}/sensor/readings/latest

- Optional property rawTemperature Added

- Response property rawTemperature value added

What's New

[ wireless ]

zigbee

PATH /devices/{serial}/wireless/zigbee/enrollments

- Path added

- New endpoint

Enqueue a job to start enrolling door locks on zigbee configured wireless devices

POST /devices/{serial}/wireless/zigbee/enrollments
{
    "enrollmentId": "1234",
    "url": "/devices/SERIAL/wireless/zigbee/enrollments/1234",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete"
}

PATH /devices/{serial}/wireless/zigbee/enrollments/{enrollmentId}

- Path added

- New endpoint

Return an enrollment

GET /devices/{serial}/wireless/zigbee/enrollments/{enrollmentId}

{
    "enrollmentId": "1234",
    "url": "/devices/SERIAL/wireless/zigbee/enrollments/1234",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "enrollmentStartedAt": "complete",
    "doorLocks": [
        {
            "doorLockId": "1",
            "name": "Door Lock 123",
            "shortId": "ABE123",
            "lqi": "1",
            "rssi": "1",
            "status": "online",
            "eui64": "DL403",
            "enrolledAt": "2023-08-14T19:57:06Z",
            "lastSeenAt": "2023-08-14T19:59:01Z",
            "network": {
                "id": "N_24329156",
                "name": "Main Office"
            },
            "gateway": {
                "name": "My AP",
                "serial": "Q234-ABCD-5678"
            }
        }
    ]
}

PATH /networks/{networkId}/wireless/zigbee

- Path added

- New endpoint

Update Zigbee Configs for specified network

PUT /networks/{networkId}/wireless/zigbee

{
    "network": {
        "id": "N_24329156"
    },
    "enabled": true,
    "iotController": {
        "name": "My AP",
        "mac": "e4:55:a8:38:f2:06",
        "serial": "Q234-ABCD-5678",
        "status": "online"
    },
    "lockManagement": {
        "address": "10.100.100.200",
        "username": "user",
        "status": "offline"
    },
    "defaults": {
        "transmitPowerLevel": 10,
        "channel": "25"
    }
}

PATH /organizations/{organizationId}/wireless/zigbee/byNetwork

- Path added

- New endpoint

Return list of Zigbee configs

GET /organizations/{organizationId}/wireless/zigbee/byNetwork

[
    {
        "network": {
            "id": "N_24329156"
        },
        "enabled": true,
        "iotController": {
            "name": "My AP",
            "mac": "e4:55:a8:38:f2:06",
            "serial": "Q234-ABCD-5678",
            "status": "online"
        },
        "lockManagement": {
            "address": "10.100.100.200",
            "username": "user",
            "status": "offline"
        },
        "defaults": {
            "transmitPowerLevel": 10,
            "channel": "25"
        }
    }
]

PATH /organizations/{organizationId}/wireless/zigbee/devices

- Path added

- New endpoint

List the Zigbee wireless devices for an organization or the supplied network(s)

GET /organizations/{organizationId}/wireless/zigbee/devices

[
    {
        "network": {
            "id": "N_1234",
            "name": "Main office"
        },
        "panId": "0x0100",
        "channel": "auto",
        "transmitPowerLevel": 12,
        "enrolled": true,
        "status": "online",
        "gateway": {
            "name": "Wireless gateway",
            "mac": "e4:55:a8:38:f2:06",
            "serial": "1234-4567-5678",
            "tags": [
                "tag1",
                "tag2"
            ]
        },
        "counts": {
            "doorLocks": {
                "byStatus": {
                    "online": 5,
                    "offline": 2,
                    "dormant": 0
                }
            }
        }
    }
]

PATH /organizations/{organizationId}/wireless/zigbee/devices/{id}

- Path added

- New endpoint

Endpoint to update zigbee gateways

PUT /organizations/{organizationId}/wireless/zigbee/devices/{id}

{
    "network": {
        "id": "N_1234",
        "name": "Main office"
    },
    "panId": "0x0100",
    "channel": "auto",
    "transmitPowerLevel": 12,
    "enrolled": true,
    "status": "online",
    "gateway": {
        "name": "Wireless gateway",
        "mac": "e4:55:a8:38:f2:06",
        "serial": "1234-4567-5678",
        "tags": [
            "tag1",
            "tag2"
        ]
    },
    "counts": {
        "doorLocks": {
            "byStatus": {
                "online": 5,
                "offline": 2,
                "dormant": 0
            }
        }
    }
}

PATH /organizations/{organizationId}/wireless/zigbee/disenrollments

- Path added

- New endpoint

Enqueue a job to start disenrolling door locks on zigbee configured wireless devices

POST /organizations/{organizationId}/wireless/zigbee/disenrollments
{
    "disenrollmentId": "1234",
    "url": "/organization/{organizationId}/wireless/zigbee/disenrollments/1234",
    "request": {
        "doorLockIds": [
            "1234"
        ]
    },
    "status": "complete"
}

PATH /organizations/{organizationId}/wireless/zigbee/disenrollments/{disenrollmentId}

- Path added

- New endpoint

Return a disenrollment

GET /organizations/{organizationId}/wireless/zigbee/disenrollments/{disenrollmentId}

{
    "disenrollmentId": "1234",
    "url": "/organization/{organizationId}/wireless/zigbee/disenrollments/1234",
    "request": {
        "doorLockIds": [
            "1234"
        ]
    },
    "status": "complete",
    "doorLocks": [
        {
            "doorLockId": "1234",
            "status": "success"
        }
    ]
}

PATH /organizations/{organizationId}/wireless/zigbee/doorLocks

- Path added

- New endpoint

Return the list of door locks for a network

GET /organizations/{organizationId}/wireless/zigbee/doorLocks

[
    {
        "doorLockId": "1",
        "name": "Door Lock 123",
        "shortId": "ABE123",
        "lqi": "1",
        "rssi": "1",
        "status": "online",
        "eui64": "DL403",
        "enrolledAt": "2023-08-14T19:57:06Z",
        "lastSeenAt": "2023-08-14T19:59:01Z",
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        },
        "gateway": {
            "name": "My AP",
            "serial": "Q234-ABCD-5678"
        }
    }
]

PATH /organizations/{organizationId}/wireless/zigbee/doorLocks/{doorLockId}

- Path added

- New endpoint

Endpoint to batch update door locks params

PUT /organizations/{organizationId}/wireless/zigbee/doorLocks/{doorLockId}

{
    "doorLockId": "1",
    "name": "Door Lock 123",
    "shortId": "ABE123",
    "lqi": "1",
    "rssi": "1",
    "status": "online",
    "eui64": "DL403",
    "enrolledAt": "2023-08-14T19:57:06Z",
    "lastSeenAt": "2023-08-14T19:59:01Z",
    "network": {
        "id": "N_24329156",
        "name": "Main Office"
    },
    "gateway": {
        "name": "My AP",
        "serial": "Q234-ABCD-5678"
    }
}

[ sensor ]

gateways

PATH /organizations/{organizationId}/sensor/gateways/connections/latest

- Path added

- New endpoint

Returns latest sensor-gateway connectivity data.

GET /organizations/{organizationId}/sensor/gateways/connections/latest

{
    "items": [
        {
            "lastReportedAt": "2024-09-04T19:29:05Z",
            "lastConnectedAt": "2024-09-04T19:29:05Z",
            "rssi": -24,
            "network": {
                "name": "My sensor",
                "id": "N_12345678"
            },
            "sensor": {
                "serial": "Q234-ABCD-0001",
                "name": "My sensor",
                "mac": "00:11:22:33:44:55"
            },
            "gateway": {
                "serial": "Q234-ABCD-0004",
                "name": "My gateway",
                "mac": "22:33:44:55:66:77"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 20,
                "remaining": 0
            }
        }
    }
}

[ spaces ]

integrate

PATH /organizations/{organizationId}/spaces/integrate/status

- Path added

- New endpoint

Get the status of the Spaces integration in Meraki

GET /organizations/{organizationId}/spaces/integrate/status

{
    "status": true,
    "states": [
        "Spaces account created",
        "Meraki Organization Import initiated",
        "Importing Meraki Organization Administrators",
        "Invite email sent to meraki-user@cisco.com"
    ],
    "email": "meraki-user@cisco.com",
    "accountName": "My First Meraki Org",
    "accountType": "Extend"
}