Meraki

Meraki Dashboard API

The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification. > Date: 05 March, 2023 > > [Recent…

IoT & devices#openapi#iot#enterprise

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.

> Date: 05 March, 2023
>
> Recent Updates


API Documentation

Community Support

Meraki Homepage

Endpoints 263

API usage

  • GETList the API requests made by an organization/organizations/:organizationId/apiRequests?t0=string&t1=string&timespan=0.0&perPage=0&startingAfter=string&endingBefore=string&adminId=string&path=string&method=string&responseCode=0&sourceIp=stringList the API requests made by an organization
  • GETReturn an aggregated overview of API requests data/organizations/:organizationId/apiRequests/overview?t0=string&t1=string&timespan=0.0Return an aggregated overview of API requests data

Action batches

  • GETReturn the list of action batches in the organization/organizations/:organizationId/actionBatches?status=completedReturn the list of action batches in the organization
  • POSTCreate an action batch/organizations/:organizationId/actionBatchesCreate an action batch
  • PUTUpdate an action batch/organizations/:organizationId/actionBatches/:actionBatchIdUpdate an action batch
  • DELETEDelete an action batch/organizations/:organizationId/actionBatches/:actionBatchIdDelete an action batch

Admins

  • GETList the dashboard administrators in this organization/organizations/:organizationId/adminsList the dashboard administrators in this organization
  • POSTCreate a new dashboard administrator/organizations/:organizationId/adminsCreate a new dashboard administrator
  • PUTUpdate an administrator/organizations/:organizationId/admins/:adminIdUpdate an administrator
  • DELETERevoke all access for a dashboard administrator within this organization/organizations/:organizationId/admins/:adminIdRevoke all access for a dashboard administrator within this organization

Alert settings

  • GETReturn the alert configuration for this network/networks/:networkId/alertSettingsReturn the alert configuration for this network
  • PUTUpdate the alert configuration for this network/networks/:networkId/alertSettingsUpdate the alert configuration for this network

Bluetooth clients

  • GETList the Bluetooth clients seen by APs in this network/networks/:networkId/bluetoothClients?t0=string&timespan=0.0&perPage=0&startingAfter=string&endingBefore=string&includeConnectivityHistory=trueList the Bluetooth clients seen by APs in this network
  • GETReturn a Bluetooth client/networks/:networkId/bluetoothClients/:bluetoothClientId?includeConnectivityHistory=true&connectivityHistoryTimespan=0Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.

Bluetooth settings

  • PUTUpdate the bluetooth settings for a wireless device/devices/:serial/wireless/bluetooth/settingsUpdate the bluetooth settings for a wireless device
  • GETReturn the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings</a> must be enabled on the network./networks/:networkId/bluetoothSettingsReturn the Bluetooth settings for a network. <a href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energy_(BLE)">Bluetooth settings</a> must be…
  • PUTUpdate the Bluetooth settings for a network/networks/:networkId/bluetoothSettingsUpdate the Bluetooth settings for a network. See the docs page for <a…

Camera quality retention profiles

  • GETList the quality retention profiles for this network/networks/:networkId/camera/qualityRetentionProfilesList the quality retention profiles for this network
  • POSTCreates new quality retention profile for this network./networks/:networkId/camera/qualityRetentionProfilesCreates new quality retention profile for this network.
  • GETRetrieve a single quality retention profile/networks/:networkId/camera/qualityRetentionProfiles/:qualityRetentionProfileIdRetrieve a single quality retention profile
  • PUTUpdate an existing quality retention profile for this network./networks/:networkId/camera/qualityRetentionProfiles/:qualityRetentionProfileIdUpdate an existing quality retention profile for this network.
  • DELETEDelete an existing quality retention profile for this network./networks/:networkId/camera/qualityRetentionProfiles/:qualityRetentionProfileIdDelete an existing quality retention profile for this network.

Cameras

  • GETReturns quality and retention settings for the given camera/devices/:serial/camera/qualityAndRetentionSettingsReturns quality and retention settings for the given camera
  • PUTUpdate quality and retention settings for the given camera/devices/:serial/camera/qualityAndRetentionSettingsUpdate quality and retention settings for the given camera
  • GETReturns video settings for the given camera/devices/:serial/camera/video/settingsReturns video settings for the given camera
  • PUTUpdate video settings for the given camera/devices/:serial/camera/video/settingsUpdate video settings for the given camera
  • GETReturns a list of all camera recording schedules./networks/:networkId/camera/schedulesReturns a list of all camera recording schedules.
  • POSTGenerate a snapshot of what the camera sees at the specified time and return a link to that image./networks/:networkId/cameras/:serial/snapshotGenerate a snapshot of what the camera sees at the specified time and return a link to that image.
  • GETReturns video link to the specified camera/networks/:networkId/cameras/:serial/videoLink?timestamp=stringReturns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.

Change log

  • GETView the Change Log for your organization/organizations/:organizationId/configurationChanges?t0=string&t1=string&timespan=0.0&perPage=0&startingAfter=string&endingBefore=string&networkId=string&adminId=stringView the Change Log for your organization

Clients

  • GETList the clients of a device, up to a maximum of a month ago/devices/:serial/clients?t0=string&timespan=0.0List the clients of a device, up to a maximum of a month ago. The usage of each client is returned in kilobytes. If the device is a switch, the switchport is…
  • GETList the clients that have used this network in the timespan/networks/:networkId/clients?t0=string&timespan=0.0&perPage=0&startingAfter=string&endingBefore=stringList the clients that have used this network in the timespan
  • POSTProvisions a client with a name and policy/networks/:networkId/clients/provisionProvisions a client with a name and policy. Clients can be provisioned before they associate to the network.
  • GETReturn the client associated with the given identifier/networks/:networkId/clients/:clientIdReturn the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network…
  • GETReturn the events associated with this client/networks/:networkId/clients/:clientId/events?perPage=0&startingAfter=string&endingBefore=stringReturn the events associated with this client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses…
  • GETReturn the latency history for a client/networks/:networkId/clients/:clientId/latencyHistory?t0=string&t1=string&timespan=0.0&resolution=0Return the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.…
  • GETReturn the policy assigned to a client on the network/networks/:networkId/clients/:clientId/policyReturn the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses…
  • PUTUpdate the policy assigned to a client on the network/networks/:networkId/clients/:clientId/policyUpdate the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses…
  • GETReturn the splash authorization for a client, for each SSID they've associated with through splash/networks/:networkId/clients/:clientId/splashAuthorizationStatusReturn the splash authorization for a client, for each SSID they've associated with through splash. Only enabled SSIDs with Click-through splash enabled will…
  • PUTUpdate a client's splash authorization/networks/:networkId/clients/:clientId/splashAuthorizationStatusUpdate a client's splash authorization. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.
  • GETReturn the client's daily usage history/networks/:networkId/clients/:clientId/usageHistoryReturn the client's daily usage history. Usage data is in kilobytes. Clients can be identified by a client key or either the MAC or IP depending on whether…

Config templates

  • GETList the configuration templates for this organization/organizations/:organizationId/configTemplatesList the configuration templates for this organization
  • DELETERemove a configuration template/organizations/:organizationId/configTemplates/:configTemplateIdRemove a configuration template

Content filtering categories

  • GETList all available content filtering categories for an MX network/networks/:networkId/contentFiltering/categoriesList all available content filtering categories for an MX network

Content filtering rules

  • GETReturn the content filtering settings for an MX network/networks/:networkId/contentFilteringReturn the content filtering settings for an MX network
  • PUTUpdate the content filtering settings for an MX network/networks/:networkId/contentFilteringUpdate the content filtering settings for an MX network

Devices

  • POSTCycle a set of switch ports/devices/:serial/switch/ports/cycleCycle a set of switch ports
  • GETList the devices in a network/networks/:networkId/devicesList the devices in a network
  • POSTClaim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requests against that device to succeed)/networks/:networkId/devices/claimClaim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requests against that device to succeed)
  • GETReturn a single device/networks/:networkId/devices/:serialReturn a single device
  • PUTUpdate the attributes of a device/networks/:networkId/devices/:serialUpdate the attributes of a device
  • GETGet the uplink loss percentage and latency in milliseconds for a wired network device./networks/:networkId/devices/:serial/lossAndLatencyHistory?t0=string&t1=string&timespan=0.0&resolution=0&uplink=cellular&ip=stringGet the uplink loss percentage and latency in milliseconds for a wired network device.
  • GETReturn the performance score for a single MX/networks/:networkId/devices/:serial/performanceReturn the performance score for a single MX. Only primary MX devices supported. If no data is available, a 204 error code is returned.
  • POSTReboot a device/networks/:networkId/devices/:serial/rebootReboot a device
  • POSTRemove a single device/networks/:networkId/devices/:serial/removeRemove a single device
  • GETReturn the uplink information for a device./networks/:networkId/devices/:serial/uplinkReturn the uplink information for a device.
  • GETList the devices in an organization/organizations/:organizationId/devices?perPage=0&startingAfter=string&endingBefore=string&configurationUpdatedAfter=stringList the devices in an organization

Events

  • GETList the events for the network/networks/:networkId/events?productType=string&includedEventTypes=string&excludedEventTypes=string&deviceMac=string&deviceSerial=string&deviceName=string&clientIp=string&clientMac=string&clientName=string&smDeviceMac=string&smDeviceName=string&perPage=0&startingAfter=string&endingBefore=stringList the events for the network
  • GETList the event type to human-readable description/networks/:networkId/events/eventTypesList the event type to human-readable description

Firewalled services

  • GETList the appliance services and their accessibility rules/networks/:networkId/firewalledServicesList the appliance services and their accessibility rules
  • GETReturn the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')/networks/:networkId/firewalledServices/:serviceReturn the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')
  • PUTUpdates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')/networks/:networkId/firewalledServices/:serviceUpdates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')

Floor plans

  • GETList the floor plans that belong to your network/networks/:networkId/floorPlansList the floor plans that belong to your network
  • POSTUpload a floor plan/networks/:networkId/floorPlansUpload a floor plan
  • GETFind a floor plan by ID/networks/:networkId/floorPlans/:floorPlanIdFind a floor plan by ID
  • PUTUpdate a floor plan's geolocation and other meta data/networks/:networkId/floorPlans/:floorPlanIdUpdate a floor plan's geolocation and other meta data
  • DELETEDestroy a floor plan/networks/:networkId/floorPlans/:floorPlanIdDestroy a floor plan

Intrusion settings

  • GETReturns all supported intrusion settings for an MX network/networks/:networkId/security/intrusionSettingsReturns all supported intrusion settings for an MX network
  • PUTSet the supported intrusion settings for an MX network/networks/:networkId/security/intrusionSettingsSet the supported intrusion settings for an MX network
  • GETReturns all supported intrusion settings for an organization/organizations/:organizationId/security/intrusionSettingsReturns all supported intrusion settings for an organization
  • PUTSets supported intrusion settings for an organization/organizations/:organizationId/security/intrusionSettingsSets supported intrusion settings for an organization

Licenses

  • GETReturn an overview of the license state for an organization/organizations/:organizationId/licenseStateReturn an overview of the license state for an organization
  • GETList the licenses for an organization/organizations/:organizationId/licenses?perPage=0&startingAfter=string&endingBefore=string&deviceSerial=string&networkId=string&state=activeList the licenses for an organization
  • POSTAssign SM seats to a network/organizations/:organizationId/licenses/assignSeatsAssign SM seats to a network. This will increase the managed SM device limit of the network
  • POSTMove SM seats to another organization/organizations/:organizationId/licenses/moveSeatsMove SM seats to another organization
  • POSTRenew SM seats of a license/organizations/:organizationId/licenses/renewSeatsRenew SM seats of a license. This will extend the license expiration date of managed SM devices covered by this license
  • GETDisplay a license/organizations/:organizationId/licenses/:licenseIdDisplay a license

Link aggregations

  • GETList link aggregation groups/networks/:networkId/switch/linkAggregationsList link aggregation groups
  • POSTCreate a link aggregation group/networks/:networkId/switch/linkAggregationsCreate a link aggregation group
  • PUTUpdate a link aggregation group/networks/:networkId/switch/linkAggregations/:linkAggregationIdUpdate a link aggregation group
  • DELETESplit a link aggregation group into separate ports/networks/:networkId/switch/linkAggregations/:linkAggregationIdSplit a link aggregation group into separate ports

MG LAN settings

  • GETShow the LAN Settings of a MG/devices/:serial/cellularGateway/settingsShow the LAN Settings of a MG
  • PUTUpdate the LAN Settings for a single MG./devices/:serial/cellularGateway/settingsUpdate the LAN Settings for a single MG.

MG port forwarding rules

  • GETReturns the port forwarding rules for a single MG./devices/:serial/cellularGateway/settings/portForwardingRulesReturns the port forwarding rules for a single MG.
  • PUTUpdates the port forwarding rules for a single MG./devices/:serial/cellularGateway/settings/portForwardingRulesUpdates the port forwarding rules for a single MG.

MR L3 firewall

  • GETReturn the L3 firewall rules for an SSID on an MR network/networks/:networkId/ssids/:number/l3FirewallRulesReturn the L3 firewall rules for an SSID on an MR network
  • PUTUpdate the L3 firewall rules of an SSID on an MR network/networks/:networkId/ssids/:number/l3FirewallRulesUpdate the L3 firewall rules of an SSID on an MR network

MV Sense

  • GETReturns live state from camera of analytics zones/devices/:serial/camera/analytics/liveReturns live state from camera of analytics zones
  • GETReturns an overview of aggregate analytics data for a timespan/devices/:serial/camera/analytics/overview?t0=string&t1=string&timespan=0.0&objectType=personReturns an overview of aggregate analytics data for a timespan
  • GETReturns most recent record for analytics zones/devices/:serial/camera/analytics/recent?objectType=personReturns most recent record for analytics zones
  • GETReturns all configured analytic zones for this camera/devices/:serial/camera/analytics/zonesReturns all configured analytic zones for this camera
  • GETReturn historical records for analytic zones/devices/:serial/camera/analytics/zones/:zoneId/history?t0=string&t1=string&timespan=0.0&resolution=0&objectType=personReturn historical records for analytic zones

MX 1:1 NAT rules

  • GETReturn the 1:1 NAT mapping rules for an MX network/networks/:networkId/oneToOneNatRulesReturn the 1:1 NAT mapping rules for an MX network
  • PUTSet the 1:1 NAT mapping rules for an MX network/networks/:networkId/oneToOneNatRulesSet the 1:1 NAT mapping rules for an MX network

MX 1:Many NAT rules

  • GETReturn the 1:Many NAT mapping rules for an MX network/networks/:networkId/oneToManyNatRulesReturn the 1:Many NAT mapping rules for an MX network
  • PUTSet the 1:Many NAT mapping rules for an MX network/networks/:networkId/oneToManyNatRulesSet the 1:Many NAT mapping rules for an MX network

MX L3 inbound firewall

  • GETReturn the inbound firewall rules for an MX network/networks/:networkId/appliance/firewall/inboundFirewallRulesReturn the inbound firewall rules for an MX network
  • PUTUpdate the inbound firewall rules of an MX network/networks/:networkId/appliance/firewall/inboundFirewallRulesUpdate the inbound firewall rules of an MX network

MX L3 outbound firewall

  • GETReturn the L3 firewall rules for an MX network/networks/:networkId/l3FirewallRulesReturn the L3 firewall rules for an MX network
  • PUTUpdate the L3 firewall rules of an MX network/networks/:networkId/l3FirewallRulesUpdate the L3 firewall rules of an MX network

MX L7 application categories

  • GETReturn the L7 firewall application categories and their associated applications for an MX network/networks/:networkId/l7FirewallRules/applicationCategoriesReturn the L7 firewall application categories and their associated applications for an MX network

MX L7 firewall

  • GETList the MX L7 firewall rules for an MX network/networks/:networkId/l7FirewallRulesList the MX L7 firewall rules for an MX network
  • PUTUpdate the MX L7 firewall rules for an MX network/networks/:networkId/l7FirewallRulesUpdate the MX L7 firewall rules for an MX network

MX VLAN ports

  • GETList per-port VLAN settings for all ports of a MX./networks/:networkId/appliancePortsList per-port VLAN settings for all ports of a MX.
  • GETReturn per-port VLAN settings for a single MX port./networks/:networkId/appliancePorts/:appliancePortIdReturn per-port VLAN settings for a single MX port.
  • PUTUpdate the per-port VLAN settings for a single MX port./networks/:networkId/appliancePorts/:appliancePortIdUpdate the per-port VLAN settings for a single MX port.

MX VPN firewall

  • GETReturn the firewall rules for an organization's site-to-site VPN/organizations/:organizationId/vpnFirewallRulesReturn the firewall rules for an organization's site-to-site VPN
  • PUTUpdate the firewall rules of an organization's site-to-site VPN/organizations/:organizationId/vpnFirewallRulesUpdate the firewall rules of an organization's site-to-site VPN

MX cellular firewall

  • GETReturn the cellular firewall rules for an MX network/networks/:networkId/cellularFirewallRulesReturn the cellular firewall rules for an MX network
  • PUTUpdate the cellular firewall rules of an MX network/networks/:networkId/cellularFirewallRulesUpdate the cellular firewall rules of an MX network

MX port forwarding rules

  • GETReturn the port forwarding rules for an MX network/networks/:networkId/portForwardingRulesReturn the port forwarding rules for an MX network
  • PUTUpdate the port forwarding rules for an MX network/networks/:networkId/portForwardingRulesUpdate the port forwarding rules for an MX network

MX static routes

  • GETList the static routes for an MX or teleworker network/networks/:networkId/staticRoutesList the static routes for an MX or teleworker network
  • POSTAdd a static route for an MX or teleworker network/networks/:networkId/staticRoutesAdd a static route for an MX or teleworker network
  • GETReturn a static route for an MX or teleworker network/networks/:networkId/staticRoutes/:staticRouteIdReturn a static route for an MX or teleworker network
  • PUTUpdate a static route for an MX or teleworker network/networks/:networkId/staticRoutes/:staticRouteIdUpdate a static route for an MX or teleworker network
  • DELETEDelete a static route from an MX or teleworker network/networks/:networkId/staticRoutes/:staticRouteIdDelete a static route from an MX or teleworker network

MX warm spare settings

  • POSTSwap MX primary and warm spare appliances/networks/:networkId/swapWarmSpareSwap MX primary and warm spare appliances
  • GETReturn MX warm spare settings/networks/:networkId/warmSpareSettingsReturn MX warm spare settings
  • PUTUpdate MX warm spare settings/networks/:networkId/warmSpareSettingsUpdate MX warm spare settings

Malware settings

  • GETReturns all supported malware settings for an MX network/networks/:networkId/security/malwareSettingsReturns all supported malware settings for an MX network
  • PUTSet the supported malware settings for an MX network/networks/:networkId/security/malwareSettingsSet the supported malware settings for an MX network

Meraki auth users

  • GETList the splash or RADIUS users configured under Meraki Authentication for a network/networks/:networkId/merakiAuthUsersList the splash or RADIUS users configured under Meraki Authentication for a network
  • GETReturn the Meraki Auth splash or RADIUS user/networks/:networkId/merakiAuthUsers/:merakiAuthUserIdReturn the Meraki Auth splash or RADIUS user

Monitored media servers

  • GETList the monitored media servers for this organization/organizations/:organizationId/insight/monitoredMediaServersList the monitored media servers for this organization. Only valid for organizations with Meraki Insight.
  • POSTAdd a media server to be monitored for this organization/organizations/:organizationId/insight/monitoredMediaServersAdd a media server to be monitored for this organization. Only valid for organizations with Meraki Insight.
  • GETReturn a monitored media server for this organization/organizations/:organizationId/insight/monitoredMediaServers/:monitoredMediaServerIdReturn a monitored media server for this organization. Only valid for organizations with Meraki Insight.
  • PUTUpdate a monitored media server for this organization/organizations/:organizationId/insight/monitoredMediaServers/:monitoredMediaServerIdUpdate a monitored media server for this organization. Only valid for organizations with Meraki Insight.
  • DELETEDelete a monitored media server from this organization/organizations/:organizationId/insight/monitoredMediaServers/:monitoredMediaServerIdDelete a monitored media server from this organization. Only valid for organizations with Meraki Insight.

Named tag scope

  • GETList the target groups in this network/networks/:networkId/sm/targetGroups?withDetails=trueList the target groups in this network
  • POSTAdd a target group/networks/:networkId/sm/targetGroupsAdd a target group
  • GETReturn a target group/networks/:networkId/sm/targetGroups/:targetGroupId?withDetails=trueReturn a target group
  • PUTUpdate a target group/networks/:networkId/sm/targetGroups/:targetGroupIdUpdate a target group
  • DELETEDelete a target group from a network/networks/:networkId/sm/targetGroups/:targetGroupIdDelete a target group from a network

Networks

  • GETReturn a network/networks/:networkIdReturn a network
  • PUTUpdate a network/networks/:networkIdUpdate a network
  • DELETEDelete a network/networks/:networkIdDelete a network
  • GETList Air Marshal scan results from a network/networks/:networkId/airMarshal?t0=string&timespan=0.0List Air Marshal scan results from a network
  • POSTBind a network to a template./networks/:networkId/bindBind a network to a template.
  • GETReturn the site-to-site VPN settings of a network/networks/:networkId/siteToSiteVpnReturn the site-to-site VPN settings of a network. Only valid for MX networks.
  • PUTUpdate the site-to-site VPN settings of a network/networks/:networkId/siteToSiteVpnUpdate the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode.
  • POSTSplit a combined network into individual networks for each type of device/networks/:networkId/splitSplit a combined network into individual networks for each type of device
  • GETReturn the traffic analysis data for this network/networks/:networkId/traffic?t0=string&timespan=0.0&deviceType=applianceReturn the traffic analysis data for this network. Traffic analysis with hostname visibility must be enabled on the network.
  • POSTUnbind a network from a template./networks/:networkId/unbindUnbind a network from a template.
  • GETList the networks in an organization/organizations/:organizationId/networks?configTemplateId=stringList the networks in an organization
  • POSTCreate a network/organizations/:organizationId/networksCreate a network
  • POSTCombine multiple networks into a single network/organizations/:organizationId/networks/combineCombine multiple networks into a single network

OpenAPI Spec

  • GETReturn the OpenAPI 2.0 Specification of the organization's API documentation in JSON/organizations/:organizationId/openapiSpecReturn the OpenAPI 2.0 Specification of the organization's API documentation in JSON

Organizations

  • GETList the organizations that the user has privileges on/organizationsList the organizations that the user has privileges on
  • GETReturn an organization/organizations/:organizationIdReturn an organization
  • POSTClaim a list of devices, licenses, and/or orders into an organization/organizations/:organizationId/claimClaim 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…
  • POSTCreate a new organization by cloning the addressed organization/organizations/:organizationId/cloneCreate a new organization by cloning the addressed organization
  • GETList the status of every Meraki device in the organization/organizations/:organizationId/deviceStatusesList the status of every Meraki device in the organization
  • GETReturn the inventory for an organization/organizations/:organizationId/inventory?includeLicenseInfo=trueReturn the inventory for an organization
  • GETReturn the third party VPN peers for an organization/organizations/:organizationId/thirdPartyVPNPeersReturn the third party VPN peers for an organization
  • PUTUpdate the third party VPN peers for an organization/organizations/:organizationId/thirdPartyVPNPeersUpdate the third party VPN peers for an organization
  • GETReturn the uplink loss and latency for every MX in the organization from at latest 2 minutes ago/organizations/:organizationId/uplinksLossAndLatency?t0=string&t1=string&timespan=0.0&uplink=cellular&ip=stringReturn the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

PII

  • GETList the keys required to access Personally Identifiable Information (PII) for a given identifier/networks/:networkId/pii/piiKeys?username=string&email=string&mac=string&serial=string&imei=string&bluetoothMac=stringList the keys required to access Personally Identifiable Information (PII) for a given identifier. Exactly one identifier will be accepted. If the…
  • GETList the PII requests for this network or organization/networks/:networkId/pii/requestsList the PII requests for this network or organization ALTERNATE PATH /organizations/{organizationId}/pii/requests
  • POSTSubmit a new delete or restrict processing PII request/networks/:networkId/pii/requestsSubmit a new delete or restrict processing PII request ALTERNATE PATH /organizations/{organizationId}/pii/requests
  • GETReturn a PII request/networks/:networkId/pii/requests/:requestIdReturn a PII request ALTERNATE PATH /organizations/{organizationId}/pii/requests/{requestId}
  • DELETEDelete a restrict processing PII request/networks/:networkId/pii/requests/:requestIdDelete a restrict processing PII request ALTERNATE PATH /organizations/{organizationId}/pii/requests/{requestId}
  • GETGiven a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier/networks/:networkId/pii/smDevicesForKey?username=string&email=string&mac=string&serial=string&imei=string&bluetoothMac=stringGiven a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier. These device IDs can be…
  • GETGiven a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier/networks/:networkId/pii/smOwnersForKey?username=string&email=string&mac=string&serial=string&imei=string&bluetoothMac=stringGiven a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier. These owner IDs can be…

Radio settings

  • GETList the non-basic RF profiles for this network/networks/:networkId/wireless/rfProfiles?includeTemplateProfiles=trueList the non-basic RF profiles for this network
  • POSTCreates new RF profile for this network/networks/:networkId/wireless/rfProfilesCreates new RF profile for this network
  • GETReturn a RF profile/networks/:networkId/wireless/rfProfiles/:rfProfileIdReturn a RF profile
  • PUTUpdates specified RF profile for this network/networks/:networkId/wireless/rfProfiles/:rfProfileIdUpdates specified RF profile for this network
  • DELETEDelete a RF Profile/networks/:networkId/wireless/rfProfiles/:rfProfileIdDelete a RF Profile

SAML roles

  • GETList the SAML roles for this organization/organizations/:organizationId/samlRolesList the SAML roles for this organization
  • POSTCreate a SAML role/organizations/:organizationId/samlRolesCreate a SAML role
  • GETReturn a SAML role/organizations/:organizationId/samlRoles/:samlRoleIdReturn a SAML role
  • PUTUpdate a SAML role/organizations/:organizationId/samlRoles/:samlRoleIdUpdate a SAML role

SM

  • POSTBypass activation lock attempt/networks/:networkId/sm/bypassActivationLockAttemptsBypass activation lock attempt
  • GETBypass activation lock attempt status/networks/:networkId/sm/bypassActivationLockAttempts/:attemptIdBypass activation lock attempt status
  • PUTModify the fields of a device/networks/:networkId/sm/device/fieldsModify the fields of a device
  • PUTWipe a device/networks/:networkId/sm/device/wipeWipe a device
  • POSTRefresh the details of a device/networks/:networkId/sm/device/:deviceId/refreshDetailsRefresh the details of a device
  • GETList the devices enrolled in an SM network with various specified fields and filters/networks/:networkId/sm/devices?fields=string&wifiMacs=string&serials=string&ids=string&scope=string&batchSize=0&batchToken=stringList the devices enrolled in an SM network with various specified fields and filters
  • PUTForce check-in a set of devices/networks/:networkId/sm/devices/checkinForce check-in a set of devices
  • PUTAdd, delete, or update the tags of a set of devices/networks/:networkId/sm/devices/tagsAdd, delete, or update the tags of a set of devices
  • POSTUnenroll a device/networks/:networkId/sm/devices/:deviceId/unenrollUnenroll a device
  • GETList all the profiles in the network/networks/:networkId/sm/profilesList all the profiles in the network
  • GETGet the profiles associated with a user/networks/:networkId/sm/user/:userId/deviceProfilesGet the profiles associated with a user
  • GETGet a list of softwares associated with a user/networks/:networkId/sm/user/:userId/softwaresGet a list of softwares associated with a user
  • GETList the owners in an SM network with various specified fields and filters/networks/:networkId/sm/users?ids=string&usernames=string&emails=string&scope=stringList the owners in an SM network with various specified fields and filters
  • GETReturn the client's daily cellular data usage history/networks/:networkId/sm/:deviceId/cellularUsageHistoryReturn the client's daily cellular data usage history. Usage data is in kilobytes.
  • GETList the certs on a device/networks/:networkId/sm/:deviceId/certsList the certs on a device
  • GETGet the profiles associated with a device/networks/:networkId/sm/:deviceId/deviceProfilesGet the profiles associated with a device
  • GETList the network adapters of a device/networks/:networkId/sm/:deviceId/networkAdaptersList the network adapters of a device
  • GETList the restrictions on a device/networks/:networkId/sm/:deviceId/restrictionsList the restrictions on a device
  • GETList the security centers on a device/networks/:networkId/sm/:deviceId/securityCentersList the security centers on a device
  • GETGet a list of softwares associated with a device/networks/:networkId/sm/:deviceId/softwaresGet a list of softwares associated with a device
  • GETList the saved SSID names on a device/networks/:networkId/sm/:deviceId/wlanListsList the saved SSID names on a device
  • PUTLock a set of devices/networks/:network_id/sm/devices/lockLock a set of devices
  • GETReturns historical connectivity data (whether a device is regularly checking in to Dashboard)./networks/:network_id/sm/:id/connectivity?perPage=0&startingAfter=string&endingBefore=stringReturns historical connectivity data (whether a device is regularly checking in to Dashboard).
  • GETReturn historical records of various Systems Manager network connection details for desktop devices./networks/:network_id/sm/:id/desktopLogs?perPage=0&startingAfter=string&endingBefore=stringReturn historical records of various Systems Manager network connection details for desktop devices.
  • GETReturn historical records of commands sent to Systems Manager devices/networks/:network_id/sm/:id/deviceCommandLogs?perPage=0&startingAfter=string&endingBefore=stringReturn historical records of commands sent to Systems Manager devices. Note that this will include the name of the Dashboard user who initiated the command if…
  • GETReturn historical records of various Systems Manager client metrics for desktop devices./networks/:network_id/sm/:id/performanceHistory?perPage=0&startingAfter=string&endingBefore=stringReturn historical records of various Systems Manager client metrics for desktop devices.

SNMP settings

  • GETReturn the SNMP settings for a network/networks/:networkId/snmpSettingsReturn the SNMP settings for a network
  • GETReturn the SNMP settings for an organization/organizations/:organizationId/snmpReturn the SNMP settings for an organization

SSIDs

  • GETReturn the SSID statuses of an access point/networks/:networkId/devices/:serial/wireless/statusReturn the SSID statuses of an access point
  • GETList the SSIDs in a network/networks/:networkId/ssidsList the SSIDs in a network. Supports networks with access points or wireless-enabled security appliances and teleworker gateways.
  • GETReturn a single SSID/networks/:networkId/ssids/:numberReturn a single SSID
  • PUTUpdate the attributes of an SSID/networks/:networkId/ssids/:numberUpdate the attributes of an SSID

Security events

  • GETList the security events (intrusion detection only) for a network/networks/:networkId/securityEvents?t0=string&t1=string&timespan=0.0&perPage=0&startingAfter=string&endingBefore=stringList the security events (intrusion detection only) for a network
  • GETList the security events (intrusion detection only) for an organization/organizations/:organizationId/securityEvents?t0=string&t1=string&timespan=0.0&perPage=0&startingAfter=string&endingBefore=stringList the security events (intrusion detection only) for an organization

Splash login attempts

  • GETList the splash login attempts for a network/networks/:networkId/splashLoginAttempts?ssidNumber=0&loginIdentifier=string&timespan=0List the splash login attempts for a network

Splash settings

  • GETDisplay the splash page settings for the given SSID/networks/:networkId/ssids/:number/splashSettingsDisplay the splash page settings for the given SSID
  • PUTModify the splash page settings for the given SSID/networks/:networkId/ssids/:number/splashSettingsModify the splash page settings for the given SSID

Switch access policies

  • GETList the access policies for this network/networks/:networkId/accessPoliciesList the access policies for this network. Only valid for MS networks.

Switch port schedules

  • GETList switch port schedules/networks/:networkId/switch/portSchedulesList switch port schedules
  • POSTAdd a switch port schedule/networks/:networkId/switch/portSchedulesAdd a switch port schedule
  • PUTUpdate a switch port schedule/networks/:networkId/switch/portSchedules/:portScheduleIdUpdate a switch port schedule
  • DELETEDelete a switch port schedule/networks/:networkId/switch/portSchedules/:portScheduleIdDelete a switch port schedule

Switch ports

  • GETReturn the status for all the ports of a switch/devices/:serial/switchPortStatuses?t0=string&timespan=0.0Return the status for all the ports of a switch
  • GETReturn the packet counters for all the ports of a switch/devices/:serial/switchPortStatuses/packets?t0=string&timespan=0.0Return the packet counters for all the ports of a switch

Switch profiles

  • GETList the switch profiles for your switch template configuration/organizations/:organizationId/configTemplates/:configTemplateId/switchProfilesList the switch profiles for your switch template configuration

Switch settings

  • GETReturns the switch network settings/networks/:networkId/switch/settingsReturns the switch network settings
  • PUTUpdate switch network settings/networks/:networkId/switch/settingsUpdate switch network settings
  • GETReturn the MTU configuration/networks/:networkId/switch/settings/mtuReturn the MTU configuration
  • PUTUpdate the MTU configuration/networks/:networkId/switch/settings/mtuUpdate the MTU configuration
  • GETReturn multicast settings for a network/networks/:networkId/switch/settings/multicastReturn multicast settings for a network
  • PUTUpdate multicast settings for a network/networks/:networkId/switch/settings/multicastUpdate multicast settings for a network
  • GETList quality of service rules/networks/:networkId/switch/settings/qosRulesList quality of service rules
  • POSTAdd a quality of service rule/networks/:networkId/switch/settings/qosRulesAdd a quality of service rule
  • GETReturn the quality of service rule IDs by order in which they will be processed by the switch/networks/:networkId/switch/settings/qosRules/orderReturn the quality of service rule IDs by order in which they will be processed by the switch
  • PUTUpdate the order in which the rules should be processed by the switch/networks/:networkId/switch/settings/qosRules/orderUpdate the order in which the rules should be processed by the switch
  • GETReturn a quality of service rule/networks/:networkId/switch/settings/qosRules/:qosRuleIdReturn a quality of service rule
  • PUTUpdate a quality of service rule/networks/:networkId/switch/settings/qosRules/:qosRuleIdUpdate a quality of service rule
  • DELETEDelete a quality of service rule/networks/:networkId/switch/settings/qosRules/:qosRuleIdDelete a quality of service rule
  • GETReturn the storm control configuration for a switch network/networks/:networkId/switch/settings/stormControlReturn the storm control configuration for a switch network
  • PUTUpdate the storm control configuration for a switch network/networks/:networkId/switch/settings/stormControlUpdate the storm control configuration for a switch network

Switch stacks

  • GETList the switch stacks in a network/networks/:networkId/switchStacksList the switch stacks in a network
  • POSTCreate a stack/networks/:networkId/switchStacksCreate a stack
  • GETShow a switch stack/networks/:networkId/switchStacks/:switchStackIdShow a switch stack
  • DELETEDelete a stack/networks/:networkId/switchStacks/:switchStackIdDelete a stack
  • POSTAdd a switch to a stack/networks/:networkId/switchStacks/:switchStackId/addAdd a switch to a stack
  • POSTRemove a switch from a stack/networks/:networkId/switchStacks/:switchStackId/removeRemove a switch from a stack

Syslog servers

  • GETList the syslog servers for a network/networks/:networkId/syslogServersList the syslog servers for a network
  • PUTUpdate the syslog servers for a network/networks/:networkId/syslogServersUpdate the syslog servers for a network

Traffic shaping uplink settings

  • GETReturns the uplink settings for your MX network./networks/:networkId/uplinkSettingsReturns the uplink settings for your MX network.
  • PUTUpdates the uplink settings for your MX network./networks/:networkId/uplinkSettingsUpdates the uplink settings for your MX network.

VLANs

  • GETList the VLANs for an MX network/networks/:networkId/vlansList the VLANs for an MX network
  • POSTAdd a VLAN/networks/:networkId/vlansAdd a VLAN
  • GETReturn a VLAN/networks/:networkId/vlans/:vlanIdReturn a VLAN
  • PUTUpdate a VLAN/networks/:networkId/vlans/:vlanIdUpdate a VLAN
  • DELETEDelete a VLAN from a network/networks/:networkId/vlans/:vlanIdDelete a VLAN from a network
  • GETReturns the enabled status of VLANs for the network/networks/:networkId/vlansEnabledStateReturns the enabled status of VLANs for the network
  • PUTEnable/Disable VLANs for the given network/networks/:networkId/vlansEnabledStateEnable/Disable VLANs for the given network

Wireless health

  • GETAggregated connectivity info for this network, grouped by clients/networks/:networkId/clients/connectionStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=stringAggregated connectivity info for this network, grouped by clients
  • GETAggregated latency info for this network, grouped by clients/networks/:networkId/clients/latencyStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=string&fields=stringAggregated latency info for this network, grouped by clients
  • GETAggregated connectivity info for a given client on this network/networks/:networkId/clients/:clientId/connectionStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=stringAggregated connectivity info for a given client on this network. Clients are identified by their MAC.
  • GETAggregated latency info for a given client on this network/networks/:networkId/clients/:clientId/latencyStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=string&fields=stringAggregated latency info for a given client on this network. Clients are identified by their MAC.
  • GETAggregated connectivity info for this network/networks/:networkId/connectionStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=stringAggregated connectivity info for this network
  • GETAggregated connectivity info for this network, grouped by node/networks/:networkId/devices/connectionStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=stringAggregated connectivity info for this network, grouped by node
  • GETAggregated latency info for this network, grouped by node/networks/:networkId/devices/latencyStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=string&fields=stringAggregated latency info for this network, grouped by node
  • GETAggregated connectivity info for a given AP on this network/networks/:networkId/devices/:serial/connectionStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=stringAggregated connectivity info for a given AP on this network
  • GETAggregated latency info for a given AP on this network/networks/:networkId/devices/:serial/latencyStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=string&fields=stringAggregated latency info for a given AP on this network
  • GETList of all failed client connection events on this network in a given time range/networks/:networkId/failedConnections?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=string&serial=string&clientId=stringList of all failed client connection events on this network in a given time range
  • GETAggregated latency info for this network/networks/:networkId/latencyStats?t0=string&t1=string&timespan=0.0&band=2.4&ssid=0&vlan=0&apTag=string&fields=stringAggregated latency info for this network

Wireless settings

  • GETReturn the wireless settings for a network/networks/:networkId/wireless/settingsReturn the wireless settings for a network
  • PUTUpdate the wireless settings for a network/networks/:networkId/wireless/settingsUpdate the wireless settings for a network

API details

Base URL
https://api.meraki.com/api/v0
Authentication
An API key in the X-Cisco-Meraki-API-Key header
Operations
263 operations on 184 pathsGET 152PUT 58POST 37DELETE 16
Main resources
SM 26Switch settings 15Networks 13Clients 11Devices 11Wireless health 11Organizations 9Cameras 7PII 7VLANs 7
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.0.0-streaming
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Meraki Dashboard API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Meraki Dashboard API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-Cisco-Meraki-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List the API requests made by an organization” (GET /organizations/:organizationId/apiRequests?t0=string&t1=string&timespan=0.0&perPage=0&startingAfter=string&endingBefore=string&adminId=string&path=string&method=string&responseCode=0&sourceIp=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Meraki Dashboard API?

The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification. > Date: 05 March, 2023 > > [Recent… It is listed under IoT & devices and has 263 endpoints.

Who publishes the Meraki Dashboard API?

It is listed from Meraki's public API description (an OpenAPI document), not published by Meraki on Swastik Codes. Anyone who controls meraki.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Meraki Dashboard API?

Requests go to https://api.meraki.com/api/v0. Endpoint paths are added to this base URL.

How do I authenticate with the Meraki Dashboard API?

With an API key in the X-Cisco-Meraki-API-Key header.

How many endpoints does the Meraki Dashboard API have?

263 operations on 184 paths (152 GET, 58 PUT, 37 POST, 16 DELETE). The largest groups are SM, Switch settings, Networks, Clients.

Is forking the Meraki Dashboard API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.