12-2023

Highlights

1. Callbacks

Callbacks are now live and supporting: ping, pingDevice and action batches.
More live tools on the way!

2. Dashboard API Python Library v1.40.0 released.

Dashboard API Releases

Changelog 1.40.0

Changelog 1.41.0

Summary of Changes

6 - New

33 - Updated

663 - Total operations

421 - Total Paths

What's New

[ licensing ]
- subscription
  - List available subscriptions
  - Claim a subscription into an organization.
  - Find a subscription by claim key. Returns 400 if the key has already been claimed.
  - Bind networks to a subscription
[ organizations ]
- webhooks
  - Return the status of an API callback
[ switch ]
- summary
  - Returns the total PoE power draw for all switch ports in the organization over the requested timespan (by default the last 24 hours). The returned array is a newest-first list of intervals. The time between intervals depends on the requested timespan with 20 minute intervals used for timespans up to 1 day, 4 hour intervals used for timespans up to 2 weeks, and 1 day intervals for timespans larger than 2 weeks.

What's Updated

[ devices ]
- ping
- pingdevice
- service
[ network ]
[ organizations ]

11-2023

Highlights

API & Webhooks Dashboard UI page
- A new page in the Meraki Dashboard dedicated solely to API and Webhook management. For more details read the community post
Integrated APIs section featuring SecureConnect published
- A new section called Integrated APIs to bridge the gap between the multitude of software solutions we encounter.
- Introducing Secure Connect Integrated APIs at api.meraki.com. A bridge to seamlessly connect diverse software solutions
Postman collection for APIv1.39 released
API interactive Documentation update
- Improved security by providing test keys to run request against the API and restricting user sensitive API keys to be pasted in the documentation.

Dashboard API Version 1.39.0 Released

Changelog

Summary of Changes

3 - New

72 - Updated

661 - Total operations

419 - Total Paths

What's New

[ wireless ]
- devices
  - Get average packet loss for the given timespan for all clients in the organization.
  - Get average packet loss for the given timespan for all devices in the organization. Does not include device’s own traffic.
  - Get average packet loss for the given timespan for all networks in the organization.

What's Changed

[ organizations ]
- devices
  - List the status of every Meraki device in the organization

What's Updated

Response properties added to the following operations

organizations
camera
sensor
appliance
switch
networks
- [settings]
  - Property clientPrivacy Deleted
sm
- [devices]
  - Optional param uuids added
- [profiles]
  - Summary changed from List all the profiles in the network to List all profiles in a network
- [vppAccounts]
  - Response and optional properties added.

10-2023

Highlights

Dashboard API Python Library v1.38.0 released. Read more about it in our community post.
Action batches supported resources has new additions to the developer document.
The Meraki ServiceGraph Connector for ServiceNow v1.3.3 now supports the Vancouver ServiceNow release.

Dashboard API Version 1.38.0 Released

Changelog

Summary of Changes

6 - New

29 - Updated

658 - Total operations

416 - Total Paths

What's New

[ sm ]
- devices
  - Install applications on a device
  - Uninstall applications on a device
[ networks ]
- vlanProfiles
  - List VLAN profiles for a network
  - Create a VLAN profile for a network
  - Get the assigned VLAN Profiles for devices in a network
  - Update the assigned VLAN Profile for devices in a network
  - Get an existing VLAN profile of a network
  - Update an existing VLAN profile of a network
  - Delete a VLAN profile of a network

What's Updated

[ devices ]
- service
  - Return a single device
    - Response property details value added
[ networks ]
- clients
  - List the clients that have used this network in the timespan
    - Optional param namedVlan added
- devices
  - List the devices in a network
    - Response property details value added
- firmwareUpgrades
  - Get firmware upgrade information for a network
    - Property cloudGateway Deleted
  - Update firmware upgrade information for a network
    - Property cloudGateway Deleted
- floorPlans
  - Destroy a floor plan
    - Optional property details Added
  - List the floor plans that belong to your network
    - Optional property details, Response property details added
  - Find a floor plan by ID
    - Optional property details, Response property details added
  - Update a floor plan's geolocation and other meta data
    - Optional property details Added
  - Upload a floor plan
    - Optional property details Added
- settings
  - Update the settings for a network
    - Optional property namedVlans Added
[ wireless ]
- settings
  - Update the wireless settings for a network
    - Optional property namedVlans Added
- ssids
  - Display the traffic shaping settings for a SSID on an MR network
    - Response property properties value added
  - Update the attributes of an MR SSID
    - Optional property namedVlans Added
[ organizations ]
- devices
  - List the devices in an organization
    - Optional property details, Response property details added
- firmware
  - Get firmware upgrade information for an organization
    - Optional properties and Response properties added

9-2023

Highlights

API Documentation improvements

Enhanced search to include API request properties
Deprecation notices on older operations
min/max value information added to property descriptions
Adjusted navigation to surface key information

Postman Collection

Navigation changes
operationId is now the name (instead of use the summary)
Authorization set to Bearer Token
Bug fix - collection variables missing

Read the Community Post for all the details.

Dashboard API Version 1.37.0 Released

Changelog

Summary of Changes

12 - New

19 - Updated

650 - Total operations

411 - Total Paths

What's Updated

[ switch ]
- settings
  - Returns the switch network settings
    - Optional property macBlocklist Added
[ wireless ]
- ssids
  - List the MR SSIDs in a network
    - Optional property localAuth Added
[ organizations ]
- inventory
  - Return the device inventory for an organization
    - Optional property countryCode Added

What's New

[ camera ]
- permissions
  - List the permissions scopes for this organization
  - Retrieve a single permission scope
- roles
  - List all the roles in this organization
  - Creates new role for this organization.
  - Retrieve a single role.
  - Update an existing role in this organization.
  - Delete an existing role for this organization.
[ appliance ]
- trafficShaping
  - Update VPN exclusion rules for an MX network.
  - Display VPN exclusion rules for MX networks.
[ wireless ]
- alternateManagementInterface
  - Update alternate management interface IPv6 address
- ethernet
  - List the AP port profiles for this network
  - Create an AP port profile
  - Assign AP port profile to list of APs
  - Set the AP port profile to be default for this network
  - Show the AP port profile by ID for this network
  - Update the AP port profile by ID for this network
  - Delete an AP port profile
[ organizations ]
- uplinksLossAndLatency
  - Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

8-2023

Highlights

Introducing callbacks, where you can now receive a webhook with the results of a long running API request (i.e. ping or an async action batch). This new capability has recently been made available to our Early Access API users. Read the community post for all the details.

Dashboard API Version 1.36.0 Released

Changelog

Summary of Changes

1 - New

142 - Updates

632 - Total operations

What's New

[ organizations ]

devices

List the availability history information for devices in an organization.

GET /organizations/{organizationId}/devices/availabilities/changeHistory

Read the Community Post for more details.

What's Updated

camera

The default quality and retention resolution for the MV32 cameras have been changed from 2058x2058 to 2112x2112

GET /devices/{serial}/camera/qualityAndRetention
PUT /devices/{serial}/camera/qualityAndRetention
POST /networks/{networkId}/camera/qualityRetentionProfiles
GET /networks/{networkId}/camera/qualityRetentionProfiles
GET /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

7-2023

Highlights

API Docs are now mobile friendly!

Dashboard API Version 1.35.0 Released

Changelog

Summary of Changes

1 - New

22 - Updated

631 - Total operations

398 - Total Paths

What's New

Appliance

Uplinks

Get the sent and received bytes for each uplink of all MX and Z networks within an organization. If more than one device was active during the specified timespan, then the sent and received bytes will be aggregated by interface.

GET /organizations/{organizationId}/appliance/uplinks/usage/byNetwork
Get the sent and received bytes for each uplink of all MX and Z networks within an organization. If more than one device was active during the specified timespan, then the sent and received bytes will be aggregated by interface.

What's Updated

Wireless

RF Profiles
- Creates new RF profile for this network: Added optional property flexRadios
- Updates specified RF profile for this network: Added optional property flexRadios
SSIDs
- List the Bonjour forwarding setting and rules for the SSID: Added response property exception
- Update the Bonjour forwarding setting and rules for the SSID: Added optional property exception

Networks

Alerts
- Update the alert configuration for this network: Added optional property muting
Floor Plans
- List the floor plans that belong to your network: Added response property productType
- Find a floor plan by ID: Added response property productType

Organizations

Devices
- List the status of every Meraki device in the organization: Added response property items

Added Response Schemas

These operations have expanded the information that the API returns, providing a more comprehensive view of each resource.

Wireless

Status
- Return the SSID statuses of an access point
Billing
- Return the billing settings of this network
SSIDs
- List the MR SSIDs in a network
- Return a single MR SSID

Networks

Floor Plans
- List the floor plans that belong to your network
- Find a floor plan by ID

Organizations

ConfigTemplates
- List the configuration templates for this organization
- Return a single configuration template

6-2023

Highlights

OpenAPI v3 is officially supported! Read the blog post
The Meraki ServiceGraph Connector for ServiceNow v1.3.3 has been released. This includes support for the Utah ServiceNow release. Read the blog post

Dashboard API Version 1.34.0 Released

Changelog

Summary of Changes

7 - New

98 - Updated

631 - Total operations

398 - Total Paths

What's New

Appliance

RF Profiles

List the RF profiles for this network

GET /networks/{networkId}/appliance/rfProfiles

Creates new RF profile for this network

POST /networks/{networkId}/appliance/rfProfiles

Return a RF profile

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

Updates specified RF profile for this network

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

Delete a RF Profile

DELETE /networks/{networkId}/appliance/rfProfiles/{rfProfileId}

Radio

Return the radio settings of an appliance

GET /devices/{serial}/appliance/radio/settings

Update the radio settings of an appliance

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

Wireless

Devices

Get average channel utilization for all bands in a network, split by AP

GET /organizations/{organizationId}/wireless/devices/channelUtilization/byDevice

Get average channel utilization across all bands for all networks in the organization

GET /organizations/{organizationId}/wireless/devices/channelUtilization/byNetwork

Get a time-series of average channel utilization for all bands, segmented by device

GET /organizations/{organizationId}/wireless/devices/channelUtilization/history/byDevice/byInterval

Get a time-series of average channel utilization for all bands

GET /organizations/{organizationId}/wireless/devices/channelUtilization/history/byNetwork/byInterval

What's Updated

Appliance

Firewall

Return the L7 firewall application categories and their associated applications for an MX network

Response schema has been added to provide detailed output.

SSIDs

Update the attributes of an MX SSID

A new optional property dot11w has been introduced.

Networks

Firmware Upgrades

Get firmware upgrade information for a network, Update firmware upgrade information for a network, Create a Staged Upgrade Event for a network

Various new optional properties like cloudGateway and switchCatalyst have been added.
Response schemas have been added to provide detailed output.

Topology

List the LLDP and CDP information for all discovered devices and connections in a network

Added response schema to provide error details.

Clients

List the clients that have used this network in the timespan

New optional param pskGroup and property pskGroup have been added.
Response schema has been added for pskGroup.

SM

Trusted Access Configs

List Trusted Access Configs

New optional properties sendExpirationEmails, notifyTimeBeforeAccessEnds, and additionalEmailText have been added.
Response schemas for the new optional properties have been introduced.

Switch

DSCP to CoS Mappings, Quality of Service Rule, Multicast Settings, DHCP Server Settings, and many more

Response schemas have been added to these services for a more detailed output.

Wireless

RF Profiles

List RF profiles for this network, Return a RF profile, Updates specified RF profile for this network, Creates new RF profile for this network

Response schemas have been added.
The optional property sixGhzSettings has been introduced.

Organizations

Admins, API Requests, SAML Roles, and many more

List the dashboard administrators in this organization, Return an aggregated overview of API requests data, List the SAML roles for this organization, Return a SAML role

Response schemas have been added to provide detailed output.

OpenAPI Spec

Return the OpenAPI Specification of the organization's API documentation in JSON

New optional param version added, which now allows returning an OpenAPI v3 specification by setting its value to 3. The summary of the operation has also been updated accordingly.

5-2023

Highlights

Dashboard API Python Library v1.33.0 released. Read more about it in our community post.
The Meraki Servicegraph Connector for ServiceNow v1.3.2 has been released. This includes a Bug fix to address challenges some users were experiencing while importing devices.

Dashboard API Version 1.33.0 Released

Changelog

Summary of Changes

3 - New

858 - Updated

620 - Total operations

391 - Total Paths

What's Updated

[appliance]

vpn

Update a Hub BGP Configuration

Description added: Network ID
Optional property sourceInterface Added
Optional property nextHopIp Added
Optional property ttlSecurity Added
Optional property authentication Added

[networks]

webhooks

List the webhook payload templates for a network

Description added: Network ID
Optional property sharing Added
Response property sharing value added

Get the webhook payload template for a network

Description added: Network ID
Description added: Payload template ID
Optional property sharing Added
Response property sharing value added

Update a webhook payload template for a network

Description added: Network ID
Description added: Payload template ID
Optional property sharing Added

Create a webhook payload template for a network

Description added: Network ID
Optional property sharing Added

[organization]

adaptivePolicy

List adaptive policy ACLs in a organization

Description added: Organization ID
Response property properties value added

Returns the adaptive policy ACL information

Description added: Organization ID
Description added: Acl ID
Response property properties value added

earlyAccess

List the available early access features for organization

Description added: Organization ID
Response property properties value added
Response property supportLink value added

[wireless]

ssids

List all Identity PSKs in a wireless network

Description added: Network ID
Description added: Number
Response property format value added

Return an Identity PSK

Description added: Network ID
Description added: Number
Description added: Identity psk ID
Response property format value added

Update an Identity PSK

Description added: Network ID
Description added: Number
Description added: Identity psk ID
Optional property expiresAt Added

Create an Identity PSK

Description added: Network ID
Description added: Number
Optional property expiresAt Added

Other updated operations

In addition to the above mentioned updates, many existing operations have been updated with new description properties. To get a detailed list of what description properties are added to each operations please refer What's updated section of the API documentation.

What's New

[sensor]

mqttBrokers

List the sensor settings of all MQTT brokers for this network. To get the brokers themselves, use /networks/{networkId}/mqttBrokers.

New path added: /networks/{networkId}/sensor/mqttBrokers
New operation: GET /networks/{networkId}/sensor/mqttBrokers

Return the sensor settings of an MQTT broker. To get the broker itself, use /networks/{networkId}/mqttBrokers/{mqttBrokerId}.

New path added: /networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}
New operation: GET /networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}

Update the sensor settings of an MQTT broker. To update the broker itself, use /networks/{networkId}/mqttBrokers/{mqttBrokerId}.

New operation: PUT /networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}

[organizations]

devices

List the provisioning statuses information for devices in an organization.

New path added: /organizations/{organizationId}/devices/provisioning/statuses
New operation: GET /organizations/{organizationId}/devices/provisioning/statuses

4-2023

Dashboard API Version 1.32.0 Released

Changelog

Summary of Changes

1 - New

16 - Updated

616 - Total operations

388 - Total Paths

What's Updated

[switch]

routing

Return a layer 3 static route for a switch

Added response schema.

accessPolicies

List the access policies for a switch network

Added optional property guestPortBouncing.
Added response property guestPortBouncing value.

Return a specific access policy for a switch network

Added optional property guestPortBouncing.
Added response property guestPortBouncing value.

Create an access policy for a switch network

Added optional property guestPortBouncing.

Update an access policy for a switch network

Added optional property guestPortBouncing.

mtu

Return the MTU configuration

Added response schema.
Added response property switchProfiles value.

[appliance]

trafficShaping

Returns the uplink bandwidth limits for your MX network

Deleted property capabilities.
Changed summary from Returns the uplink bandwidth settings for your MX network. to Returns the uplink bandwidth limits for your MX network.

[networks]

events

List the events for the network

Added optional property category.
Added response property category value.

[organizations]

devices

List the devices in an organization

Added response schema.

What's New

[organizations]

inventory

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

New path added: /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare
New operation: POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare

3-2023

Meraki Dashboard API v1 Release Notes

Version v1.30.0 to v1.31.0

Summary of Changes

2 - New

13 - Updated

615 - Total operations

387 - Total Paths

What's Updated

[organizations]

inventory

Return the device inventory for an organization

Added optional property orderNumbers.

earlyAccess

List the available early access features for organization

Added response property documentationLink value.

[appliance]

trafficShaping

Returns the uplink bandwidth settings for your MX network

Added response schema and property capabilities values.

[sm]

profiles

List all profiles in a network

Added response property items value.
Changed summary from List all the profiles in the network to List all profiles in a network.

[switch]

accessControlLists

Return the access control lists for a MS network

Added response schema.

stacks

Show a switch stack

Added response schema.

[wireless]

ssids

Return the EAP overridden parameters for an SSID

Added response properties properties, timeout, maxRetries, identity, and eapolKey values.

What's New

[organizations]

inventory

Imports event logs related to the onboarding app into elastisearch

New path added: /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents
New operation: POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents

Returns list of networks eligible for adding cloud monitored device

New path added: /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks
New operation: GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks

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

New path added: /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare
New operation: POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare

2-2023

Highlights

The Meraki SGC for ServiceNow v1.3 has been released. Read all about it on our API Community here

Dashboard API Version 1.30.0 Released

Changelog

What's New?