Version 1.22.0 to 1.23.0

Summary of Changes

6 - New

125 - Updated

551 - Total operations

348 - Total Paths

What's Changed

[ wireless ]

rfProfiles

Creates new RF profile for this network

POST /networks/{networkId}/wireless/rfProfiles

- Property minBitrate type turn from number to integer

Updates specified RF profile for this network

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

- Property minBitrate type turn from number to integer

[ global ]

service

PATH /organizations/{organizationId}/adaptivePolicy/groups/{groupId}

- renamed to /organizations/{organizationId}/adaptivePolicy/groups/{id}

What's Updated

[ wireless ]

rfProfiles

List the non-basic RF profiles for this network

GET /networks/{networkId}/wireless/rfProfiles

- Response property transmission value added

Return a RF profile

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

- Response property transmission value added

clientCountHistory

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

GET /networks/{networkId}/wireless/clientCountHistory

- Response property properties value added

dataRateHistory

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

GET /networks/{networkId}/wireless/dataRateHistory

- Response property properties value added

failedConnections

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

GET /networks/{networkId}/wireless/failedConnections

- Response property properties value added

latencyHistory

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

GET /networks/{networkId}/wireless/latencyHistory

- Response property properties value added

signalQualityHistory

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

GET /networks/{networkId}/wireless/signalQualityHistory

- Response property properties value added

ssids

List all Identity PSKs in a wireless network

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

- Response property properties value added

- Response property wifiPersonalNetworkId value added

- Response property email value added

Return an Identity PSK

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

- Response property properties value added

- Response property wifiPersonalNetworkId value added

- Response property email value added

Display the splash page settings for the given SSID

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

- Response property properties value added

- Response property extension value added

- Response property splashTimeout value added

- Response property guestSponsorship value added

- Response property blockAllTrafficBeforeSignOn value added

- Response property controllerDisconnectionBehavior value added

- Response property allowSimultaneousLogins value added

- Response property billing value added

- Response property sentryEnrollment value added

usageHistory

Return AP usage over time for a device or network client

GET /networks/{networkId}/wireless/usageHistory

- Response property properties value added

devices

Aggregated connectivity info for this network, grouped by node

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

- Response property properties value added

connectionStats

Aggregated connectivity info for a given AP on this network

GET /devices/{serial}/wireless/connectionStats

- Response property properties value added

Aggregated connectivity info for this network

GET /networks/{networkId}/wireless/connectionStats

- Response property properties value added

bluetooth

Return the bluetooth settings for a wireless device

GET /devices/{serial}/wireless/bluetooth/settings

- Response property properties value added

Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.

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

- Response property properties value added

- Response property minor value added

channelUtilizationHistory

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

GET /networks/{networkId}/wireless/channelUtilizationHistory

- Response property properties value added

[ switch ]

dhcpServerPolicy

Return the list of servers trusted by Dynamic ARP Inspection on this network

GET /networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers

- Response property properties value added

Return the devices that have a Dynamic ARP Inspection warning and their warnings

GET /networks/{networkId}/switch/dhcpServerPolicy/arpInspection/warnings/byDevice

- Response property properties value added

dhcp

Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day)

GET /networks/{networkId}/switch/dhcp/v4/servers/seen

- Response property properties value added

alternateManagementInterface

Update the switch alternate management interface for the network

PUT /networks/{networkId}/switch/alternateManagementInterface

- Optional property subnetMask Added

- Optional property gateway Added

Return the switch alternate management interface for the network

GET /networks/{networkId}/switch/alternateManagementInterface

- Response property subnetMask value added

- Response property gateway value added

accessPolicies

List the access policies for a switch network

GET /networks/{networkId}/switch/accessPolicies

- Response property properties value added

Return a specific access policy for a switch network

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

- Response property properties value added

routing

List layer 3 interfaces for a switch

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

- Response property properties value added

Return a layer 3 interface for a switch

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

- Response property properties value added

[ appliance ]

vlans

Add a VLAN

POST /networks/{networkId}/appliance/vlans

- Optional property templateVlanType Added

- Optional property cidr Added

- Optional property mask Added

Update a VLAN

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

- Optional property templateVlanType Added

- Optional property cidr Added

- Optional property mask Added

settings

Update the appliance settings for a network

PUT /networks/{networkId}/appliance/settings

- Added operation method

Update the appliance settings for a network

updateNetworkApplianceSettings
Code Snippet
Copy{
    "clientTrackingMethod": "MAC address"
}

[ networks ]

syslogServers

List the syslog servers for a network

GET /networks/{networkId}/syslogServers

- Response property properties value added

webhooks

List the HTTP servers for a network

GET /networks/{networkId}/webhooks/httpServers

- Response property properties value added

- Response property networkId value added

Return an HTTP server for a network

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

- Response property properties value added

- Response property networkId value added

Return the status of a webhook test for a network

GET /networks/{networkId}/webhooks/webhookTests/{webhookTestId}

- Response property properties value added

merakiAuthUsers

Authorize 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

- Optional property isAdmin Added

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

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

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

- Response property isAdmin value added

firmwareUpgrades

Get firmware upgrade information for a network

GET /networks/{networkId}/firmwareUpgrades

- Response property properties value added

- Response property wireless value added

- Response property appliance value added

- Response property vmxHost value added

- Response property environmental value added

- Response property sensor value added

- Response property cellularGateway value added

[ sm ]

users

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

GET /networks/{networkId}/sm/users

- Response property properties value added

Get the profiles associated with a user

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

- Response property properties value added

Get a list of softwares associated with a user

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

- Response property properties value added

userAccessDevices

List User Access Devices and its Trusted Access Connections

GET /networks/{networkId}/sm/userAccessDevices

- Response property properties value added

profiles

List all profiles in a network

GET /networks/{networkId}/sm/profiles

- Response property properties value added

devices

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

GET /networks/{networkId}/sm/devices

- Response property items value added

Return the client's daily cellular data usage history

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

- Response property properties value added

List the certs on a device

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

- Response property properties value added

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

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

- Response property properties value added

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

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

- Response property properties value added

Return historical records of commands sent to Systems Manager devices

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

- Response property properties value added

Get the installed profiles associated with a device

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

- Response property properties value added

List the network adapters of a device

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

- Response property properties value added

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

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

- Response property properties value added

List the security centers on a device

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

- Response property properties value added

Get a list of softwares associated with a device

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

- Response property properties value added

List the saved SSID names on a device

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

- Response property properties value added

apnsCert

Get the organization's APNS certificate

GET /organizations/{organizationId}/sm/apnsCert

- Response property properties value added

vppAccounts

List the VPP accounts in the organization

GET /organizations/{organizationId}/sm/vppAccounts

- Response property properties value added

Get a hash containing the unparsed token of the VPP account with the given ID

GET /organizations/{organizationId}/sm/vppAccounts/{vppAccountId}

- Response property properties value added

[ organizations ]

webhooks

Return the log of webhook POSTs sent

GET /organizations/{organizationId}/webhooks/logs

- Response property properties value added

clients

Return summary information around client data usage (in mb) across the given organization.

GET /organizations/{organizationId}/clients/overview

- Response property properties value added

licenses

List the licenses for an organization

GET /organizations/{organizationId}/licenses

- Response property properties value added

Display a license

GET /organizations/{organizationId}/licenses/{licenseId}

- Response property properties value added

networks

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

GET /organizations/{organizationId}/networks

- Response property properties value added

- Response property url value added

devices

List the status of every Meraki device in the organization

GET /organizations/{organizationId}/devices/statuses

- Response property properties value added

Return an overview of current device statuses

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

- Response property properties value added

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

GET /organizations/{organizationId}/devices/uplinksLossAndLatency

- Response property properties value added

summary

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

- Response property properties value added

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

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

- Response property properties value added

uplinks

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

GET /organizations/{organizationId}/uplinks/statuses

- Response property properties value added

- Response property provider value added

- Response property signalStat value added

- Response property connectionType value added

- Response property apn value added

- Response property dns1 value added

- Response property dns2 value added

- Response property signalType value added

- Response property iccid value added

[ sensor ]

readings

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

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

- Response property properties value added

- Response property humidity value added

- Response property water value added

- Response property door value added

- Response property tvoc value added

- Response property pm25 value added

- Response property noise value added

- Response property indoorAirQuality value added

- Response property button value added

- Response property battery value added

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

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

- Response property properties value added

- Response property humidity value added

- Response property water value added

- Response property door value added

- Response property tvoc value added

- Response property pm25 value added

- Response property noise value added

- Response property indoorAirQuality value added

- Response property button value added

- Response property battery value added

What's New

[ sm ]

trustedAccessConfigs

PATH /networks/{networkId}/sm/trustedAccessConfigs

- Path added

- New operation

List Trusted Access Configs

GET /networks/{networkId}/sm/trustedAccessConfigs

Code Snippet

Copy[
    {
        "id": "1284392014819",
        "ssidName": "My SSID",
        "name": "Cisco Meraki valued client",
        "scope": "with",
        "tags": [
            "tag1",
            "tag2"
        ],
        "accessStartAt": "2018-02-11T00:00:00Z",
        "accessEndAt": "2018-05-12T00:00:00Z"
    }
]

[ organizations ]

devices

PATH /organizations/{organizationId}/devices/availabilities

- Path added

- New operation

List the availability information for devices in an organization. The data returned by this operation is updated every 5 minutes.

GET /organizations/{organizationId}/devices/availabilities
Code Snippet
Copy[
    {
        "mac": "00:11:22:33:44:55",
        "name": "My AP",
        "network": {
            "id": "N_24329156"
        },
        "productType": "switch",
        "serial": "Q234-ABCD-5678",
        "status": "online",
        "tags": [
            "tag1",
            "tag2"
        ]
    }
]

earlyAccess

PATH /organizations/{organizationId}/earlyAccess/features

- Path added

- New operation

List the available early access features for organization

GET /organizations/{organizationId}/earlyAccess/features

Code Snippet

Copy[
    {
        "shortName": "has_new_feature",
        "name": "New Feature Beta",
        "descriptions": {
            "short": "New Feature Beta",
            "long": "New Feature Beta long description. consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
        },
        "topic": "Dashboard",
        "isOrgScopedOnly": true
    }
]

PATH /organizations/{organizationId}/earlyAccess/features/optIns

- Path added

- New operation

List the early access feature opt-ins for an organization

GET /organizations/{organizationId}/earlyAccess/features/optIns
Code Snippet
Copy[
    {
        "id": "1",
        "shortName": "has_new_feature",
        "limitScopeToNetworks": [
            {
                "id": "L_1234",
                "name": "My Network"
            }
        ],
        "createdAt": "2022-05-01T04:07:15Z"
    }
]
- New operation

Create a new early access feature opt-in for an organization

POST /organizations/{organizationId}/earlyAccess/features/optIns
Code Snippet
Copy{
    "id": "1",
    "shortName": "has_new_feature",
    "limitScopeToNetworks": [
        {
            "id": "L_1234",
            "name": "My Network"
        }
    ],
    "createdAt": "2022-05-01T04:07:15Z"
}

PATH /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}

- Path added

- New operation

Show an early access feature opt-in for an organization

GET /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
Code Snippet
Copy{
    "id": "1",
    "shortName": "has_new_feature",
    "limitScopeToNetworks": [
        {
            "id": "L_1234",
            "name": "My Network"
        }
    ],
    "createdAt": "2022-05-01T04:07:15Z"
}
- New operation

Update an early access feature opt-in for an organization

PUT /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
Code Snippet
Copy{
    "id": "1",
    "shortName": "has_new_feature",
    "limitScopeToNetworks": [
        {
            "id": "L_1234",
            "name": "My Network"
        }
    ],
    "createdAt": "2022-05-01T04:07:15Z"
}
- New operation

Delete an early access feature opt-in

DELETE /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}

[ administered ]

identities

PATH /administered/identities/me

- Path added

- New operation

Returns the identity of the current user.

GET /administered/identities/me

Code Snippet

Copy{
    "name": "Miles Meraki",
    "email": "miles@meraki.com",
    "lastUsedDashboardAt": "2018-02-11T00:00:00.090210Z",
    "authentication": {
        "mode": "email",
        "api": {
            "key": {
                "created": true
            }
        },
        "twoFactor": {
            "enabled": false
        },
        "saml": {
            "enabled": false
        }
    }
}