11-2024

Dashboard API Release v1.52.0

Changelog

Version 1.51.0 to v1.52.0

Summary of Changes

• 8 - New
• 20 - Updated
• 768 - Total Operations
• 515 - Total Paths

Highlights

• Floor Plan Auto Locate Jobs: Schedule, manage, and update device locations across network floor plans with new capabilities for bulk job handling and assignment updates.

• Automated RF Channel Recalculation: Improved control over wireless network performance with the ability to recalculate channels, enhancing connectivity and reducing interference.

10-2024

Dashboard API Release v1.51.1

Changelog

Version 1.50.0 to v1.51.1

Summary of Changes

• New operations: 17
• Updated operations: 51
• Total operations: 760
• Total Paths: 507

Highlights

• Dasboard API python library version 1.51.1 released.

• This release introduces wireless LAN controller management capabilities with a suite of new operations. These operations enable granular tracking of connectivity status, interface performance, and failover events.

What's New

wireless

• List access point client count at the moment in an organization

wirelessController

• List connectivity data of wireless LAN controllers in an organization
• List wireless client counts of wireless LAN controllers over time in an organization
• List all access points associated with wireless LAN controllers in an organization
• List wireless LAN controller layer 2 interfaces in an organization
• List wireless LAN controller layer 2 interfaces history status in an organization
• List wireless LAN controller layer 2 interfaces history usage in an organization
• List wireless LAN controller layer 3 interfaces in an organization
• List wireless LAN controller layer 3 interfaces history status in an organization
• List wireless LAN controller layer 3 interfaces history usage in an organization
• Retrieve the packet counters for the interfaces of a Wireless LAN controller
• Retrieve the traffic for the interfaces of a Wireless LAN controller
• List the failover events of wireless LAN controllers in an organization
• List redundancy details of wireless LAN controllers in an organization

09-2024

Dashboard API Release v1.50

Changelog

Summary of Changes

• New operations: 9
• Updated operations: 37
• Total operations: 743
• Total Paths: 490

This version introduces new eSIM management operations and updates to licensing, device details, camera retention profiles, and switch stacks with additional properties and parameters to enhance functionality.

What's New

[ cellularGateway ]

eSIM Management

• List the eSIM inventory of an organization
• Toggle the status of an eSIM
• List service providers customers can add accounts for
• List the inventory of service provider accounts
• Add a service provider account
• List communication plans available for a provider
• List rate plans available for a provider
• Swap which profile an eSIM uses
• Get the status of a profile swap

What's Updated

Licensing

• Properties Added: webOrderLineId, smartAccount, smartAccountStatus
  • List available subscriptions
  • Claim a subscription
  • Find a subscription by claim key

Devices

• Properties Added: name, model, version, device

  • List LLDP and CDP information for a device

• Param Added: isCatalyst

  • List the events for the network

Cameras

• Property Added: smartRetention
  • List the quality retention profiles
  • Retrieve a quality retention profile
  • Create a quality retention profile
  • Update a quality retention profile

Switch Stacks

• Property Added: managementNextHop
  • Update a layer 3 static route for a switch stack

08-2024

Dashboard API Release v1.49

Changelog

Summary of Changes

• New operations: 3
• Updated operations: 51
• Total operations: 732
• Total Paths: 481

What's New

[ administered ]

List the non-sensitive metadata associated with the API keys that belong to the user

GET /administered/identities/me/api/keys

Generates an API key for an identity

POST /administered/identities/me/api/keys/generate

Revokes an identity's API key, using the last four characters of the key

POST /administered/identities/me/api/keys/{suffix}/revoke

What's Updated

[ switch ]

ports

• List the switch ports for a switch
• Return a switch port
• Update a switch port

Added properties: schedule, adaptivePolicyGroup

routing

• List layer 3 static routes for a switch
• Return a layer 3 static route for a switch
• Update a layer 3 static route for a switch
• Create a layer 3 static route for a switch

Added property: managementNextHop

stacks

• List layer 3 static routes for a switch stack
• Return a layer 3 static route for a switch stack
• Update a layer 3 static route for a switch stack
• Create a layer 3 static route for a switch stack

Added property: managementNextHop

configTemplates

• Return all the ports of a switch template
• Return a switch template port
• Update a switch template port

Added property: schedule

[ wireless ]

clients

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

Added properties: sortOrder, captureId

rfProfiles

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

Added properties: isIndoorDefault, isOutdoorDefault

[ organizations ]

alerts

• Return overview of active health alerts for an organization
• Return a Summary of Alerts grouped by network and severity
• Return a Summary of Alerts grouped by type and severity
• Returns historical health alert overviews

Added param: category

devices

• List the devices in an organization that have been assigned to a network

Summary changed from List the devices in an organization to List the devices in an organization that have been assigned to a network.

firmware

• Get firmware upgrade status for the filtered devices

Added param: currentUpgradesOnly

07-2024

Dashboard API Release v1.48

Changelog

Summary of Changes

• New operations: 1
• Updated operations: 53
• Total operations: 729
• Total Paths: 478

What's New

Organizations - Devices

• Bulk Update Device Details: Updating device details (currently only used for Catalyst devices)
  • This new operation allows bulk updating of device details, which is currently applicable to Catalyst devices. It helps streamline the management of multiple devices within an organization.
  • POST /organizations/{organizationId}/devices/details/bulkUpdate

What's Updated

Licensing

• Subscription Management:
  • List Available Subscriptions: GET /administered/licensing/subscription/subscriptions
  • Claim a Subscription: POST /administered/licensing/subscription/subscriptions/claim
  • Find Subscription by Claim Key: POST /administered/licensing/subscription/subscriptions/claimKey/validate
  • Enhanced these operations with optional properties organizations and enterpriseAgreement.

Devices

• Cellular Configuration:
  • Update SIM and APN Configurations: PUT /devices/{serial}/cellular/sims
    • Added optional properties simOrder and simOrdering.

Switch

• Port Management:

  • List Switch Ports: GET /devices/{serial}/switch/ports
  • Return Switch Port: GET /devices/{serial}/switch/ports/{portId}
  • Update Switch Port: PUT /devices/{serial}/switch/ports/{portId}
  • Added optional property dot3az and corresponding response values to these operations.

• Routing Management:

  • List Layer 3 Interfaces for a Switch: GET /devices/{serial}/switch/routing/interfaces
  • Return Layer 3 Interface for a Switch: GET /devices/{serial}/switch/routing/interfaces/{interfaceId}
  • Create Layer 3 Interface for a Switch: POST /devices/{serial}/switch/routing/interfaces
  • Update Layer 3 Interface for a Switch: PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}
  • List Layer 3 Interfaces for a Switch Stack: GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
  • Return Layer 3 Interface from a Switch Stack: GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
  • Create Layer 3 Interface for a Switch Stack: POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
  • Update Layer 3 Interface for a Switch Stack: PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
  • Added optional properties uplinkV4 and uplinkV6 and corresponding response values to these operations.

• Switch Template Ports Management:

  • Return All Ports of a Switch Template: GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
  • Return a Switch Template Port: GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
  • Update a Switch Template Port: PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
  • Added optional property dot3az and corresponding response values to these operations.

Networks

• Clients Management:

  • List Network Clients: GET /networks/{networkId}/clients
    • Added response property items.

• Events Management:

  • List Network Events: GET /networks/{networkId}/events
    • Added optional parameters eventDetails and eventSeverity.

• Firmware Upgrades:

  • Get Firmware Upgrade Information: GET /networks/{networkId}/firmwareUpgrades
  • Update Firmware Upgrade Information: PUT /networks/{networkId}/firmwareUpgrades
  • Added optional property wirelessController and corresponding response values to these operations.

06-2024

Dashboard API Release v1.47

Changelog

Summary of Changes

• New operations: 5
• Updated operations: 87
• Total operations: 728
• Total Paths: 477

What's New

Organizations - Summary

• Top Applications by Data Usage: Return the top applications sorted by data usage over given time range

  • This new operation provides a list of the top applications sorted by data usage (in MB) within a specified time range, helping administrators identify high-traffic applications.
  • GET /organizations/{organizationId}/summary/top/applications/byUsage

• Top Application Categories by Data Usage: Return the top application categories sorted by data usage over given time range

  • Similar to the previous operation, this feature sorts application categories by data usage to help in managing bandwidth consumption and network resource allocation.
  • GET /organizations/{organizationId}/summary/top/applications/categories/byUsage

Wireless - Electronic Shelf Label (ESL)

• Device ESL Settings: Return and update the ESL settings of a device

  • Enables users to return and update the ESL settings for specific devices, facilitating the management of electronic shelf labels within the network.
  • GET /devices/{serial}/wireless/electronicShelfLabel
  • PUT /devices/{serial}/wireless/electronicShelfLabel

• Network ESL Settings: Return and update the ESL settings of a wireless network

  • These operations allow for retrieving and updating the ESL settings across an entire wireless network, ensuring consistent configurations.
  • GET /networks/{networkId}/wireless/electronicShelfLabel
  • PUT /networks/{networkId}/wireless/electronicShelfLabel

• ESL Eligible Devices: Get a list of all ESL eligible devices of a network

  • Lists all devices within a network that are eligible for ESL settings, aiding in the deployment and management of electronic shelf labels.
  • GET /networks/{networkId}/wireless/electronicShelfLabel/configuredDevices

What's Updated

Organizations

• Client Data Usage: Return data usage over time for all clients

  • Added optional parameters: networkTag, deviceTag, networkId, ssidName, and usageUplink.
  • GET /organizations/{organizationId}/clients/bandwidthUsageHistory

• Device Uplink Addresses: List current uplink addresses for devices

  • Added optional property vlan to the request and response.
  • GET /organizations/{organizationId}/devices/uplinks/addresses/byDevice

• Network Privileges: List networks with user privileges

  • Added optional parameter productTypes.
  • GET /organizations/{organizationId}/networks

• Top Utilization Metrics: Return top utilization metrics

  • Enhanced multiple summary operations to include optional parameters for better filtering and sorting, such as networkTag, deviceTag, networkId, quantity, ssidName, and usageUplink.
  • GET /organizations/{organizationId}/summary/top/appliances/byUtilization
  • GET /organizations/{organizationId}/summary/top/clients/byUsage
  • GET /organizations/{organizationId}/summary/top/clients/manufacturers/byUsage
  • GET /organizations/{organizationId}/summary/top/devices/byUsage
  • GET /organizations/{organizationId}/summary/top/devices/models/byUsage
  • GET /organizations/{organizationId}/summary/top/networks/byStatus
  • GET /organizations/{organizationId}/summary/top/ssids/byUsage
  • GET /organizations/{organizationId}/summary/top/switches/byEnergyUsage

Camera

• Quality Retention Profiles: Create and update quality retention profiles
  • Added optional properties MV33M, MV13M, MV63M, and MV93M to support new camera models.
  • POST /networks/{networkId}/camera/qualityRetentionProfiles
  • PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

Networks

• Client Information: Return client associated with given identifier

  • Added optional property notes.
  • GET /networks/{networkId}/clients/{clientId}

• Device Claims: Claim devices into a network

  • Added optional parameter addAtomically and new property errors.
  • POST /networks/{networkId}/devices/claim

Sensor

• Sensor Alerts: Manage sensor alert profiles
  • Added optional property co2 to sensor alert profiles.
  • POST /networks/{networkId}/sensor/alerts/profiles
  • PUT /networks/{networkId}/sensor/alerts/profiles/{id}
  • GET /networks/{networkId}/sensor/alerts/profiles
  • GET /networks/{networkId}/sensor/alerts/profiles/{id}

Switch

• Access Policies: Manage access policies for a switch network
  • Added optional property cache and removed serverId.
  • POST /networks/{networkId}/switch/accessPolicies
  • PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
  • GET /networks/{networkId}/switch/accessPolicies
  • GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

Wireless

• SSID Splash Settings: Display splash page settings for a given SSID
  • Added response property enum.
  • GET /networks/{networkId}/wireless/ssids/{number}/splash/settings

05-2024

Highlights

• Cisco Meraki API collection received The Best API Award at the 2024 Postman API Network Awards. The Meraki Dashboard API has not only earned this recognition but also secured Rank 10 out of more than 100,000 APIs on the Postman Public API Network.
• Meraki ServiceNow Graph connector version 1.4.0 is released and is compatible with ServiceNow's Washington DC release.
• New feature added to the connector! The new version of the connector now supports multiple API key credentials. Customers will now be able to add multiple Meraki API keys in the ServiceNow integration.
• Dasboard API python library version 1.46.0 released.

Dashboard API Release v1.46

Summary of Changes for Version 1.46.0

Changelog

• New operations: 18
• Updated operations: 66
• Total operations: 721
• Total Paths: 472

What's New

Organizations - Alerts

• Comprehensive Health Alerts Management
  • View All Health Alerts: Return all health alerts for an organization
    • Retrieves every registered health alert across the organization's networks, providing detailed categorization and historical data.
  • Dismiss and Restore Health Alerts: Dismiss health alerts and Restore dismissed health alerts
    • Manage alert lifecycle by dismissing current alerts or restoring previously dismissed alerts to active status.
  • Health Alerts Summaries: Active alerts overview and Historical alert overviews
    • Summarize alerts by severity and type, both currently active and historical, to enhance organizational response strategies.

Devices

• Device Model Count: Lists the count for each device model
  • Provides a count of each device model within the organization, aiding inventory assessments and resource planning.

Splash Themes

• Splash Theme Management: Create, list, and delete Splash Themes
  • Full management capabilities for customizing captive portal themes, including creating new themes, listing existing themes, and deleting outdated themes.
  • Manage Splash Theme Assets: Add and remove assets for Splash Themes
    • Detailed asset management within themes, allowing customization of individual components such as welcome screens or login pages.

Wireless - Air Marshal

• Air Marshal Configuration: Configure Air Marshal settings and rules
  • Introduces comprehensive control over Air Marshal settings, including the ability to create, update, and delete rules tailored to specific network security needs.
  • View Air Marshal Settings and Rules: View current settings and rules
    • Access and review the current configurations and rules set for Air Marshal, ensuring alignment with organizational security policies.

04-2024

Highlights

• Terraform

  • Meraki has just released an official Terraform provider, enabling Infrastructure as Code.
  • Community post

• API Index

  • A new page on the API Docs is available to explore, filter and search all Meraki API operations and their related details.
  • Community post

• Cisco XDR Integration

  • A new custom webhook template for the Cisco XDR Automation service is now available.
  • Docs

• Response Schemas

  • Major improvements to over 200 response schemas across the API. These updates provide comprehensive property documentation, ensuring complete and accurate API responses for better integration and automation.

Dashboard API Release v1.45

Changelog

Summary of Changes

• 6 - New
• 203 - Updated
• 700 - Total operations
• 454 - Total Paths

What's New

Appliance - SDWAN

• Update SDWAN Internet Traffic Preferences for an MX Network [PUT /networks/{networkId}/appliance/sdwan/internetPolicies]
  • Enhance MX network performance by customizing SDWAN internet traffic preferences, including uplink choices based on performance criteria and traffic filters.
  • Resource

Switch - Ports

• Returns Active Ports Overview [GET /organizations/{organizationId}/switch/ports/overview]
  • Offers a detailed count of all active and inactive switch ports within a specified timeframe, categorized by speed and media type.
  • Resource

Sensor - Commands

• Historical Log of Commands [GET /devices/{serial}/sensor/commands]

  • Retrieve a log of all sensor-related commands issued to a device, detailing each command's execution status and administrative origin.
  • Resource

• Send Command to Sensor [POST /devices/{serial}/sensor/commands]

  • Issue direct commands to Meraki MT sensors, enabling remote sensor management and configuration.
  • Resource

• Command Execution Status [GET /devices/{serial}/sensor/commands/{commandId}]

  • Access detailed information on the execution of specific sensor commands, including operational outcomes and any encountered errors.
  • Resource

Wireless - SSIDs and RF Profiles

• List BSSID Status Information [GET /organizations/{organizationId}/wireless/ssids/statuses/byDevice]

  • Gather status details for all BSSIDs across the organization, including RF band, channel information, and SSID configuration.
  • Resource

• RF Profile Assignments by Device [GET /organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice]

  • Enumerate RF profile settings applied across devices within the organization, facilitating optimized wireless performance management.
  • Resource

03-2024

Highlights

• Introduction of the throughputTest Live Tool for devices, enabling testing of device throughput over a specified duration with an option of to send results via a callback webhook.
• New inventory management features have been added, including bulk device swaps.
• Enhanced licensing management with operations for retrieving subscription entitlements and checking compliance status for subscriptions.
• Several operations have been updated with complete response schemas within the OpenAPI specification. This should improve the quality of the API documentation as well as libraries and tools that utilize the spec.

Dashboard API Release v1.44

Changelog 1.44.0

Summary of Changes

• 7 - New
• 41 - Updated
• 694 - Total operations
• 449 - Total Paths

02-2024

Highlights

• 3 new Livetools with callbacks are now available!
  • Create Device LiveTools Wake On LAN
  • Create Device LiveTools Cable test
  • Create Device LiveTools Arp table

Dashboard API Release 1.43

Changelog 1.43.0

Summary of Changes

• 17 - New
• 139 - Updated
• 687 - Total operations
• 442 - Total Paths

What's New

==========

• [ sm ]
  • devices
    • Reboot a set of operations
    • Shutdown a set of operations
  • admins
    • List the Limited Access Roles for an organization
    • CRUD group for a Limited Access Role
  • sentry
    • Update an Organizations Sentry Policies using the provided list.
    • List the Sentry Policies for an organization ordered in ascending order of priority
• [ organizations ]
  • summary
    • List the client and status overview information for the networks in an organization.
• [ devices ]
  • cableTest
    • Enqueue a job to perform a cable test for the device on the specified ports.
    • Return a cable test live tool job.
  • wakeOnLan
    • Enqueue a job to send a Wake-on-LAN packet from the device
    • Return a Wake-on-LAN job
  • arpTable
    • Enqueue a job to perform a ARP table request for the device. This operation currently supports switches.
    • Return an ARP table live tool job.
• [ appliance ]
  • uplinks
    • Returns an overview of uplink statuses
• [ camera ]
  • boundaries
    • Returns all configured area boundaries of cameras
    • Returns all configured crossingline boundaries of cameras
  • detections
    • Returns analytics data for timespans

What's Updated

========== Optional parameters and response properties are added to the following operations.

• [ licensing ]
  • susbscription
• [ switch ]
  • accessPolicies
  • ports
• [ sensor ]
  • readings
  • alerts
• [ sm ]
  • devices
• [ wireless ]
  • settings
• [ organizations ]
  • uplinks

01-2024

Highlights

• Pagination (Number of entries per page) limit increased to 5000 for Get Network Clients API operation

Dashboard API Release v1.42

Changelog 1.42.0

Summary of Changes

• 0 - New
• 6 - Updated
• 667 - Total operations
• 425 - Total Paths

What's Updated

==========

• [ organizations ]
  • actionBatches
  • New response properties added
  • configurationChanges
  • Optional property networkUrl Added
  • Response property networkUrl value added