Meraki Dashboard API
The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification. > Date: 05 April, 2023 > > [Recent Updates](https://meraki.io/whats-new/) --- [API Documentation](https://meraki.io/api) [Community Support](https://meraki.io/community) [Meraki Homepage](https://www.meraki.com)
Base URL:
Auth: unknown
Endpoints: 366
Reachable: unknown
CORS: unknown
https://api.meraki.com/api/v1Auth: unknown
Endpoints: 366
Reachable: unknown
CORS: unknown
Links
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
GET |
/devices/{serial} | Return a single device | — | — | — |
GET |
/devices/{serial}/appliance/dhcp/subnets | Return the DHCP subnet information for an appliance | — | — | — |
GET |
/devices/{serial}/appliance/performance | Return the performance score for a single MX | — | — | — |
GET |
/devices/{serial}/appliance/prefixes/delegated | Return current delegated IPv6 prefixes on an appliance. | — | — | — |
GET |
/devices/{serial}/appliance/prefixes/delegated/vlanAssignments | Return prefixes assigned to all IPv6 enabled VLANs on an appliance. | — | — | — |
GET |
/devices/{serial}/camera/analytics/live | Returns live state from camera of analytics zones | — | — | — |
GET |
/devices/{serial}/camera/analytics/overview | Returns an overview of aggregate analytics data for a timespan | — | — | — |
GET |
/devices/{serial}/camera/analytics/recent | Returns most recent record for analytics zones | — | — | — |
GET |
/devices/{serial}/camera/analytics/zones | Returns all configured analytic zones for this camera | — | — | — |
GET |
/devices/{serial}/camera/analytics/zones/{zoneId}/history | Return historical records for analytic zones | — | — | — |
GET |
/devices/{serial}/camera/customAnalytics | Return custom analytics settings for a camera | — | — | — |
GET |
/devices/{serial}/camera/qualityAndRetention | Returns quality and retention settings for the given camera | — | — | — |
GET |
/devices/{serial}/camera/sense | Returns sense settings for a given camera | — | — | — |
GET |
/devices/{serial}/camera/sense/objectDetectionModels | Returns the MV Sense object detection model list for the given camera | — | — | — |
GET |
/devices/{serial}/camera/videoLink | Returns video link to the specified camera | — | — | — |
GET |
/devices/{serial}/camera/wirelessProfiles | Returns wireless profile assigned to the given camera | — | — | — |
GET |
/devices/{serial}/cellular/sims | Return the SIM and APN configurations for a cellular device. | — | — | — |
GET |
/devices/{serial}/cellularGateway/lan | Show the LAN Settings of a MG | — | — | — |
GET |
/devices/{serial}/cellularGateway/portForwardingRules | Returns the port forwarding rules for a single MG. | — | — | — |
GET |
/devices/{serial}/clients | List the clients of a device, up to a maximum of a month ago | — | — | — |
GET |
/devices/{serial}/liveTools/ping/{id} | Return a ping job | — | — | — |
GET |
/devices/{serial}/liveTools/pingDevice/{id} | Return a ping device job | — | — | — |
GET |
/devices/{serial}/lldpCdp | List LLDP and CDP information for a device | — | — | — |
GET |
/devices/{serial}/lossAndLatencyHistory | Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device. | — | — | — |
GET |
/devices/{serial}/managementInterface | Return the management interface settings for a device | — | — | — |
GET |
/devices/{serial}/sensor/relationships | List the sensor roles for a given sensor or camera device. | — | — | — |
GET |
/devices/{serial}/switch/ports | List the switch ports for a switch | — | — | — |
GET |
/devices/{serial}/switch/ports/statuses | Return the status for all the ports of a switch | — | — | — |
GET |
/devices/{serial}/switch/ports/statuses/packets | Return the packet counters for all the ports of a switch | — | — | — |
GET |
/devices/{serial}/switch/ports/{portId} | Return a switch port | — | — | — |
GET |
/devices/{serial}/switch/routing/interfaces | List layer 3 interfaces for a switch | — | — | — |
GET |
/devices/{serial}/switch/routing/interfaces/{interfaceId} | Return a layer 3 interface for a switch | — | — | — |
GET |
/devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp | Return a layer 3 interface DHCP configuration for a switch | — | — | — |
GET |
/devices/{serial}/switch/routing/staticRoutes | List layer 3 static routes for a switch | — | — | — |
GET |
/devices/{serial}/switch/routing/staticRoutes/{staticRouteId} | Return a layer 3 static route for a switch | — | — | — |
GET |
/devices/{serial}/switch/warmSpare | Return warm spare configuration for a switch | — | — | — |
GET |
/devices/{serial}/switchPortStatuses | Return the status for all the ports of a switch | — | — | — |
GET |
/devices/{serial}/switchPortStatuses/packets | Return the packet counters for all the ports of a switch | — | — | — |
GET |
/devices/{serial}/wireless/connectionStats | Aggregated connectivity info for a given AP on this network | — | — | — |
GET |
/devices/{serial}/wireless/latencyStats | Aggregated latency info for a given AP on this network | — | — | — |
GET |
/devices/{serial}/wireless/status | Return the SSID statuses of an access point | — | — | — |
GET |
/networks/{networkId} | Return a network | — | — | — |
GET |
/networks/{networkId}/accessPolicies | List the access policies for this network | — | — | — |
GET |
/networks/{networkId}/airMarshal | List Air Marshal scan results from a network | — | — | — |
GET |
/networks/{networkId}/alertSettings | Return the alert configuration for this network | — | — | — |
GET |
/networks/{networkId}/alerts/history | Return the alert history for this network | — | — | — |
GET |
/networks/{networkId}/appliance/clients/{clientId}/security/events | List the security events for a client | — | — | — |
GET |
/networks/{networkId}/appliance/connectivityMonitoringDestinations | Return the connectivity testing destinations for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/contentFiltering | Return the content filtering settings for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/contentFiltering/categories | List all available content filtering categories for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/cellularFirewallRules | Return the cellular firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/firewalledServices | List the appliance services and their accessibility rules | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/firewalledServices/{service} | Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP') | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/inboundCellularFirewallRules | Return the inbound cellular firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/inboundFirewallRules | Return the inbound firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/l3FirewallRules | Return the L3 firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/l7FirewallRules | List the MX L7 firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/l7FirewallRules/applicationCategories | Return the L7 firewall application categories and their associated applications for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/oneToManyNatRules | Return the 1:Many NAT mapping rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/oneToOneNatRules | Return the 1:1 NAT mapping rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/firewall/portForwardingRules | Return the port forwarding rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/ports | List per-port VLAN settings for all ports of a MX. | — | — | — |
GET |
/networks/{networkId}/appliance/ports/{portId} | Return per-port VLAN settings for a single MX port. | — | — | — |
GET |
/networks/{networkId}/appliance/prefixes/delegated/statics | List static delegated prefixes for a network | — | — | — |
GET |
/networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId} | Return a static delegated prefix from a network | — | — | — |
GET |
/networks/{networkId}/appliance/security/events | List the security events for a network | — | — | — |
GET |
/networks/{networkId}/appliance/security/intrusion | Returns all supported intrusion settings for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/security/malware | Returns all supported malware settings for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/singleLan | Return single LAN configuration | — | — | — |
GET |
/networks/{networkId}/appliance/ssids | List the MX SSIDs in a network | — | — | — |
GET |
/networks/{networkId}/appliance/ssids/{number} | Return a single MX SSID | — | — | — |
GET |
/networks/{networkId}/appliance/staticRoutes | List the static routes for an MX or teleworker network | — | — | — |
GET |
/networks/{networkId}/appliance/staticRoutes/{staticRouteId} | Return a static route for an MX or teleworker network | — | — | — |
GET |
/networks/{networkId}/appliance/trafficShaping | Display the traffic shaping settings for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses | List all custom performance classes for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId} | Return a custom performance class for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/trafficShaping/rules | Display the traffic shaping settings rules for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/trafficShaping/uplinkBandwidth | Returns the uplink bandwidth limits for your MX network | — | — | — |
GET |
/networks/{networkId}/appliance/trafficShaping/uplinkSelection | Show uplink selection settings for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/uplinks/usageHistory | Get the sent and received bytes for each uplink of a network. | — | — | — |
GET |
/networks/{networkId}/appliance/vlans | List the VLANs for an MX network | — | — | — |
GET |
/networks/{networkId}/appliance/vlans/{vlanId} | Return a VLAN | — | — | — |
GET |
/networks/{networkId}/appliance/vpn/bgp | Return a Hub BGP Configuration | — | — | — |
GET |
/networks/{networkId}/appliance/vpn/siteToSiteVpn | Return the site-to-site VPN settings of a network | — | — | — |
GET |
/networks/{networkId}/appliance/warmSpare | Return MX warm spare settings | — | — | — |
GET |
/networks/{networkId}/appliancePorts | List per-port VLAN settings for all ports of a MX. | — | — | — |
GET |
/networks/{networkId}/appliancePorts/{appliancePortId} | Return per-port VLAN settings for a single MX port. | — | — | — |
GET |
/networks/{networkId}/bluetoothClients | List the Bluetooth clients seen by APs in this network | — | — | — |
GET |
/networks/{networkId}/bluetoothClients/{bluetoothClientId} | Return a Bluetooth client | — | — | — |
GET |
/networks/{networkId}/bluetoothSettings | Return 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. | — | — | — |
GET |
/networks/{networkId}/camera/qualityRetentionProfiles | List the quality retention profiles for this network | — | — | — |
GET |
/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId} | Retrieve a single quality retention profile | — | — | — |
GET |
/networks/{networkId}/camera/schedules | Returns a list of all camera recording schedules. | — | — | — |
GET |
/networks/{networkId}/camera/wirelessProfiles | List the camera wireless profiles for this network. | — | — | — |
GET |
/networks/{networkId}/camera/wirelessProfiles/{wirelessProfileId} | Retrieve a single camera wireless profile. | — | — | — |
GET |
/networks/{networkId}/cameras/{serial}/videoLink | Returns video link to the specified camera | — | — | — |
GET |
/networks/{networkId}/cellularFirewallRules | Return the cellular firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/cellularGateway/connectivityMonitoringDestinations | Return the connectivity testing destinations for an MG network | — | — | — |
GET |
/networks/{networkId}/cellularGateway/dhcp | List common DHCP settings of MGs | — | — | — |
GET |
/networks/{networkId}/cellularGateway/subnetPool | Return the subnet pool and mask configured for MGs in the network. | — | — | — |
GET |
/networks/{networkId}/cellularGateway/uplink | Returns the uplink settings for your MG network. | — | — | — |
GET |
/networks/{networkId}/clients | List the clients that have used this network in the timespan | — | — | — |
GET |
/networks/{networkId}/clients/applicationUsage | Return the application usage data for clients | — | — | — |
GET |
/networks/{networkId}/clients/bandwidthUsageHistory | Returns a timeseries of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second. | — | — | — |
GET |
/networks/{networkId}/clients/connectionStats | Aggregated connectivity info for this network, grouped by clients | — | — | — |
GET |
/networks/{networkId}/clients/latencyStats | Aggregated latency info for this network, grouped by clients | — | — | — |
GET |
/networks/{networkId}/clients/overview | Return overview statistics for network clients | — | — | — |
GET |
/networks/{networkId}/clients/usageHistories | Return the usage histories for clients | — | — | — |
GET |
/networks/{networkId}/clients/{clientId} | Return the client associated with the given identifier | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/connectionStats | Aggregated connectivity info for a given client on this network | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/events | Return the events associated with this client | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/latencyHistory | Return the latency history for a client | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/latencyStats | Aggregated latency info for a given client on this network | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/policy | Return the policy assigned to a client on the network | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/splashAuthorizationStatus | Return the splash authorization for a client, for each SSID they've associated with through splash | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/trafficHistory | Return the client's network traffic data over time | — | — | — |
GET |
/networks/{networkId}/clients/{clientId}/usageHistory | Return the client's daily usage history | — | — | — |
GET |
/networks/{networkId}/connectionStats | Aggregated connectivity info for this network | — | — | — |
GET |
/networks/{networkId}/contentFiltering | Return the content filtering settings for an MX network | — | — | — |
GET |
/networks/{networkId}/contentFiltering/categories | List all available content filtering categories for an MX network | — | — | — |
GET |
/networks/{networkId}/devices | List the devices in a network | — | — | — |
GET |
/networks/{networkId}/devices/connectionStats | Aggregated connectivity info for this network, grouped by node | — | — | — |
GET |
/networks/{networkId}/devices/latencyStats | Aggregated latency info for this network, grouped by node | — | — | — |
GET |
/networks/{networkId}/devices/{serial} | Return a single device | — | — | — |
GET |
/networks/{networkId}/devices/{serial}/connectionStats | Aggregated connectivity info for a given AP on this network | — | — | — |
GET |
/networks/{networkId}/devices/{serial}/latencyStats | Aggregated latency info for a given AP on this network | — | — | — |
GET |
/networks/{networkId}/devices/{serial}/lossAndLatencyHistory | Get the uplink loss percentage and latency in milliseconds for a wired network device. | — | — | — |
GET |
/networks/{networkId}/devices/{serial}/performance | Return the performance score for a single MX | — | — | — |
GET |
/networks/{networkId}/devices/{serial}/uplink | Return the uplink information for a device. | — | — | — |
GET |
/networks/{networkId}/devices/{serial}/wireless/status | Return the SSID statuses of an access point | — | — | — |
GET |
/networks/{networkId}/events | List the events for the network | — | — | — |
GET |
/networks/{networkId}/events/eventTypes | List the event type to human-readable description | — | — | — |
GET |
/networks/{networkId}/failedConnections | List of all failed client connection events on this network in a given time range | — | — | — |
GET |
/networks/{networkId}/firewalledServices | List the appliance services and their accessibility rules | — | — | — |
GET |
/networks/{networkId}/firewalledServices/{service} | Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP') | — | — | — |
GET |
/networks/{networkId}/firmwareUpgrades | Get firmware upgrade information for a network | — | — | — |
GET |
/networks/{networkId}/firmwareUpgrades/staged/events | Get the Staged Upgrade Event from a network | — | — | — |
GET |
/networks/{networkId}/firmwareUpgrades/staged/groups | List of Staged Upgrade Groups in a network | — | — | — |
GET |
/networks/{networkId}/firmwareUpgrades/staged/groups/{groupId} | Get a Staged Upgrade Group from a network | — | — | — |
GET |
/networks/{networkId}/firmwareUpgrades/staged/stages | Order of Staged Upgrade Groups in a network | — | — | — |
GET |
/networks/{networkId}/floorPlans | List the floor plans that belong to your network | — | — | — |
GET |
/networks/{networkId}/floorPlans/{floorPlanId} | Find a floor plan by ID | — | — | — |
GET |
/networks/{networkId}/groupPolicies | List the group policies in a network | — | — | — |
GET |
/networks/{networkId}/groupPolicies/{groupPolicyId} | Display a group policy | — | — | — |
GET |
/networks/{networkId}/health/alerts | Return all global alerts on this network | — | — | — |
GET |
/networks/{networkId}/insight/applications/{applicationId}/healthByTime | Get application health by time | — | — | — |
GET |
/networks/{networkId}/l3FirewallRules | Return the L3 firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/l7FirewallRules | List the MX L7 firewall rules for an MX network | — | — | — |
GET |
/networks/{networkId}/l7FirewallRules/applicationCategories | Return the L7 firewall application categories and their associated applications for an MX network | — | — | — |
GET |
/networks/{networkId}/latencyStats | Aggregated latency info for this network | — | — | — |
GET |
/networks/{networkId}/merakiAuthUsers | List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a wired network) | — | — | — |
GET |
/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId} | Return the Meraki Auth splash guest, RADIUS, or client VPN user | — | — | — |
GET |
/networks/{networkId}/mqttBrokers | List the MQTT brokers for this network | — | — | — |
GET |
/networks/{networkId}/mqttBrokers/{mqttBrokerId} | Return an MQTT broker | — | — | — |
GET |
/networks/{networkId}/netflow | Return the NetFlow traffic reporting settings for a network | — | — | — |
GET |
/networks/{networkId}/networkHealth/channelUtilization | Get the channel utilization over each radio for all APs in a network. | — | — | — |
GET |
/networks/{networkId}/oneToManyNatRules | Return the 1:Many NAT mapping rules for an MX network | — | — | — |
GET |
/networks/{networkId}/oneToOneNatRules | Return the 1:1 NAT mapping rules for an MX network | — | — | — |
GET |
/networks/{networkId}/pii/piiKeys | List the keys required to access Personally Identifiable Information (PII) for a given identifier | — | — | — |
GET |
/networks/{networkId}/pii/requests | List the PII requests for this network or organization | — | — | — |
GET |
/networks/{networkId}/pii/requests/{requestId} | Return a PII request | — | — | — |
GET |
/networks/{networkId}/pii/smDevicesForKey | Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier | — | — | — |
GET |
/networks/{networkId}/pii/smOwnersForKey | Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier | — | — | — |
GET |
/networks/{networkId}/policies/byClient | Get policies for all clients with policies | — | — | — |
GET |
/networks/{networkId}/portForwardingRules | Return the port forwarding rules for an MX network | — | — | — |
GET |
/networks/{networkId}/security/intrusionSettings | Returns all supported intrusion settings for an MX network | — | — | — |
GET |
/networks/{networkId}/security/malwareSettings | Returns all supported malware settings for an MX network | — | — | — |
GET |
/networks/{networkId}/securityEvents | List the security events (intrusion detection only) for a network | — | — | — |
GET |
/networks/{networkId}/sensor/alerts/current/overview/byMetric | Return an overview of currently alerting sensors by metric | — | — | — |
GET |
/networks/{networkId}/sensor/alerts/overview/byMetric | Return an overview of alert occurrences over a timespan, by metric | — | — | — |
GET |
/networks/{networkId}/sensor/relationships | List the sensor roles for devices in a given network | — | — | — |
GET |
/networks/{networkId}/siteToSiteVpn | Return the site-to-site VPN settings of a network | — | — | — |
GET |
/networks/{networkId}/sm/bypassActivationLockAttempts/{attemptId} | Bypass activation lock attempt status | — | — | — |
GET |
/networks/{networkId}/sm/devices | List the devices enrolled in an SM network with various specified fields and filters | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/cellularUsageHistory | Return the client's daily cellular data usage history | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/certs | List the certs on a device | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/connectivity | Returns historical connectivity data (whether a device is regularly checking in to Dashboard). | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/desktopLogs | Return historical records of various Systems Manager network connection details for desktop devices. | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/deviceCommandLogs | Return historical records of commands sent to Systems Manager devices | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/deviceProfiles | Get the installed profiles associated with a device | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/networkAdapters | List the network adapters of a device | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/performanceHistory | Return historical records of various Systems Manager client metrics for desktop devices. | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/restrictions | List the restrictions on a device | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/securityCenters | List the security centers on a device | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/softwares | Get a list of softwares associated with a device | — | — | — |
GET |
/networks/{networkId}/sm/devices/{deviceId}/wlanLists | List the saved SSID names on a device | — | — | — |
GET |
/networks/{networkId}/sm/targetGroups | List the target groups in this network | — | — | — |
GET |
/networks/{networkId}/sm/targetGroups/{targetGroupId} | Return a target group | — | — | — |
GET |
/networks/{networkId}/sm/trustedAccessConfigs | List Trusted Access Configs | — | — | — |
GET |
/networks/{networkId}/sm/userAccessDevices | List User Access Devices and its Trusted Access Connections | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/cellularUsageHistory | Return the client's daily cellular data usage history | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/certs | List the certs on a device | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/deviceProfiles | Get the profiles associated with a device | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/networkAdapters | List the network adapters of a device | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/restrictions | List the restrictions on a device | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/securityCenters | List the security centers on a device | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/softwares | Get a list of softwares associated with a device | — | — | — |
GET |
/networks/{networkId}/sm/{deviceId}/wlanLists | List the saved SSID names on a device | — | — | — |
GET |
/networks/{networkId}/snmp | Return the SNMP settings for a network | — | — | — |
GET |
/networks/{networkId}/snmpSettings | Return the SNMP settings for a network | — | — | — |
GET |
/networks/{networkId}/splashLoginAttempts | List the splash login attempts for a network | — | — | — |
GET |
/networks/{networkId}/ssids | List the SSIDs in a network | — | — | — |
GET |
/networks/{networkId}/ssids/{number} | Return a single SSID | — | — | — |
GET |
/networks/{networkId}/ssids/{number}/l3FirewallRules | Return the L3 firewall rules for an SSID on an MR network | — | — | — |
GET |
/networks/{networkId}/ssids/{number}/splashSettings | Display the splash page settings for the given SSID | — | — | — |
GET |
/networks/{networkId}/staticRoutes | List the static routes for an MX or teleworker network | — | — | — |
GET |
/networks/{networkId}/staticRoutes/{staticRouteId} | Return a static route for an MX or teleworker network | — | — | — |
GET |
/networks/{networkId}/switch/accessControlLists | Return the access control lists for a MS network | — | — | — |
GET |
/networks/{networkId}/switch/accessPolicies | List the access policies for a switch network | — | — | — |
GET |
/networks/{networkId}/switch/accessPolicies/{accessPolicyNumber} | Return a specific access policy for a switch network | — | — | — |
GET |
/networks/{networkId}/switch/alternateManagementInterface | Return the switch alternate management interface for the network | — | — | — |
GET |
/networks/{networkId}/switch/dhcp/v4/servers/seen | Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day) | — | — | — |
GET |
/networks/{networkId}/switch/dhcpServerPolicy | Return the DHCP server settings | — | — | — |
GET |
/networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers | Return the list of servers trusted by Dynamic ARP Inspection on this network | — | — | — |
GET |
/networks/{networkId}/switch/dhcpServerPolicy/arpInspection/warnings/byDevice | Return the devices that have a Dynamic ARP Inspection warning and their warnings | — | — | — |
GET |
/networks/{networkId}/switch/dscpToCosMappings | Return the DSCP to CoS mappings | — | — | — |
GET |
/networks/{networkId}/switch/linkAggregations | List link aggregation groups | — | — | — |
GET |
/networks/{networkId}/switch/mtu | Return the MTU configuration | — | — | — |
GET |
/networks/{networkId}/switch/portSchedules | List switch port schedules | — | — | — |
GET |
/networks/{networkId}/switch/qosRules | List quality of service rules | — | — | — |
GET |
/networks/{networkId}/switch/qosRules/order | Return the quality of service rule IDs by order in which they will be processed by the switch | — | — | — |
GET |
/networks/{networkId}/switch/qosRules/{qosRuleId} | Return a quality of service rule | — | — | — |
GET |
/networks/{networkId}/switch/routing/multicast | Return multicast settings for a network | — | — | — |
GET |
/networks/{networkId}/switch/routing/multicast/rendezvousPoints | List multicast rendezvous points | — | — | — |
GET |
/networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId} | Return a multicast rendezvous point | — | — | — |
GET |
/networks/{networkId}/switch/routing/ospf | Return layer 3 OSPF routing configuration | — | — | — |
GET |
/networks/{networkId}/switch/stacks | List the switch stacks in a network | — | — | — |
GET |
/networks/{networkId}/switch/stacks/{switchStackId} | Show a switch stack | — | — | — |
GET |
/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces | List layer 3 interfaces for a switch stack | — | — | — |
GET |
/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId} | Return a layer 3 interface from a switch stack | — | — | — |
GET |
/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp | Return a layer 3 interface DHCP configuration for a switch stack | — | — | — |
GET |
/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes | List layer 3 static routes for a switch stack | — | — | — |
GET |
/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId} | Return a layer 3 static route for a switch stack | — | — | — |
GET |
/networks/{networkId}/switch/stormControl | Return the storm control configuration for a switch network | — | — | — |
GET |
/networks/{networkId}/switch/stp | Returns STP settings | — | — | — |
GET |
/networks/{networkId}/switchStacks | List the switch stacks in a network | — | — | — |
GET |
/networks/{networkId}/syslogServers | List the syslog servers for a network | — | — | — |
GET |
/networks/{networkId}/topology/linkLayer | List the LLDP and CDP information for all discovered devices and connections in a network. | — | — | — |
GET |
/networks/{networkId}/traffic | Return the traffic analysis data for this network | — | — | — |
GET |
/networks/{networkId}/trafficAnalysis | Return the traffic analysis settings for a network | — | — | — |
GET |
/networks/{networkId}/trafficShaping/applicationCategories | Returns the application categories for traffic shaping rules. | — | — | — |
GET |
/networks/{networkId}/trafficShaping/dscpTaggingOptions | Returns the available DSCP tagging options for your traffic shaping rules. | — | — | — |
GET |
/networks/{networkId}/uplinkSettings | Returns the uplink settings for your MX network. | — | — | — |
GET |
/networks/{networkId}/vlans | List the VLANs for an MX network | — | — | — |
GET |
/networks/{networkId}/vlans/{vlanId} | Return a VLAN | — | — | — |
GET |
/networks/{networkId}/vlansEnabledState | Returns the enabled status of VLANs for the network | — | — | — |
GET |
/networks/{networkId}/warmSpareSettings | Return MX warm spare settings | — | — | — |
GET |
/networks/{networkId}/wireless/airMarshal | List Air Marshal scan results from a network | — | — | — |
GET |
/networks/{networkId}/wireless/alternateManagementInterface | Return alternate management interface and devices with IP assigned | — | — | — |
GET |
/networks/{networkId}/wireless/channelUtilizationHistory | Return AP channel utilization over time for a device or network client | — | — | — |
GET |
/networks/{networkId}/wireless/clientCountHistory | Return wireless client counts over time for a network, device, or network client | — | — | — |
GET |
/networks/{networkId}/wireless/clients/connectionStats | Aggregated connectivity info for this network, grouped by clients | — | — | — |
GET |
/networks/{networkId}/wireless/clients/latencyStats | Aggregated latency info for this network, grouped by clients | — | — | — |
GET |
/networks/{networkId}/wireless/clients/{clientId}/connectionStats | Aggregated connectivity info for a given client on this network | — | — | — |
GET |
/networks/{networkId}/wireless/clients/{clientId}/connectivityEvents | List the wireless connectivity events for a client within a network in the timespan. | — | — | — |
GET |
/networks/{networkId}/wireless/clients/{clientId}/latencyHistory | Return the latency history for a client | — | — | — |
GET |
/networks/{networkId}/wireless/clients/{clientId}/latencyStats | Aggregated latency info for a given client on this network | — | — | — |
GET |
/networks/{networkId}/wireless/connectionStats | Aggregated connectivity info for this network | — | — | — |
GET |
/networks/{networkId}/wireless/dataRateHistory | Return PHY data rates over time for a network, device, or network client | — | — | — |
GET |
/networks/{networkId}/wireless/devices/connectionStats | Aggregated connectivity info for this network, grouped by node | — | — | — |
GET |
/networks/{networkId}/wireless/devices/latencyStats | Aggregated latency info for this network, grouped by node | — | — | — |
GET |
/networks/{networkId}/wireless/failedConnections | List of all failed client connection events on this network in a given time range | — | — | — |
GET |
/networks/{networkId}/wireless/latencyHistory | Return average wireless latency over time for a network, device, or network client | — | — | — |
GET |
/networks/{networkId}/wireless/latencyStats | Aggregated latency info for this network | — | — | — |
GET |
/networks/{networkId}/wireless/meshStatuses | List wireless mesh statuses for repeaters | — | — | — |
GET |
/networks/{networkId}/wireless/rfProfiles | List the non-basic RF profiles for this network | — | — | — |
GET |
/networks/{networkId}/wireless/rfProfiles/{rfProfileId} | Return a RF profile | — | — | — |
GET |
/networks/{networkId}/wireless/signalQualityHistory | Return signal quality (SNR/RSSI) over time for a device or network client | — | — | — |
GET |
/networks/{networkId}/wireless/ssids | List the MR SSIDs in a network | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number} | Return a single MR SSID | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/bonjourForwarding | List the Bonjour forwarding setting and rules for the SSID | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/deviceTypeGroupPolicies | List the device type group policies for the SSID | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/eapOverride | Return the EAP overridden parameters for an SSID | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/firewall/l3FirewallRules | Return the L3 firewall rules for an SSID on an MR network | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/firewall/l7FirewallRules | Return the L7 firewall rules for an SSID on an MR network | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/hotspot20 | Return the Hotspot 2.0 settings for an SSID | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/identityPsks | List all Identity PSKs in a wireless network | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId} | Return an Identity PSK | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/schedules | List the outage schedule for the SSID | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/trafficShaping/rules | Display the traffic shaping settings for a SSID on an MR network | — | — | — |
GET |
/networks/{networkId}/wireless/ssids/{number}/vpn | List the VPN settings for the SSID. | — | — | — |
GET |
/networks/{networkId}/wireless/usageHistory | Return AP usage over time for a device or network client | — | — | — |
GET |
/networks/{network_id}/sm/{id}/connectivity | Returns historical connectivity data (whether a device is regularly checking in to Dashboard). | — | — | — |
GET |
/networks/{network_id}/sm/{id}/desktopLogs | Return historical records of various Systems Manager network connection details for desktop devices. | — | — | — |
GET |
/networks/{network_id}/sm/{id}/deviceCommandLogs | Return historical records of commands sent to Systems Manager devices | — | — | — |
GET |
/networks/{network_id}/sm/{id}/performanceHistory | Return historical records of various Systems Manager client metrics for desktop devices. | — | — | — |
GET |
/organizations | List the organizations that the user has privileges on | — | — | — |
GET |
/organizations/{organizationId} | Return an organization | — | — | — |
GET |
/organizations/{organizationId}/actionBatches | Return the list of action batches in the organization | — | — | — |
GET |
/organizations/{organizationId}/actionBatches/{actionBatchId} | Return an action batch | — | — | — |
GET |
/organizations/{organizationId}/adaptivePolicy/acls | List adaptive policy ACLs in a organization | — | — | — |
GET |
/organizations/{organizationId}/adaptivePolicy/acls/{aclId} | Returns the adaptive policy ACL information | — | — | — |
GET |
/organizations/{organizationId}/adaptivePolicy/groups | List adaptive policy groups in a organization | — | — | — |
GET |
/organizations/{organizationId}/adaptivePolicy/groups/{id} | Returns an adaptive policy group | — | — | — |
GET |
/organizations/{organizationId}/adaptivePolicy/overview | Returns adaptive policy aggregate statistics for an organization | — | — | — |
GET |
/organizations/{organizationId}/adaptivePolicy/policies | List adaptive policies in an organization | — | — | — |
GET |
/organizations/{organizationId}/adaptivePolicy/policies/{id} | Return an adaptive policy | — | — | — |
GET |
/organizations/{organizationId}/admins | List the dashboard administrators in this organization | — | — | — |
GET |
/organizations/{organizationId}/apiRequests | List the API requests made by an organization | — | — | — |
GET |
/organizations/{organizationId}/apiRequests/overview | Return an aggregated overview of API requests data | — | — | — |
GET |
/organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval | Tracks organizations' API requests by response code across a given time period | — | — | — |
GET |
/organizations/{organizationId}/appliance/security/events | List the security events for an organization | — | — | — |
GET |
/organizations/{organizationId}/appliance/security/intrusion | Returns all supported intrusion settings for an organization | — | — | — |
GET |
/organizations/{organizationId}/appliance/uplink/statuses | List the uplink status of every Meraki MX and Z series appliances in the organization | — | — | — |
GET |
/organizations/{organizationId}/appliance/vpn/stats | Show VPN history stat for networks in an organization | — | — | — |
GET |
/organizations/{organizationId}/appliance/vpn/statuses | Show VPN status for networks in an organization | — | — | — |
GET |
/organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers | Return the third party VPN peers for an organization | — | — | — |
GET |
/organizations/{organizationId}/appliance/vpn/vpnFirewallRules | Return the firewall rules for an organization's site-to-site VPN | — | — | — |
GET |
/organizations/{organizationId}/brandingPolicies | List the branding policies of an organization | — | — | — |
GET |
/organizations/{organizationId}/brandingPolicies/priorities | Return the branding policy IDs of an organization in priority order | — | — | — |
GET |
/organizations/{organizationId}/brandingPolicies/{brandingPolicyId} | Return a branding policy | — | — | — |
GET |
/organizations/{organizationId}/camera/customAnalytics/artifacts | List Custom Analytics Artifacts | — | — | — |
GET |
/organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId} | Get Custom Analytics Artifact | — | — | — |
GET |
/organizations/{organizationId}/camera/onboarding/statuses | Fetch onboarding status of cameras | — | — | — |
GET |
/organizations/{organizationId}/cellularGateway/uplink/statuses | List the uplink status of every Meraki MG cellular gateway in the organization | — | — | — |
GET |
/organizations/{organizationId}/clients/bandwidthUsageHistory | Return data usage (in megabits per second) over time for all clients in the given organization within a given time range. | — | — | — |
GET |
/organizations/{organizationId}/clients/overview | Return summary information around client data usage (in mb) across the given organization. | — | — | — |
GET |
/organizations/{organizationId}/clients/search | Return the client details in an organization | — | — | — |
GET |
/organizations/{organizationId}/configTemplates | List the configuration templates for this organization | — | — | — |
GET |
/organizations/{organizationId}/configTemplates/{configTemplateId} | Return a single configuration template | — | — | — |
GET |
/organizations/{organizationId}/configTemplates/{configTemplateId}/switchProfiles | List the switch profiles for your switch template configuration | — | — | — |
GET |
/organizations/{organizationId}/configurationChanges | View the Change Log for your organization | — | — | — |
GET |
/organizations/{organizationId}/deviceStatuses | List the status of every Meraki device in the organization | — | — | — |
GET |
/organizations/{organizationId}/devices | List the devices in an organization | — | — | — |
GET |
/organizations/{organizationId}/devices/availabilities | List the availability information for devices in an organization | — | — | — |
GET |
/organizations/{organizationId}/devices/powerModules/statuses/byDevice | List the power status information for devices in an organization | — | — | — |
GET |
/organizations/{organizationId}/devices/statuses | List the status of every Meraki device in the organization | — | — | — |
GET |
/organizations/{organizationId}/devices/statuses/overview | Return an overview of current device statuses | — | — | — |
GET |
/organizations/{organizationId}/devices/uplinks/addresses/byDevice | List the current uplink addresses for devices in an organization. | — | — | — |
GET |
/organizations/{organizationId}/devices/uplinksLossAndLatency | Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago | — | — | — |
GET |
/organizations/{organizationId}/earlyAccess/features | List the available early access features for organization | — | — | — |
GET |
/organizations/{organizationId}/earlyAccess/features/optIns | List the early access feature opt-ins for an organization | — | — | — |
GET |
/organizations/{organizationId}/earlyAccess/features/optIns/{optInId} | Show an early access feature opt-in for an organization | — | — | — |
GET |
/organizations/{organizationId}/firmware/upgrades | Get firmware upgrade information for an organization | — | — | — |
GET |
/organizations/{organizationId}/firmware/upgrades/byDevice | Get firmware upgrade status for the filtered devices | — | — | — |
GET |
/organizations/{organizationId}/insight/applications | List all Insight tracked applications | — | — | — |
GET |
/organizations/{organizationId}/insight/monitoredMediaServers | List the monitored media servers for this organization | — | — | — |
GET |
/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId} | Return a monitored media server for this organization | — | — | — |
GET |
/organizations/{organizationId}/inventory | Return the inventory for an organization | — | — | — |
GET |
/organizations/{organizationId}/inventory/devices | Return the device inventory for an organization | — | — | — |
GET |
/organizations/{organizationId}/inventory/devices/{serial} | Return a single device from the inventory of an organization | — | — | — |
GET |
/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports | Check the status of a committed Import operation | — | — | — |
GET |
/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks | Returns list of networks eligible for adding cloud monitored device | — | — | — |
GET |
/organizations/{organizationId}/licenseState | Return an overview of the license state for an organization | — | — | — |
GET |
/organizations/{organizationId}/licenses | List the licenses for an organization | — | — | — |
GET |
/organizations/{organizationId}/licenses/overview | Return an overview of the license state for an organization | — | — | — |
GET |
/organizations/{organizationId}/licenses/{licenseId} | Display a license | — | — | — |
GET |
/organizations/{organizationId}/licensing/coterm/licenses | List the licenses in a coterm organization | — | — | — |
GET |
/organizations/{organizationId}/loginSecurity | Returns the login security settings for an organization. | — | — | — |
GET |
/organizations/{organizationId}/networks | List the networks that the user has privileges on in an organization | — | — | — |
GET |
/organizations/{organizationId}/openapiSpec | Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON | — | — | — |
GET |
/organizations/{organizationId}/policyObjects | Lists Policy Objects belonging to the organization. | — | — | — |
GET |
/organizations/{organizationId}/policyObjects/groups | Lists Policy Object Groups belonging to the organization. | — | — | — |
GET |
/organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId} | Shows details of a Policy Object Group. | — | — | — |
GET |
/organizations/{organizationId}/policyObjects/{policyObjectId} | Shows details of a Policy Object. | — | — | — |
GET |
/organizations/{organizationId}/samlRoles | List the SAML roles for this organization | — | — | — |
GET |
/organizations/{organizationId}/samlRoles/{samlRoleId} | Return a SAML role | — | — | — |
GET |
/organizations/{organizationId}/security/intrusionSettings | Returns all supported intrusion settings for an organization | — | — | — |
GET |
/organizations/{organizationId}/securityEvents | List the security events (intrusion detection only) for an organization | — | — | — |
GET |
/organizations/{organizationId}/sensor/readings/history | Return all reported readings from sensors in a given timespan, sorted by timestamp | — | — | — |
GET |
/organizations/{organizationId}/sensor/readings/latest | Return the latest available reading for each metric from each sensor, sorted by sensor serial | — | — | — |
GET |
/organizations/{organizationId}/sm/apnsCert | Get the organization's APNS certificate | — | — | — |
GET |
/organizations/{organizationId}/sm/vppAccounts | List the VPP accounts in the organization | — | — | — |
GET |
/organizations/{organizationId}/sm/vppAccounts/{vppAccountId} | Get a hash containing the unparsed token of the VPP account with the given ID | — | — | — |
GET |
/organizations/{organizationId}/snmp | Return the SNMP settings for an organization | — | — | — |
GET |
/organizations/{organizationId}/summary/top/appliances/byUtilization | Return the top 10 appliances sorted by utilization over given time range. | — | — | — |
GET |
/organizations/{organizationId}/summary/top/clients/byUsage | Return metrics for organization's top 10 clients by data usage (in mb) over given time range. | — | — | — |
GET |
/organizations/{organizationId}/summary/top/clients/manufacturers/byUsage | Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer. | — | — | — |
GET |
/organizations/{organizationId}/summary/top/devices/byUsage | Return metrics for organization's top 10 devices sorted by data usage over given time range | — | — | — |
GET |
/organizations/{organizationId}/summary/top/devices/models/byUsage | Return metrics for organization's top 10 device models sorted by data usage over given time range | — | — | — |
GET |
/organizations/{organizationId}/summary/top/ssids/byUsage | Return metrics for organization's top 10 ssids by data usage over given time range | — | — | — |
GET |
/organizations/{organizationId}/summary/top/switches/byEnergyUsage | Return metrics for organization's top 10 switches by energy usage over given time range | — | — | — |
GET |
/organizations/{organizationId}/switch/ports/bySwitch | List the switchports in an organization by switch | — | — | — |
GET |
/organizations/{organizationId}/thirdPartyVPNPeers | Return the third party VPN peers for an organization | — | — | — |
GET |
/organizations/{organizationId}/uplinks/statuses | List the uplink status of every Meraki MX, MG and Z series devices in the organization | — | — | — |
GET |
/organizations/{organizationId}/uplinksLossAndLatency | Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago | — | — | — |
GET |
/organizations/{organizationId}/vpnFirewallRules | Return the firewall rules for an organization's site-to-site VPN | — | — | — |
GET |
/organizations/{organizationId}/wireless/devices/ethernet/statuses | Endpoint to see power status for wireless devices | — | — | — |