What's Changed
- [ wireless ]
  - radio
    - Update the radio settings of a device
- [ switch ]
  - routing
    - Update layer 3 OSPF routing configuration
What's Updated
What's New
- [ networks ]
  - clients
    - Returns a timeseries of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second.
  - topology
    - List of devices and connections among them within the network.
- [ organizations ]

Version 1.14.0 to 1.15.0

Summary of Changes

8 - New

161 - Updated

506 - Total operations

321 - Total Paths

What's Changed

[ wireless ]

radio

Update the radio settings of a device

PUT /devices/{serial}/wireless/radio/settings

[ switch ]

routing

Update layer 3 OSPF routing configuration

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

What's Updated

[ wireless ]

airMarshal

List Air Marshal scan results from a network

GET /networks/{networkId}/wireless/airMarshal

channelUtilizationHistory

Return AP channel utilization over time for a device or network client

GET /networks/{networkId}/wireless/channelUtilizationHistory

clientCountHistory

Return wireless client counts over time for a network, device, or network client

GET /networks/{networkId}/wireless/clientCountHistory

dataRateHistory

Return PHY data rates over time for a network, device, or network client

GET /networks/{networkId}/wireless/dataRateHistory

failedConnections

List of all failed client connection events on this network in a given time range

GET /networks/{networkId}/wireless/failedConnections

latencyHistory

Return average wireless latency over time for a network, device, or network client

GET /networks/{networkId}/wireless/latencyHistory

rfProfiles

List the non-basic RF profiles for this network

GET /networks/{networkId}/wireless/rfProfiles

Return a RF profile

GET /networks/{networkId}/wireless/rfProfiles/{rfProfileId}

signalQualityHistory

Return signal quality (SNR/RSSI) over time for a device or network client

GET /networks/{networkId}/wireless/signalQualityHistory

ssids

List the MR SSIDs in a network

GET /networks/{networkId}/wireless/ssids

List all Identity PSKs in a wireless network

GET /networks/{networkId}/wireless/ssids/{number}/identityPsks

usageHistory

Return AP usage over time for a device or network client

GET /networks/{networkId}/wireless/usageHistory

devices

Aggregated connectivity info for this network, grouped by node

GET /networks/{networkId}/wireless/devices/connectionStats

Aggregated latency info for this network, grouped by node

GET /networks/{networkId}/wireless/devices/latencyStats

clients

Aggregated connectivity info for this network, grouped by clients

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

Aggregated latency info for this network, grouped by clients

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

List the wireless connectivity events for a client within a network in the timespan.

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

Return the latency history for a client

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

[ switch ]

accessPolicies

List the access policies for a switch network

GET /networks/{networkId}/switch/accessPolicies

linkAggregations

List link aggregation groups

GET /networks/{networkId}/switch/linkAggregations

qosRules

List quality of service rules

GET /networks/{networkId}/switch/qosRules

stacks

List the switch stacks in a network

GET /networks/{networkId}/switch/stacks

List layer 3 interfaces for a switch stack

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

List layer 3 static routes for a switch stack

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

configTemplates

List the switch profiles for your switch template configuration

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles

ports

List the switch ports for a switch

GET /devices/{serial}/switch/ports

Return the status for all the ports of a switch

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

Return the packet counters for all the ports of a switch

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

routing

List layer 3 interfaces for a switch

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

List layer 3 static routes for a switch

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

List multicast rendezvous points

GET /networks/{networkId}/switch/routing/multicast/rendezvousPoints

portSchedules

List switch port schedules

GET /networks/{networkId}/switch/portSchedules

[ appliance ]

uplink

List the uplink status of every Meraki MX and Z series appliances in the organization

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

vpn

Show VPN history stat for networks in an organization

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

Show VPN status for networks in an organization

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

vlans

List the VLANs for an MX network

GET /networks/{networkId}/appliance/vlans

uplinks

Get the sent and received bytes for each uplink of a network.

GET /networks/{networkId}/appliance/uplinks/usageHistory

trafficShaping

List all custom performance classes for an MX network

GET /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses

staticRoutes

Update a static route for an MX or teleworker network

PUT /networks/{networkId}/appliance/staticRoutes/{staticRouteId}

List the static routes for an MX or teleworker network

GET /networks/{networkId}/appliance/staticRoutes

Add a static route for an MX or teleworker network

POST /networks/{networkId}/appliance/staticRoutes

security

List the security events for a network

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

List the security events for an organization

GET /organizations/{organizationId}/appliance/security/events

firewall

List the appliance services and their accessibility rules

GET /networks/{networkId}/appliance/firewall/firewalledServices

ports

List per-port VLAN settings for all ports of a MX.

GET /networks/{networkId}/appliance/ports

clients

List the security events for a client

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

dhcp

Return the DHCP subnet information for an appliance

GET /devices/{serial}/appliance/dhcp/subnets

[ camera ]

wirelessProfiles

List the camera wireless profiles for this network.

GET /networks/{networkId}/camera/wirelessProfiles

schedules

Returns a list of all camera recording schedules.

GET /networks/{networkId}/camera/schedules

qualityRetentionProfiles

List the quality retention profiles for this network

GET /networks/{networkId}/camera/qualityRetentionProfiles

onboarding

Fetch onboarding status of cameras

GET /organizations/{organizationId}/camera/onboarding/statuses

sense

Returns the MV Sense object detection model list for the given camera

GET /devices/{serial}/camera/sense/objectDetectionModels

analytics

Returns an overview of aggregate analytics data for a timespan

GET /devices/{serial}/camera/analytics/overview

Returns most recent record for analytics zones

GET /devices/{serial}/camera/analytics/recent

Returns all configured analytic zones for this camera

GET /devices/{serial}/camera/analytics/zones

Return historical records for analytic zones

GET /devices/{serial}/camera/analytics/zones/{zoneId}/history

[ devices ]

lossAndLatencyHistory

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

GET /devices/{serial}/lossAndLatencyHistory

clients

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

GET /devices/{serial}/clients

[ networks ]

splashLoginAttempts

GET /networks/{networkId}/splashLoginAttempts

traffic

Return the traffic analysis data for this network

GET /networks/{networkId}/traffic

webhooks

Update an HTTP server

PUT /networks/{networkId}/webhooks/httpServers/{httpServerId}

List the HTTP servers for a network

GET /networks/{networkId}/webhooks/httpServers

Return an HTTP server for a network

GET /networks/{networkId}/webhooks/httpServers/{httpServerId}

Add an HTTP server to a network

POST /networks/{networkId}/webhooks/httpServers

Send a test webhook for a network

POST /networks/{networkId}/webhooks/webhookTests

pii

List the PII requests for this network or organization

GET /networks/{networkId}/pii/requests

networkHealth

Get the channel utilization over each radio for all APs in a network.

GET /networks/{networkId}/networkHealth/channelUtilization

mqttBrokers

List the MQTT brokers for this network

GET /networks/{networkId}/mqttBrokers

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

groupPolicies

List the group policies in a network

GET /networks/{networkId}/groupPolicies

floorPlans

List the floor plans that belong to your network

GET /networks/{networkId}/floorPlans

events

List the event type to human-readable description

GET /networks/{networkId}/events/eventTypes

devices

List the devices in a network

GET /networks/{networkId}/devices

bluetoothClients

List the Bluetooth clients seen by APs in this network

GET /networks/{networkId}/bluetoothClients

trafficShaping

Returns the available DSCP tagging options for your traffic shaping rules.

GET /networks/{networkId}/trafficShaping/dscpTaggingOptions

clients

List the clients that have used this network in the timespan

GET /networks/{networkId}/clients

Return the application usage data for clients

GET /networks/{networkId}/clients/applicationUsage

Return the usage histories for clients

GET /networks/{networkId}/clients/usageHistories

Return the client's network traffic data over time

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

Return the client's daily usage history

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

[ insight ]

applications

Get application health by time

GET /networks/{networkId}/insight/applications/{applicationId}/healthByTime

List all Insight tracked applications

GET /organizations/{organizationId}/insight/applications

monitoredMediaServers

List the monitored media servers for this organization

GET /organizations/{organizationId}/insight/monitoredMediaServers

[ sm ]

users

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

GET /networks/{networkId}/sm/users

Get the profiles associated with a user

GET /networks/{networkId}/sm/users/{userId}/deviceProfiles

Get a list of softwares associated with a user

GET /networks/{networkId}/sm/users/{userId}/softwares

userAccessDevices

List User Access Devices and its Trusted Access Connections

GET /networks/{networkId}/sm/userAccessDevices

targetGroups

List the target groups in this network

GET /networks/{networkId}/sm/targetGroups

profiles

List all profiles in a network

GET /networks/{networkId}/sm/profiles

devices

Return the client's daily cellular data usage history

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

List the certs on a device

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

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

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

Return historical records of various Systems Manager network connection details for desktop devices.

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

Return historical records of commands sent to Systems Manager devices

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

Get the profiles associated with a device

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

List the network adapters of a device

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

Return historical records of various Systems Manager client metrics for desktop devices.

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

List the restrictions on a device

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

List the security centers on a device

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

Get a list of softwares associated with a device

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

List the saved SSID names on a device

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

vppAccounts

List the VPP accounts in the organization

GET /organizations/{organizationId}/sm/vppAccounts

[ organizations ]

webhooks

Return a list of alert types to be used with managing webhook alerts

GET /organizations/{organizationId}/webhooks/alertTypes

Return the log of webhook POSTs sent

GET /organizations/{organizationId}/webhooks/logs

actionBatches

Return the list of action batches in the organization

GET /organizations/{organizationId}/actionBatches

devices

List the devices in an organization

GET /organizations/{organizationId}/devices

List the status of every Meraki device in the organization

GET /organizations/{organizationId}/devices/statuses

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

GET /organizations/{organizationId}/devices/uplinksLossAndLatency

adaptivePolicy

List adaptive policy ACLs in a organization

GET /organizations/{organizationId}/adaptivePolicy/acls

admins

List the dashboard administrators in this organization

GET /organizations/{organizationId}/admins

apiRequests

List the API requests made by an organization

GET /organizations/{organizationId}/apiRequests

brandingPolicies

List the branding policies of an organization

GET /organizations/{organizationId}/brandingPolicies

uplinks

List the uplink status of every Meraki MX, MG and Z series devices in the organization

GET /organizations/{organizationId}/uplinks/statuses

configTemplates

List the configuration templates for this organization

GET /organizations/{organizationId}/configTemplates

configurationChanges

View the Change Log for your organization

GET /organizations/{organizationId}/configurationChanges

inventoryDevices

Return the device inventory for an organization

GET /organizations/{organizationId}/inventoryDevices

Return a single device from the inventory of an organization

GET /organizations/{organizationId}/inventoryDevices/{serial}

licenses

List the licenses for an organization

GET /organizations/{organizationId}/licenses

networks

List the networks that the user has privileges on in an organization

GET /organizations/{organizationId}/networks

saml

List the SAML IdPs in your organization.

GET /organizations/{organizationId}/saml/idps

samlRoles

List the SAML roles for this organization

GET /organizations/{organizationId}/samlRoles

summary

Return the top 10 appliances sorted by utilization over given time range.

GET /organizations/{organizationId}/summary/top/appliances/byUtilization

Return metrics for organization's top 10 clients by data usage (in mb) over given time range.

GET /organizations/{organizationId}/summary/top/clients/byUsage

Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.

GET /organizations/{organizationId}/summary/top/clients/manufacturers/byUsage

Return metrics for organization's top 10 devices sorted by data usage over given time range

GET /organizations/{organizationId}/summary/top/devices/byUsage

Return metrics for organization's top 10 device models sorted by data usage over given time range

GET /organizations/{organizationId}/summary/top/devices/models/byUsage

Return metrics for organization's top 10 ssids by data usage over given time range

GET /organizations/{organizationId}/summary/top/ssids/byUsage

Return metrics for organization's top 10 switches by energy usage over given time range

GET /organizations/{organizationId}/summary/top/switches/byEnergyUsage

service

List the organizations that the user has privileges on

GET /organizations

[ cellularGateway ]

uplink

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

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

What's New

[ networks ]

clients

PATH /networks/{networkId}/clients/bandwidthUsageHistory

topology

PATH /networks/{networkId}/topology/linkLayer

- Path added

- New operation

List of devices and connections among them within the network.

GET /networks/{networkId}/topology/linkLayer

{
    "nodes": [
        {
            "derivedId": "ccddeeffgghh",
            "mac": "CC:DD:EE:FF:GG:HH",
            "type": "discovered",
            "root": true,
            "discovered": {
                "lldp": {
                    "chassisId": "12345",
                    "systemName": "Non-Meraki device",
                    "systemDescription": "Router and Switch Device",
                    "systemCapabilities": [
                        "router",
                        "switch"
                    ],
                    "managementAddress": "10.130.105.154"
                },
                "cdp": "null"
            }
        },
        {
            "derivedId": "34564",
            "mac": "null",
            "type": "stack",
            "stack": {
                "id": 98765,
                "name": "Corp Stack",
                "members": [
                    {
                        "derivedId": "4567",
                        "mac": "EE:FF:GG:HH:II:JJ",
                        "type": "device",
                        "device": {
                            "serial": "Q2UN-A44e-CU4L",
                            "name": "Study Switch",
                            "product": "switch",
                            "model": "GS110",
                            "status": "online",
                            "lastReportedAt": "2021-06-24T10:23:12z",
                            "clients": {
                                "counts": {
                                    "total": 8
                                }
                            },
                            "switch": {
                                "ports": {
                                    "counts": {
                                        "byStatus": {
                                            "active": 11
                                        }
                                    }
                                }
                            },
                            "uplinks": [
                                {
                                    "vlanId": 0
                                }
                            ]
                        }
                    },
                    {
                        "derivedId": "4567",
                        "mac": "GG:HH:II:JJ:KK:LL",
                        "type": "device",
                        "device": {
                            "serial": "Q2UN-E55e-KO6L",
                            "name": "Study Switch 2",
                            "model": "GS110",
                            "productType": "switch",
                            "status": "online",
                            "lastReportedAt": "2021-06-24T10:23:12z",
                            "clients": {
                                "counts": {
                                    "total": 8
                                }
                            },
                            "switch": {
                                "ports": {
                                    "counts": {
                                        "byStatus": {
                                            "active": 11
                                        }
                                    }
                                }
                            },
                            "uplinks": [
                                {
                                    "vlanId": 0
                                }
                            ]
                        }
                    }
                ],
                "clients": {
                    "counts": {
                        "total": 14
                    }
                }
            }
        },
        {
            "derivedId": "aabbccddeeff",
            "mac": "AA:BB:CC:DD:EE:FF",
            "type": "device",
            "device": {
                "serial": "Q2UN-A44e-CU4L",
                "name": "Living Room Gateway",
                "model": "GX20",
                "productType": "appliance",
                "status": "online",
                "lastReportedAt": "2021-06-24T10:23:12z",
                "uplinks": [
                    {
                        "vlanId": 0,
                        "pppoe": {
                            "enabled": true
                        }
                    }
                ]
            }
        }
    ],
    "links": [
        {
            "ends": [
                {
                    "node": {
                        "derivedId": "34564",
                        "type": "stack"
                    },
                    "device": {
                        "serial": "Q2UN-E55e-KO6L",
                        "name": "Study Switch 2"
                    },
                    "discovered": {
                        "lldp": {
                            "portId": "Port 20",
                            "portDescription": "eth0"
                        },
                        "cdp": {
                            "portId": "Port 20",
                            "nativeVlan": 102
                        }
                    }
                },
                {
                    "node": {
                        "derivedId": "ccddeeffgghh",
                        "type": "discovered"
                    },
                    "discovered": {
                        "lldp": {
                            "portId": "0010.7fdb.51f7",
                            "portDescription": "eth1"
                        },
                        "cdp": "null"
                    }
                }
            ],
            "lastReportedAt": "2021-06-25T14:56:27z"
        }
    ]
}

[ organizations ]

alerts

PATH /organizations/{organizationId}/alerts/profiles

- Path added

- New operation

List all organization-wide alert configurations

GET /organizations/{organizationId}/alerts/profiles

[
    {
        "id": "1284392014819",
        "type": "wanUtilization",
        "enabled": true,
        "alertCondition": {
            "duration": 60,
            "window": 600,
            "bit_rate_bps": 10000,
            "interface": "wan1"
        },
        "recipients": {
            "emails": [
                "admin@example.org"
            ],
            "httpServerIds": [
                "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA=="
            ]
        },
        "networkTags": [
            "tag1",
            "tag2"
        ],
        "description": "WAN 1 high utilization"
    }
]

- New operation

Create an organization-wide alert configuration

POST /organizations/{organizationId}/alerts/profiles

{
    "id": "1284392014819",
    "type": "wanUtilization",
    "enabled": true,
    "alertCondition": {
        "duration": 60,
        "window": 600,
        "bit_rate_bps": 10000,
        "interface": "wan1"
    },
    "recipients": {
        "emails": [
            "admin@example.org"
        ],
        "httpServerIds": [
            "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA=="
        ]
    },
    "networkTags": [
        "tag1",
        "tag2"
    ],
    "description": "WAN 1 high utilization"
}

PATH /organizations/{organizationId}/alerts/profiles/{alertConfigId}

devices

PATH /organizations/{organizationId}/devices/statuses/overview

clients

PATH /organizations/{organizationId}/clients/bandwidthUsageHistory

PATH /organizations/{organizationId}/clients/overview

PATH /organizations/{organizationId}/clients/search

- Path added

- New operation

Return the client details in an organization

GET /organizations/{organizationId}/clients/search

{
    "clientId": "k74272e",
    "mac": "22:33:44:55:66:77",
    "manufacturer": "Apple",
    "records": [
        {
            "network": {
                "id": "L_123456",
                "organizationId": "2930418",
                "name": "Long Island Office",
                "timeZone": "America/Los_Angeles",
                "tags": [
                    "tag1",
                    "tag2"
                ],
                "productTypes": [
                    "appliance",
                    "switch",
                    "wireless"
                ],
                "enrollmentString": "long-island-office",
                "notes": "Combined network for Long Island Office"
            },
            "description": "Miles's phone",
            "os": "iOS",
            "user": "milesmeraki",
            "ip": "1.2.3.4",
            "ip6": "2001:db8:3c4d:15::1",
            "firstSeen": 1518365681,
            "lastSeen": 1526087474,
            "vlan": "255",
            "switchport": null,
            "wirelessCapabilities": "802.11ac - 2.4 and 5 GHz",
            "smInstalled": true,
            "ssid": "My SSID",
            "clientVpnConnections": [
                {
                    "remoteIp": "1.2.3.4",
                    "connectedAt": 1522613355,
                    "disconnectedAt": 1522613360
                }
            ],
            "lldp": [
                [
                    "System name",
                    "Some system name"
                ],
                [
                    "System description",
                    "Some system description"
                ],
                [
                    "Port ID",
                    "1"
                ],
                [
                    "Chassis ID",
                    "00:18:0a:00:00:00"
                ],
                [
                    "Port description",
                    "eth0"
                ],
                [
                    "System capabilities",
                    "Two-port MAC Relay"
                ]
            ],
            "cdp": null,
            "status": "Online"
        }
    ]
}