• What's Updated
  • [ devices ]
    • managementInterface
      • Return the management interface settings for a device
      • Update the management interface settings for a device
    • lldpCdp
      • List LLDP and CDP information for a device
    • pingDevice
      • Return a ping device job
      • Enqueue a job to check connectivity status to the device
    • ping
      • Return a ping job
      • Enqueue a job to ping a target host from the device
    • clients
      • List the clients of a device, up to a maximum of a month ago
    • cellular
      • Return the SIM and APN configurations for a cellular device.
      • Updates the SIM and APN configurations for a cellular device.
    • uplinks
      • Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.
    • service
      • Return a single device
      • Update the attributes of a device
      • Blink the LEDs on a device
      • Reboot a device
  • [ camera ]
    • schedules
      • Returns a list of all camera recording schedules.
    • qualityRetentionProfiles
      • List the quality retention profiles for this network
      • Retrieve a single quality retention profile
      • Update an existing quality retention profile for this network.
      • Creates new quality retention profile for this network.
      • Delete an existing quality retention profile for this network.
    • onboarding
      • Fetch onboarding status of cameras
      • Notify that credential handoff to camera has completed
    • wirelessProfiles
      • Returns wireless profile assigned to the given camera
      • List the camera wireless profiles for this network.
      • Retrieve a single camera wireless profile.
      • Assign wireless profiles to the given camera
      • Update an existing camera wireless profile in this network.
      • Creates a new camera wireless profile for this network.
      • Delete an existing camera wireless profile for this network.
    • videoLink
      • Returns video link to the specified camera
    • video
      • Returns video settings for the given camera
      • Update video settings for the given camera
    • sense
      • Returns sense settings for a given camera
      • Returns the MV Sense object detection model list for the given camera
      • Update sense settings for the given camera
    • qualityAndRetention
      • Returns quality and retention settings for the given camera
      • Update quality and retention settings for the given camera
    • customAnalytics
      • Return custom analytics settings for a camera
      • List Custom Analytics Artifacts
      • Get Custom Analytics Artifact
      • Update custom analytics settings for a camera
      • Create custom analytics artifact
      • Delete Custom Analytics Artifact
    • analytics
      • Returns live state from camera of analytics zones
      • Returns an overview of aggregate analytics data for a timespan
      • Returns most recent record for analytics zones
      • Returns all configured analytic zones for this camera
      • Return historical records for analytic zones
    • service
      • Generate a snapshot of what the camera sees at the specified time and return a link to that image.
  • [ cellularGateway ]
    • uplink
      • Returns the uplink settings for your MG network.
      • List the uplink status of every Meraki MG cellular gateway in the organization
      • Updates the uplink settings for your MG network.
    • subnetPool
      • Return the subnet pool and mask configured for MGs in the network.
      • Update the subnet pool and mask configuration for MGs in the network.
    • connectivityMonitoringDestinations
      • Return the connectivity testing destinations for an MG network
      • Update the connectivity testing destinations for an MG network
    • portForwardingRules
      • Returns the port forwarding rules for a single MG.
      • Updates the port forwarding rules for a single MG.
    • lan
      • Show the LAN Settings of a MG
      • Update the LAN Settings for a single MG.
    • dhcp
      • List common DHCP settings of MGs
      • Update common DHCP settings of MGs
  • [ sensor ]
    • alerts
      • Return an overview of currently alerting sensors by metric
      • Return an overview of alert occurrences over a timespan, by metric
      • Lists all sensor alert profiles for a network.
      • Show details of a sensor alert profile for a network.
      • Updates a sensor alert profile for a network.
      • Creates a sensor alert profile for a network.
      • Deletes a sensor alert profile from a network.
    • relationships
      • List the sensor roles for a given sensor or camera device.
      • List the sensor roles for devices in a given network
      • Assign one or more sensor roles to a given sensor or camera device.
    • readings
      • Return all reported readings from sensors in a given timespan, sorted by timestamp
      • Return the latest available reading for each metric from each sensor, sorted by sensor serial
  • [ switch ]
    • accessControlLists
      • Return the access control lists for a MS network
      • Update the access control lists for a MS network
    • accessPolicies
      • List the access policies for a switch network
      • Return a specific access policy for a switch network
      • Update an access policy for a switch network
      • Create an access policy for a switch network
      • Delete an access policy for a switch network
    • alternateManagementInterface
      • Return the switch alternate management interface for the network
      • Update the switch alternate management interface for the network
    • dhcpServerPolicy
      • Return the DHCP server settings
      • Return the list of servers trusted by Dynamic ARP Inspection on this network
      • Return the devices that have a Dynamic ARP Inspection warning and their warnings
      • Update the DHCP server settings
      • Update a server that is trusted by Dynamic ARP Inspection on this network
      • Add a server to be trusted by Dynamic ARP Inspection on this network
      • Remove a server from being trusted by Dynamic ARP Inspection on this network
    • devices
      • Clone port-level and some switch-level configuration settings from a source switch to one or more target switches
    • dscpToCosMappings
      • Return the DSCP to CoS mappings
      • Update the DSCP to CoS mappings
    • linkAggregations
      • List link aggregation groups
      • Update a link aggregation group
      • Create a link aggregation group
      • Split a link aggregation group into separate ports
    • mtu
      • Return the MTU configuration
      • Update the MTU configuration
    • portSchedules
      • List switch port schedules
      • Update a switch port schedule
      • Add a switch port schedule
      • Delete a switch port schedule
    • qosRules
      • List quality of service rules
      • Return the quality of service rule IDs by order in which they will be processed by the switch
      • Return a quality of service rule
      • Update the order in which the rules should be processed by the switch
      • Update a quality of service rule
      • Add a quality of service rule
      • Delete a quality of service rule
    • stacks
      • List the switch stacks in a network
      • Show a switch stack
      • List layer 3 interfaces for a switch stack
      • Return a layer 3 interface from a switch stack
      • Return a layer 3 interface DHCP configuration for a switch stack
      • List layer 3 static routes for a switch stack
      • Return a layer 3 static route for a switch stack
      • Update a layer 3 interface for a switch stack
      • Update a layer 3 interface DHCP configuration for a switch stack
      • Update a layer 3 static route for a switch stack
      • Create a stack
      • Add a switch to a stack
      • Remove a switch from a stack
      • Create a layer 3 interface for a switch stack
      • Create a layer 3 static route for a switch stack
      • Delete a stack
      • Delete a layer 3 interface from a switch stack
      • Delete a layer 3 static route for a switch stack
    • stormControl
      • Return the storm control configuration for a switch network
      • Update the storm control configuration for a switch network
    • stp
      • Returns STP settings
      • Updates STP settings
    • settings
      • Returns the switch network settings
      • Update switch network settings
    • warmSpare
      • Return warm spare configuration for a switch
      • Update warm spare configuration for a switch
    • routing
      • List layer 3 interfaces for a switch
      • Return a layer 3 interface for a switch
      • Return a layer 3 interface DHCP configuration for a switch
      • List layer 3 static routes for a switch
      • Return a layer 3 static route for a switch
      • Return multicast settings for a network
      • List multicast rendezvous points
      • Return a multicast rendezvous point
      • Return layer 3 OSPF routing configuration
      • Update a layer 3 interface for a switch
      • Update a layer 3 interface DHCP configuration for a switch
      • Update a layer 3 static route for a switch
      • Update multicast settings for a network
      • Update a multicast rendezvous point
      • Update layer 3 OSPF routing configuration
      • Create a layer 3 interface for a switch
      • Create a layer 3 static route for a switch
      • Create a multicast rendezvous point
      • Delete a layer 3 interface from the switch
      • Delete a layer 3 static route for a switch
      • Delete a multicast rendezvous point
    • ports
      • List the switch ports for a switch
      • Return the status for all the ports of a switch
      • Return the packet counters for all the ports of a switch
      • Return a switch port
      • List the switchports in an organization by switch
      • Update a switch port
      • Cycle a set of switch ports
    • configTemplates
      • List the switch profiles for your switch template configuration
      • Return all the ports of a switch profile
      • Return a switch profile port
      • Update a switch profile port
    • dhcp
      • Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day)
  • [ appliance ]
    • vpn
      • Return a Hub BGP Configuration
      • Return the site-to-site VPN settings of a network
      • Show VPN history stat for networks in an organization
      • Show VPN status for networks in an organization
      • Return the third party VPN peers for an organization
      • Return the firewall rules for an organization's site-to-site VPN
      • Update a Hub BGP Configuration
      • Update the site-to-site VPN settings of a network
      • Update the third party VPN peers for an organization
      • Update the firewall rules of an organization's site-to-site VPN
    • vlans
      • List the VLANs for an MX network
      • Returns the enabled status of VLANs for the network
      • Return a VLAN
      • Enable/Disable VLANs for the given network
      • Update a VLAN
      • Add a VLAN
      • Delete a VLAN from a network
    • trafficShaping
      • Display the traffic shaping settings for an MX network
      • List all custom performance classes for an MX network
      • Return a custom performance class for an MX network
      • Display the traffic shaping settings rules for an MX network
      • Returns the uplink bandwidth limits for your MX network
      • Show uplink selection settings for an MX network
      • Update the traffic shaping settings for an MX network
      • Update a custom performance class for an MX network
      • Update the traffic shaping settings rules for an MX network
      • Updates the uplink bandwidth settings for your MX network.
      • Update uplink selection settings for an MX network
      • Add a custom performance class for an MX network
      • Delete a custom performance class from an MX network
    • staticRoutes
      • List the static routes for an MX or teleworker network
      • Return a static route for an MX or teleworker network
      • Update a static route for an MX or teleworker network
      • Add a static route for an MX or teleworker network
      • Delete a static route from an MX or teleworker network
    • ssids
      • List the MX SSIDs in a network
      • Return a single MX SSID
      • Update the attributes of an MX SSID
    • singleLan
      • Return single LAN configuration
      • Update single LAN configuration
    • settings
      • Return the appliance settings for a network
      • Update the appliance settings for a network
    • security
      • List the security events for a network
      • Returns all supported intrusion settings for an MX network
      • Returns all supported malware settings for an MX network
      • List the security events for an organization
      • Returns all supported intrusion settings for an organization
      • Set the supported intrusion settings for an MX network
      • Set the supported malware settings for an MX network
      • Sets supported intrusion settings for an organization
    • firewall
      • Return the cellular firewall rules for an MX network
      • List the appliance services and their accessibility rules
      • Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')
      • Return the inbound cellular firewall rules for an MX network
      • Return the inbound firewall rules for an MX network
      • Return the L3 firewall rules for an MX network
      • List the MX L7 firewall rules for an MX network
      • Return the L7 firewall application categories and their associated applications for an MX network
      • Return the 1:Many NAT mapping rules for an MX network
      • Return the 1:1 NAT mapping rules for an MX network
      • Return the port forwarding rules for an MX network
      • Return the firewall settings for this network
      • Update the cellular firewall rules of an MX network
      • Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')
      • Update the inbound cellular firewall rules of an MX network
      • Update the inbound firewall rules of an MX network
      • Update the L3 firewall rules of an MX network
      • Update the MX L7 firewall rules for an MX network
      • Set the 1:Many NAT mapping rules for an MX network
      • Set the 1:1 NAT mapping rules for an MX network
      • Update the port forwarding rules for an MX network
      • Update the firewall settings for this network
    • contentFiltering
      • Return the content filtering settings for an MX network
      • List all available content filtering categories for an MX network
      • Update the content filtering settings for an MX network
    • connectivityMonitoringDestinations
      • Return the connectivity testing destinations for an MX network
      • Update the connectivity testing destinations for an MX network
    • warmSpare
      • Return MX warm spare settings
      • Update MX warm spare settings
      • Swap MX primary and warm spare appliances
    • ports
      • List per-port VLAN settings for all ports of a MX.
      • Return per-port VLAN settings for a single MX port.
      • Update the per-port VLAN settings for a single MX port.
    • clients
      • List the security events for a client
    • vmx
      • Generate a new vMX authentication token
    • uplinks
      • Return the uplink settings for an MX appliance
      • Get the sent and received bytes for each uplink of a network.
      • List the uplink status of every Meraki MX and Z series appliances in the organization
      • Update the uplink settings for an MX appliance
    • prefixes
      • Return current delegated IPv6 prefixes on an appliance.
      • Return prefixes assigned to all IPv6 enabled VLANs on an appliance.
      • List static delegated prefixes for a network
      • Return a static delegated prefix from a network
      • Update a static delegated prefix from a network
      • Add a static delegated prefix from a network
      • Delete a static delegated prefix from a network
    • performance
      • Return the performance score for a single MX
    • dhcp
      • Return the DHCP subnet information for an appliance
  • [ networks ]
    • netflow
      • Return the NetFlow traffic reporting settings for a network
      • Update the NetFlow traffic reporting settings for a network
    • networkHealth
      • Get the channel utilization over each radio for all APs in a network.
    • pii
      • List the keys required to access Personally Identifiable Information (PII) for a given identifier
      • List the PII requests for this network or organization
      • Return a PII request
      • Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier
      • Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier
      • Submit a new delete or restrict processing PII request
      • Delete a restrict processing PII request
    • mqttBrokers
      • List the MQTT brokers for this network
      • Return an MQTT broker
      • Update an MQTT broker
      • Add an MQTT broker
      • Delete an MQTT broker
    • 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)
      • Return the Meraki Auth splash guest, RADIUS, or client VPN user
      • Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated)
      • Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)
      • Deauthorize a user
    • snmp
      • Return the SNMP settings for a network
      • Update the SNMP settings for a network
    • health
      • Return all global alerts on this network
    • splashLoginAttempts
      • List the splash login attempts for a network
    • groupPolicies
      • List the group policies in a network
      • Display a group policy
      • Update a group policy
      • Create a group policy
      • Delete a group policy
    • floorPlans
      • List the floor plans that belong to your network
      • Find a floor plan by ID
      • Update a floor plan's geolocation and other meta data
      • Upload a floor plan
      • Destroy a floor plan
    • firmwareUpgrades
      • Get firmware upgrade information for a network
      • Get the Staged Upgrade Event from a network
      • List of Staged Upgrade Groups in a network
      • Get a Staged Upgrade Group from a network
      • Order of Staged Upgrade Groups in a network
      • Update firmware upgrade information for a network
      • Update the Staged Upgrade Event for a network
      • Update a Staged Upgrade Group for a network
      • Assign Staged Upgrade Group order in the sequence.
      • Rollback a Firmware Upgrade For A Network
      • Create a Staged Upgrade Event for a network
      • Postpone by 1 week all pending staged upgrade stages for a network
      • Rollback a Staged Upgrade Event for a network
      • Create a Staged Upgrade Group for a network
      • Delete a Staged Upgrade Group
    • events
      • List the events for the network
      • List the event type to human-readable description
    • devices
      • List the devices in a network
      • Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requsts against that device to succeed)
      • Claim a vMX into a network
      • Remove a single device
    • bluetoothClients
      • List the Bluetooth clients seen by APs in this network
      • Return a Bluetooth client
    • trafficShaping
      • Returns the application categories for traffic shaping rules.
      • Returns the available DSCP tagging options for your traffic shaping rules.
    • syslogServers
      • List the syslog servers for a network
      • Update the syslog servers for a network
    • topology
      • List the LLDP and CDP information for all discovered devices and connections in a network.
    • traffic
      • Return the traffic analysis data for this network
    • trafficAnalysis
      • Return the traffic analysis settings for a network
      • Update the traffic analysis settings for a network
    • settings
      • Return the settings for a network
      • Update the settings for a network
    • webhooks
      • List the HTTP servers for a network
      • Return an HTTP server for a network
      • List the webhook payload templates for a network
      • Get the webhook payload template for a network
      • Return the status of a webhook test for a network
      • Update an HTTP server
      • Update a webhook payload template for a network
      • Add an HTTP server to a network
      • Create a webhook payload template for a network
      • Send a test webhook for a network
      • Delete an HTTP server from a network
      • Destroy a webhook payload template for a network
    • alerts
      • Return the alert history for this network
      • Return the alert configuration for this network
      • Update the alert configuration for this network
    • clients
      • List the clients that have used this network in the timespan
      • Return the application usage data for clients
      • Returns a timeseries of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second.
      • Return overview statistics for network clients
      • Return the usage histories for clients
      • Return the client associated with the given identifier
      • Return the policy assigned to a client on the network
      • Return the splash authorization for a client, for each SSID they've associated with through splash
      • Return the client's network traffic data over time
      • Return the client's daily usage history
      • Update the policy assigned to a client on the network
      • Update a client's splash authorization
      • Provisions a client with a name and policy
    • policies
      • Get policies for all clients with policies
    • service
      • Return a network
      • Update a network
      • Bind a network to a template.
      • Split a combined network into individual networks for each type of device
      • Unbind a network from a template.
      • Delete a network
  • [ insight ]
    • applications
      • Get application health by time
      • List all Insight tracked applications
    • monitoredMediaServers
      • List the monitored media servers for this organization
      • Return a monitored media server for this organization
      • Update a monitored media server for this organization
      • Add a media server to be monitored for this organization
      • Delete a monitored media server from this organization
  • [ sm ]
    • bypassActivationLockAttempts
      • Bypass activation lock attempt status
      • Bypass activation lock attempt
    • profiles
      • List all profiles in a network
    • targetGroups
      • List the target groups in this network
      • Return a target group
      • Update a target group
      • Add a target group
      • Delete a target group from a network
    • trustedAccessConfigs
      • List Trusted Access Configs
    • userAccessDevices
      • List User Access Devices and its Trusted Access Connections
      • Delete a User Access Device
    • users
      • List the owners in an SM network with various specified fields and filters
      • Get the profiles associated with a user
      • Get a list of softwares associated with a user
    • devices
      • List the devices enrolled in an SM network with various specified fields and filters
      • Return the client's daily cellular data usage history
      • List the certs on a device
      • Returns historical connectivity data (whether a device is regularly checking in to Dashboard).
      • Return historical records of various Systems Manager network connection details for desktop devices.
      • Return historical records of commands sent to Systems Manager devices
      • Get the installed profiles associated with a device
      • List the network adapters of a device
      • Return historical records of various Systems Manager client metrics for desktop devices.
      • List the restrictions on a device
      • List the security centers on a device
      • Get a list of softwares associated with a device
      • List the saved SSID names on a device
      • Modify the fields of a device
      • Force check-in a set of devices
      • Lock a set of devices
      • Add, delete, or update the tags of a set of devices
      • Move a set of devices to a new network
      • Wipe a device
      • Refresh the details of a device
      • Unenroll a device
    • apnsCert
      • Get the organization's APNS certificate
    • vppAccounts
      • List the VPP accounts in the organization
      • Get a hash containing the unparsed token of the VPP account with the given ID
  • [ organizations ]
    • summary
      • Return the top 10 appliances sorted by utilization over given time range.
      • Return metrics for organization's top 10 clients by data usage (in mb) over given time range.
      • Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.
      • Return metrics for organization's top 10 devices sorted by data usage over given time range
      • Return metrics for organization's top 10 device models sorted by data usage over given time range
      • Return metrics for organization's top 10 ssids by data usage over given time range
      • Return metrics for organization's top 10 switches by energy usage over given time range
    • users
      • Delete a user and all of its authentication methods.
    • snmp
      • Return the SNMP settings for an organization
      • Update the SNMP settings for an organization
    • devices
      • List the devices in an organization
      • List the availability information for devices in an organization
      • List the power status information for devices in an organization
      • List the status of every Meraki device in the organization
      • Return an overview of current device statuses
      • List the current uplink addresses for devices in an organization.
      • Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
    • webhooks
      • Return a list of alert types to be used with managing webhook alerts
      • Return the log of webhook POSTs sent
    • alerts
      • List all organization-wide alert configurations
      • Update an organization-wide alert config
      • Create an organization-wide alert configuration
      • Removes an organization-wide alert config
    • actionBatches
      • Return the list of action batches in the organization
      • Return an action batch
      • Update an action batch
      • Create an action batch
      • Delete an action batch
    • adaptivePolicy
      • List adaptive policy ACLs in a organization
      • Returns the adaptive policy ACL information
      • List adaptive policy groups in a organization
      • Returns an adaptive policy group
      • Returns adaptive policy aggregate statistics for an organization
      • List adaptive policies in an organization
      • Return an adaptive policy
      • Returns global adaptive policy settings in an organization
      • Updates an adaptive policy ACL
      • Updates an adaptive policy group
      • Update an Adaptive Policy
      • Update global adaptive policy settings
      • Creates new adaptive policy ACL
      • Creates a new adaptive policy group
      • Add an Adaptive Policy
      • Deletes the specified adaptive policy ACL
      • Deletes the specified adaptive policy group and any associated policies and references
      • Delete an Adaptive Policy
    • admins
      • List the dashboard administrators in this organization
      • Update an administrator
      • Create a new dashboard administrator
      • Revoke all access for a dashboard administrator within this organization
    • apiRequests
      • List the API requests made by an organization
      • Return an aggregated overview of API requests data
      • Tracks organizations' API requests by response code across a given time period
    • brandingPolicies
      • List the branding policies of an organization
      • Return the branding policy IDs of an organization in priority order
      • Return a branding policy
      • Update the priority ordering of an organization's branding policies.
      • Update a branding policy
      • Add a new branding policy to an organization
      • Delete a branding policy
    • configTemplates
      • List the configuration templates for this organization
      • Return a single configuration template
      • Update a configuration template
      • Create a new configuration template
      • Remove a configuration template
    • clients
      • Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.
      • Return summary information around client data usage (in mb) across the given organization.
      • Return the client details in an organization
    • configurationChanges
      • View the Change Log for your organization
    • earlyAccess
      • List the available early access features for organization
      • List the early access feature opt-ins for an organization
      • Show an early access feature opt-in for an organization
      • Update an early access feature opt-in for an organization
      • Create a new early access feature opt-in for an organization
      • Delete an early access feature opt-in
    • firmware
      • Get firmware upgrade information for an organization
      • Get firmware upgrade status for the filtered devices
    • inventory
      • Return the device inventory for an organization
      • Return a single device from the inventory of an organization
      • Check the status of a committed Import operation
      • Returns list of networks eligible for adding cloud monitored device
      • Claim a list of devices, licenses, and/or orders into an organization inventory
      • Imports event logs related to the onboarding app into elastisearch
      • Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.
      • Initiates or updates an import session
      • Release a list of claimed devices from an organization.
    • licenses
      • List the licenses for an organization
      • Return an overview of the license state for an organization
      • Display a license
      • Update a license
      • Assign SM seats to a network
      • Move licenses to another organization
      • Move SM seats to another organization
      • Renew SM seats of a license
    • loginSecurity
      • Returns the login security settings for an organization.
      • Update the login security settings for an organization
    • networks
      • List the networks that the user has privileges on in an organization
      • Create a network
      • Combine multiple networks into a single network
    • openapiSpec
      • Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON
    • policyObjects
      • Lists Policy Objects belonging to the organization.
      • Lists Policy Object Groups belonging to the organization.
      • Shows details of a Policy Object Group.
      • Shows details of a Policy Object.
      • Updates a Policy Object Group.
      • Updates a Policy Object.
      • Creates a new Policy Object.
      • Creates a new Policy Object Group.
      • Deletes a Policy Object Group.
      • Deletes a Policy Object.
    • saml
      • Returns the SAML SSO enabled settings for an organization.
      • List the SAML IdPs in your organization.
      • Get a SAML IdP from your organization.
      • Updates the SAML SSO enabled settings for an organization.
      • Update a SAML IdP in your organization
      • Create a SAML IdP for your organization.
      • Remove a SAML IdP in your organization.
    • uplinks
      • List the uplink status of every Meraki MX, MG and Z series devices in the organization
    • samlRoles
      • List the SAML roles for this organization
      • Return a SAML role
      • Update a SAML role
      • Create a SAML role
      • Remove a SAML role
    • service
      • Return an organization
      • Update an organization
      • Claim a list of devices, licenses, and/or orders into an organization
      • Create a new organization by cloning the addressed organization
      • Delete an organization
  • [ licensing ]
    • coterm
      • List the licenses in a coterm organization
      • Moves a license to a different organization (coterm only)
  • [ wireless ]
    • alternateManagementInterface
      • Return alternate management interface and devices with IP assigned
      • Update alternate management interface and device static IP
    • devices
      • Aggregated connectivity info for this network, grouped by node
      • Aggregated latency info for this network, grouped by node
      • operation to see power status for wireless devices
    • ssids
      • List the MR SSIDs in a network
      • Return a single MR SSID
      • List the Bonjour forwarding setting and rules for the SSID
      • List the device type group policies for the SSID
      • Return the EAP overridden parameters for an SSID
      • Return the L3 firewall rules for an SSID on an MR network
      • Return the L7 firewall rules for an SSID on an MR network
      • Return the Hotspot 2.0 settings for an SSID
      • List all Identity PSKs in a wireless network
      • Return an Identity PSK
      • List the outage schedule for the SSID
      • Display the splash page settings for the given SSID
      • Display the traffic shaping settings for a SSID on an MR network
      • List the VPN settings for the SSID.
      • Update the attributes of an MR SSID
      • Update the bonjour forwarding setting and rules for the SSID
      • Update the device type group policies for the SSID
      • Update the EAP overridden parameters for an SSID.
      • Update the L3 firewall rules of an SSID on an MR network
      • Update the L7 firewall rules of an SSID on an MR network
      • Update the Hotspot 2.0 settings of an SSID
      • Update an Identity PSK
      • Update the outage schedule for the SSID
      • Modify the splash page settings for the given SSID
      • Update the traffic shaping settings for an SSID on an MR network
      • Update the VPN settings for the SSID
      • Create an Identity PSK
      • Delete an Identity PSK
    • settings
      • Return the wireless settings for a network
      • Update the wireless settings for a network
    • airMarshal
      • List Air Marshal scan results from a network
    • billing
      • Return the billing settings of this network
      • Update the billing settings
    • channelUtilizationHistory
      • Return AP channel utilization over time for a device or network client
    • clientCountHistory
      • Return wireless client counts over time for a network, device, or network client
    • dataRateHistory
      • Return PHY data rates over time for a network, device, or network client
    • status
      • Return the SSID statuses of an access point
    • failedConnections
      • List of all failed client connection events on this network in a given time range
    • radio
      • Return the radio settings of a device
      • Update the radio settings of a device
    • latencyHistory
      • Return average wireless latency over time for a network, device, or network client
    • latencyStats
      • Aggregated latency info for a given AP on this network
      • Aggregated latency info for this network
    • meshStatuses
      • List wireless mesh statuses for repeaters
    • connectionStats
      • Aggregated connectivity info for a given AP on this network
      • Aggregated connectivity info for this network
    • rfProfiles
      • List the non-basic RF profiles for this network
      • Return a RF profile
      • Updates specified RF profile for this network
      • Creates new RF profile for this network
      • Delete a RF Profile
    • bluetooth
      • Return the bluetooth settings for a wireless device
      • Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.
      • Update the bluetooth settings for a wireless device
      • Update the Bluetooth settings for a network
    • signalQualityHistory
      • Return signal quality (SNR/RSSI) over time for a device or network client
    • usageHistory
      • Return AP usage over time for a device or network client
    • clients
      • Aggregated connectivity info for this network, grouped by clients
      • Aggregated latency info for this network, grouped by clients
      • Aggregated connectivity info for a given client on this network
      • List the wireless connectivity events for a client within a network in the timespan.
      • Return the latency history for a client
      • Aggregated latency info for a given client on this network
• What's New
  • [ sensor ]
    • mqttBrokers
      • List the sensor settings of all MQTT brokers for this network. To get the brokers themselves, use /networks/{networkId}/mqttBrokers.
      • Return the sensor settings of an MQTT broker. To get the broker itself, use /networks/{networkId}/mqttBrokers/{mqttBrokerId}.
      • Update the sensor settings of an MQTT broker. To update the broker itself, use /networks/{networkId}/mqttBrokers/{mqttBrokerId}.
  • [ organizations ]
    • devices
      • List the provisioning statuses information for devices in an organization.

Version 1.32.0 to 1.33.0

---

Summary of Changes

3 - New

858 - Updated

620 - Total operations

391 - Total Paths

---

---

What's Updated

[ devices ]

managementInterface

Return the management interface settings for a device

GET /devices/{serial}/managementInterface

- Description added: Serial

---

Update the management interface settings for a device

PUT /devices/{serial}/managementInterface

- Description added: Serial

---

lldpCdp

List LLDP and CDP information for a device

GET /devices/{serial}/lldpCdp

- Description added: Serial

---

pingDevice

Return a ping device job

GET /devices/{serial}/liveTools/pingDevice/{id}

- Description added: Serial

- Description added: Id

---

Enqueue a job to check connectivity status to the device

POST /devices/{serial}/liveTools/pingDevice

- Description added: Serial

---

ping

Return a ping job

GET /devices/{serial}/liveTools/ping/{id}

- Description added: Serial

- Description added: Id

---

Enqueue a job to ping a target host from the device

POST /devices/{serial}/liveTools/ping

- Description added: Serial

---

clients

List the clients of a device, up to a maximum of a month ago

GET /devices/{serial}/clients

- Description added: Serial

---

cellular

Return the SIM and APN configurations for a cellular device.

GET /devices/{serial}/cellular/sims

- Description added: Serial

---

Updates the SIM and APN configurations for a cellular device.

PUT /devices/{serial}/cellular/sims

- Description added: Serial

---

uplinks

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

GET /devices/{serial}/lossAndLatencyHistory

- Description added: Serial

---

service

Return a single device

GET /devices/{serial}

- Description added: Serial

---

Update the attributes of a device

PUT /devices/{serial}

- Description added: Serial

---

Blink the LEDs on a device

POST /devices/{serial}/blinkLeds

- Description added: Serial

---

Reboot a device

POST /devices/{serial}/reboot

- Description added: Serial

---

[ camera ]

schedules

Returns a list of all camera recording schedules.

GET /networks/{networkId}/camera/schedules

- Description added: Network ID

---

qualityRetentionProfiles

List the quality retention profiles for this network

GET /networks/{networkId}/camera/qualityRetentionProfiles

- Description added: Network ID

---

Retrieve a single quality retention profile

GET /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Description added: Network ID

- Description added: Quality retention profile ID

---

Update an existing quality retention profile for this network.

PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Description added: Network ID

- Description added: Quality retention profile ID

---

Creates new quality retention profile for this network.

POST /networks/{networkId}/camera/qualityRetentionProfiles

- Description added: Network ID

---

Delete an existing quality retention profile for this network.

DELETE /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- Description added: Network ID

- Description added: Quality retention profile ID

---

onboarding

Fetch onboarding status of cameras

GET /organizations/{organizationId}/camera/onboarding/statuses

- Description added: Organization ID

---

Notify that credential handoff to camera has completed

PUT /organizations/{organizationId}/camera/onboarding/statuses

- Description added: Organization ID

---

wirelessProfiles

Returns wireless profile assigned to the given camera

GET /devices/{serial}/camera/wirelessProfiles

- Description added: Serial

---

List the camera wireless profiles for this network.

GET /networks/{networkId}/camera/wirelessProfiles

- Description added: Network ID

---

Retrieve a single camera wireless profile.

GET /networks/{networkId}/camera/wirelessProfiles/{wirelessProfileId}

- Description added: Network ID

- Description added: Wireless profile ID

---

Assign wireless profiles to the given camera

PUT /devices/{serial}/camera/wirelessProfiles

- Description added: Serial

---

Update an existing camera wireless profile in this network.

PUT /networks/{networkId}/camera/wirelessProfiles/{wirelessProfileId}

- Description added: Network ID

- Description added: Wireless profile ID

---

Creates a new camera wireless profile for this network.

POST /networks/{networkId}/camera/wirelessProfiles

- Description added: Network ID

---

Delete an existing camera wireless profile for this network.

DELETE /networks/{networkId}/camera/wirelessProfiles/{wirelessProfileId}

- Description added: Network ID

- Description added: Wireless profile ID

---

videoLink

Returns video link to the specified camera

GET /devices/{serial}/camera/videoLink

- Description added: Serial

---

video

Returns video settings for the given camera

GET /devices/{serial}/camera/video/settings

- Description added: Serial

---

Update video settings for the given camera

PUT /devices/{serial}/camera/video/settings

- Description added: Serial

---

sense

Returns sense settings for a given camera

GET /devices/{serial}/camera/sense

- Description added: Serial

---

Returns the MV Sense object detection model list for the given camera

GET /devices/{serial}/camera/sense/objectDetectionModels

- Description added: Serial

---

Update sense settings for the given camera

PUT /devices/{serial}/camera/sense

- Description added: Serial

---

qualityAndRetention

Returns quality and retention settings for the given camera

GET /devices/{serial}/camera/qualityAndRetention

- Description added: Serial

---

Update quality and retention settings for the given camera

PUT /devices/{serial}/camera/qualityAndRetention

- Description added: Serial

---

customAnalytics

Return custom analytics settings for a camera

GET /devices/{serial}/camera/customAnalytics

- Description added: Serial

---

List Custom Analytics Artifacts

GET /organizations/{organizationId}/camera/customAnalytics/artifacts

- Description added: Organization ID

---

Get Custom Analytics Artifact

GET /organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}

- Description added: Organization ID

- Description added: Artifact ID

---

Update custom analytics settings for a camera

PUT /devices/{serial}/camera/customAnalytics

- Description added: Serial

---

Create custom analytics artifact

POST /organizations/{organizationId}/camera/customAnalytics/artifacts

- Description added: Organization ID

---

Delete Custom Analytics Artifact

DELETE /organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}

- Description added: Organization ID

- Description added: Artifact ID

---

analytics

Returns live state from camera of analytics zones

GET /devices/{serial}/camera/analytics/live

- Description added: Serial

---

Returns an overview of aggregate analytics data for a timespan

GET /devices/{serial}/camera/analytics/overview

- Description added: Serial

---

Returns most recent record for analytics zones

GET /devices/{serial}/camera/analytics/recent

- Description added: Serial

---

Returns all configured analytic zones for this camera

GET /devices/{serial}/camera/analytics/zones

- Description added: Serial

---

Return historical records for analytic zones

GET /devices/{serial}/camera/analytics/zones/{zoneId}/history

- Description added: Serial

- Description added: Zone ID

---

service

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

POST /devices/{serial}/camera/generateSnapshot

- Description added: Serial

---

[ cellularGateway ]

uplink

Returns the uplink settings for your MG network.

GET /networks/{networkId}/cellularGateway/uplink

- Description added: Network ID

---

List the uplink status of every Meraki MG cellular gateway in the organization

GET /organizations/{organizationId}/cellularGateway/uplink/statuses

- Description added: Organization ID

---

Updates the uplink settings for your MG network.

PUT /networks/{networkId}/cellularGateway/uplink

- Description added: Network ID

---

subnetPool

Return the subnet pool and mask configured for MGs in the network.

GET /networks/{networkId}/cellularGateway/subnetPool

- Description added: Network ID

---

Update the subnet pool and mask configuration for MGs in the network.

PUT /networks/{networkId}/cellularGateway/subnetPool

- Description added: Network ID

---

connectivityMonitoringDestinations

Return the connectivity testing destinations for an MG network

GET /networks/{networkId}/cellularGateway/connectivityMonitoringDestinations

- Description added: Network ID

---

Update the connectivity testing destinations for an MG network

PUT /networks/{networkId}/cellularGateway/connectivityMonitoringDestinations

- Description added: Network ID

---

portForwardingRules

Returns the port forwarding rules for a single MG.

GET /devices/{serial}/cellularGateway/portForwardingRules

- Description added: Serial

---

Updates the port forwarding rules for a single MG.

PUT /devices/{serial}/cellularGateway/portForwardingRules

- Description added: Serial

---

lan

Show the LAN Settings of a MG

GET /devices/{serial}/cellularGateway/lan

- Description added: Serial

---

Update the LAN Settings for a single MG.

PUT /devices/{serial}/cellularGateway/lan

- Description added: Serial

---

dhcp

List common DHCP settings of MGs

GET /networks/{networkId}/cellularGateway/dhcp

- Description added: Network ID

---

Update common DHCP settings of MGs

PUT /networks/{networkId}/cellularGateway/dhcp

- Description added: Network ID

---

[ sensor ]

alerts

Return an overview of currently alerting sensors by metric

GET /networks/{networkId}/sensor/alerts/current/overview/byMetric

- Description added: Network ID

---

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

GET /networks/{networkId}/sensor/alerts/overview/byMetric

- Description added: Network ID

---

Lists all sensor alert profiles for a network.

GET /networks/{networkId}/sensor/alerts/profiles

- Description added: Network ID

---

Show details of a sensor alert profile for a network.

GET /networks/{networkId}/sensor/alerts/profiles/{id}

- Description added: Network ID

- Description added: Id

---

Updates a sensor alert profile for a network.

PUT /networks/{networkId}/sensor/alerts/profiles/{id}

- Description added: Network ID

- Description added: Id

---

Creates a sensor alert profile for a network.

POST /networks/{networkId}/sensor/alerts/profiles

- Description added: Network ID

---

Deletes a sensor alert profile from a network.

DELETE /networks/{networkId}/sensor/alerts/profiles/{id}

- Description added: Network ID

- Description added: Id

---

relationships

List the sensor roles for a given sensor or camera device.

GET /devices/{serial}/sensor/relationships

- Description added: Serial

---

List the sensor roles for devices in a given network

GET /networks/{networkId}/sensor/relationships

- Description added: Network ID

---

Assign one or more sensor roles to a given sensor or camera device.

PUT /devices/{serial}/sensor/relationships

- Description added: Serial

---

readings

Return all reported readings from sensors in a given timespan, sorted by timestamp

GET /organizations/{organizationId}/sensor/readings/history

- Description added: Organization ID

---

Return the latest available reading for each metric from each sensor, sorted by sensor serial

GET /organizations/{organizationId}/sensor/readings/latest

- Description added: Organization ID

---

[ switch ]

accessControlLists

Return the access control lists for a MS network

GET /networks/{networkId}/switch/accessControlLists

- Description added: Network ID

---

Update the access control lists for a MS network

PUT /networks/{networkId}/switch/accessControlLists

- Description added: Network ID

---

accessPolicies

List the access policies for a switch network

GET /networks/{networkId}/switch/accessPolicies

- Description added: Network ID

---

Return a specific access policy for a switch network

GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

- Description added: Network ID

- Description added: Access policy number

---

Update an access policy for a switch network

PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

- Description added: Network ID

- Description added: Access policy number

---

Create an access policy for a switch network

POST /networks/{networkId}/switch/accessPolicies

- Description added: Network ID

---

Delete an access policy for a switch network

DELETE /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}

- Description added: Network ID

- Description added: Access policy number

---

alternateManagementInterface

Return the switch alternate management interface for the network

GET /networks/{networkId}/switch/alternateManagementInterface

- Description added: Network ID

---

Update the switch alternate management interface for the network

PUT /networks/{networkId}/switch/alternateManagementInterface

- Description added: Network ID

---

dhcpServerPolicy

Return the DHCP server settings

GET /networks/{networkId}/switch/dhcpServerPolicy

- Description added: Network ID

---

Return the list of servers trusted by Dynamic ARP Inspection on this network

GET /networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers

- Description added: Network ID

---

Return the devices that have a Dynamic ARP Inspection warning and their warnings

GET /networks/{networkId}/switch/dhcpServerPolicy/arpInspection/warnings/byDevice

- Description added: Network ID

---

Update the DHCP server settings

PUT /networks/{networkId}/switch/dhcpServerPolicy

- Description added: Network ID

---

Update a server that is trusted by Dynamic ARP Inspection on this network

PUT /networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers/{trustedServerId}

- Description added: Network ID

- Description added: Trusted server ID

---

Add a server to be trusted by Dynamic ARP Inspection on this network

POST /networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers

- Description added: Network ID

---

Remove a server from being trusted by Dynamic ARP Inspection on this network

DELETE /networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers/{trustedServerId}

- Description added: Network ID

- Description added: Trusted server ID

---

devices

Clone port-level and some switch-level configuration settings from a source switch to one or more target switches

POST /organizations/{organizationId}/switch/devices/clone

- Description added: Organization ID

---

dscpToCosMappings

Return the DSCP to CoS mappings

GET /networks/{networkId}/switch/dscpToCosMappings

- Description added: Network ID

---

Update the DSCP to CoS mappings

PUT /networks/{networkId}/switch/dscpToCosMappings

- Description added: Network ID

---

linkAggregations

List link aggregation groups

GET /networks/{networkId}/switch/linkAggregations

- Description added: Network ID

---

Update a link aggregation group

PUT /networks/{networkId}/switch/linkAggregations/{linkAggregationId}

- Description added: Network ID

- Description added: Link aggregation ID

---

Create a link aggregation group

POST /networks/{networkId}/switch/linkAggregations

- Description added: Network ID

---

Split a link aggregation group into separate ports

DELETE /networks/{networkId}/switch/linkAggregations/{linkAggregationId}

- Description added: Network ID

- Description added: Link aggregation ID

---

mtu

Return the MTU configuration

GET /networks/{networkId}/switch/mtu

- Description added: Network ID

---

Update the MTU configuration

PUT /networks/{networkId}/switch/mtu

- Description added: Network ID

---

portSchedules

List switch port schedules

GET /networks/{networkId}/switch/portSchedules

- Description added: Network ID

---

Update a switch port schedule

PUT /networks/{networkId}/switch/portSchedules/{portScheduleId}

- Description added: Network ID

- Description added: Port schedule ID

---

Add a switch port schedule

POST /networks/{networkId}/switch/portSchedules

- Description added: Network ID

---

Delete a switch port schedule

DELETE /networks/{networkId}/switch/portSchedules/{portScheduleId}

- Description added: Network ID

- Description added: Port schedule ID

---

qosRules

List quality of service rules

GET /networks/{networkId}/switch/qosRules

- Description added: Network ID

---

Return the quality of service rule IDs by order in which they will be processed by the switch

GET /networks/{networkId}/switch/qosRules/order

- Description added: Network ID

---

Return a quality of service rule

GET /networks/{networkId}/switch/qosRules/{qosRuleId}

- Description added: Network ID

- Description added: Qos rule ID

---

Update the order in which the rules should be processed by the switch

PUT /networks/{networkId}/switch/qosRules/order

- Description added: Network ID

---

Update a quality of service rule

PUT /networks/{networkId}/switch/qosRules/{qosRuleId}

- Description added: Network ID

- Description added: Qos rule ID

---

Add a quality of service rule

POST /networks/{networkId}/switch/qosRules

- Description added: Network ID

---

Delete a quality of service rule

DELETE /networks/{networkId}/switch/qosRules/{qosRuleId}

- Description added: Network ID

- Description added: Qos rule ID

---

stacks

List the switch stacks in a network

GET /networks/{networkId}/switch/stacks

- Description added: Network ID

---

Show a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}

- Description added: Network ID

- Description added: Switch stack ID

---

List layer 3 interfaces for a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- Description added: Network ID

- Description added: Switch stack ID

---

Return a layer 3 interface from a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Interface ID

---

Return a layer 3 interface DHCP configuration for a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Interface ID

---

List layer 3 static routes for a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes

- Description added: Network ID

- Description added: Switch stack ID

---

Return a layer 3 static route for a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Static route ID

---

Update a layer 3 interface for a switch stack

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Interface ID

---

Update a layer 3 interface DHCP configuration for a switch stack

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Interface ID

---

Update a layer 3 static route for a switch stack

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Static route ID

---

Create a stack

POST /networks/{networkId}/switch/stacks

- Description added: Network ID

---

Add a switch to a stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/add

- Description added: Network ID

- Description added: Switch stack ID

---

Remove a switch from a stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/remove

- Description added: Network ID

- Description added: Switch stack ID

---

Create a layer 3 interface for a switch stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- Description added: Network ID

- Description added: Switch stack ID

---

Create a layer 3 static route for a switch stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes

- Description added: Network ID

- Description added: Switch stack ID

---

Delete a stack

DELETE /networks/{networkId}/switch/stacks/{switchStackId}

- Description added: Network ID

- Description added: Switch stack ID

---

Delete a layer 3 interface from a switch stack

DELETE /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Interface ID

---

Delete a layer 3 static route for a switch stack

DELETE /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}

- Description added: Network ID

- Description added: Switch stack ID

- Description added: Static route ID

---

stormControl

Return the storm control configuration for a switch network

GET /networks/{networkId}/switch/stormControl

- Description added: Network ID

---

Update the storm control configuration for a switch network

PUT /networks/{networkId}/switch/stormControl

- Description added: Network ID

---

stp

Returns STP settings

GET /networks/{networkId}/switch/stp

- Description added: Network ID

---

Updates STP settings

PUT /networks/{networkId}/switch/stp

- Description added: Network ID

---

settings

Returns the switch network settings

GET /networks/{networkId}/switch/settings

- Description added: Network ID

---

Update switch network settings

PUT /networks/{networkId}/switch/settings

- Description added: Network ID

---

warmSpare

Return warm spare configuration for a switch

GET /devices/{serial}/switch/warmSpare

- Description added: Serial

---

Update warm spare configuration for a switch

PUT /devices/{serial}/switch/warmSpare

- Description added: Serial

---

routing

List layer 3 interfaces for a switch

GET /devices/{serial}/switch/routing/interfaces

- Description added: Serial

---

Return a layer 3 interface for a switch

GET /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Description added: Serial

- Description added: Interface ID

---

Return a layer 3 interface DHCP configuration for a switch

GET /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp

- Description added: Serial

- Description added: Interface ID

---

List layer 3 static routes for a switch

GET /devices/{serial}/switch/routing/staticRoutes

- Description added: Serial

---

Return a layer 3 static route for a switch

GET /devices/{serial}/switch/routing/staticRoutes/{staticRouteId}

- Description added: Serial

- Description added: Static route ID

---

Return multicast settings for a network

GET /networks/{networkId}/switch/routing/multicast

- Description added: Network ID

---

List multicast rendezvous points

GET /networks/{networkId}/switch/routing/multicast/rendezvousPoints

- Description added: Network ID

---

Return a multicast rendezvous point

GET /networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}

- Description added: Network ID

- Description added: Rendezvous point ID

---

Return layer 3 OSPF routing configuration

GET /networks/{networkId}/switch/routing/ospf

- Description added: Network ID

---

Update a layer 3 interface for a switch

PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Description added: Serial

- Description added: Interface ID

---

Update a layer 3 interface DHCP configuration for a switch

PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp

- Description added: Serial

- Description added: Interface ID

---

Update a layer 3 static route for a switch

PUT /devices/{serial}/switch/routing/staticRoutes/{staticRouteId}

- Description added: Serial

- Description added: Static route ID

---

Update multicast settings for a network

PUT /networks/{networkId}/switch/routing/multicast

- Description added: Network ID

---

Update a multicast rendezvous point

PUT /networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}

- Description added: Network ID

- Description added: Rendezvous point ID

---

Update layer 3 OSPF routing configuration

PUT /networks/{networkId}/switch/routing/ospf

- Description added: Network ID

---

Create a layer 3 interface for a switch

POST /devices/{serial}/switch/routing/interfaces

- Description added: Serial

---

Create a layer 3 static route for a switch

POST /devices/{serial}/switch/routing/staticRoutes

- Description added: Serial

---

Create a multicast rendezvous point

POST /networks/{networkId}/switch/routing/multicast/rendezvousPoints

- Description added: Network ID

---

Delete a layer 3 interface from the switch

DELETE /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Description added: Serial

- Description added: Interface ID

---

Delete a layer 3 static route for a switch

DELETE /devices/{serial}/switch/routing/staticRoutes/{staticRouteId}

- Description added: Serial

- Description added: Static route ID

---

Delete a multicast rendezvous point

DELETE /networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}

- Description added: Network ID

- Description added: Rendezvous point ID

---

ports

List the switch ports for a switch

GET /devices/{serial}/switch/ports

- Description added: Serial

---

Return the status for all the ports of a switch

GET /devices/{serial}/switch/ports/statuses

- Description added: Serial

---

Return the packet counters for all the ports of a switch

GET /devices/{serial}/switch/ports/statuses/packets

- Description added: Serial

---

Return a switch port

GET /devices/{serial}/switch/ports/{portId}

- Description added: Serial

- Description added: Port ID

---

List the switchports in an organization by switch

GET /organizations/{organizationId}/switch/ports/bySwitch

- Description added: Organization ID

---

Update a switch port

PUT /devices/{serial}/switch/ports/{portId}

- Description added: Serial

- Description added: Port ID

---

Cycle a set of switch ports

POST /devices/{serial}/switch/ports/cycle

- Description added: Serial

---

configTemplates

List the switch profiles for your switch template configuration

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles

- Description added: Organization ID

- Description added: Config template ID

---

Return all the ports of a switch profile

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports

- Description added: Organization ID

- Description added: Config template ID

- Description added: Profile ID

---

Return a switch profile port

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}

- Description added: Organization ID

- Description added: Config template ID

- Description added: Profile ID

- Description added: Port ID

---

Update a switch profile port

PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}

- Description added: Organization ID

- Description added: Config template ID

- Description added: Profile ID

- Description added: Port ID

---

dhcp

Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day)

GET /networks/{networkId}/switch/dhcp/v4/servers/seen

- Description added: Network ID

---

[ appliance ]

vpn

Return a Hub BGP Configuration

GET /networks/{networkId}/appliance/vpn/bgp

- Description added: Network ID

---

Return the site-to-site VPN settings of a network

GET /networks/{networkId}/appliance/vpn/siteToSiteVpn

- Description added: Network ID

---

Show VPN history stat for networks in an organization

GET /organizations/{organizationId}/appliance/vpn/stats

- Description added: Organization ID

---

Show VPN status for networks in an organization

GET /organizations/{organizationId}/appliance/vpn/statuses

- Description added: Organization ID

---

Return the third party VPN peers for an organization

GET /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers

- Description added: Organization ID

---

Return the firewall rules for an organization's site-to-site VPN

GET /organizations/{organizationId}/appliance/vpn/vpnFirewallRules

- Description added: Organization ID

---

Update a Hub BGP Configuration

PUT /networks/{networkId}/appliance/vpn/bgp

- Description added: Network ID

- Optional property sourceInterface Added

- Optional property nextHopIp Added

- Optional property ttlSecurity Added

- Optional property authentication Added

---

Update the site-to-site VPN settings of a network

PUT /networks/{networkId}/appliance/vpn/siteToSiteVpn

- Description added: Network ID

---

Update the third party VPN peers for an organization

PUT /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers

- Description added: Organization ID

---

Update the firewall rules of an organization's site-to-site VPN

PUT /organizations/{organizationId}/appliance/vpn/vpnFirewallRules

- Description added: Organization ID

---

vlans

List the VLANs for an MX network

GET /networks/{networkId}/appliance/vlans

- Description added: Network ID

---

Returns the enabled status of VLANs for the network

GET /networks/{networkId}/appliance/vlans/settings

- Description added: Network ID

---

Return a VLAN

GET /networks/{networkId}/appliance/vlans/{vlanId}

- Description added: Network ID

- Description added: Vlan ID

---

Enable/Disable VLANs for the given network

PUT /networks/{networkId}/appliance/vlans/settings

- Description added: Network ID

---

Update a VLAN

PUT /networks/{networkId}/appliance/vlans/{vlanId}

- Description added: Network ID

- Description added: Vlan ID

---

Add a VLAN

POST /networks/{networkId}/appliance/vlans

- Description added: Network ID

---

Delete a VLAN from a network

DELETE /networks/{networkId}/appliance/vlans/{vlanId}

- Description added: Network ID

- Description added: Vlan ID

---

trafficShaping

Display the traffic shaping settings for an MX network

GET /networks/{networkId}/appliance/trafficShaping

- Description added: Network ID

---

List all custom performance classes for an MX network

GET /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses

- Description added: Network ID

---

Return a custom performance class for an MX network

GET /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}

- Description added: Network ID

- Description added: Custom performance class ID

---

Display the traffic shaping settings rules for an MX network

GET /networks/{networkId}/appliance/trafficShaping/rules

- Description added: Network ID

---

Returns the uplink bandwidth limits for your MX network

GET /networks/{networkId}/appliance/trafficShaping/uplinkBandwidth

- Description added: Network ID

---

Show uplink selection settings for an MX network

GET /networks/{networkId}/appliance/trafficShaping/uplinkSelection

- Description added: Network ID

---

Update the traffic shaping settings for an MX network

PUT /networks/{networkId}/appliance/trafficShaping

- Description added: Network ID

---

Update a custom performance class for an MX network

PUT /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}

- Description added: Network ID

- Description added: Custom performance class ID

---

Update the traffic shaping settings rules for an MX network

PUT /networks/{networkId}/appliance/trafficShaping/rules

- Description added: Network ID

---

Updates the uplink bandwidth settings for your MX network.

PUT /networks/{networkId}/appliance/trafficShaping/uplinkBandwidth

- Description added: Network ID

---

Update uplink selection settings for an MX network

PUT /networks/{networkId}/appliance/trafficShaping/uplinkSelection

- Description added: Network ID

---

Add a custom performance class for an MX network

POST /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses

- Description added: Network ID

---

Delete a custom performance class from an MX network

DELETE /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}

- Description added: Network ID

- Description added: Custom performance class ID

---

staticRoutes

List the static routes for an MX or teleworker network

GET /networks/{networkId}/appliance/staticRoutes

- Description added: Network ID

---

Return a static route for an MX or teleworker network

GET /networks/{networkId}/appliance/staticRoutes/{staticRouteId}

- Description added: Network ID

- Description added: Static route ID

---

Update a static route for an MX or teleworker network

PUT /networks/{networkId}/appliance/staticRoutes/{staticRouteId}

- Description added: Network ID

- Description added: Static route ID

---

Add a static route for an MX or teleworker network

POST /networks/{networkId}/appliance/staticRoutes

- Description added: Network ID

---

Delete a static route from an MX or teleworker network

DELETE /networks/{networkId}/appliance/staticRoutes/{staticRouteId}

- Description added: Network ID

- Description added: Static route ID

---

ssids

List the MX SSIDs in a network

GET /networks/{networkId}/appliance/ssids

- Description added: Network ID

---

Return a single MX SSID

GET /networks/{networkId}/appliance/ssids/{number}

- Description added: Network ID

- Description added: Number

---

Update the attributes of an MX SSID

PUT /networks/{networkId}/appliance/ssids/{number}

- Description added: Network ID

- Description added: Number

---

singleLan

Return single LAN configuration

GET /networks/{networkId}/appliance/singleLan

- Description added: Network ID

---

Update single LAN configuration

PUT /networks/{networkId}/appliance/singleLan

- Description added: Network ID

---

settings

Return the appliance settings for a network

GET /networks/{networkId}/appliance/settings

- Description added: Network ID

---

Update the appliance settings for a network

PUT /networks/{networkId}/appliance/settings

- Description added: Network ID

---

security

List the security events for a network

GET /networks/{networkId}/appliance/security/events

- Description added: Network ID

---

Returns all supported intrusion settings for an MX network

GET /networks/{networkId}/appliance/security/intrusion

- Description added: Network ID

---

Returns all supported malware settings for an MX network

GET /networks/{networkId}/appliance/security/malware

- Description added: Network ID

---

List the security events for an organization

GET /organizations/{organizationId}/appliance/security/events

- Description added: Organization ID

---

Returns all supported intrusion settings for an organization

GET /organizations/{organizationId}/appliance/security/intrusion

- Description added: Organization ID

---

Set the supported intrusion settings for an MX network

PUT /networks/{networkId}/appliance/security/intrusion

- Description added: Network ID

---

Set the supported malware settings for an MX network

PUT /networks/{networkId}/appliance/security/malware

- Description added: Network ID

---

Sets supported intrusion settings for an organization

PUT /organizations/{organizationId}/appliance/security/intrusion

- Description added: Organization ID

---

firewall

Return the cellular firewall rules for an MX network

GET /networks/{networkId}/appliance/firewall/cellularFirewallRules

- Description added: Network ID

---

List the appliance services and their accessibility rules

GET /networks/{networkId}/appliance/firewall/firewalledServices

- Description added: Network ID

---

Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')

GET /networks/{networkId}/appliance/firewall/firewalledServices/{service}

- Description added: Network ID

- Description added: Service

---

Return the inbound cellular firewall rules for an MX network

GET /networks/{networkId}/appliance/firewall/inboundCellularFirewallRules

- Description added: Network ID

---

Return the inbound firewall rules for an MX network

GET /networks/{networkId}/appliance/firewall/inboundFirewallRules

- Description added: Network ID

---

Return the L3 firewall rules for an MX network

GET /networks/{networkId}/appliance/firewall/l3FirewallRules

- Description added: Network ID

---

List the MX L7 firewall rules for an MX network

GET /networks/{networkId}/appliance/firewall/l7FirewallRules

- Description added: Network ID

---

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

GET /networks/{networkId}/appliance/firewall/l7FirewallRules/applicationCategories

- Description added: Network ID

---

Return the 1:Many NAT mapping rules for an MX network

GET /networks/{networkId}/appliance/firewall/oneToManyNatRules

- Description added: Network ID

---

Return the 1:1 NAT mapping rules for an MX network

GET /networks/{networkId}/appliance/firewall/oneToOneNatRules

- Description added: Network ID

---

Return the port forwarding rules for an MX network

GET /networks/{networkId}/appliance/firewall/portForwardingRules

- Description added: Network ID

---

Return the firewall settings for this network

GET /networks/{networkId}/appliance/firewall/settings

- Description added: Network ID

---

Update the cellular firewall rules of an MX network

PUT /networks/{networkId}/appliance/firewall/cellularFirewallRules

- Description added: Network ID

---

Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')

PUT /networks/{networkId}/appliance/firewall/firewalledServices/{service}

- Description added: Network ID

- Description added: Service

---

Update the inbound cellular firewall rules of an MX network

PUT /networks/{networkId}/appliance/firewall/inboundCellularFirewallRules

- Description added: Network ID

---

Update the inbound firewall rules of an MX network

PUT /networks/{networkId}/appliance/firewall/inboundFirewallRules

- Description added: Network ID

---

Update the L3 firewall rules of an MX network

PUT /networks/{networkId}/appliance/firewall/l3FirewallRules

- Description added: Network ID

---

Update the MX L7 firewall rules for an MX network

PUT /networks/{networkId}/appliance/firewall/l7FirewallRules

- Description added: Network ID

---

Set the 1:Many NAT mapping rules for an MX network

PUT /networks/{networkId}/appliance/firewall/oneToManyNatRules

- Description added: Network ID

---

Set the 1:1 NAT mapping rules for an MX network

PUT /networks/{networkId}/appliance/firewall/oneToOneNatRules

- Description added: Network ID

---

Update the port forwarding rules for an MX network

PUT /networks/{networkId}/appliance/firewall/portForwardingRules

- Description added: Network ID

---

Update the firewall settings for this network

PUT /networks/{networkId}/appliance/firewall/settings

- Description added: Network ID

---

contentFiltering

Return the content filtering settings for an MX network

GET /networks/{networkId}/appliance/contentFiltering

- Description added: Network ID

---

List all available content filtering categories for an MX network

GET /networks/{networkId}/appliance/contentFiltering/categories

- Description added: Network ID

---

Update the content filtering settings for an MX network

PUT /networks/{networkId}/appliance/contentFiltering

- Description added: Network ID

---

connectivityMonitoringDestinations

Return the connectivity testing destinations for an MX network

GET /networks/{networkId}/appliance/connectivityMonitoringDestinations

- Description added: Network ID

---

Update the connectivity testing destinations for an MX network

PUT /networks/{networkId}/appliance/connectivityMonitoringDestinations

- Description added: Network ID

---

warmSpare

Return MX warm spare settings

GET /networks/{networkId}/appliance/warmSpare

- Description added: Network ID

---

Update MX warm spare settings

PUT /networks/{networkId}/appliance/warmSpare

- Description added: Network ID

---

Swap MX primary and warm spare appliances

POST /networks/{networkId}/appliance/warmSpare/swap

- Description added: Network ID

---

ports

List per-port VLAN settings for all ports of a MX.

GET /networks/{networkId}/appliance/ports

- Description added: Network ID

---

Return per-port VLAN settings for a single MX port.

GET /networks/{networkId}/appliance/ports/{portId}

- Description added: Network ID

- Description added: Port ID

---

Update the per-port VLAN settings for a single MX port.

PUT /networks/{networkId}/appliance/ports/{portId}

- Description added: Network ID

- Description added: Port ID

---

clients

List the security events for a client

GET /networks/{networkId}/appliance/clients/{clientId}/security/events

- Description added: Network ID

- Description added: Client ID

---

vmx

Generate a new vMX authentication token

POST /devices/{serial}/appliance/vmx/authenticationToken

- Description added: Serial

---

uplinks

Return the uplink settings for an MX appliance

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

- Description added: Serial

---

Get the sent and received bytes for each uplink of a network.

GET /networks/{networkId}/appliance/uplinks/usageHistory

- Description added: Network ID

---

List the uplink status of every Meraki MX and Z series appliances in the organization

GET /organizations/{organizationId}/appliance/uplink/statuses

- Description added: Organization ID

---

Update the uplink settings for an MX appliance

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

- Description added: Serial

---

prefixes

Return current delegated IPv6 prefixes on an appliance.

GET /devices/{serial}/appliance/prefixes/delegated

- Description added: Serial

---

Return prefixes assigned to all IPv6 enabled VLANs on an appliance.

GET /devices/{serial}/appliance/prefixes/delegated/vlanAssignments

- Description added: Serial

---

List static delegated prefixes for a network

GET /networks/{networkId}/appliance/prefixes/delegated/statics

- Description added: Network ID

---

Return a static delegated prefix from a network

GET /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}

- Description added: Network ID

- Description added: Static delegated prefix ID

---

Update a static delegated prefix from a network

PUT /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}

- Description added: Network ID

- Description added: Static delegated prefix ID

---

Add a static delegated prefix from a network

POST /networks/{networkId}/appliance/prefixes/delegated/statics

- Description added: Network ID

---

Delete a static delegated prefix from a network

DELETE /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}

- Description added: Network ID

- Description added: Static delegated prefix ID

---

performance

Return the performance score for a single MX

GET /devices/{serial}/appliance/performance

- Description added: Serial

---

dhcp

Return the DHCP subnet information for an appliance

GET /devices/{serial}/appliance/dhcp/subnets

- Description added: Serial

---

[ networks ]

netflow

Return the NetFlow traffic reporting settings for a network

GET /networks/{networkId}/netflow

- Description added: Network ID

---

Update the NetFlow traffic reporting settings for a network

PUT /networks/{networkId}/netflow

- Description added: Network ID

---

networkHealth

Get the channel utilization over each radio for all APs in a network.

GET /networks/{networkId}/networkHealth/channelUtilization

- Description added: Network ID

---

pii

List the keys required to access Personally Identifiable Information (PII) for a given identifier

GET /networks/{networkId}/pii/piiKeys

- Description added: Network ID

---

List the PII requests for this network or organization

GET /networks/{networkId}/pii/requests

- Description added: Network ID

---

Return a PII request

GET /networks/{networkId}/pii/requests/{requestId}

- Description added: Network ID

- Description added: Request ID

---

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier

GET /networks/{networkId}/pii/smDevicesForKey

- Description added: Network ID

---

Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier

GET /networks/{networkId}/pii/smOwnersForKey

- Description added: Network ID

---

Submit a new delete or restrict processing PII request

POST /networks/{networkId}/pii/requests

- Description added: Network ID

---

Delete a restrict processing PII request

DELETE /networks/{networkId}/pii/requests/{requestId}

- Description added: Network ID

- Description added: Request ID

---

mqttBrokers

List the MQTT brokers for this network

GET /networks/{networkId}/mqttBrokers

- Description added: Network ID

---

Return an MQTT broker

GET /networks/{networkId}/mqttBrokers/{mqttBrokerId}

- Description added: Network ID

- Description added: Mqtt broker ID

---

Update an MQTT broker

PUT /networks/{networkId}/mqttBrokers/{mqttBrokerId}

- Description added: Network ID

- Description added: Mqtt broker ID

---

Add an MQTT broker

POST /networks/{networkId}/mqttBrokers

- Description added: Network ID

---

Delete an MQTT broker

DELETE /networks/{networkId}/mqttBrokers/{mqttBrokerId}

- Description added: Network ID

- Description added: Mqtt broker ID

---

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

- Description added: Network ID

---

Return the Meraki Auth splash guest, RADIUS, or client VPN user

GET /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}

- Description added: Network ID

- Description added: Meraki auth user ID

---

Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated)

PUT /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}

- Description added: Network ID

- Description added: Meraki auth user ID

---

Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)

POST /networks/{networkId}/merakiAuthUsers

- Description added: Network ID

---

Deauthorize a user

DELETE /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}

- Description added: Network ID

- Description added: Meraki auth user ID

---

snmp

Return the SNMP settings for a network

GET /networks/{networkId}/snmp

- Description added: Network ID

---

Update the SNMP settings for a network

PUT /networks/{networkId}/snmp

- Description added: Network ID

---

health

Return all global alerts on this network

GET /networks/{networkId}/health/alerts

- Description added: Network ID

---

splashLoginAttempts

List the splash login attempts for a network

GET /networks/{networkId}/splashLoginAttempts

- Description added: Network ID

---

groupPolicies

List the group policies in a network

GET /networks/{networkId}/groupPolicies

- Description added: Network ID

---

Display a group policy

GET /networks/{networkId}/groupPolicies/{groupPolicyId}

- Description added: Network ID

- Description added: Group policy ID

---

Update a group policy

PUT /networks/{networkId}/groupPolicies/{groupPolicyId}

- Description added: Network ID

- Description added: Group policy ID

---

Create a group policy

POST /networks/{networkId}/groupPolicies

- Description added: Network ID

---

Delete a group policy

DELETE /networks/{networkId}/groupPolicies/{groupPolicyId}

- Description added: Network ID

- Description added: Group policy ID

---

floorPlans

List the floor plans that belong to your network

GET /networks/{networkId}/floorPlans

- Description added: Network ID

---

Find a floor plan by ID

GET /networks/{networkId}/floorPlans/{floorPlanId}

- Description added: Network ID

- Description added: Floor plan ID

---

Update a floor plan's geolocation and other meta data

PUT /networks/{networkId}/floorPlans/{floorPlanId}

- Description added: Network ID

- Description added: Floor plan ID

---

Upload a floor plan

POST /networks/{networkId}/floorPlans

- Description added: Network ID

---

Destroy a floor plan

DELETE /networks/{networkId}/floorPlans/{floorPlanId}

- Description added: Network ID

- Description added: Floor plan ID

---

firmwareUpgrades

Get firmware upgrade information for a network

GET /networks/{networkId}/firmwareUpgrades

- Description added: Network ID

---

Get the Staged Upgrade Event from a network

GET /networks/{networkId}/firmwareUpgrades/staged/events

- Description added: Network ID

---

List of Staged Upgrade Groups in a network

GET /networks/{networkId}/firmwareUpgrades/staged/groups

- Description added: Network ID

---

Get a Staged Upgrade Group from a network

GET /networks/{networkId}/firmwareUpgrades/staged/groups/{groupId}

- Description added: Network ID

- Description added: Group ID

---

Order of Staged Upgrade Groups in a network

GET /networks/{networkId}/firmwareUpgrades/staged/stages

- Description added: Network ID

---

Update firmware upgrade information for a network

PUT /networks/{networkId}/firmwareUpgrades

- Description added: Network ID

---

Update the Staged Upgrade Event for a network

PUT /networks/{networkId}/firmwareUpgrades/staged/events

- Description added: Network ID

---

Update a Staged Upgrade Group for a network

PUT /networks/{networkId}/firmwareUpgrades/staged/groups/{groupId}

- Description added: Network ID

- Description added: Group ID

---

Assign Staged Upgrade Group order in the sequence.

PUT /networks/{networkId}/firmwareUpgrades/staged/stages

- Description added: Network ID

---

Rollback a Firmware Upgrade For A Network

POST /networks/{networkId}/firmwareUpgrades/rollbacks

- Description added: Network ID

---

Create a Staged Upgrade Event for a network

POST /networks/{networkId}/firmwareUpgrades/staged/events

- Description added: Network ID

---

Postpone by 1 week all pending staged upgrade stages for a network

POST /networks/{networkId}/firmwareUpgrades/staged/events/defer

- Description added: Network ID

---

Rollback a Staged Upgrade Event for a network

POST /networks/{networkId}/firmwareUpgrades/staged/events/rollbacks

- Description added: Network ID

---

Create a Staged Upgrade Group for a network

POST /networks/{networkId}/firmwareUpgrades/staged/groups

- Description added: Network ID

---

Delete a Staged Upgrade Group

DELETE /networks/{networkId}/firmwareUpgrades/staged/groups/{groupId}

- Description added: Network ID

- Description added: Group ID

---

events

List the events for the network

GET /networks/{networkId}/events

- Description added: Network ID

---

List the event type to human-readable description

GET /networks/{networkId}/events/eventTypes

- Description added: Network ID

---

devices

List the devices in a network

GET /networks/{networkId}/devices

- Description added: Network ID

---

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requsts against that device to succeed)

POST /networks/{networkId}/devices/claim

- Description added: Network ID

---

Claim a vMX into a network

POST /networks/{networkId}/devices/claim/vmx

- Description added: Network ID

---

Remove a single device

POST /networks/{networkId}/devices/remove

- Description added: Network ID

---

bluetoothClients

List the Bluetooth clients seen by APs in this network

GET /networks/{networkId}/bluetoothClients

- Description added: Network ID

---

Return a Bluetooth client

GET /networks/{networkId}/bluetoothClients/{bluetoothClientId}

- Description added: Network ID

- Description added: Bluetooth client ID

---

trafficShaping

Returns the application categories for traffic shaping rules.

GET /networks/{networkId}/trafficShaping/applicationCategories

- Description added: Network ID

---

Returns the available DSCP tagging options for your traffic shaping rules.

GET /networks/{networkId}/trafficShaping/dscpTaggingOptions

- Description added: Network ID

---

syslogServers

List the syslog servers for a network

GET /networks/{networkId}/syslogServers

- Description added: Network ID

---

Update the syslog servers for a network

PUT /networks/{networkId}/syslogServers

- Description added: Network ID

---

topology

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

GET /networks/{networkId}/topology/linkLayer

- Description added: Network ID

---

traffic

Return the traffic analysis data for this network

GET /networks/{networkId}/traffic

- Description added: Network ID

---

trafficAnalysis

Return the traffic analysis settings for a network

GET /networks/{networkId}/trafficAnalysis

- Description added: Network ID

---

Update the traffic analysis settings for a network

PUT /networks/{networkId}/trafficAnalysis

- Description added: Network ID

---

settings

Return the settings for a network

GET /networks/{networkId}/settings

- Description added: Network ID

---

Update the settings for a network

PUT /networks/{networkId}/settings

- Description added: Network ID

---

webhooks

List the HTTP servers for a network

GET /networks/{networkId}/webhooks/httpServers

- Description added: Network ID

---

Return an HTTP server for a network

GET /networks/{networkId}/webhooks/httpServers/{httpServerId}

- Description added: Network ID

- Description added: Http server ID

---

List the webhook payload templates for a network

GET /networks/{networkId}/webhooks/payloadTemplates

- Description added: Network ID

- Optional property sharing Added

- Response property sharing value added

---

Get the webhook payload template for a network

GET /networks/{networkId}/webhooks/payloadTemplates/{payloadTemplateId}

- Description added: Network ID

- Description added: Payload template ID

- Optional property sharing Added

- Response property sharing value added

---

Return the status of a webhook test for a network

GET /networks/{networkId}/webhooks/webhookTests/{webhookTestId}

- Description added: Network ID

- Description added: Webhook test ID

---

Update an HTTP server

PUT /networks/{networkId}/webhooks/httpServers/{httpServerId}

- Description added: Network ID

- Description added: Http server ID

---

Update a webhook payload template for a network

PUT /networks/{networkId}/webhooks/payloadTemplates/{payloadTemplateId}

- Description added: Network ID

- Description added: Payload template ID

- Optional property sharing Added

---

Add an HTTP server to a network

POST /networks/{networkId}/webhooks/httpServers

- Description added: Network ID

---

Create a webhook payload template for a network

POST /networks/{networkId}/webhooks/payloadTemplates

- Description added: Network ID

- Optional property sharing Added

---

Send a test webhook for a network

POST /networks/{networkId}/webhooks/webhookTests

- Description added: Network ID

---

Delete an HTTP server from a network

DELETE /networks/{networkId}/webhooks/httpServers/{httpServerId}

- Description added: Network ID

- Description added: Http server ID

---

Destroy a webhook payload template for a network

DELETE /networks/{networkId}/webhooks/payloadTemplates/{payloadTemplateId}

- Description added: Network ID

- Description added: Payload template ID

---

alerts

Return the alert history for this network

GET /networks/{networkId}/alerts/history

- Description added: Network ID

---

Return the alert configuration for this network

GET /networks/{networkId}/alerts/settings

- Description added: Network ID

---

Update the alert configuration for this network

PUT /networks/{networkId}/alerts/settings

- Description added: Network ID

---

clients

List the clients that have used this network in the timespan

GET /networks/{networkId}/clients

- Description added: Network ID

---

Return the application usage data for clients

GET /networks/{networkId}/clients/applicationUsage

- Description added: Network ID

---

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/bandwidthUsageHistory

- Description added: Network ID

---

Return overview statistics for network clients

GET /networks/{networkId}/clients/overview

- Description added: Network ID

---

Return the usage histories for clients

GET /networks/{networkId}/clients/usageHistories

- Description added: Network ID

---

Return the client associated with the given identifier

GET /networks/{networkId}/clients/{clientId}

- Description added: Network ID

- Description added: Client ID

---

Return the policy assigned to a client on the network

GET /networks/{networkId}/clients/{clientId}/policy

- Description added: Network ID

- Description added: Client ID

---

Return the splash authorization for a client, for each SSID they've associated with through splash

GET /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus

- Description added: Network ID

- Description added: Client ID

---

Return the client's network traffic data over time

GET /networks/{networkId}/clients/{clientId}/trafficHistory

- Description added: Network ID

- Description added: Client ID

---

Return the client's daily usage history

GET /networks/{networkId}/clients/{clientId}/usageHistory

- Description added: Network ID

- Description added: Client ID

---

Update the policy assigned to a client on the network

PUT /networks/{networkId}/clients/{clientId}/policy

- Description added: Network ID

- Description added: Client ID

---

Update a client's splash authorization

PUT /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus

- Description added: Network ID

- Description added: Client ID

---

Provisions a client with a name and policy

POST /networks/{networkId}/clients/provision

- Description added: Network ID

---

policies

Get policies for all clients with policies

GET /networks/{networkId}/policies/byClient

- Description added: Network ID

---

service

Return a network

GET /networks/{networkId}

- Description added: Network ID

---

Update a network

PUT /networks/{networkId}

- Description added: Network ID

---

Bind a network to a template.

POST /networks/{networkId}/bind

- Description added: Network ID

---

Split a combined network into individual networks for each type of device

POST /networks/{networkId}/split

- Description added: Network ID

---

Unbind a network from a template.

POST /networks/{networkId}/unbind

- Description added: Network ID

---

Delete a network

DELETE /networks/{networkId}

- Description added: Network ID

---

[ insight ]

applications

Get application health by time

GET /networks/{networkId}/insight/applications/{applicationId}/healthByTime

- Description added: Network ID

- Description added: Application ID

---

List all Insight tracked applications

GET /organizations/{organizationId}/insight/applications

- Description added: Organization ID

---

monitoredMediaServers

List the monitored media servers for this organization

GET /organizations/{organizationId}/insight/monitoredMediaServers

- Description added: Organization ID

---

Return a monitored media server for this organization

GET /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}

- Description added: Organization ID

- Description added: Monitored media server ID

---

Update a monitored media server for this organization

PUT /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}

- Description added: Organization ID

- Description added: Monitored media server ID

---

Add a media server to be monitored for this organization

POST /organizations/{organizationId}/insight/monitoredMediaServers

- Description added: Organization ID

---

Delete a monitored media server from this organization

DELETE /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}

- Description added: Organization ID

- Description added: Monitored media server ID

---

[ sm ]

bypassActivationLockAttempts

Bypass activation lock attempt status

GET /networks/{networkId}/sm/bypassActivationLockAttempts/{attemptId}

- Description added: Network ID

- Description added: Attempt ID

---

Bypass activation lock attempt

POST /networks/{networkId}/sm/bypassActivationLockAttempts

- Description added: Network ID

---

profiles

List all profiles in a network

GET /networks/{networkId}/sm/profiles

- Description added: Network ID

---

targetGroups

List the target groups in this network

GET /networks/{networkId}/sm/targetGroups

- Description added: Network ID

---

Return a target group

GET /networks/{networkId}/sm/targetGroups/{targetGroupId}

- Description added: Network ID

- Description added: Target group ID

---

Update a target group

PUT /networks/{networkId}/sm/targetGroups/{targetGroupId}

- Description added: Network ID

- Description added: Target group ID

---

Add a target group

POST /networks/{networkId}/sm/targetGroups

- Description added: Network ID

---

Delete a target group from a network

DELETE /networks/{networkId}/sm/targetGroups/{targetGroupId}

- Description added: Network ID

- Description added: Target group ID

---

trustedAccessConfigs

List Trusted Access Configs

GET /networks/{networkId}/sm/trustedAccessConfigs

- Description added: Network ID

---

userAccessDevices

List User Access Devices and its Trusted Access Connections

GET /networks/{networkId}/sm/userAccessDevices

- Description added: Network ID

---

Delete a User Access Device

DELETE /networks/{networkId}/sm/userAccessDevices/{userAccessDeviceId}

- Description added: Network ID

- Description added: User access device ID

---

users

List the owners in an SM network with various specified fields and filters

GET /networks/{networkId}/sm/users

- Description added: Network ID

---

Get the profiles associated with a user

GET /networks/{networkId}/sm/users/{userId}/deviceProfiles

- Description added: Network ID

- Description added: User ID

---

Get a list of softwares associated with a user

GET /networks/{networkId}/sm/users/{userId}/softwares

- Description added: Network ID

- Description added: User ID

---

devices

List the devices enrolled in an SM network with various specified fields and filters

GET /networks/{networkId}/sm/devices

- Description added: Network ID

---

Return the client's daily cellular data usage history

GET /networks/{networkId}/sm/devices/{deviceId}/cellularUsageHistory

- Description added: Network ID

- Description added: Device ID

---

List the certs on a device

GET /networks/{networkId}/sm/devices/{deviceId}/certs

- Description added: Network ID

- Description added: Device ID

---

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

GET /networks/{networkId}/sm/devices/{deviceId}/connectivity

- Description added: Network ID

- Description added: Device ID

---

Return historical records of various Systems Manager network connection details for desktop devices.

GET /networks/{networkId}/sm/devices/{deviceId}/desktopLogs

- Description added: Network ID

- Description added: Device ID

---

Return historical records of commands sent to Systems Manager devices

GET /networks/{networkId}/sm/devices/{deviceId}/deviceCommandLogs

- Description added: Network ID

- Description added: Device ID

---

Get the installed profiles associated with a device

GET /networks/{networkId}/sm/devices/{deviceId}/deviceProfiles

- Description added: Network ID

- Description added: Device ID

---

List the network adapters of a device

GET /networks/{networkId}/sm/devices/{deviceId}/networkAdapters

- Description added: Network ID

- Description added: Device ID

---

Return historical records of various Systems Manager client metrics for desktop devices.

GET /networks/{networkId}/sm/devices/{deviceId}/performanceHistory

- Description added: Network ID

- Description added: Device ID

---

List the restrictions on a device

GET /networks/{networkId}/sm/devices/{deviceId}/restrictions

- Description added: Network ID

- Description added: Device ID

---

List the security centers on a device

GET /networks/{networkId}/sm/devices/{deviceId}/securityCenters

- Description added: Network ID

- Description added: Device ID

---

Get a list of softwares associated with a device

GET /networks/{networkId}/sm/devices/{deviceId}/softwares

- Description added: Network ID

- Description added: Device ID

---

List the saved SSID names on a device

GET /networks/{networkId}/sm/devices/{deviceId}/wlanLists

- Description added: Network ID

- Description added: Device ID

---

Modify the fields of a device

PUT /networks/{networkId}/sm/devices/fields

- Description added: Network ID

---

Force check-in a set of devices

POST /networks/{networkId}/sm/devices/checkin

- Description added: Network ID

---

Lock a set of devices

POST /networks/{networkId}/sm/devices/lock

- Description added: Network ID

---

Add, delete, or update the tags of a set of devices

POST /networks/{networkId}/sm/devices/modifyTags

- Description added: Network ID

---

Move a set of devices to a new network

POST /networks/{networkId}/sm/devices/move

- Description added: Network ID

---

Wipe a device

POST /networks/{networkId}/sm/devices/wipe

- Description added: Network ID

---

Refresh the details of a device

POST /networks/{networkId}/sm/devices/{deviceId}/refreshDetails

- Description added: Network ID

- Description added: Device ID

---

Unenroll a device

POST /networks/{networkId}/sm/devices/{deviceId}/unenroll

- Description added: Network ID

- Description added: Device ID

---

apnsCert

Get the organization's APNS certificate

GET /organizations/{organizationId}/sm/apnsCert

- Description added: Organization ID

---

vppAccounts

List the VPP accounts in the organization

GET /organizations/{organizationId}/sm/vppAccounts

- Description added: Organization ID

---

Get a hash containing the unparsed token of the VPP account with the given ID

GET /organizations/{organizationId}/sm/vppAccounts/{vppAccountId}

- Description added: Organization ID

- Description added: Vpp account ID

---

[ organizations ]

summary

Return the top 10 appliances sorted by utilization over given time range.

GET /organizations/{organizationId}/summary/top/appliances/byUtilization

- Description added: Organization ID

---

Return metrics for organization's top 10 clients by data usage (in mb) over given time range.

GET /organizations/{organizationId}/summary/top/clients/byUsage

- Description added: Organization ID

---

Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.

GET /organizations/{organizationId}/summary/top/clients/manufacturers/byUsage

- Description added: Organization ID

---

Return metrics for organization's top 10 devices sorted by data usage over given time range

GET /organizations/{organizationId}/summary/top/devices/byUsage

- Description added: Organization ID

---

Return metrics for organization's top 10 device models sorted by data usage over given time range

GET /organizations/{organizationId}/summary/top/devices/models/byUsage

- Description added: Organization ID

---

Return metrics for organization's top 10 ssids by data usage over given time range

GET /organizations/{organizationId}/summary/top/ssids/byUsage

- Description added: Organization ID

---

Return metrics for organization's top 10 switches by energy usage over given time range

GET /organizations/{organizationId}/summary/top/switches/byEnergyUsage

- Description added: Organization ID

---

users

Delete a user and all of its authentication methods.

DELETE /organizations/{organizationId}/users/{userId}

- Description added: Organization ID

- Description added: User ID

---

snmp

Return the SNMP settings for an organization

GET /organizations/{organizationId}/snmp

- Description added: Organization ID

---

Update the SNMP settings for an organization

PUT /organizations/{organizationId}/snmp

- Description added: Organization ID

---

devices

List the devices in an organization

GET /organizations/{organizationId}/devices

- Description added: Organization ID

---

List the availability information for devices in an organization

GET /organizations/{organizationId}/devices/availabilities

- Description added: Organization ID

---

List the power status information for devices in an organization

GET /organizations/{organizationId}/devices/powerModules/statuses/byDevice

- Description added: Organization ID

---

List the status of every Meraki device in the organization

GET /organizations/{organizationId}/devices/statuses

- Description added: Organization ID

---

Return an overview of current device statuses

GET /organizations/{organizationId}/devices/statuses/overview

- Description added: Organization ID

---

List the current uplink addresses for devices in an organization.

GET /organizations/{organizationId}/devices/uplinks/addresses/byDevice

- Description added: Organization ID

---

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

GET /organizations/{organizationId}/devices/uplinksLossAndLatency

- Description added: Organization ID

---

webhooks

Return a list of alert types to be used with managing webhook alerts

GET /organizations/{organizationId}/webhooks/alertTypes

- Description added: Organization ID

---

Return the log of webhook POSTs sent

GET /organizations/{organizationId}/webhooks/logs

- Description added: Organization ID

---

alerts

List all organization-wide alert configurations

GET /organizations/{organizationId}/alerts/profiles

- Description added: Organization ID

---

Update an organization-wide alert config

PUT /organizations/{organizationId}/alerts/profiles/{alertConfigId}

- Description added: Organization ID

- Description added: Alert config ID

---

Create an organization-wide alert configuration

POST /organizations/{organizationId}/alerts/profiles

- Description added: Organization ID

---

Removes an organization-wide alert config

DELETE /organizations/{organizationId}/alerts/profiles/{alertConfigId}

- Description added: Organization ID

- Description added: Alert config ID

---

actionBatches

Return the list of action batches in the organization

GET /organizations/{organizationId}/actionBatches

- Description added: Organization ID

---

Return an action batch

GET /organizations/{organizationId}/actionBatches/{actionBatchId}

- Description added: Organization ID

- Description added: Action batch ID

---

Update an action batch

PUT /organizations/{organizationId}/actionBatches/{actionBatchId}

- Description added: Organization ID

- Description added: Action batch ID

---

Create an action batch

POST /organizations/{organizationId}/actionBatches

- Description added: Organization ID

---

Delete an action batch

DELETE /organizations/{organizationId}/actionBatches/{actionBatchId}

- Description added: Organization ID

- Description added: Action batch ID

---

adaptivePolicy

List adaptive policy ACLs in a organization

GET /organizations/{organizationId}/adaptivePolicy/acls

- Description added: Organization ID

- Response property properties value added

---

Returns the adaptive policy ACL information

GET /organizations/{organizationId}/adaptivePolicy/acls/{aclId}

- Description added: Organization ID

- Description added: Acl ID

- Response property properties value added

---

List adaptive policy groups in a organization

GET /organizations/{organizationId}/adaptivePolicy/groups

- Description added: Organization ID

---

Returns an adaptive policy group

GET /organizations/{organizationId}/adaptivePolicy/groups/{id}

- Description added: Organization ID

- Description added: Id

---

Returns adaptive policy aggregate statistics for an organization

GET /organizations/{organizationId}/adaptivePolicy/overview

- Description added: Organization ID

---

List adaptive policies in an organization

GET /organizations/{organizationId}/adaptivePolicy/policies

- Description added: Organization ID

---

Return an adaptive policy

GET /organizations/{organizationId}/adaptivePolicy/policies/{id}

- Description added: Organization ID

- Description added: Id

---

Returns global adaptive policy settings in an organization

GET /organizations/{organizationId}/adaptivePolicy/settings

- Description added: Organization ID

---

Updates an adaptive policy ACL

PUT /organizations/{organizationId}/adaptivePolicy/acls/{aclId}

- Description added: Organization ID

- Description added: Acl ID

---

Updates an adaptive policy group

PUT /organizations/{organizationId}/adaptivePolicy/groups/{id}

- Description added: Organization ID

- Description added: Id

---

Update an Adaptive Policy

PUT /organizations/{organizationId}/adaptivePolicy/policies/{id}

- Description added: Organization ID

- Description added: Id

---

Update global adaptive policy settings

PUT /organizations/{organizationId}/adaptivePolicy/settings

- Description added: Organization ID

---

Creates new adaptive policy ACL

POST /organizations/{organizationId}/adaptivePolicy/acls

- Description added: Organization ID

---

Creates a new adaptive policy group

POST /organizations/{organizationId}/adaptivePolicy/groups

- Description added: Organization ID

---

Add an Adaptive Policy

POST /organizations/{organizationId}/adaptivePolicy/policies

- Description added: Organization ID

---

Deletes the specified adaptive policy ACL

DELETE /organizations/{organizationId}/adaptivePolicy/acls/{aclId}

- Description added: Organization ID

- Description added: Acl ID

---

Deletes the specified adaptive policy group and any associated policies and references

DELETE /organizations/{organizationId}/adaptivePolicy/groups/{id}

- Description added: Organization ID

- Description added: Id

---

Delete an Adaptive Policy

DELETE /organizations/{organizationId}/adaptivePolicy/policies/{id}

- Description added: Organization ID

- Description added: Id

---

admins

List the dashboard administrators in this organization

GET /organizations/{organizationId}/admins

- Description added: Organization ID

---

Update an administrator

PUT /organizations/{organizationId}/admins/{adminId}

- Description added: Organization ID

- Description added: Admin ID

---

Create a new dashboard administrator

POST /organizations/{organizationId}/admins

- Description added: Organization ID

---

Revoke all access for a dashboard administrator within this organization

DELETE /organizations/{organizationId}/admins/{adminId}

- Description added: Organization ID

- Description added: Admin ID

---

apiRequests

List the API requests made by an organization

GET /organizations/{organizationId}/apiRequests

- Description added: Organization ID

---

Return an aggregated overview of API requests data

GET /organizations/{organizationId}/apiRequests/overview

- Description added: Organization ID

---

Tracks organizations' API requests by response code across a given time period

GET /organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval

- Description added: Organization ID

---

brandingPolicies

List the branding policies of an organization

GET /organizations/{organizationId}/brandingPolicies

- Description added: Organization ID

---

Return the branding policy IDs of an organization in priority order

GET /organizations/{organizationId}/brandingPolicies/priorities

- Description added: Organization ID

---

Return a branding policy

GET /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}

- Description added: Organization ID

- Description added: Branding policy ID

---

Update the priority ordering of an organization's branding policies.

PUT /organizations/{organizationId}/brandingPolicies/priorities

- Description added: Organization ID

---

Update a branding policy

PUT /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}

- Description added: Organization ID

- Description added: Branding policy ID

---

Add a new branding policy to an organization

POST /organizations/{organizationId}/brandingPolicies

- Description added: Organization ID

---

Delete a branding policy

DELETE /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}

- Description added: Organization ID

- Description added: Branding policy ID

---

configTemplates

List the configuration templates for this organization

GET /organizations/{organizationId}/configTemplates

- Description added: Organization ID

---

Return a single configuration template

GET /organizations/{organizationId}/configTemplates/{configTemplateId}

- Description added: Organization ID

- Description added: Config template ID

---

Update a configuration template

PUT /organizations/{organizationId}/configTemplates/{configTemplateId}

- Description added: Organization ID

- Description added: Config template ID

---

Create a new configuration template

POST /organizations/{organizationId}/configTemplates

- Description added: Organization ID

---

Remove a configuration template

DELETE /organizations/{organizationId}/configTemplates/{configTemplateId}

- Description added: Organization ID

- Description added: Config template ID

---

clients

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/bandwidthUsageHistory

- Description added: Organization ID

---

Return summary information around client data usage (in mb) across the given organization.

GET /organizations/{organizationId}/clients/overview

- Description added: Organization ID

---

Return the client details in an organization

GET /organizations/{organizationId}/clients/search

- Description added: Organization ID

---

configurationChanges

View the Change Log for your organization

GET /organizations/{organizationId}/configurationChanges

- Description added: Organization ID

---

earlyAccess

List the available early access features for organization

GET /organizations/{organizationId}/earlyAccess/features

- Description added: Organization ID

- Response property properties value added

- Response property supportLink value added

---

List the early access feature opt-ins for an organization

GET /organizations/{organizationId}/earlyAccess/features/optIns

- Description added: Organization ID

---

Show an early access feature opt-in for an organization

GET /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}

- Description added: Organization ID

- Description added: Opt in ID

---

Update an early access feature opt-in for an organization

PUT /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}

- Description added: Organization ID

- Description added: Opt in ID

---

Create a new early access feature opt-in for an organization

POST /organizations/{organizationId}/earlyAccess/features/optIns

- Description added: Organization ID

---

Delete an early access feature opt-in

DELETE /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}

- Description added: Organization ID

- Description added: Opt in ID

---

firmware

Get firmware upgrade information for an organization

GET /organizations/{organizationId}/firmware/upgrades

- Description added: Organization ID

---

Get firmware upgrade status for the filtered devices

GET /organizations/{organizationId}/firmware/upgrades/byDevice

- Description added: Organization ID

---

inventory

Return the device inventory for an organization

GET /organizations/{organizationId}/inventory/devices

- Description added: Organization ID

---

Return a single device from the inventory of an organization

GET /organizations/{organizationId}/inventory/devices/{serial}

- Description added: Organization ID

- Description added: Serial

---

Check the status of a committed Import operation

GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports

- Description added: Organization ID

---

Returns list of networks eligible for adding cloud monitored device

GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks

- Description added: Organization ID

---

Claim a list of devices, licenses, and/or orders into an organization inventory

POST /organizations/{organizationId}/inventory/claim

- Description added: Organization ID

---

Imports event logs related to the onboarding app into elastisearch

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents

- Description added: Organization ID

---

Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports

- Description added: Organization ID

---

Initiates or updates an import session

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare

- Description added: Organization ID

---

Release a list of claimed devices from an organization.

POST /organizations/{organizationId}/inventory/release

- Description added: Organization ID

---

licenses

List the licenses for an organization

GET /organizations/{organizationId}/licenses

- Description added: Organization ID

---

Return an overview of the license state for an organization

GET /organizations/{organizationId}/licenses/overview

- Description added: Organization ID

---

Display a license

GET /organizations/{organizationId}/licenses/{licenseId}

- Description added: Organization ID

- Description added: License ID

---

Update a license

PUT /organizations/{organizationId}/licenses/{licenseId}

- Description added: Organization ID

- Description added: License ID

---

Assign SM seats to a network

POST /organizations/{organizationId}/licenses/assignSeats

- Description added: Organization ID

---

Move licenses to another organization

POST /organizations/{organizationId}/licenses/move

- Description added: Organization ID

---

Move SM seats to another organization

POST /organizations/{organizationId}/licenses/moveSeats

- Description added: Organization ID

---

Renew SM seats of a license

POST /organizations/{organizationId}/licenses/renewSeats

- Description added: Organization ID

---

loginSecurity

Returns the login security settings for an organization.

GET /organizations/{organizationId}/loginSecurity

- Description added: Organization ID

---

Update the login security settings for an organization

PUT /organizations/{organizationId}/loginSecurity

- Description added: Organization ID

---

networks

List the networks that the user has privileges on in an organization

GET /organizations/{organizationId}/networks

- Description added: Organization ID

---

Create a network

POST /organizations/{organizationId}/networks

- Description added: Organization ID

---

Combine multiple networks into a single network

POST /organizations/{organizationId}/networks/combine

- Description added: Organization ID

---

openapiSpec

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

GET /organizations/{organizationId}/openapiSpec

- Description added: Organization ID

---

policyObjects

Lists Policy Objects belonging to the organization.

GET /organizations/{organizationId}/policyObjects

- Description added: Organization ID

---

Lists Policy Object Groups belonging to the organization.

GET /organizations/{organizationId}/policyObjects/groups

- Description added: Organization ID

---

Shows details of a Policy Object Group.

GET /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}

- Description added: Organization ID

- Description added: Policy object group ID

---

Shows details of a Policy Object.

GET /organizations/{organizationId}/policyObjects/{policyObjectId}

- Description added: Organization ID

- Description added: Policy object ID

---

Updates a Policy Object Group.

PUT /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}

- Description added: Organization ID

- Description added: Policy object group ID

---

Updates a Policy Object.

PUT /organizations/{organizationId}/policyObjects/{policyObjectId}

- Description added: Organization ID

- Description added: Policy object ID

---

Creates a new Policy Object.

POST /organizations/{organizationId}/policyObjects

- Description added: Organization ID

---

Creates a new Policy Object Group.

POST /organizations/{organizationId}/policyObjects/groups

- Description added: Organization ID

---

Deletes a Policy Object Group.

DELETE /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}

- Description added: Organization ID

- Description added: Policy object group ID

---

Deletes a Policy Object.

DELETE /organizations/{organizationId}/policyObjects/{policyObjectId}

- Description added: Organization ID

- Description added: Policy object ID

---

saml

Returns the SAML SSO enabled settings for an organization.

GET /organizations/{organizationId}/saml

- Description added: Organization ID

---

List the SAML IdPs in your organization.

GET /organizations/{organizationId}/saml/idps

- Description added: Organization ID

---

Get a SAML IdP from your organization.

GET /organizations/{organizationId}/saml/idps/{idpId}

- Description added: Organization ID

- Description added: Idp ID

---

Updates the SAML SSO enabled settings for an organization.

PUT /organizations/{organizationId}/saml

- Description added: Organization ID

---

Update a SAML IdP in your organization

PUT /organizations/{organizationId}/saml/idps/{idpId}

- Description added: Organization ID

- Description added: Idp ID

---

Create a SAML IdP for your organization.

POST /organizations/{organizationId}/saml/idps

- Description added: Organization ID

---

Remove a SAML IdP in your organization.

DELETE /organizations/{organizationId}/saml/idps/{idpId}

- Description added: Organization ID

- Description added: Idp ID

---

uplinks

List the uplink status of every Meraki MX, MG and Z series devices in the organization

GET /organizations/{organizationId}/uplinks/statuses

- Description added: Organization ID

---

samlRoles

List the SAML roles for this organization

GET /organizations/{organizationId}/samlRoles

- Description added: Organization ID

---

Return a SAML role

GET /organizations/{organizationId}/samlRoles/{samlRoleId}

- Description added: Organization ID

- Description added: Saml role ID

---

Update a SAML role

PUT /organizations/{organizationId}/samlRoles/{samlRoleId}

- Description added: Organization ID

- Description added: Saml role ID

---

Create a SAML role

POST /organizations/{organizationId}/samlRoles

- Description added: Organization ID

---

Remove a SAML role

DELETE /organizations/{organizationId}/samlRoles/{samlRoleId}

- Description added: Organization ID

- Description added: Saml role ID

---

service

Return an organization

GET /organizations/{organizationId}

- Description added: Organization ID

---

Update an organization

PUT /organizations/{organizationId}

- Description added: Organization ID

---

Claim a list of devices, licenses, and/or orders into an organization

POST /organizations/{organizationId}/claim

- Description added: Organization ID

---

Create a new organization by cloning the addressed organization

POST /organizations/{organizationId}/clone

- Description added: Organization ID

---

Delete an organization

DELETE /organizations/{organizationId}

- Description added: Organization ID

---

[ licensing ]

coterm

List the licenses in a coterm organization

GET /organizations/{organizationId}/licensing/coterm/licenses

- Description added: Organization ID

---

Moves a license to a different organization (coterm only)

POST /organizations/{organizationId}/licensing/coterm/licenses/move

- Description added: Organization ID

---

[ wireless ]

alternateManagementInterface

Return alternate management interface and devices with IP assigned

GET /networks/{networkId}/wireless/alternateManagementInterface

- Description added: Network ID

---

Update alternate management interface and device static IP

PUT /networks/{networkId}/wireless/alternateManagementInterface

- Description added: Network ID

---

devices

Aggregated connectivity info for this network, grouped by node

GET /networks/{networkId}/wireless/devices/connectionStats

- Description added: Network ID

---

Aggregated latency info for this network, grouped by node

GET /networks/{networkId}/wireless/devices/latencyStats

- Description added: Network ID

---

operation to see power status for wireless devices

GET /organizations/{organizationId}/wireless/devices/ethernet/statuses

- Description added: Organization ID

---

ssids

List the MR SSIDs in a network

GET /networks/{networkId}/wireless/ssids

- Description added: Network ID

---

Return a single MR SSID

GET /networks/{networkId}/wireless/ssids/{number}

- Description added: Network ID

- Description added: Number

---

List the Bonjour forwarding setting and rules for the SSID

GET /networks/{networkId}/wireless/ssids/{number}/bonjourForwarding

- Description added: Network ID

- Description added: Number

---

List the device type group policies for the SSID

GET /networks/{networkId}/wireless/ssids/{number}/deviceTypeGroupPolicies

- Description added: Network ID

- Description added: Number

---

Return the EAP overridden parameters for an SSID

GET /networks/{networkId}/wireless/ssids/{number}/eapOverride

- Description added: Network ID

- Description added: Number

---

Return the L3 firewall rules for an SSID on an MR network

GET /networks/{networkId}/wireless/ssids/{number}/firewall/l3FirewallRules

- Description added: Network ID

- Description added: Number

---

Return the L7 firewall rules for an SSID on an MR network

GET /networks/{networkId}/wireless/ssids/{number}/firewall/l7FirewallRules

- Description added: Network ID

- Description added: Number

---

Return the Hotspot 2.0 settings for an SSID

GET /networks/{networkId}/wireless/ssids/{number}/hotspot20

- Description added: Network ID

- Description added: Number

---

List all Identity PSKs in a wireless network

GET /networks/{networkId}/wireless/ssids/{number}/identityPsks

- Description added: Network ID

- Description added: Number

- Response property format value added

---

Return an Identity PSK

GET /networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId}

- Description added: Network ID

- Description added: Number

- Description added: Identity psk ID

- Response property format value added

---

List the outage schedule for the SSID

GET /networks/{networkId}/wireless/ssids/{number}/schedules

- Description added: Network ID

- Description added: Number

---

Display the splash page settings for the given SSID

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

- Description added: Network ID

- Description added: Number

---

Display the traffic shaping settings for a SSID on an MR network

GET /networks/{networkId}/wireless/ssids/{number}/trafficShaping/rules

- Description added: Network ID

- Description added: Number

---

List the VPN settings for the SSID.

GET /networks/{networkId}/wireless/ssids/{number}/vpn

- Description added: Network ID

- Description added: Number

---

Update the attributes of an MR SSID

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

- Description added: Network ID

- Description added: Number

---

Update the bonjour forwarding setting and rules for the SSID

PUT /networks/{networkId}/wireless/ssids/{number}/bonjourForwarding

- Description added: Network ID

- Description added: Number

---

Update the device type group policies for the SSID

PUT /networks/{networkId}/wireless/ssids/{number}/deviceTypeGroupPolicies

- Description added: Network ID

- Description added: Number

---

Update the EAP overridden parameters for an SSID.

PUT /networks/{networkId}/wireless/ssids/{number}/eapOverride

- Description added: Network ID

- Description added: Number

---

Update the L3 firewall rules of an SSID on an MR network

PUT /networks/{networkId}/wireless/ssids/{number}/firewall/l3FirewallRules

- Description added: Network ID

- Description added: Number

---

Update the L7 firewall rules of an SSID on an MR network

PUT /networks/{networkId}/wireless/ssids/{number}/firewall/l7FirewallRules

- Description added: Network ID

- Description added: Number

---

Update the Hotspot 2.0 settings of an SSID

PUT /networks/{networkId}/wireless/ssids/{number}/hotspot20

- Description added: Network ID

- Description added: Number

---

Update an Identity PSK

PUT /networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId}

- Description added: Network ID

- Description added: Number

- Description added: Identity psk ID

- Optional property expiresAt Added

---

Update the outage schedule for the SSID

PUT /networks/{networkId}/wireless/ssids/{number}/schedules

- Description added: Network ID

- Description added: Number

---

Modify the splash page settings for the given SSID

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

- Description added: Network ID

- Description added: Number

---

Update the traffic shaping settings for an SSID on an MR network

PUT /networks/{networkId}/wireless/ssids/{number}/trafficShaping/rules

- Description added: Network ID

- Description added: Number

---

Update the VPN settings for the SSID

PUT /networks/{networkId}/wireless/ssids/{number}/vpn

- Description added: Network ID

- Description added: Number

---

Create an Identity PSK

POST /networks/{networkId}/wireless/ssids/{number}/identityPsks

- Description added: Network ID

- Description added: Number

- Optional property expiresAt Added

---

Delete an Identity PSK

DELETE /networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId}

- Description added: Network ID

- Description added: Number

- Description added: Identity psk ID

---

settings

Return the wireless settings for a network

GET /networks/{networkId}/wireless/settings

- Description added: Network ID

---

Update the wireless settings for a network

PUT /networks/{networkId}/wireless/settings

- Description added: Network ID

---

airMarshal

List Air Marshal scan results from a network

GET /networks/{networkId}/wireless/airMarshal

- Description added: Network ID

---

billing

Return the billing settings of this network

GET /networks/{networkId}/wireless/billing

- Description added: Network ID

---

Update the billing settings

PUT /networks/{networkId}/wireless/billing

- Description added: Network ID

---

channelUtilizationHistory

Return AP channel utilization over time for a device or network client

GET /networks/{networkId}/wireless/channelUtilizationHistory

- Description added: Network ID

---

clientCountHistory

Return wireless client counts over time for a network, device, or network client

GET /networks/{networkId}/wireless/clientCountHistory

- Description added: Network ID

---

dataRateHistory

Return PHY data rates over time for a network, device, or network client

GET /networks/{networkId}/wireless/dataRateHistory

- Description added: Network ID

---

status

Return the SSID statuses of an access point

GET /devices/{serial}/wireless/status

- Description added: Serial

---

failedConnections

List of all failed client connection events on this network in a given time range

GET /networks/{networkId}/wireless/failedConnections

- Description added: Network ID

---

radio

Return the radio settings of a device

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

- Description added: Serial

---

Update the radio settings of a device

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

- Description added: Serial

---

latencyHistory

Return average wireless latency over time for a network, device, or network client

GET /networks/{networkId}/wireless/latencyHistory

- Description added: Network ID

---

latencyStats

Aggregated latency info for a given AP on this network

GET /devices/{serial}/wireless/latencyStats

- Description added: Serial

---

Aggregated latency info for this network

GET /networks/{networkId}/wireless/latencyStats

- Description added: Network ID

---

meshStatuses

List wireless mesh statuses for repeaters

GET /networks/{networkId}/wireless/meshStatuses

- Description added: Network ID

---

connectionStats

Aggregated connectivity info for a given AP on this network

GET /devices/{serial}/wireless/connectionStats

- Description added: Serial

---

Aggregated connectivity info for this network

GET /networks/{networkId}/wireless/connectionStats

- Description added: Network ID

---

rfProfiles

List the non-basic RF profiles for this network

GET /networks/{networkId}/wireless/rfProfiles

- Description added: Network ID

---

Return a RF profile

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

- Description added: Network ID

- Description added: Rf profile ID

---

Updates specified RF profile for this network

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

- Description added: Network ID

- Description added: Rf profile ID

---

Creates new RF profile for this network

POST /networks/{networkId}/wireless/rfProfiles

- Description added: Network ID

---

Delete a RF Profile

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

- Description added: Network ID

- Description added: Rf profile ID

---

bluetooth

Return the bluetooth settings for a wireless device

GET /devices/{serial}/wireless/bluetooth/settings

- Description added: Serial

---

Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.

GET /networks/{networkId}/wireless/bluetooth/settings

- Description added: Network ID

---

Update the bluetooth settings for a wireless device

PUT /devices/{serial}/wireless/bluetooth/settings

- Description added: Serial

---

Update the Bluetooth settings for a network

PUT /networks/{networkId}/wireless/bluetooth/settings

- Description added: Network ID

---

signalQualityHistory

Return signal quality (SNR/RSSI) over time for a device or network client

GET /networks/{networkId}/wireless/signalQualityHistory

- Description added: Network ID

---

usageHistory

Return AP usage over time for a device or network client

GET /networks/{networkId}/wireless/usageHistory

- Description added: Network ID

---

clients

Aggregated connectivity info for this network, grouped by clients

GET /networks/{networkId}/wireless/clients/connectionStats

- Description added: Network ID

---

Aggregated latency info for this network, grouped by clients

GET /networks/{networkId}/wireless/clients/latencyStats

- Description added: Network ID

---

Aggregated connectivity info for a given client on this network

GET /networks/{networkId}/wireless/clients/{clientId}/connectionStats

- Description added: Network ID

- Description added: Client ID

---

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

GET /networks/{networkId}/wireless/clients/{clientId}/connectivityEvents

- Description added: Network ID

- Description added: Client ID

---

Return the latency history for a client

GET /networks/{networkId}/wireless/clients/{clientId}/latencyHistory

- Description added: Network ID

- Description added: Client ID

---

Aggregated latency info for a given client on this network

GET /networks/{networkId}/wireless/clients/{clientId}/latencyStats

- Description added: Network ID

- Description added: Client ID

---

What's New

[ sensor ]

mqttBrokers

PATH /networks/{networkId}/sensor/mqttBrokers

- Path added

- New operation

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

GET /networks/{networkId}/sensor/mqttBrokers

Code Snippet

Copy[
    {
        "mqttBrokerId": "1234",
        "enabled": true
    }
]

---

---

PATH /networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}

- Path added

- New operation

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

GET /networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}

Code Snippet

Copy{
    "mqttBrokerId": "1234",
    "enabled": true
}

---

- New operation

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

PUT /networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}

Code Snippet

Copy{
    "mqttBrokerId": "1234",
    "enabled": true
}

---

---

[ organizations ]

devices

PATH /organizations/{organizationId}/devices/provisioning/statuses

- Path added

- New operation

List the provisioning statuses information for devices in an organization.

GET /organizations/{organizationId}/devices/provisioning/statuses

Code Snippet

Copy[
    {
        "mac": "00:11:22:33:44:55",
        "name": "My AP",
        "network": {
            "id": "N_24329156"
        },
        "productType": "switch",
        "serial": "Q234-ABCD-5678",
        "status": "complete",
        "tags": [
            "tag1",
            "tag2"
        ]
    }
]

---

---