Version 1.1.0 to 1.2.0

What's Updated

[ appliance ]

Return the performance score for a single MX

GET /devices/{serial}/appliance/performance

- Summary changed from Return the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned. to Return the performance score for a single MX


List the security events for a client

GET /networks/{networkId}/appliance/clients/{clientId}/security/events

- Summary changed from List the security events for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to List the security events for a client


Return the site-to-site VPN settings of a network

GET /networks/{networkId}/appliance/vpn/siteToSiteVpn

- Summary changed from Return the site-to-site VPN settings of a network. Only valid for MX networks. to Return the site-to-site VPN settings of a network


Update the site-to-site VPN settings of a network

PUT /networks/{networkId}/appliance/vpn/siteToSiteVpn

- Summary changed from Update the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode. to Update the site-to-site VPN settings of a network


PATH /networks/{networkId}/appliance/settings

- Path added

- New operation

Return the appliance settings for a network

GET /networks/{networkId}/appliance/settings

{
    "clientTrackingMethod": "MAC address"
}


[ camera ]

GET /devices/{serial}/camera/videoLink

- Summary changed from Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp. to Returns video link to the specified camera


[ devices ]

List the clients of a device, up to a maximum of a month ago

GET /devices/{serial}/clients

- Summary changed from List the clients of a device, up to a maximum of a month ago. The usage of each client is returned in kilobytes. If the device is a switch, the switchport is returned; otherwise the switchport field is null. to List the clients of a device, up to a maximum of a month ago


[ switch ]

Update warm spare configuration for a switch

PUT /devices/{serial}/switch/warmSpare

- Summary changed from Update warm spare configuration for a switch. The spare will use the same L3 configuration as the primary. Note that this will irreversibly destroy any existing L3 configuration on the spare. to Update warm spare configuration for a switch


PATH /networks/{networkId}/switch/accessPolicies

- Path added

- New operation

List the access policies for a switch network. Only returns access policies with 'my RADIUS server' as authentication method

GET /networks/{networkId}/switch/accessPolicies

[
    {
        "accessPolicyNumber": "1234",
        "name": "Access policy #1",
        "radiusServers": [
            {
                "host": "1.2.3.4",
                "port": 22,
                "secret": "password1"
            }
        ],
        "radiusTestingEnabled": false,
        "radiusCoaSupportEnabled": false,
        "radiusAccountingEnabled": true,
        "radiusAccountingServers": [
            {
                "host": "1.2.3.4",
                "port": 22,
                "secret": "password1"
            }
        ],
        "hostMode": "Single-Host",
        "accessPolicyType": "Hybrid authentication",
        "increaseAccessSpeed": false,
        "guestVlanId": 100,
        "voiceVlanClients": true,
        "urlRedirectWalledGardenEnabled": true,
        "urlRedirectWalledGardenRanges": "192.168.1.0/24"
    }
]

- New operation

Create an access policy for a switch network. This operation only supports access policies with 'My RADIUS server' as authentication method.

POST /networks/{networkId}/switch/accessPolicies

{
    "accessPolicyNumber": "1234",
    "name": "Access policy #1",
    "radiusServers": [
        {
            "host": "1.2.3.4",
            "port": 22,
            "secret": "password1"
        }
    ],
    "radiusTestingEnabled": false,
    "radiusCoaSupportEnabled": false,
    "radiusAccountingEnabled": true,
    "radiusAccountingServers": [
        {
            "host": "1.2.3.4",
            "port": 22,
            "secret": "password1"
        }
    ],
    "hostMode": "Single-Host",
    "accessPolicyType": "Hybrid authentication",
    "increaseAccessSpeed": false,
    "guestVlanId": 100,
    "voiceVlanClients": true,
    "urlRedirectWalledGardenEnabled": true,
    "urlRedirectWalledGardenRanges": "192.168.1.0/24"
}


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

- Path added

- New operation

Return a specific access policy for a switch network

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

{
    "accessPolicyNumber": "1234",
    "name": "Access policy #1",
    "radiusServers": [
        {
            "host": "1.2.3.4",
            "port": 22,
            "secret": "password1"
        }
    ],
    "radiusTestingEnabled": false,
    "radiusCoaSupportEnabled": false,
    "radiusAccountingEnabled": true,
    "radiusAccountingServers": [
        {
            "host": "1.2.3.4",
            "port": 22,
            "secret": "password1"
        }
    ],
    "hostMode": "Single-Host",
    "accessPolicyType": "Hybrid authentication",
    "increaseAccessSpeed": false,
    "guestVlanId": 100,
    "voiceVlanClients": true,
    "urlRedirectWalledGardenEnabled": true,
    "urlRedirectWalledGardenRanges": "192.168.1.0/24"
}

- New operation

Update an access policy for a switch network. This operation only supports access policies with 'My RADIUS server' as authentication method.

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

{
    "accessPolicyNumber": "1234",
    "name": "Access policy #1",
    "radiusServers": [
        {
            "host": "1.2.3.4",
            "port": 22,
            "secret": "password1"
        }
    ],
    "radiusTestingEnabled": false,
    "radiusCoaSupportEnabled": false,
    "radiusAccountingEnabled": true,
    "radiusAccountingServers": [
        {
            "host": "1.2.3.4",
            "port": 22,
            "secret": "password1"
        }
    ],
    "hostMode": "Single-Host",
    "accessPolicyType": "Hybrid authentication",
    "increaseAccessSpeed": false,
    "guestVlanId": 100,
    "voiceVlanClients": true,
    "urlRedirectWalledGardenEnabled": true,
    "urlRedirectWalledGardenRanges": "192.168.1.0/24"
}

- New operation

Delete an access policy for a switch network

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



PATH /organizations/{organizationId}/switch/devices/clone

- Path added

- New operation

Clone port-level and some switch-level configuration settings from a source switch to one or more target switches. Cloned settings include: Aggregation Groups, Power Settings, Multicast Settings, MTU Configuration, STP Bridge priority, Port Mirroring

POST /organizations/{organizationId}/switch/devices/clone

{
    "sourceSerial": "Q234-ABCD-5678",
    "targetSerials": [
        "Q234-ABCD-0001",
        "Q234-ABCD-0002",
        "Q234-ABCD-0003"
    ]
}


[ networks ]

Return a Bluetooth client

GET /networks/{networkId}/bluetoothClients/{bluetoothClientId}

- Summary changed from Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC. to Return a Bluetooth client


Return the client associated with the given identifier

GET /networks/{networkId}/clients/{clientId}

- Summary changed from Return the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to Return the client associated with the given identifier


Return the policy assigned to a client on the network

GET /networks/{networkId}/clients/{clientId}/policy

- Summary changed from Return the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to Return the policy assigned to a client on the network


Return the splash authorization for a client, for each SSID they've associated with through splash

GET /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus

- Summary changed from Return the splash authorization for a client, for each SSID they've associated with through splash. Only enabled SSIDs with Click-through splash enabled will be included. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to Return the splash authorization for a client, for each SSID they've associated with through splash


Return the client's network traffic data over time

GET /networks/{networkId}/clients/{clientId}/trafficHistory

- Summary changed from Return the client's network traffic data over time. Usage data is in kilobytes. This operation requires detailed traffic analysis to be enabled on the Network-wide > General page. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to Return the client's network traffic data over time


Return the client's daily usage history

GET /networks/{networkId}/clients/{clientId}/usageHistory

- Summary changed from Return the client's daily usage history. Usage data is in kilobytes. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to Return the client's daily usage history


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 ssidNumber value added

- Summary changed from List the splash or RADIUS users configured under Meraki Authentication for a network to 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)


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

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

- Response property ssidNumber value added

- Summary changed from Return the Meraki Auth splash or RADIUS user to Return the Meraki Auth splash guest, RADIUS, or client VPN user


List the keys required to access Personally Identifiable Information (PII) for a given identifier

GET /networks/{networkId}/pii/piiKeys

- Summary changed from List the keys required to access Personally Identifiable Information (PII) for a given identifier. Exactly one identifier will be accepted. If the organization contains org-wide Systems Manager users matching the key provided then there will be an entry with the key "0" containing the applicable keys. to List the keys required to access Personally Identifiable Information (PII) for a given identifier


Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier

GET /networks/{networkId}/pii/smDevicesForKey

- Summary changed from Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier. These device IDs can be used with the Systems Manager API operations to retrieve device details. Exactly one identifier will be accepted. to Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier


Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier

GET /networks/{networkId}/pii/smOwnersForKey

- Summary changed from Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier. These owner IDs can be used with the Systems Manager API operations to retrieve owner details. Exactly one identifier will be accepted. to Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier


Return the traffic analysis data for this network

GET /networks/{networkId}/traffic

- Summary changed from The traffic analysis data for this network. [Traffic Analysis with Hostname Visibility](https://documentation.meraki.com/MR/Monitoring_and_Reporting/Hostname_Visibility) must be enabled on the network. to Return the traffic analysis data for this network


Update the policy assigned to a client on the network

PUT /networks/{networkId}/clients/{clientId}/policy

- Summary changed from Update the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to Update the policy assigned to a client on the network


Update a client's splash authorization

PUT /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus

- Summary changed from Update a client's splash authorization. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. to Update a client's splash authorization


Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be deleted)

PUT /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}

- Summary changed from Update a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be updated) to Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be deleted)


Provisions a client with a name and policy

POST /networks/{networkId}/clients/provision

- Summary changed from Provisions a client with a name and policy. Clients can be provisioned before they associate to the network. to Provisions a client with a name and policy


Create a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)

POST /networks/{networkId}/merakiAuthUsers

- Summary changed from Create a user configured with Meraki Authentication for a network (currently supports 802.1X and Splash Guest users, and currently, organizations have a 50,000 user cap) to Create a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)


Delete a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be deleted)

DELETE /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}

- Summary changed from Delete a user configured with Meraki Authentication (currently only 802.1X RADIUS users can be deleted) to Delete a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be deleted)


PATH /networks/{networkId}/environmental/events

- Path added

- New operation

List the environmental events for the network

GET /networks/{networkId}/environmental/events

{
    "pageStartAt": "2018-02-11T00:00:00.090210Z",
    "pageEndAt": "2018-02-11T00:00:00.090210Z",
    "events": [
        {
            "occurredAt": "2018-02-11T00:00:00.090210Z",
            "networkId": "N_24329156",
            "type": "mt_application_upgraded",
            "description": "Application upgraded",
            "sensorSerial": "Q234-ABCD-5678",
            "gatewaySerial": "Q234-ABCD-5678",
            "eventData": {
                "version": "mt_1_1"
            }
        }
    ]
}


PATH /networks/{networkId}/environmental/events/eventTypes

- Path added

- New operation

List the event type to human-readable description

GET /networks/{networkId}/environmental/events/eventTypes

[
    {
        "category": "Environmental",
        "type": "mt_application_upgraded",
        "description": "Application upgraded"
    }
]


[ sm ]

Return the client's daily cellular data usage history

GET /networks/{networkId}/sm/devices/{deviceId}/cellularUsageHistory

- Summary changed from Return the client's daily cellular data usage history. Usage data is in kilobytes. to Return the client's daily cellular data usage history


Return historical records of commands sent to Systems Manager devices

GET /networks/{networkId}/sm/devices/{deviceId}/deviceCommandLogs

- Summary changed from Return historical records of commands sent to Systems Manager devices.

Note that this will include the name of the Dashboard user who initiated the command if it was generated by a Dashboard admin rather than the automatic behavior of the system; you may wish to filter this out of any reports.

to Return historical records of commands sent to Systems Manager devices


PATH /networks/{networkId}/sm/devices

- Path added

- New operation

List the devices enrolled in an SM network with various specified fields and filters

GET /networks/{networkId}/sm/devices

{
    "id": "1284392014819",
    "name": "Miles's phone",
    "tags": [
        "tag1",
        "tag2"
    ],
    "ssid": "My SSID",
    "wifiMac": "00:11:22:33:44:55",
    "osName": "iOS 9.3.5",
    "systemModel": "iPhone",
    "uuid": "3d990628ede4c628d52",
    "serialNumber": "F5XKHEBX",
    "serial": "F5XKHEBX",
    "ip": "1.2.3.4",
    "notes": "Here's some info about my device"
}


PATH /networks/{networkId}/sm/devices/checkin

- Path added

- New operation

Force check-in a set of devices

POST /networks/{networkId}/sm/devices/checkin

{
    "ids": "\"1284392014819\""
}


PATH /networks/{networkId}/sm/devices/lock

- Path added

- New operation

Lock a set of devices

POST /networks/{networkId}/sm/devices/lock

{
    "ids": "\"1284392014819\""
}


PATH /networks/{networkId}/sm/devices/modifyTags

- Path added

- New operation

Add, delete, or update the tags of a set of devices

POST /networks/{networkId}/sm/devices/modifyTags

[
    {
        "id": "1284392014819",
        "serial": "F5XKHEBX",
        "wifiMac": "00:11:22:33:44:55",
        "tags": [
            "tag1",
            "tag2"
        ]
    }
]


PATH /networks/{networkId}/sm/devices/move

- Path added

- New operation

Move a set of devices to a new network

POST /networks/{networkId}/sm/devices/move

{
    "ids": "\"1284392014819\"",
    "newNetwork": "N_24329156"
}


PATH /networks/{networkId}/sm/users

- Path added

- New operation

List the owners in an SM network with various specified fields and filters

GET /networks/{networkId}/sm/users

[
    {
        "id": "1234",
        "email": "miles@meraki.com",
        "fullName": "Miles Meraki",
        "username": "",
        "hasPassword": false,
        "tags": [
            "tag1",
            "tag2"
        ],
        "adGroups": [],
        "asmGroups": [],
        "isExternal": false,
        "displayName": "Miles Meraki <miles@meraki.com>",
        "hasIdentityCertificate": false,
        "userThumbnail": "https://s3.amazonaws.com/image.extension"
    }
]


[ wireless ]

Aggregated connectivity info for a given client on this network

GET /networks/{networkId}/wireless/clients/{clientId}/connectionStats

- Summary changed from Aggregated connectivity info for a given client on this network. Clients are identified by their MAC. to Aggregated connectivity info for a given client on this network


Return the latency history for a client

GET /networks/{networkId}/wireless/clients/{clientId}/latencyHistory

- Summary changed from Return the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds. to Return the latency history for a client


Aggregated latency info for a given client on this network

GET /networks/{networkId}/wireless/clients/{clientId}/latencyStats

- Summary changed from Aggregated latency info for a given client on this network. Clients are identified by their MAC. to Aggregated latency info for a given client on this network


Display the splash page settings for the given SSID

GET /networks/{networkId}/wireless/ssids/{number}/splash/settings

- Response property redirectUrl value added

- Response property useRedirectUrl value added

- Response property welcomeMessage value added

- Response property splashLogo value added

- Response property splashImage value added

- Response property splashPrepaidFront value added


Update the Bluetooth settings for a network

PUT /networks/{networkId}/wireless/bluetooth/settings

- Summary changed from Update the Bluetooth settings for a network. See the docs page for [Bluetooth settings](https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)). to Update the Bluetooth settings for a network


Modify the splash page settings for the given SSID

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

- Optional property splashTimeout Added

- Optional property redirectUrl Added

- Optional property useRedirectUrl Added

- Optional property welcomeMessage Added

- Optional property splashLogo Added

- Optional property splashImage Added

- Optional property splashPrepaidFront Added


[ organizations ]

Return the branding policy IDs of an organization in priority order

GET /organizations/{organizationId}/brandingPolicies/priorities

- Summary changed from Return the branding policy IDs of an organization in priority order. IDs are ordered in ascending order of priority (IDs later in the array have higher priority). to Return the branding policy IDs of an organization in priority order


Claim a list of devices, licenses, and/or orders into an organization

POST /organizations/{organizationId}/claim

- Summary changed from Claim a list of devices, licenses, and/or orders into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory. to Claim a list of devices, licenses, and/or orders into an organization


Assign SM seats to a network

POST /organizations/{organizationId}/licenses/assignSeats

- Summary changed from Assign SM seats to a network. This will increase the managed SM device limit of the network to Assign SM seats to a network


Move licenses to another organization

POST /organizations/{organizationId}/licenses/move

- Summary changed from Move licenses to another organization. This will also move any devices that the licenses are assigned to to Move licenses to another organization


Renew SM seats of a license

POST /organizations/{organizationId}/licenses/renewSeats

- Summary changed from Renew SM seats of a license. This will extend the license expiration date of managed SM devices covered by this license to Renew SM seats of a license


PATH /organizations/{organizationId}/loginSecurity

- Path added

- New operation

Returns the login security settings for an organization.

GET /organizations/{organizationId}/loginSecurity

{
    "enforcePasswordExpiration": true,
    "passwordExpirationDays": 90,
    "enforceDifferentPasswords": true,
    "numDifferentPasswords": 3,
    "enforceStrongPasswords": true,
    "enforceAccountLockout": true,
    "accountLockoutAttempts": 3,
    "enforceIdleTimeout": true,
    "idleTimeoutMinutes": 30,
    "enforceTwoFactorAuth": true,
    "enforceLoginIpRanges": true,
    "loginIpRanges": [
        "192.195.83.1",
        "192.195.83.255"
    ]
}

- New operation

Update the login security settings for an organization

PUT /organizations/{organizationId}/loginSecurity

{
    "enforcePasswordExpiration": true,
    "passwordExpirationDays": 90,
    "enforceDifferentPasswords": true,
    "numDifferentPasswords": 3,
    "enforceStrongPasswords": true,
    "enforceAccountLockout": true,
    "accountLockoutAttempts": 3,
    "enforceIdleTimeout": true,
    "idleTimeoutMinutes": 30,
    "enforceTwoFactorAuth": true,
    "enforceLoginIpRanges": true,
    "loginIpRanges": [
        "192.195.83.1",
        "192.195.83.255"
    ]
}


[ insight ]

List the monitored media servers for this organization

GET /organizations/{organizationId}/insight/monitoredMediaServers

- Summary changed from List the monitored media servers for this organization. Only valid for organizations with Meraki Insight. to List the monitored media servers for this organization


Return a monitored media server for this organization

GET /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}

- Summary changed from Return a monitored media server for this organization. Only valid for organizations with Meraki Insight. to Return a monitored media server for this organization


Update a monitored media server for this organization

PUT /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}

- Optional property bestEffortMonitoringEnabled Added

- Summary changed from Update a monitored media server for this organization. Only valid for organizations with Meraki Insight. to Update a monitored media server for this organization


Add a media server to be monitored for this organization

POST /organizations/{organizationId}/insight/monitoredMediaServers

- Optional property bestEffortMonitoringEnabled Added

- Summary changed from Add a media server to be monitored for this organization. Only valid for organizations with Meraki Insight. to Add a media server to be monitored for this organization


Delete a monitored media server from this organization

DELETE /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}

- Summary changed from Delete a monitored media server from this organization. Only valid for organizations with Meraki Insight. to Delete a monitored media server from this organization