12-2022

Highlights

A new learning lab has been created and added to meraki.io to help get you started with building webhook payload templates.

• Webhooks Learning Lab

Upcoming changes to enhance webhook templates may impact you.

• Read more to find out what's changing.

Dashboard API Version 1.28.0 Released

Changelog

What’s New

Wireless

[devices]

• operation to see power status for wireless devices

What's Updated

Wireless

[SSIDs]

• Optional property dhcpEnforcedDeauthentication Added

[settings]

• Response property ledLightsOn value added

• Response property namedVlans value added

Appliance

[Traffic Shaping]

• Response property failoverAndFailback value added

[VLANs]

• Optional property mandatoryDhcp Added

[thirdPartyVPNPeers]

• Optional property secret Added

Network

[settings]

• Response property clientPrivacy value added

[clients]

• Response property serialNumber value added

• Response property osVersion value added

• Response property lastMDMCheckin value added

• Response property anyconnectAppVersion value added

• Response property ownerUsername value added

• Response property ownerEmail value added

11-2022

Highlights

The Webhook Template Editor is now available to our Early API Access users. With this new editor included in the Meraki Dashboard, you can easily manage, extend and create webhook templates.

• Documentation
• Early Access Post

The DataDog webhook template has been updated to support new features and a nicer layout.

• Documentation
• Video Presentation

Webhook HTTPS Receiver limit has increased from 10 to 100 configured servers per network!

• API operation

Dashboard API Version 1.27.0 Released

Changelog

What’s New

cellular

• Return the SIM and APN configurations for a cellular device.
• Updates the SIM and APN configurations for a cellular device.

sensor

• Return an overview of alert occurrences over a timespan, by metric

policyObjects

• Lists Policy Objects belonging to the organization.
• Creates a new Policy Object.
• Lists Policy Object Groups belonging to the organization.
• Creates a new Policy Object Group.
• Shows details of a Policy Object Group.
• Updates a Policy Object Group.
• Deletes a Policy Object Group.
• Shows details of a Policy Object.
• Updates a Policy Object.
• Deletes a Policy Object.

inventory

• Check the status of a committed Import operation
• Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.
• Initiates or updates an import session. An import ID will be generated and used when you are ready to commit the import.

firmware

• Get firmware upgrade status for the filtered devices

10-2022

Highlights

Webhooks

• Added "ServiceNow" included payload template. Webhook Docs
• Updated DataDog custom template. Webhook Docs
• You can now have up to 100 configured httpServers, a 10x increase! API Doc

Dashboard API Version 1.26.0 Released

Changelog

What's New

Platform

• Firmware Upgrades
  • Several new operations available to manage firmware upgrades, rollbacks and staging.

Sensor

• Alerts byMetric
  • Return an overview of currently alerting sensors by metric

Appliance

• Extended IPv6 support

  • prefixes

• uplinks

  • Return the uplink settings for an MX appliance
  • Update the uplink settings for an MX appliance

• firewall

  • Return the inbound cellular firewall rules for an MX network
  • Update the inbound cellular firewall rules of an MX network

9-2022

Highlights

Documentation Enhancements

• Webhook Alerts for MT Sensors are now documented and viewable in the API

Dashboard API Version 1.25.0 Released

Changelog

What's New

Platform

• Early Access

  • Returns list of enabled early access features for the identity.

• Firmware

  • Get firmware upgrade information for an organization

Appliance

• SSIDs
  • SSID management for MXw appliances !

8-2022

Highlights

Documentation Enhancements

• The API Reference section has been adjusted to enable easier discovery of API operations without being concerned with the organizations, networks or devices scope. These core operations along with all other non product specific ones will now live under the Platform folder.

  

• The search capability has been super charged. You can now search for all key information of an API operation and get a detailed listing of related APIs and docs. The search even supports filtering by prefixing your query with api: or doc:

  

• Early API Access is now publically available to opt-in via the Dashboard. To enable our early adopters to test and provide feedback, a new Early Access section of the API docs will include a listing of all new and updated operations.

  

Dashboard API Version 1.24.0 Released

Changelog

What's New

Switch

• ports
  • Switch Port Profiles

Networks

• alerts
  • Alert History

Appliance

• firewall
  • Settings (spoofing protection)

Organizations

• devices
  • Power Module Status
  • Uplink Addresses

Sensor

• alerts
  • Alert Profiles

What's Updated

Switch

List the switch ports for a switch

GET /devices/{serial}/switch/ports

- Response property properties value added

- Response property allowedVlans value added

- Response property accessPolicyNumber value added

- Response property macAllowList value added

- Response property flexibleStackingEnabled value added

Wireless

Modify the splash page settings for the given SSID

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

- Optional property selfRegistration Added

7-2022

Highlights

Me

Do you ever wonder who you are when developing an application? Now you can easily get the name, email and other details of the account bound to the API key currently in use.

API Docs

Early API Access

Added "x-release-stage": "beta" to all beta operations and properties that are available for Early API Access users. This is available in the v1 beta branch of the Meraki OpenAPI specification.

Documentation, SDKs and other tooling can now take advantage of this information to highlight features that are in development.

API Response Schemas

We are excited to begin including API response schemas in the OpenAPI specification and documentation. In addition, over 1/3 of all existing operations have recently been updated to include schemas with more to come.

Webhooks

With the launch of webhook integrations, there have been a number of new solutions that have been made possible such as IT notification bots, provisioning workflows and custom security requirements for inbound API calls.

We are also happy to announce two new integrations, that were contributed by our community, for all to use as custom payload templates!

• Discord
• AlertMagic

Dashboard API Version 1.23.0 Released

Changelog

Version 1.22.0 to 1.23.0

Summary of Changes

6 - New

125 - Updated

551 - Total operations

348 - Total Paths

What's New

• [ sm ]
  • trustedAccessConfigs
    • List Trusted Access Configs
• [ organizations ]
  • devices
    • List the availability information for devices in an organization. The data returned by this operation is updated every 5 minutes.
  • earlyAccess
    • List the available early access features for organization
    • List the early access feature opt-ins for an organization
    • Create a new early access feature opt-in for an organization
    • Show an early access feature opt-in for an organization
    • Update an early access feature opt-in for an organization
    • Delete an early access feature opt-in
• [ administered ]
  • identities
    • Returns the identity of the current user.

What's Updated

• 125 Operations updated with schemas or more information!

6-2022

Dashboard API Version 1.22.0 Released

Changelog

Highlights

• What’s New

  • [ switch ]

    • dhcpServerPolicy
      • Return the list of servers trusted by Dynamic ARP Inspection on this network. These are also known as whitelisted snoop entries
      • Add a server to be trusted by Dynamic ARP Inspection on this network
      • Update a server that is trusted by Dynamic ARP Inspection on this network
      • Remove a server from being trusted by Dynamic ARP Inspection on this network
      • Return the devices that have a Dynamic ARP Inspection warning and their warnings
    • dhcp
      • Return the network’s DHCPv4 servers seen within the selected timeframe (default 1 day)

  • [ networks ]

    • policies
      • Get policies for all clients with policies

• What's Updated

  • [ switch ]

    • accessPolicies
      • Optional property failedAuthVlanId Added
      • Optional property reAuthenticationInterval Added
    • dhcpServerPolicy
      • Optional property alerts Added
      • Optional property arpInspection Added

  • [ wireless ]

    • rfProfiles
      • Optional property transmission Added

  • [ organizations ]

    • apiRequests
      • Optional param version added
      • Optional param operationIds added
      • Optional property version Added
      • Optional property operationId Added
      • Response property version value added
      • Response property operationId value added

What's New

5-2022

Dashboard API Version 1.21.0 Released

Changelog

Highlights

• What's New

  • [ switch ]
    • ports
      • List the switchports in an organization by switch

• What's Updated

  • [ organizations ]
    • network settings
      • Response property isBoundToConfigTemplate value added
    • brandingPolicies
      • Response property customLogo value added
    • apiRequests
      • Optional param userAgent added

4-2022

Dashboard API Version 1.20.0 Released

Changelog

Highlights

• What's New

  • [ appliance ]
    • vmx Generate a new vMX authentication token
  • [ camera ]
    • customAnalytics
      • Return custom analytics settings for a camera
      • Update custom analytics settings for a camera
      • List Custom Analytics Artifacts
      • Create custom analytics artifact. Returns an artifact upload URL with expiry time. Upload the artifact file with a put request to the returned upload URL before its expiry.
      • Get Custom Analytics Artifact
      • Delete Custom Analytics Artifact

• What's Updated

  • [ switch ]

    • Switch ports statuses operation now has an isUplink boolean value
    • Switch DHCP server policy operation now offers additional information/config options for things like alerts/arp inspection
    • Switch access policy now enabled dot1X control direction config

    • Switch port config operation now lists the link negotiation capabilities for that port
      

  • [ network ]

    • Firmware upgrades and rollbacks operations now list release dates for the software

3-2022

Dashboard API Version 1.19.0 Released

Changelog

Highlights

• What's New

  • [ organizations ]
    • inventory
      • 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. Use /organizations/{organizationId}/inventory/release to release devices from an organization.
      • Release a list of claimed devices from an organization.
  • [ sensor ]
    • readings
      • Return all reported readings from sensors in a given timespan, sorted by timestamp
      • Return the latest available reading for each metric from each sensor, sorted by sensor serial

• What's Updated

  • [ wireless ]
    • rfProfiles
      • Optional property perSsidSettings Added
  • [ ssids ]
    • Update the attributes of an MR SSID
      • Optional property secondaryConcentratorNetworkId Added
      • Optional property disassociateClientsOnVpnFailover Added
      • Optional property speedBurst Added
  • [ organizations ]
    • adaptivePolicy
      • Response property isDefaultGroup value added
      • Response property requiredIpMappings value added
    • loginSecurity
      • Limit API access based on IP address
    • service
      • Obtain the cloud region details for the organization

ServiceNow SG Connector for Meraki - San Diego Certified

The connector has been validated for the latest ServiceNow version.

Store Link

2-2022

Dashboard API Version 0 Sunset

SUNSET NOTICE

Dashboard API v0 has reached its end-of-support

Please use Dashboard API v1 and take advantage of the many new enhancements.

You can read more about this in our Community post.

Dashboard API Version 1.18.0 Released

Changelog

Highlights

• What's New

  • [networks]
    • webhooks
      • List the webhook payload templates for a network
      • Create a webhook payload template for a network
      • Get the webhook payload template for a network
      • Update a webhook payload template for a network
      • Destroy a webhook payload template for a network.

• What's Updated

  • [networks]
    • webhooks
      • Add an HTTP server to a network (with a webhook payload template)
      • Send a test webhook for a network (with a webhook payload template)
  • [wireless]
    • ssids
      • List the VPN settings for the SSID.
      • Update the VPN settings for the SSID
  • [organizations]
    • webhooks
      • Return a list of alert types to be used with managing webhook alerts
    • devices
      • List the status of every Meraki device in the organization
    • service
      • List the organizations that the user has privileges on
      • Return an organization
        • Optional property licensing Added
        • Response property licensing value added

1-2022

Dashboard API Version 1.17.0 Released

Changelog

Highlights

[ switch ]

• Response property ipv6 value added to routing interfaces

[ organizations ]

adaptivePolicy

• List adaptive policy groups in a organization
• Creates a new adaptive policy group
• Returns an adaptive policy group
• Updates an adaptive policy group.
• Deletes the specified adaptive policy group and any associated policies and references
• Returns adaptive policy aggregate statistics for an organization
• List adaptive policies in an organization
• Add an Adaptive Policy
• Return an adaptive policy
• Update an Adaptive Policy
• Delete an Adaptive Policy