• Added
  • [ wirelessController ]
    • regulatoryDomain
      • Generate the regulatory domain package
      • Generate the regulatory domain package
    • connections
      • List of unassigned Catalyst access points and summary information
      • List of unassigned Catalyst access points and summary information
  • [ support ]
    • salesRepresentatives
      • Returns the organization's sales representatives
      • Returns the organization's sales representatives
  • [ sm ]
    • bulkEnrollment
      • Create a PccBulkEnrollmentToken
      • Create a PccBulkEnrollmentToken
      • Return a BulkEnrollmentToken
      • Return a BulkEnrollmentToken
      • Update a PccBulkEnrollmentToken
      • Delete a PccBulkEnrollmentToken
      • List all BulkEnrollmentTokens for an organization.
      • List all BulkEnrollmentTokens for an organization.
    • apple
      • Enqueue a sync job for an ADE account
      • Enqueue a sync job for an ADE account
      • Retrieve the status of an ADE sync job
      • Retrieve the status of an ADE sync job
  • [ secureConnect ]
    • sites
      • List sites in this organization
      • List sites in this organization
      • Enroll sites in this organization to Secure Connect. For an organization, a maximum of 4000 sites can be enrolled if they are in spoke mode or a maximum of 10 sites can be enrolled in hub mode.
      • Detach given sites from Secure Connect
    • remoteAccessLogsExports
      • Provides a list of remote access logs exports for an Organization
      • Provides a list of remote access logs exports for an Organization
      • Creates a export for a provided timestamp interval.
      • Redirects to the download link of the completed export.
      • Redirects to the download link of the completed export.
      • Return the details of a specific remote access logs export
      • Return the details of a specific remote access logs export
    • remoteAccessLog
      • List the latest 5000 events logged by remote access.
      • List the latest 5000 events logged by remote access.
    • regions
      • List deployed cloud hubs and regions in this organization
      • List deployed cloud hubs and regions in this organization
    • publicApplications
      • Provides a list of public applications for an Organization.
      • Provides a list of public applications for an Organization.
    • privateResources
      • Provides a list of private resources for an organization.
      • Provides a list of private resources for an organization.
      • Adds a new private resource to the organization.
      • Updates a specific private resource.
      • Updates a specific private resource.
      • Deletes a specific private resource. If this is the last resource in a resource group you must remove it from that resource group before deleting.
    • privateResourceGroups
      • Provides a list of the private resource groups in an organization.
      • Provides a list of the private resource groups in an organization.
      • Adds a new private resource group to an organization.
      • Updates a specific private resource group.
      • Updates a specific private resource group.
      • Deletes a specific private resource group.
    • privateApplications
      • Provides a list of private applications for an Organization.
      • Provides a list of private applications for an Organization.
      • Adds a new private application to the Organization. A maximum of 300 private applications are allowed for an organization.
      • Updates a specific private application
      • Return the details of a specific private application
      • Updates a specific private application. Updates can be made to Name, Description, Destinations, App Protocol, SNI and SSL verification. Application groups can be added or removed.
      • Deletes a specific private application. Delink the application from any application groups before deleting the app. Cascade delete application group if this is the only application in the group.
    • privateApplicationGroups
      • Provides a list of private application groups for an Organization
      • Provides a list of private application groups for an Organization
      • Creates a group of private applications to apply to policy. A maximum of 300 private application groups are allowed for an organization.
      • Update an application group in an Organization
      • Return the details of a specific private application group
      • Update an application group in an Organization. Updates are allowed on Group Name and Group Description. Applications can be added or removed. Group type and Policy cannot be changed.
      • Deletes private application group from an Organization. Detaches application from groups before deleting
  • [ nac ]
    • sessions
      • List the NAC Sessions for this organization
      • List the NAC Sessions for this organization
      • Return the details of selected NAC Sessions
      • Return the details of selected NAC Sessions
    • license
      • Returns license usage data for a specific organization
      • Returns license usage data for a specific organization
    • authorization
      • Get all nac authorization policies for this organization
      • Get all nac authorization policies for this organization
  • [ users ]
    • iam
      • List specific authorizations for the list of Meraki end users.
      • List specific authorizations for the list of Meraki end users.
      • Authorize a Meraki end user for an auth zone.
      • Update a Meraki end user's access to an auth zone.
      • Revoke a Meraki end user's access to an auth zone.
      • Revoke a Meraki end user's access to an auth zone.
      • List all of the available auth zones for an organization.
      • List all of the available auth zones for an organization.
      • Delete an authorization for a Meraki end user.
      • Delete an authorization for a Meraki end user.
      • Create an identity provider for an organization
      • Create an identity provider for an organization. Only Entra ID(Azure AD) is supported at this time.
      • Search all IdP groups for an organization
      • Search all IdP groups for an organization. Filter by IdP IDs and Auth Zone. Parameters are assembled as an AND query.
      • List all available IdP Product Integration urls for the organization
      • List all available IdP Product Integration urls for the organization
      • Search all IdPs for an organization
      • Search all IdPs for an organization. Filter by IdP ID, IdP type, and Auth Zone. Parameters are assembled as an AND query.
      • Get the IdP sync status records for an organization
      • Get the IdP sync status records for an organization. Only Entra ID(Azure AD) is supported at this time.
      • Get the latest IdP sync status records for all IdPs in an organization
      • Get the latest IdP sync status records for all IdPs in an organization. Only Entra ID(Azure AD) is supported at this time.
      • Test connectivity to an Entra ID identity provider.
      • Test connectivity to an Entra ID identity provider.
      • Create a Meraki user
      • Create a Meraki user
      • Update a Meraki user
      • Update a Meraki user
      • Delete a Meraki end user
      • Trigger an IdP sync for an identity provider
      • Trigger an IdP sync for an identity provider. Only Entra ID(Azure AD) is supported at this time.
      • Get the latest IdP sync status for an identity provider
      • Get the latest IdP sync status for an identity provider. Only Entra ID(Azure AD) is supported at this time.
      • Update an identity provider
      • Update an identity provider. Only Entra ID(Azure AD) is supported at this time.
      • Delete a identity provider from an organization. Only Entra ID(Azure AD) is supported at this time.
      • List all auth zones for an identity provider
      • List all auth zones for an identity provider
      • List the end users and their associated identity providers for an organization.
      • List the end users and their associated identity providers for an organization.
      • Get the count of users and user groups for an organization.
      • Get the count of users and user groups for an organization.
  • [ camera ]
    • videoWalls
      • Create a new video wall.
      • Create a new video wall.
      • Update the specified video wall.
      • Update the specified video wall.
      • Delete the specified video wall.
      • Return a list of video walls.
      • Return a list of video walls.
      • Return the specified video wall.
      • Return the specified video wall.
      • Returns video wall link to the specified video wall id
      • Returns video wall link to the specified video wall id. If a timestamp is supplied, it links to that timestamp.
    • devices
      • Lists all the capabilities of cameras in this organization
      • Lists all the capabilities of cameras in this organization
  • [ devices ]
    • vrrpTable
      • Enqueue a job to perform a VRRP table request for the device
      • Enqueue a job to perform a VRRP table request for the device. This endpoint currently supports Catalyst switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return an VRRP table live tool job.
      • Return an VRRP table live tool job.
    • traceRoute
      • Enqueue a job to run trace route in the device
      • Enqueue a job to run trace route in the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return a trace route job
      • Return a trace route job
    • speedTest
      • Enqueue a job to execute a speed test from a device
      • Enqueue a job to execute a speed test from a device
      • Returns a speed test result in megabits per second
      • Returns a speed test result in megabits per second. If test is not complete, no results are present.
    • routingTable
      • Enqueue a job to perform a routing table request for the device
      • Enqueue a job to perform a routing table request for the device. Only native Catalyst switches are supported. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return an routing table live tool job.
      • Return an routing table live tool job.
    • ospfNeighbors
      • Enqueue a job to perform a OSPF neighbors request for the device
      • Enqueue a job to perform a OSPF neighbors request for the device. This endpoint currently supports switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return an OSPF neighbors live tool job.
      • Return an OSPF neighbors live tool job.
    • dhcpLeases
      • Enqueue a job to perform a DHCP leases request for the device
      • Enqueue a job to perform a DHCP leases request for the device. This endpoint currently supports all devices. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return a DHCP leases live tool job.
      • Return a DHCP leases live tool job.
    • cyclePort
      • Enqueue a job to perform a cycle port for the device on the specified ports
      • Enqueue a job to perform a cycle port for the device on the specified ports. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return a cycle port live tool job.
      • Return a cycle port live tool job.
    • aclHitCount
      • Enqueue a job to perform an ACL hit count for the device
      • Enqueue a job to perform an ACL hit count for the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return an ACL hit count live tool job.
      • Return an ACL hit count live tool job.
    • clients
      • Enqueue a job to disconnect a client from an AP
      • Enqueue a job to disconnect a client from an AP. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
      • Return a client disconnect job.
      • Return a client disconnect job.
  • [ licensing ]
    • subscription
      • Batch change networks to their desired feature tier for specified product types
      • Batch change networks to their desired feature tier for specified product types
  • [ insight ]
    • webApps
      • Lists all default web applications rules with counter set rule ids
      • Lists all default web applications rules with counter set rule ids
      • Add a custom web application for Insight to be able to track
      • Update a custom web application for Insight to be able to track
      • Update a custom web application for Insight to be able to track
      • Delete a custom web application by counter set rule id.
    • speedTestResults
      • List the speed tests for the given devices under this organization
      • List the speed tests for the given devices under this organization. Only valid for organizations with Meraki Insight.
    • applications
      • Update an Insight tracked application
      • Update an Insight tracked application
      • Delete an Insight tracked application
  • [ organizations ]
    • webhooks
      • List the HTTP servers for this organization
      • List the HTTP servers for this organization
      • Add an HTTP server to an organization
      • Return an HTTP server for an organization
      • Return an HTTP server for an organization
      • Update an HTTP server for an organization
      • Delete an HTTP server from an organization
      • List the webhook payload templates for an organization
      • List the webhook payload templates for an organization
      • Create a webhook payload template for an organization
      • Get the webhook payload template for an organization
      • Get the webhook payload template for an organization
      • Update a webhook payload template for an organization
      • Destroy a webhook payload template for an organization. Does not work for included templates ('wpt_00001', 'wpt_00002', 'wpt_00003', 'wpt_00004', 'wpt_00005', 'wpt_00006' or 'wpt_00007')
      • Send a test webhook for an organization
      • Send a test webhook for an organization
      • Return the status of a webhook test for an organization
      • Return the status of a webhook test for an organization
    • policy
      • List all layer 7 CASI categories and applications that can be used with Org Wide Policies
      • List all layer 7 CASI categories and applications that can be used with Org Wide Policies
      • List Organization-Wide Policy Firewall Profiles
      • List Organization-Wide Policy Firewall Profiles
      • Create an Organization-Wide Policy Firewall Profile
      • Provision default Organization-Wide Policy Firewall Profiles
      • Provision default Organization-Wide Policy Firewall Profiles
      • Update an Organization-Wide Policy Firewall Profile
      • Update an Organization-Wide Policy Firewall Profile
      • Delete an Organization-Wide Policy Firewall Profile
      • Delete multiple Organization-Wide Policy Firewall Rules
      • Delete multiple Organization-Wide Policy Firewall Rules
      • Change Rules definition
      • Change Rules definition
      • Get Organization-Wide Policy Firewall Rules Errors
      • Get Organization-Wide Policy Firewall Rules Errors
      • List Organization-Wide Policy Firewall Rules
      • List Organization-Wide Policy Firewall Rules
      • Search for Organization-wide Firewall Rules by source and destination IPs
      • Search for Organization-wide Firewall Rules by source and destination IPs
      • List Organization-Wide Policies
      • List Organization-Wide Policies
      • Change Policy definition
      • Change Policy definition
      • Delete an Organization-Wide Policy
      • Delete an Organization-Wide Policy
      • List Organization-Wide Policy Vlans
      • List Organization-Wide Policy Vlans
      • List Organization-Wide Policy Zones
      • List Organization-Wide Policy Zones
      • Create an Organization-Wide Policy Zone
      • Get Enforcement details
      • Get Enforcement details
      • Update an Organization-Wide Policy Zone
      • Update an Organization-Wide Policy Zone
      • Delete an Organization-Wide Policy Zone
      • Assign VLANs to a given Zone
      • Assign VLANs to a given Zone
      • Remove VLANs from a given Zone
      • Remove VLANs from a given Zone
    • networks
      • Move networks from one organization to another
      • Return a list of network move operations in the organization
      • Move networks from one organization to another. Note that as this is an Early Access feature it may result in unexpected behavior and is best tested with non-critical networks. For more information and caveats around network move limitations see Network Portability
      • Return details on the specified network move operation
      • Return details on the specified network move operation
    • inventory
      • Claim an order by the secure unique order claim number, the order claim id
      • Claim an order by the secure unique order claim number, the order claim id
      • Preview the results and status of an order claim by the secure order id
      • Preview the results and status of an order claim by the secure order id
    • extensions
      • Update name and status of an Interconnect
      • Update name and status of an Interconnect
      • List the ThousandEyes agent configurations under this organization
      • List the ThousandEyes agent configurations under this organization. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
      • Add a ThousandEyes agent for this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
      • List all the networks eligible for ThousandEyes agent activation under this organization.
      • List all the networks eligible for ThousandEyes agent activation under this organization.
      • List the ThousandEyes agent configuration under this network
      • List the ThousandEyes agent configuration under this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
      • Update a ThousandEyes agent from this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
      • Delete a ThousandEyes agent from this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
      • Create a ThousandEyes test based on a provided test template
      • Create a ThousandEyes test based on a provided test template. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
    • cloud
      • List of source/destination traffic rules
      • List of source/destination traffic rules
    • certificates
      • Gets all or specific certificates for an organization
      • Gets all or specific certificates for an organization
      • Import certificate for this organization
      • Import certificate for this organization
      • Delete a certificate for an organization
      • Update a certificate's description for an organization
      • Delete a certificate for an organization
      • Download the trusted certificate by certificate id.
      • Download the trusted certificate by certificate id.
    • auth
      • List the organization-wide RADIUS servers in the organization
      • List the organization-wide RADIUS servers in the organization
      • Add an organization-wide RADIUS server
      • Return list of network and policies that organization-wide RADIUS servers are bing used
      • Return list of network and policies that organization-wide RADIUS servers are bing used
      • Return an organization-wide RADIUS server
      • Return an organization-wide RADIUS server
      • Update an organization-wide RADIUS server
      • Delete an organization-wide RADIUS server from a organization
    • workflows
      • Return workflows filtered by organization ID, network ID, type, and category
      • Return workflows filtered by organization ID, network ID, type, and category
    • productAnnouncements
      • Gets relevant product announcements for a user
      • Gets relevant product announcements for a user
    • snmp
      • Retrieve the SNMP trap configuration for the networks in an organization
      • Retrieve the SNMP trap configuration for the networks in an organization
    • devices
      • Returns the history of device boots in reverse chronological order (most recent first)
      • Returns the history of device boots in reverse chronological order (most recent first). Currently supported for MS devices only.
      • Delete packet capture schedules
      • Delete packet capture schedules
      • Enqueues a task for a specific packet capture
      • Enqueues a task for a specific packet capture. This endpoint has a sustained rate limit of one request every 60 seconds.
      • Retrieves packet capture analysis result for a specific packet capture task.
      • Retrieves packet capture analysis result for a specific packet capture task.
      • Returns syslog servers configured for the networks within an organization.
      • Returns syslog servers configured for the networks within an organization.
      • Returns roles that can be assigned to a syslog server for a given network.
      • Returns roles that can be assigned to a syslog server for a given network.
  • [ networks ]
    • snmp
      • Update the SNMP trap configuration for the specified network
      • Update the SNMP trap configuration for the specified network
    • locationScanning
      • Return scanning API settings
      • Return scanning API settings
      • Change scanning API settings
      • Return list of scanning API receivers
      • Return list of scanning API receivers
      • Set the list of scanning API receivers. Old receivers will be removed
    • devices
      • Updates the syslog servers configuration for a network.
      • Updates the syslog servers configuration for a network.
  • [ wireless ]
    • mqtt
      • Return MQTT Settings for networks
      • Return MQTT Settings for networks
      • Add new broker config for wireless MQTT
    • certificates
      • Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs).
      • Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs).
    • ssids
      • Update the client exclusion status configuration for a given SSID
      • Update the client exclusion status configuration for a given SSID
      • Set the static client exclusion list for the given SSID
      • Set the static client exclusion list for the given SSID
      • Add a list of MAC addresses to the static client exclusion list for the given SSID
      • Add a list of MAC addresses to the static client exclusion list for the given SSID
      • Delete a list of MAC addresses from the static client exclusion list for the given SSID
      • Delete a list of MAC addresses from the static client exclusion list for the given SSID
      • Returns an array of objects, each containing client exclusion enablement statuses for one SSID
      • Returns an array of objects, each containing client exclusion enablement statuses for one SSID
      • Returns an array of objects, each containing a list of MAC's excluded from a given SSID
      • Returns an array of objects, each containing a list of MAC's excluded from a given SSID
    • opportunisticPcap
      • Update the Opportunistic Pcap settings for a wireless network
      • Update the Opportunistic Pcap settings for a wireless network
      • List the Opportunistic Pcap settings of an organization by network
      • List the Opportunistic Pcap settings of an organization by network
      • Check the Opportunistic Pcap license status of an organization by network
      • Check the Opportunistic Pcap license status of an organization by network
    • radio
      • Return the position for a wireless device
      • Return the position for a wireless device
      • Update the position attributes for this device
      • Return the AFC power limits for a wireless device
      • Return the AFC power limits for a wireless device
      • Show the status of this device's radios
      • Show the status of this device's radios
      • Update the AutoRF settings for a wireless network
      • Update the AutoRF settings for a wireless network
      • Update the AutoRF settings for a wireless network
      • Update the AutoRF settings for a wireless network
      • List the AFC power limits of an organization by device
      • List the AFC power limits of an organization by device
      • List the AFC power limits of an organization by device
      • List the AFC power limits of an organization by device
      • List the AutoRF settings of an organization by network
      • List the AutoRF settings of an organization by network
      • List the channel planning activities of an organization
      • List the channel planning activities of an organization
      • List the AutoRF settings of an organization by network
      • List the AutoRF settings of an organization by network
      • Show the status of this organization's radios, categorized by network and device
      • Show the status of this organization's radios, categorized by network and device
    • healthScores
      • Fetch the health scores for a given AP on this network
      • Fetch the health scores for a given AP on this network
    • devices
      • Fetch the health scores of all APs on this network
      • Fetch the health scores of all APs on this network
      • List the most recent AP accelerometer status information for wireless devices that support it.
      • List the most recent AP accelerometer status information for wireless devices that support it.
      • Get latency summaries for all wireless devices in an organization.
      • Get latency summaries for all wireless devices in an organization.
      • Get latency summaries for all wireless devices in an organization.
      • Get latency summaries for all wireless devices in an organization.
      • Get per-network latency summaries for all wireless networks in an organization.
      • Get per-network latency summaries for all wireless networks in an organization.
      • Get average signal quality for all clients in the organization
      • Get average signal quality for all clients in the organization
      • Get average signal quality for all devices in the organization
      • Get average signal quality for all devices in the organization
      • Get average signal quality for all networks in the organization
      • Get average signal quality for all networks in the organization
    • clients
      • Fetch the health scores for all clients on this network
      • Fetch the health scores for all clients on this network
      • Return counts of distinct wireless clients connecting to a network over time
      • Return counts of distinct wireless clients connecting to a network over time
      • Fetch the health scores for a given client on this network
      • Fetch the health scores for a given client on this network. Clients are identified by their MAC or ID
  • [ switch ]
    • configTemplates
      • list the port mirror configurations in an organization by switch profile
      • list the port mirror configurations in an organization by switch profile
      • Update a port mirror
      • Update a port mirror
    • raGuardPolicy
      • Return RA Guard settings
      • Return RA Guard settings. Blocked servers are applied when default policy is allowed, and vice versa for allowed servers and blocked default policy.
      • Update RA Guard settings
    • devices
      • Return a historical record of packet transmission and loss, broken down by protocol, for insight into switch device health.
      • Return a historical record of packet transmission and loss, broken down by protocol, for insight into switch device health.
    • stacks
      • Update switch port mirrors for switch stacks
      • Update switch port mirrors for switch stacks
      • List the port mirror configurations in an organization by switch
      • List the port mirror configurations in an organization by switch
    • ports
      • Update a port mirror
      • Update a port mirror
      • List the port profiles in a network
      • List the port profiles in a network
      • Create a port profile in a network
      • Update a port profile in a network
      • Update a port profile in a network
      • Delete a port profile from a network
      • list the port mirror configurations in an organization by switch
      • list the port mirror configurations in an organization by switch
      • List the port profiles in an organization
      • List the port profiles in an organization
      • Create a port profile in an organization
      • list the automation port profiles in an organization
      • list the automation port profiles in an organization
      • Create a port profile automation for an organization
      • Update a port profile automation in an organization
      • Update a port profile automation in an organization
      • Delete an automation port profile from an organization
      • Fetch all Network - Smart Port Profile associations for an organization
      • Fetch all Network - Smart Port Profile associations for an organization
      • Create Network and Smart Ports Profile association for a specific profile
      • Batch Create Network and Smart Ports Profile associations for a specific profile
      • Batch Create Network and Smart Ports Profile associations for a specific profile
      • Bulk delete Network and Smart Port Profile associations
      • Bulk delete Network and Smart Port Profile associations
      • Delete Network and Smart Port profile association for a specific profile
      • Delete Network and Smart Port profile association for a specific profile
      • List the port profiles in an organization
      • List the port profiles in an organization
      • Get detailed information about a port profile
      • Get detailed information about a port profile
      • Update a port profile in an organization
      • Delete a port profile from an organization
      • Return time-series digital optical monitoring (DOM) readings for ports on each DOM-enabled switch in an organization, in addition to thresholds for each relevant Small Form Factor Pluggable (SFP) module.
      • Return time-series digital optical monitoring (DOM) readings for ports on each DOM-enabled switch in an organization, in addition to thresholds for each relevant Small Form Factor Pluggable (SFP) module.
  • [ sensor ]
    • readings
      • Return all reported readings from sensors in a given timespan, summarized as a series of intervals, sorted by interval start time in descending order
      • Return all reported readings from sensors in a given timespan, summarized as a series of intervals, sorted by interval start time in descending order
    • alerts
      • Return a list of sensor alert events
      • Return a list of sensor alert events
    • schedules
      • Returns a list of all sensor schedules.
      • Returns a list of all sensor schedules.
  • [ appliance ]
    • sdwan
      • Get the SDWAN internet traffic preferences for an MX network
      • Get the SDWAN internet traffic preferences for an MX network
    • umbrella
      • Connect to Cisco Umbrella account to this network
      • Connect to Cisco Umbrella account to this network
      • Disconnect Umbrella account from this network
      • Disconnect Umbrella account from this network
      • Disable umbrella protection for an MX network
      • Disable umbrella protection for an MX network
      • Enable umbrella protection for an MX network
      • Enable umbrella protection for an MX network
      • Specify one or more domain names to be excluded from being routed to Cisco Umbrella.
      • Specify one or more domain names to be excluded from being routed to Cisco Umbrella.
      • Update umbrella policies applied to MX network.
      • Update umbrella policies applied to MX network.
    • vlans
      • List the VLANs for an Organization
      • List the VLANs for an Organization
• Changed
  • [ insight ]
    • applications
      • Add an Insight tracked application
      • Add an Insight tracked application
  • [ 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
      • List the client and status overview information for the networks in an organization
      • 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
    • devices
      • List the availability history information for devices in an organization.
      • List the status of every Meraki device in the organization
    • clients
      • Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.
  • [ networks ]
    • settings
      • Update the settings for a network
    • firmwareUpgrades
      • Rollback a Firmware Upgrade For A Network
      • Update firmware upgrade information for a network
      • Get firmware upgrade information for a network
  • [ wireless ]
    • rfProfiles
      • Creates new RF profile for this network
      • Updates specified RF profile for this network
      • List RF profiles for this network
      • Return a RF profile
    • settings
      • Update the wireless settings for a network
      • Return the wireless settings for a network
    • bluetooth
      • Update the bluetooth settings for a wireless device
      • Update the Bluetooth settings for a network
      • Return the bluetooth settings for a wireless device
      • Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.
  • [ switch ]
    • stacks
      • Create a layer 3 interface for a switch stack
      • Update a layer 3 interface for a switch stack
      • List layer 3 interfaces for a switch stack
      • Return a layer 3 interface from a switch stack
    • ports
      • List the switchports in an organization by switch
    • routing
      • Create a layer 3 interface for a switch
      • Create a multicast rendezvous point
      • Update a layer 3 interface for a switch
      • Update a multicast rendezvous point
      • List layer 3 interfaces for a switch
      • Return a layer 3 interface for a switch
      • List multicast rendezvous points
      • Return a multicast rendezvous point
  • [ sensor ]
    • commands
      • Sends a command to a sensor
  • [ appliance ]
    • vlans
      • Add a VLAN
      • Update a VLAN
    • ports
      • Update the per-port VLAN settings for a single MX port.
      • List per-port VLAN settings for all ports of a MX.
      • Return per-port VLAN settings for a single MX port.
    • uplinks
      • Update the uplink settings for an MX appliance
      • Return the uplink settings for an MX appliance

Version 1.62.0 to 1.62.0-beta.0

Summary of Changes

194 - New

147 - Updated

1104 - Total Endpoints

779 - Total Paths

Added

[ wirelessController ]

regulatoryDomain

Docs

Generate the regulatory domain package

Operation ID: generateOrganizationWirelessControllerRegulatoryDomainPackage

PATH /organizations/{organizationId}/wirelessController/regulatoryDomain/package/generate

{
  "content": {
    "devices": [
      {
        "serial": "Q234-ABCD-5678",
        "mac": "00:11:22:33:44:55",
        "regulatoryDomain": {
          "country": "US",
          "method": "manual"
        }
      }
    ],
    "details": {
      "schemaVersion": "1.0.0",
      "organizationId": "2930418",
      "createdAt": "2018-05-12T00:00:00Z",
      "counts": {
        "devices": 1
      },
      "createdBy": {
        "id": "212406",
        "email": "miles@meraki.com"
      }
    }
  },
  "signature": "a1b2c3d4e5f6g7h8i9j0",
  "certificates": [
    {
      "purpose": "signature",
      "content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tIE1JSUZZRENDQTBpZ0F3SUJBZ0lRQ2dGQ2dBQUFBVVVqeQ=="
    }
  ]
}

- Path added

- New endpoint

Generate the regulatory domain package

POST /organizations/{organizationId}/wirelessController/regulatoryDomain/package/generate

{
    "content": {
        "devices": [
            {
                "serial": "Q234-ABCD-5678",
                "mac": "00:11:22:33:44:55",
                "regulatoryDomain": {
                    "country": "US",
                    "method": "manual"
                }
            }
        ],
        "details": {
            "schemaVersion": "1.0.0",
            "organizationId": "2930418",
            "createdAt": "2018-05-12T00:00:00Z",
            "counts": {
                "devices": 1
            },
            "createdBy": {
                "id": "212406",
                "email": "miles@meraki.com"
            }
        }
    },
    "signature": "a1b2c3d4e5f6g7h8i9j0",
    "certificates": [
        {
            "purpose": "signature",
            "content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tIE1JSUZZRENDQTBpZ0F3SUJBZ0lRQ2dGQ2dBQUFBVVVqeQ=="
        }
    ]
}

---

connections

Docs

List of unassigned Catalyst access points and summary information

Operation ID: getOrganizationWirelessControllerConnectionsUnassigned

PATH /organizations/{organizationId}/wirelessController/connections/unassigned

{
  "items": [
    {
      "id": "958271979973",
      "name": "MBY-CON-NCC_HLWY-24",
      "model": "AIR-AP1815I-B-K9",
      "serial": "",
      "mac": "8c:94:1f:97:54:01",
      "onboarding": {
        "isSupported": true,
        "status": "unregistered",
        "errors": [
          "DNS failure"
        ]
      },
      "tags": {
        "policy": "default-policy-tag",
        "site": "default-site-tag",
        "rf": "default-rf-tag"
      },
      "details": [
        {
          "name": "Catalyst serial",
          "value": "FCW2325N3RY"
        }
      ],
      "uplinks": [
        {
          "addresses": [
            {
              "address": "10.104.55.4"
            }
          ]
        }
      ],
      "controller": {
        "serial": "A2CC-8TYV-VCO9"
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

List of unassigned Catalyst access points and summary information

GET /organizations/{organizationId}/wirelessController/connections/unassigned

{
    "items": [
        {
            "id": "958271979973",
            "name": "MBY-CON-NCC_HLWY-24",
            "model": "AIR-AP1815I-B-K9",
            "serial": "",
            "mac": "8c:94:1f:97:54:01",
            "onboarding": {
                "isSupported": true,
                "status": "unregistered",
                "errors": [
                    "DNS failure"
                ]
            },
            "tags": {
                "policy": "default-policy-tag",
                "site": "default-site-tag",
                "rf": "default-rf-tag"
            },
            "details": [
                {
                    "name": "Catalyst serial",
                    "value": "FCW2325N3RY"
                }
            ],
            "uplinks": [
                {
                    "addresses": [
                        {
                            "address": "10.104.55.4"
                        }
                    ]
                }
            ],
            "controller": {
                "serial": "A2CC-8TYV-VCO9"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1,
                "remaining": 0
            }
        }
    }
}

---

[ support ]

salesRepresentatives

Docs

Returns the organization's sales representatives

Operation ID: getOrganizationSupportSalesRepresentatives

PATH /organizations/{organizationId}/support/salesRepresentatives

[
  {
    "name": "Miles Meraki",
    "email": "miles@meraki.com",
    "phone": "+15555555555"
  }
]

- Path added

- New endpoint

Returns the organization's sales representatives

GET /organizations/{organizationId}/support/salesRepresentatives

[
    {
        "name": "Miles Meraki",
        "email": "miles@meraki.com",
        "phone": "+15555555555"
    }
]

---

[ sm ]

bulkEnrollment

Docs

Create a PccBulkEnrollmentToken

Operation ID: createOrganizationSmBulkEnrollmentToken

PATH /organizations/{organizationId}/sm/bulkEnrollment/token

{
  "id": "1284392014819",
  "networkId": "N_24329156",
  "expiresAt": "2023-10-15T00:00:00Z",
  "rawToken": "MMbCbpHZtG3TKUCr9B9uc5"
}

- Path added

- New endpoint

Create a PccBulkEnrollmentToken

POST /organizations/{organizationId}/sm/bulkEnrollment/token

{
    "id": "1284392014819",
    "networkId": "N_24329156",
    "expiresAt": "2023-10-15T00:00:00Z",
    "rawToken": "MMbCbpHZtG3TKUCr9B9uc5"
}

---

Docs

Return a BulkEnrollmentToken

Operation ID: getOrganizationSmBulkEnrollmentToken

PATH /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

{
  "id": "1284392014819",
  "networkId": "N_24329156",
  "expiresAt": "2023-10-15T00:00:00Z"
}

- Path added

- New endpoint

Return a BulkEnrollmentToken

GET /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

{
    "id": "1284392014819",
    "networkId": "N_24329156",
    "expiresAt": "2023-10-15T00:00:00Z"
}

---

- New endpoint

Update a PccBulkEnrollmentToken

PUT /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

{
    "id": "1284392014819",
    "networkId": "N_24329156",
    "expiresAt": "2023-10-15T00:00:00Z"
}

---

- New endpoint

Delete a PccBulkEnrollmentToken

DELETE /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

---

Docs

List all BulkEnrollmentTokens for an organization.

Operation ID: getOrganizationSmBulkEnrollmentTokens

PATH /organizations/{organizationId}/sm/bulkEnrollment/tokens

[
  {
    "id": "1284392014819",
    "networkId": "N_24329156",
    "expiresAt": "2023-10-15T00:00:00Z"
  }
]

- Path added

- New endpoint

List all BulkEnrollmentTokens for an organization.

GET /organizations/{organizationId}/sm/bulkEnrollment/tokens

[
    {
        "id": "1284392014819",
        "networkId": "N_24329156",
        "expiresAt": "2023-10-15T00:00:00Z"
    }
]

---

apple

Docs

Enqueue a sync job for an ADE account

Operation ID: createOrganizationSmAppleCloudEnrollmentSyncJob

PATH /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs

{
  "syncJobId": "1284392014819",
  "adeAccountId": "1284392014819",
  "status": "pending"
}

- Path added

- New endpoint

Enqueue a sync job for an ADE account

POST /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs

{
    "syncJobId": "1284392014819",
    "adeAccountId": "1284392014819",
    "status": "pending"
}

---

Docs

Retrieve the status of an ADE sync job

Operation ID: getOrganizationSmAppleCloudEnrollmentSyncJob

PATH /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs/{syncJobId}

{
  "syncJobId": "1284392014819",
  "adeAccountId": "1284392014819",
  "status": "pending"
}

- Path added

- New endpoint

Retrieve the status of an ADE sync job

GET /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs/{syncJobId}

{
    "syncJobId": "1284392014819",
    "adeAccountId": "1284392014819",
    "status": "pending"
}

---

[ secureConnect ]

sites

Docs

List sites in this organization

Operation ID: getOrganizationSecureConnectSites

PATH /organizations/{organizationId}/secureConnect/sites

{
  "data": [
    {
      "id": "123",
      "type": "MerakiSpoke",
      "name": "London Office",
      "region": "US East",
      "deviceType": "MX95-HW",
      "address": "123 Main St",
      "enrolled": true,
      "vpnType": "Hub",
      "defaultRoute": true
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

List sites in this organization

GET /organizations/{organizationId}/secureConnect/sites

{
    "data": [
        {
            "id": "123",
            "type": "MerakiSpoke",
            "name": "London Office",
            "region": "US East",
            "deviceType": "MX95-HW",
            "address": "123 Main St",
            "enrolled": true,
            "vpnType": "Hub",
            "defaultRoute": true
        }
    ],
    "meta": {
        "total": 1
    }
}

---

- New endpoint

Enroll sites in this organization to Secure Connect. For an organization, a maximum of 4000 sites can be enrolled if they are in spoke mode or a maximum of 10 sites can be enrolled in hub mode.

POST /organizations/{organizationId}/secureConnect/sites

{
    "action": "enroll",
    "status": "success",
    "message": "Site enrolled successfully",
    "request": {
        "siteId": "1520758",
        "regionId": "42"
    },
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

- New endpoint

Detach given sites from Secure Connect

DELETE /organizations/{organizationId}/secureConnect/sites

{
    "action": "detach",
    "status": "success",
    "message": "Site enrolled successfully",
    "request": {
        "siteId": "1520758"
    },
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

remoteAccessLogsExports

Docs

Provides a list of remote access logs exports for an Organization

Operation ID: getOrganizationSecureConnectRemoteAccessLogsExports

PATH /organizations/{organizationId}/secureConnect/remoteAccessLogsExports

{
  "data": [
    {
      "id": "123",
      "from": "2023-05-16 04:23:43 UTC",
      "to": "2023-06-14 04:23:52 UTC",
      "userEmail": "joe@meraki.net",
      "status": "new",
      "metadata": {
        "fileCount": 0,
        "logCount": 0,
        "currentFileLogCount": 0,
        "generatorCount": 0,
        "limitReached": false,
        "startedAt": "2023-05-15 21:23:43.388597",
        "endedAt": "2023-05-15 21:23:43.388597",
        "duration": 60
      }
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

Provides a list of remote access logs exports for an Organization

GET /organizations/{organizationId}/secureConnect/remoteAccessLogsExports

{
    "data": [
        {
            "id": "123",
            "from": "2023-05-16 04:23:43 UTC",
            "to": "2023-06-14 04:23:52 UTC",
            "userEmail": "joe@meraki.net",
            "status": "new",
            "metadata": {
                "fileCount": 0,
                "logCount": 0,
                "currentFileLogCount": 0,
                "generatorCount": 0,
                "limitReached": false,
                "startedAt": "2023-05-15 21:23:43.388597",
                "endedAt": "2023-05-15 21:23:43.388597",
                "duration": 60
            }
        }
    ],
    "meta": {
        "total": 1
    }
}

---

- New endpoint

Creates a export for a provided timestamp interval.

POST /organizations/{organizationId}/secureConnect/remoteAccessLogsExports

{
    "id": "123",
    "from": "2023-05-16 04:23:43 UTC",
    "to": "2023-06-14 04:23:52 UTC",
    "userEmail": "joe@meraki.net",
    "status": "new",
    "metadata": {
        "fileCount": 0,
        "logCount": 0,
        "currentFileLogCount": 0,
        "generatorCount": 0,
        "limitReached": false,
        "startedAt": "2023-05-15 21:23:43.388597",
        "endedAt": "2023-05-15 21:23:43.388597",
        "duration": 60
    }
}

---

Docs

Redirects to the download link of the completed export.

Operation ID: getOrganizationSecureConnectRemoteAccessLogsExportsDownload

PATH /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/download

{
  "link": "download"
}

- Path added

- New endpoint

Redirects to the download link of the completed export.

GET /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/download

{
    "link": "download"
}

---

Docs

Return the details of a specific remote access logs export

Operation ID: getOrganizationSecureConnectRemoteAccessLogsExport

PATH /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/{id}

{
  "id": "123",
  "from": "2023-05-16 04:23:43 UTC",
  "to": "2023-06-14 04:23:52 UTC",
  "userEmail": "joe@meraki.net",
  "status": "new",
  "metadata": {
    "fileCount": 0,
    "logCount": 0,
    "currentFileLogCount": 0,
    "generatorCount": 0,
    "limitReached": false,
    "startedAt": "2023-05-15 21:23:43.388597",
    "endedAt": "2023-05-15 21:23:43.388597",
    "duration": 60
  }
}

- Path added

- New endpoint

Return the details of a specific remote access logs export

GET /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/{id}

{
    "id": "123",
    "from": "2023-05-16 04:23:43 UTC",
    "to": "2023-06-14 04:23:52 UTC",
    "userEmail": "joe@meraki.net",
    "status": "new",
    "metadata": {
        "fileCount": 0,
        "logCount": 0,
        "currentFileLogCount": 0,
        "generatorCount": 0,
        "limitReached": false,
        "startedAt": "2023-05-15 21:23:43.388597",
        "endedAt": "2023-05-15 21:23:43.388597",
        "duration": 60
    }
}

---

remoteAccessLog

Docs

List the latest 5000 events logged by remote access.

Operation ID: getOrganizationSecureConnectRemoteAccessLog

PATH /organizations/{organizationId}/secureConnect/remoteAccessLog

{
  "data": [
    {
      "osversion": "win-10.0.19044",
      "internalip": "10.0.1.5",
      "connecttimestamp": 1667252442,
      "identities": [
        {
          "id": "1173502975",
          "type": {
            "id": "7",
            "type": "directory_user",
            "label": "AD Users"
          },
          "label": "sample-remote-access@cisco.com",
          "deleted": false
        }
      ],
      "reason": "ACCT_DISC_USER_REQ",
      "failedreasons": [],
      "connectionevent": "disconnected",
      "anyconnectversion": "4.10.05095",
      "timestamp": 1667252458
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

List the latest 5000 events logged by remote access.

GET /organizations/{organizationId}/secureConnect/remoteAccessLog

{
    "data": [
        {
            "osversion": "win-10.0.19044",
            "internalip": "10.0.1.5",
            "connecttimestamp": 1667252442,
            "identities": [
                {
                    "id": "1173502975",
                    "type": {
                        "id": "7",
                        "type": "directory_user",
                        "label": "AD Users"
                    },
                    "label": "sample-remote-access@cisco.com",
                    "deleted": false
                }
            ],
            "reason": "ACCT_DISC_USER_REQ",
            "failedreasons": [],
            "connectionevent": "disconnected",
            "anyconnectversion": "4.10.05095",
            "timestamp": 1667252458
        }
    ],
    "meta": {
        "total": 1
    }
}

---

regions

Docs

List deployed cloud hubs and regions in this organization

Operation ID: getOrganizationSecureConnectRegions

PATH /organizations/{organizationId}/secureConnect/regions

{
  "data": [
    {
      "id": "123",
      "type": "Region",
      "name": "US West Coast",
      "dcPair": [
        "Los Angeles",
        "Palo Alto"
      ]
    }
  ],
  "meta": {
    "maxTotalCloudHubs": 5
  }
}

- Path added

- New endpoint

List deployed cloud hubs and regions in this organization

GET /organizations/{organizationId}/secureConnect/regions

{
    "data": [
        {
            "id": "123",
            "type": "Region",
            "name": "US West Coast",
            "dcPair": [
                "Los Angeles",
                "Palo Alto"
            ]
        }
    ],
    "meta": {
        "maxTotalCloudHubs": 5
    }
}

---

publicApplications

Docs

Provides a list of public applications for an Organization.

Operation ID: getOrganizationSecureConnectPublicApplications

PATH /organizations/{organizationId}/secureConnect/publicApplications

{
  "items": [
    {
      "id": "ABCDEFG",
      "name": "Snapcraft",
      "lastDetected": "2021-12-13T16:07:07.222Z",
      "risk": "medium",
      "category": "Application Development and Testing",
      "appType": "paas"
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

Provides a list of public applications for an Organization.

GET /organizations/{organizationId}/secureConnect/publicApplications

{
    "items": [
        {
            "id": "ABCDEFG",
            "name": "Snapcraft",
            "lastDetected": "2021-12-13T16:07:07.222Z",
            "risk": "medium",
            "category": "Application Development and Testing",
            "appType": "paas"
        }
    ],
    "meta": {
        "total": 1
    }
}

---

privateResources

Docs

Provides a list of private resources for an organization.

Operation ID: getOrganizationSecureConnectPrivateResources

PATH /organizations/{organizationId}/secureConnect/privateResources

{
  "data": [
    {
      "resourceId": "5",
      "name": "Sample Resource Name",
      "description": "A sample description",
      "accessTypes": [
        {
          "type": "client",
          "reachableAddresses": [
            "192.0.0.0"
          ]
        }
      ],
      "resourceAddresses": [
        {
          "protocolPorts": [
            {
              "protocol": "any",
              "ports": "80"
            }
          ],
          "destinationAddr": [
            "192.0.0.0"
          ]
        }
      ],
      "resourceGroupIds": [
        "1122321"
      ],
      "dnsServerId": "12345",
      "certificateId": "54321",
      "organizationId": "106642",
      "createdAt": "2024-03-06T15:11:55.323445Z",
      "updatedAt": "2024-03-06T15:11:55.323445Z",
      "deletedAt": "2024-03-06T15:11:55.323445Z",
      "umbrellaResourceId": "123",
      "umbrellaResourceCreatedAt": "2024-03-06T15:11:55.323445Z",
      "umbrellaResourceUpdatedAt": "2024-03-06T15:11:55.323445Z",
      "umbrellaResourceDeletedAt": "2024-03-06T15:11:55.323445Z",
      "umbrellaResourceCreatedBy": "",
      "umbrellaResourceModifiedBy": "",
      "umbrellaResourceErrorMessage": "",
      "umbrellaApplicationId": "321",
      "umbrellaApplicationCreatedAt": "2024-03-06T15:11:55.323445Z",
      "umbrellaApplicationUpdatedAt": "2024-03-06T15:11:55.323445Z",
      "umbrellaApplicationDeletedAt": "2024-03-06T15:11:55.323445Z",
      "umbrellaApplicationErrorMessage": ""
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

Provides a list of private resources for an organization.

GET /organizations/{organizationId}/secureConnect/privateResources

{
    "data": [
        {
            "resourceId": "5",
            "name": "Sample Resource Name",
            "description": "A sample description",
            "accessTypes": [
                {
                    "type": "client",
                    "reachableAddresses": [
                        "192.0.0.0"
                    ]
                }
            ],
            "resourceAddresses": [
                {
                    "protocolPorts": [
                        {
                            "protocol": "any",
                            "ports": "80"
                        }
                    ],
                    "destinationAddr": [
                        "192.0.0.0"
                    ]
                }
            ],
            "resourceGroupIds": [
                "1122321"
            ],
            "dnsServerId": "12345",
            "certificateId": "54321",
            "organizationId": "106642",
            "createdAt": "2024-03-06T15:11:55.323445Z",
            "updatedAt": "2024-03-06T15:11:55.323445Z",
            "deletedAt": "2024-03-06T15:11:55.323445Z",
            "umbrellaResourceId": "123",
            "umbrellaResourceCreatedAt": "2024-03-06T15:11:55.323445Z",
            "umbrellaResourceUpdatedAt": "2024-03-06T15:11:55.323445Z",
            "umbrellaResourceDeletedAt": "2024-03-06T15:11:55.323445Z",
            "umbrellaResourceCreatedBy": "",
            "umbrellaResourceModifiedBy": "",
            "umbrellaResourceErrorMessage": "",
            "umbrellaApplicationId": "321",
            "umbrellaApplicationCreatedAt": "2024-03-06T15:11:55.323445Z",
            "umbrellaApplicationUpdatedAt": "2024-03-06T15:11:55.323445Z",
            "umbrellaApplicationDeletedAt": "2024-03-06T15:11:55.323445Z",
            "umbrellaApplicationErrorMessage": ""
        }
    ],
    "meta": {
        "total": 1
    }
}

---

- New endpoint

Adds a new private resource to the organization.

POST /organizations/{organizationId}/secureConnect/privateResources

{
    "resourceId": "5",
    "name": "Sample Resource Name",
    "description": "A sample description",
    "accessTypes": [
        {
            "type": "client",
            "reachableAddresses": [
                "192.0.0.0"
            ]
        }
    ],
    "resourceAddresses": [
        {
            "protocolPorts": [
                {
                    "protocol": "any",
                    "ports": "80"
                }
            ],
            "destinationAddr": [
                "192.0.0.0"
            ]
        }
    ],
    "resourceGroupIds": [
        "1122321"
    ],
    "dnsServerId": "12345",
    "certificateId": "54321",
    "organizationId": "106642",
    "createdAt": "2024-03-06T15:11:55.323445Z",
    "updatedAt": "2024-03-06T15:11:55.323445Z",
    "deletedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceId": "123",
    "umbrellaResourceCreatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceUpdatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceDeletedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceCreatedBy": "",
    "umbrellaResourceModifiedBy": "",
    "umbrellaResourceErrorMessage": "",
    "umbrellaApplicationId": "321",
    "umbrellaApplicationCreatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaApplicationUpdatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaApplicationDeletedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaApplicationErrorMessage": ""
}

---

Docs

Updates a specific private resource.

Operation ID: updateOrganizationSecureConnectPrivateResource

PATH /organizations/{organizationId}/secureConnect/privateResources/{id}

{
  "resourceId": "5",
  "name": "Sample Resource Name",
  "description": "A sample description",
  "accessTypes": [
    {
      "type": "client",
      "reachableAddresses": [
        "192.0.0.0"
      ]
    }
  ],
  "resourceAddresses": [
    {
      "protocolPorts": [
        {
          "protocol": "any",
          "ports": "80"
        }
      ],
      "destinationAddr": [
        "192.0.0.0"
      ]
    }
  ],
  "resourceGroupIds": [
    "1122321"
  ],
  "dnsServerId": "12345",
  "certificateId": "54321",
  "organizationId": "106642",
  "createdAt": "2024-03-06T15:11:55.323445Z",
  "updatedAt": "2024-03-06T15:11:55.323445Z",
  "deletedAt": "2024-03-06T15:11:55.323445Z",
  "umbrellaResourceId": "123",
  "umbrellaResourceCreatedAt": "2024-03-06T15:11:55.323445Z",
  "umbrellaResourceUpdatedAt": "2024-03-06T15:11:55.323445Z",
  "umbrellaResourceDeletedAt": "2024-03-06T15:11:55.323445Z",
  "umbrellaResourceCreatedBy": "",
  "umbrellaResourceModifiedBy": "",
  "umbrellaResourceErrorMessage": "",
  "umbrellaApplicationId": "321",
  "umbrellaApplicationCreatedAt": "2024-03-06T15:11:55.323445Z",
  "umbrellaApplicationUpdatedAt": "2024-03-06T15:11:55.323445Z",
  "umbrellaApplicationDeletedAt": "2024-03-06T15:11:55.323445Z",
  "umbrellaApplicationErrorMessage": ""
}

- Path added

- New endpoint

Updates a specific private resource.

PUT /organizations/{organizationId}/secureConnect/privateResources/{id}

{
    "resourceId": "5",
    "name": "Sample Resource Name",
    "description": "A sample description",
    "accessTypes": [
        {
            "type": "client",
            "reachableAddresses": [
                "192.0.0.0"
            ]
        }
    ],
    "resourceAddresses": [
        {
            "protocolPorts": [
                {
                    "protocol": "any",
                    "ports": "80"
                }
            ],
            "destinationAddr": [
                "192.0.0.0"
            ]
        }
    ],
    "resourceGroupIds": [
        "1122321"
    ],
    "dnsServerId": "12345",
    "certificateId": "54321",
    "organizationId": "106642",
    "createdAt": "2024-03-06T15:11:55.323445Z",
    "updatedAt": "2024-03-06T15:11:55.323445Z",
    "deletedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceId": "123",
    "umbrellaResourceCreatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceUpdatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceDeletedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaResourceCreatedBy": "",
    "umbrellaResourceModifiedBy": "",
    "umbrellaResourceErrorMessage": "",
    "umbrellaApplicationId": "321",
    "umbrellaApplicationCreatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaApplicationUpdatedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaApplicationDeletedAt": "2024-03-06T15:11:55.323445Z",
    "umbrellaApplicationErrorMessage": ""
}

---

- New endpoint

Deletes a specific private resource. If this is the last resource in a resource group you must remove it from that resource group before deleting.

DELETE /organizations/{organizationId}/secureConnect/privateResources/{id}

---

privateResourceGroups

Docs

Provides a list of the private resource groups in an organization.

Operation ID: getOrganizationSecureConnectPrivateResourceGroups

PATH /organizations/{organizationId}/secureConnect/privateResourceGroups

{
  "data": [
    {
      "resourceGroupId": "123",
      "createdAt": "2024-03-06T15:11:55.323445Z",
      "updatedAt": "2024-03-06T15:11:55.323445Z",
      "name": "group 2",
      "description": "",
      "resourceIds": [
        "12345"
      ]
    }
  ]
}

- Path added

- New endpoint

Provides a list of the private resource groups in an organization.

GET /organizations/{organizationId}/secureConnect/privateResourceGroups

{
    "data": [
        {
            "resourceGroupId": "123",
            "createdAt": "2024-03-06T15:11:55.323445Z",
            "updatedAt": "2024-03-06T15:11:55.323445Z",
            "name": "group 2",
            "description": "",
            "resourceIds": [
                "12345"
            ]
        }
    ]
}

---

- New endpoint

Adds a new private resource group to an organization.

POST /organizations/{organizationId}/secureConnect/privateResourceGroups

{
    "data": [
        {
            "resourceGroupId": "123",
            "createdAt": "2024-03-06T15:11:55.323445Z",
            "updatedAt": "2024-03-06T15:11:55.323445Z",
            "name": "group 2",
            "description": "",
            "resourceIds": [
                "12345"
            ]
        }
    ]
}

---

Docs

Updates a specific private resource group.

Operation ID: updateOrganizationSecureConnectPrivateResourceGroup

PATH /organizations/{organizationId}/secureConnect/privateResourceGroups/{id}

{
  "data": [
    {
      "resourceGroupId": "123",
      "createdAt": "2024-03-06T15:11:55.323445Z",
      "updatedAt": "2024-03-06T15:11:55.323445Z",
      "name": "group 2",
      "description": "",
      "resourceIds": [
        "12345"
      ]
    }
  ]
}

- Path added

- New endpoint

Updates a specific private resource group.

PUT /organizations/{organizationId}/secureConnect/privateResourceGroups/{id}

{
    "data": [
        {
            "resourceGroupId": "123",
            "createdAt": "2024-03-06T15:11:55.323445Z",
            "updatedAt": "2024-03-06T15:11:55.323445Z",
            "name": "group 2",
            "description": "",
            "resourceIds": [
                "12345"
            ]
        }
    ]
}

---

- New endpoint

Deletes a specific private resource group.

DELETE /organizations/{organizationId}/secureConnect/privateResourceGroups/{id}

---

privateApplications

Docs

Provides a list of private applications for an Organization.

Operation ID: getOrganizationSecureConnectPrivateApplications

PATH /organizations/{organizationId}/secureConnect/privateApplications

{
  "data": [
    {
      "applicationId": "183456",
      "name": "Jira",
      "description": "Jira App For My Org",
      "destinations": [
        {
          "destinationAddr": [
            "172.6.0.0/32",
            "255.100.100.0/24"
          ],
          "protocolPorts": [
            {
              "protocol": "TCP",
              "ports": "80-82"
            }
          ],
          "accessType": "network"
        }
      ],
      "appProtocol": "https",
      "sni": "xyz123.jira.com",
      "externalFQDN": "https://jira-5001.ztna.ciscoplus.com",
      "sslVerificationEnabled": true,
      "applicationGroupIds": [
        "1122321"
      ],
      "createdAt": "2021-12-13T16:07:07.222000Z",
      "modifiedAt": "2021-12-13T16:07:07.222000Z"
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

Provides a list of private applications for an Organization.

GET /organizations/{organizationId}/secureConnect/privateApplications

{
    "data": [
        {
            "applicationId": "183456",
            "name": "Jira",
            "description": "Jira App For My Org",
            "destinations": [
                {
                    "destinationAddr": [
                        "172.6.0.0/32",
                        "255.100.100.0/24"
                    ],
                    "protocolPorts": [
                        {
                            "protocol": "TCP",
                            "ports": "80-82"
                        }
                    ],
                    "accessType": "network"
                }
            ],
            "appProtocol": "https",
            "sni": "xyz123.jira.com",
            "externalFQDN": "https://jira-5001.ztna.ciscoplus.com",
            "sslVerificationEnabled": true,
            "applicationGroupIds": [
                "1122321"
            ],
            "createdAt": "2021-12-13T16:07:07.222000Z",
            "modifiedAt": "2021-12-13T16:07:07.222000Z"
        }
    ],
    "meta": {
        "total": 1
    }
}

---

- New endpoint

Adds a new private application to the Organization. A maximum of 300 private applications are allowed for an organization.

POST /organizations/{organizationId}/secureConnect/privateApplications

{
    "applicationId": "183456",
    "name": "Jira",
    "description": "Jira App For My Org",
    "destinations": [
        {
            "destinationAddr": [
                "172.6.0.0/32",
                "255.100.100.0/24"
            ],
            "protocolPorts": [
                {
                    "protocol": "TCP",
                    "ports": "80-82"
                }
            ],
            "accessType": "network"
        }
    ],
    "appProtocol": "https",
    "sni": "xyz123.jira.com",
    "externalFQDN": "https://jira-5001.ztna.ciscoplus.com",
    "sslVerificationEnabled": true,
    "applicationGroupIds": [
        "1122321"
    ],
    "createdAt": "2021-12-13T16:07:07.222000Z",
    "modifiedAt": "2021-12-13T16:07:07.222000Z"
}

---

Docs

Updates a specific private application

Operation ID: updateOrganizationSecureConnectPrivateApplication

PATH /organizations/{organizationId}/secureConnect/privateApplications/{id}

{
  "applicationId": "183456",
  "name": "Jira",
  "description": "Jira App For My Org",
  "destinations": [
    {
      "destinationAddr": [
        "172.6.0.0/32",
        "255.100.100.0/24"
      ],
      "protocolPorts": [
        {
          "protocol": "TCP",
          "ports": "80-82"
        }
      ],
      "accessType": "network"
    }
  ],
  "appProtocol": "https",
  "sni": "xyz123.jira.com",
  "externalFQDN": "https://jira-5001.ztna.ciscoplus.com",
  "sslVerificationEnabled": true,
  "applicationGroupIds": [
    "1122321"
  ],
  "createdAt": "2021-12-13T16:07:07.222000Z",
  "modifiedAt": "2021-12-13T16:07:07.222000Z"
}

- Path added

- New endpoint

Return the details of a specific private application

GET /organizations/{organizationId}/secureConnect/privateApplications/{id}

{
    "applicationId": "183456",
    "name": "Jira",
    "description": "Jira App For My Org",
    "destinations": [
        {
            "destinationAddr": [
                "172.6.0.0/32",
                "255.100.100.0/24"
            ],
            "protocolPorts": [
                {
                    "protocol": "TCP",
                    "ports": "80-82"
                }
            ],
            "accessType": "network"
        }
    ],
    "appProtocol": "https",
    "sni": "xyz123.jira.com",
    "externalFQDN": "https://jira-5001.ztna.ciscoplus.com",
    "sslVerificationEnabled": true,
    "applicationGroupIds": [
        "1122321"
    ],
    "createdAt": "2021-12-13T16:07:07.222Z",
    "modifiedAt": "2021-12-13T16:07:07.222Z"
}

---

- New endpoint

Updates a specific private application. Updates can be made to Name, Description, Destinations, App Protocol, SNI and SSL verification. Application groups can be added or removed.

PUT /organizations/{organizationId}/secureConnect/privateApplications/{id}

{
    "applicationId": "183456",
    "name": "Jira",
    "description": "Jira App For My Org",
    "destinations": [
        {
            "destinationAddr": [
                "172.6.0.0/32",
                "255.100.100.0/24"
            ],
            "protocolPorts": [
                {
                    "protocol": "TCP",
                    "ports": "80-82"
                }
            ],
            "accessType": "network"
        }
    ],
    "appProtocol": "https",
    "sni": "xyz123.jira.com",
    "externalFQDN": "https://jira-5001.ztna.ciscoplus.com",
    "sslVerificationEnabled": true,
    "applicationGroupIds": [
        "1122321"
    ],
    "createdAt": "2021-12-13T16:07:07.222000Z",
    "modifiedAt": "2021-12-13T16:07:07.222000Z"
}

---

- New endpoint

Deletes a specific private application. Delink the application from any application groups before deleting the app. Cascade delete application group if this is the only application in the group.

DELETE /organizations/{organizationId}/secureConnect/privateApplications/{id}

---

privateApplicationGroups

Docs

Provides a list of private application groups for an Organization

Operation ID: getOrganizationSecureConnectPrivateApplicationGroups

PATH /organizations/{organizationId}/secureConnect/privateApplicationGroups

{
  "data": [
    {
      "applicationGroupId": "1122321",
      "name": "Westcoast Data Center",
      "description": "Private applications in Westcoast Data Center",
      "applicationIds": [
        "183456",
        "123568"
      ],
      "createdAt": "2021-12-13T16:07:07.222Z",
      "modifiedAt": "2021-12-13T16:07:07.222Z"
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

Provides a list of private application groups for an Organization

GET /organizations/{organizationId}/secureConnect/privateApplicationGroups

{
    "data": [
        {
            "applicationGroupId": "1122321",
            "name": "Westcoast Data Center",
            "description": "Private applications in Westcoast Data Center",
            "applicationIds": [
                "183456",
                "123568"
            ],
            "createdAt": "2021-12-13T16:07:07.222Z",
            "modifiedAt": "2021-12-13T16:07:07.222Z"
        }
    ],
    "meta": {
        "total": 1
    }
}

---

- New endpoint

Creates a group of private applications to apply to policy. A maximum of 300 private application groups are allowed for an organization.

POST /organizations/{organizationId}/secureConnect/privateApplicationGroups

{
    "applicationGroupId": "1122321",
    "name": "Westcoast Data Center",
    "description": "Private applications in Westcoast Data Center",
    "applicationIds": [
        "183456",
        "123568"
    ],
    "createdAt": "2021-12-13T16:07:07.222Z",
    "modifiedAt": "2021-12-13T16:07:07.222Z"
}

---

Docs

Update an application group in an Organization

Operation ID: updateOrganizationSecureConnectPrivateApplicationGroup

PATH /organizations/{organizationId}/secureConnect/privateApplicationGroups/{id}

{
  "applicationGroupId": "1122321",
  "name": "Westcoast Data Center",
  "description": "Private applications in Westcoast Data Center",
  "applicationIds": [
    "183456",
    "123568"
  ],
  "createdAt": "2021-12-13T16:07:07.222Z",
  "modifiedAt": "2021-12-13T16:07:07.222Z"
}

- Path added

- New endpoint

Return the details of a specific private application group

GET /organizations/{organizationId}/secureConnect/privateApplicationGroups/{id}

{
    "applicationGroupId": "1122321",
    "name": "Westcoast Data Center",
    "description": "Private applications in Westcoast Data Center",
    "applicationIds": [
        "183456",
        "123568"
    ],
    "createdAt": "2021-12-13T16:07:07.222Z",
    "modifiedAt": "2021-12-13T16:07:07.222Z"
}

---

- New endpoint

Update an application group in an Organization. Updates are allowed on Group Name and Group Description. Applications can be added or removed. Group type and Policy cannot be changed.

PUT /organizations/{organizationId}/secureConnect/privateApplicationGroups/{id}

{
    "applicationGroupId": "1122321",
    "name": "Westcoast Data Center",
    "description": "Private applications in Westcoast Data Center",
    "applicationIds": [
        "183456",
        "123568"
    ],
    "createdAt": "2021-12-13T16:07:07.222Z",
    "modifiedAt": "2021-12-13T16:07:07.222Z"
}

---

- New endpoint

Deletes private application group from an Organization. Detaches application from groups before deleting

DELETE /organizations/{organizationId}/secureConnect/privateApplicationGroups/{id}

---

[ nac ]

sessions

Docs

List the NAC Sessions for this organization

Operation ID: getOrganizationNacSessionsHistory

PATH /organizations/{organizationId}/nac/sessions/history

{
  "items": [
    {
      "sessionId": "0677ba3c-a867-461d-97c9-e5b60066f2b3",
      "counts": {
        "events": {
          "total": 5
        }
      },
      "ts": "2023-02-01T11:36:25.480Z",
      "status": "Success",
      "details": "A policy for whose first matched rule will return its assigned authz profile",
      "user": {
        "id": "stress"
      },
      "client": {
        "id": "00-14-11-12-12-12:mab2"
      },
      "authentication": {
        "protocol": "MAB"
      },
      "ssid": {
        "name": ""
      },
      "device": {
        "id": "167231144861997",
        "serial": "Q3AC-J3V8-DWNP",
        "group": {
          "id": "167231144861998",
          "encryptedId": "OSYcyb2h",
          "localeName": "SJC-Test-Network"
        }
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 4,
        "byResult": [
          {
            "result": "Authentication Failed",
            "total": 120
          }
        ]
      }
    }
  }
}

- Path added

- New endpoint

List the NAC Sessions for this organization

GET /organizations/{organizationId}/nac/sessions/history

{
    "items": [
        {
            "sessionId": "0677ba3c-a867-461d-97c9-e5b60066f2b3",
            "counts": {
                "events": {
                    "total": 5
                }
            },
            "ts": "2023-02-01T11:36:25.480Z",
            "status": "Success",
            "details": "A policy for whose first matched rule will return its assigned authz profile",
            "user": {
                "id": "stress"
            },
            "client": {
                "id": "00-14-11-12-12-12:mab2"
            },
            "authentication": {
                "protocol": "MAB"
            },
            "ssid": {
                "name": ""
            },
            "device": {
                "id": "167231144861997",
                "serial": "Q3AC-J3V8-DWNP",
                "group": {
                    "id": "167231144861998",
                    "encryptedId": "OSYcyb2h",
                    "localeName": "SJC-Test-Network"
                }
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 4,
                "byResult": [
                    {
                        "result": "Authentication Failed",
                        "total": 120
                    }
                ]
            }
        }
    }
}

---

Docs

Return the details of selected NAC Sessions

Operation ID: getOrganizationNacSessionDetails

PATH /organizations/{organizationId}/nac/sessions/{sessionId}/details

{
  "sessionId": "e6b7d57b-1ddb-47f5-8d76-c06e10570297",
  "hasCompleteEvent": true,
  "ts": "2023-02-01T13:25:26.181Z",
  "status": "Success",
  "details": "",
  "counts": {
    "events": {
      "total": 5
    }
  },
  "user": {
    "id": "Device ID Username",
    "idp": "Active Directory",
    "groups": "ID group names"
  },
  "client": {
    "id": "2c:3f:0b:00:14:00",
    "addresses": [
      {
        "protocol": "ipv4",
        "address": "112.112.112.112"
      }
    ],
    "groups": "ID group names",
    "deviceProfiling": "Macbook Pro",
    "guid": "00-00-00-00-00-00"
  },
  "authentication": {
    "latency": 500,
    "method": "EAP-TLS",
    "protocol": "EAP",
    "policy": "Active Directory",
    "endpointCertificate": {
      "title": "Endpoint Certificate Name",
      "issuer": "Issuer's Name",
      "isExpired": false,
      "status": "Trusted",
      "subjectName": {
        "commonName": "hosuk",
        "organizationalUnit": "Example Unit",
        "organization": "Company Name",
        "locality": "City",
        "state": "State",
        "country": "US"
      },
      "issuerName": {
        "commonName": "Certificate Services Endpoint Sub CA - ise",
        "serial": "58 BA BA 47 4F 4B 58 BA BA 47 4F 4B 74 72",
        "version": "3",
        "signatureAlgorithm": "XXX",
        "parameters": "None",
        "validity": {
          "start": "2023-01-01T13:25:26.181Z",
          "end": "2024-01-01T13:25:26.181Z"
        }
      },
      "publicKey": {
        "algorithm": "XXX",
        "parameters": "XXX",
        "body": "XXX",
        "exponent": "XXX",
        "size": "XXX",
        "usage": "XXX",
        "signature": "XXX"
      },
      "directoryName": {
        "commonName": "XXX",
        "serial": "XXX"
      },
      "fingerprints": {
        "sha256": "XXX",
        "sha1": "XXX"
      },
      "extensions": [
        {
          "oid": "2.5.28.15",
          "name": "Key Usage",
          "fields": [
            {
              "name": "Critical",
              "value": "Yes"
            }
          ]
        }
      ]
    }
  },
  "authorization": {
    "rule": "Rule Name",
    "profile": "List all the profiles here"
  },
  "network": {
    "name": "Name",
    "accessType": "Wired",
    "ssid": {
      "name": "SSID"
    },
    "port": {
      "name": "Port"
    },
    "tags": "tag names"
  },
  "device": {
    "name": "Device model name",
    "model": "Device model name",
    "addresses": [
      {
        "protocol": "ipv4",
        "address": "100.10.100.10"
      }
    ],
    "tags": "tag names",
    "id": "167231144861997",
    "serial": "Q3AC-J3V8-DWNP",
    "group": {
      "id": "167231144861998",
      "encryptedId": "OSYcyb2h",
      "localeName": "SJC-Test-Network"
    }
  },
  "radius": {
    "attributes": {
      "incoming": [
        {
          "code": "1",
          "name": "Username",
          "value": "hosuk"
        }
      ],
      "outgoing": [
        {
          "code": "1",
          "name": "Username",
          "value": "hosuk"
        }
      ]
    }
  }
}

- Path added

- New endpoint

Return the details of selected NAC Sessions

GET /organizations/{organizationId}/nac/sessions/{sessionId}/details

{
    "sessionId": "e6b7d57b-1ddb-47f5-8d76-c06e10570297",
    "hasCompleteEvent": true,
    "ts": "2023-02-01T13:25:26.181Z",
    "status": "Success",
    "details": "",
    "counts": {
        "events": {
            "total": 5
        }
    },
    "user": {
        "id": "Device ID Username",
        "idp": "Active Directory",
        "groups": "ID group names"
    },
    "client": {
        "id": "2c:3f:0b:00:14:00",
        "addresses": [
            {
                "protocol": "ipv4",
                "address": "112.112.112.112"
            }
        ],
        "groups": "ID group names",
        "deviceProfiling": "Macbook Pro",
        "guid": "00-00-00-00-00-00"
    },
    "authentication": {
        "latency": 500,
        "method": "EAP-TLS",
        "protocol": "EAP",
        "policy": "Active Directory",
        "endpointCertificate": {
            "title": "Endpoint Certificate Name",
            "issuer": "Issuer's Name",
            "isExpired": false,
            "status": "Trusted",
            "subjectName": {
                "commonName": "hosuk",
                "organizationalUnit": "Example Unit",
                "organization": "Company Name",
                "locality": "City",
                "state": "State",
                "country": "US"
            },
            "issuerName": {
                "commonName": "Certificate Services Endpoint Sub CA - ise",
                "serial": "58 BA BA 47 4F 4B 58 BA BA 47 4F 4B 74 72",
                "version": "3",
                "signatureAlgorithm": "XXX",
                "parameters": "None",
                "validity": {
                    "start": "2023-01-01T13:25:26.181Z",
                    "end": "2024-01-01T13:25:26.181Z"
                }
            },
            "publicKey": {
                "algorithm": "XXX",
                "parameters": "XXX",
                "body": "XXX",
                "exponent": "XXX",
                "size": "XXX",
                "usage": "XXX",
                "signature": "XXX"
            },
            "directoryName": {
                "commonName": "XXX",
                "serial": "XXX"
            },
            "fingerprints": {
                "sha256": "XXX",
                "sha1": "XXX"
            },
            "extensions": [
                {
                    "oid": "2.5.28.15",
                    "name": "Key Usage",
                    "fields": [
                        {
                            "name": "Critical",
                            "value": "Yes"
                        }
                    ]
                }
            ]
        }
    },
    "authorization": {
        "rule": "Rule Name",
        "profile": "List all the profiles here"
    },
    "network": {
        "name": "Name",
        "accessType": "Wired",
        "ssid": {
            "name": "SSID"
        },
        "port": {
            "name": "Port"
        },
        "tags": "tag names"
    },
    "device": {
        "name": "Device model name",
        "model": "Device model name",
        "addresses": [
            {
                "protocol": "ipv4",
                "address": "100.10.100.10"
            }
        ],
        "tags": "tag names",
        "id": "167231144861997",
        "serial": "Q3AC-J3V8-DWNP",
        "group": {
            "id": "167231144861998",
            "encryptedId": "OSYcyb2h",
            "localeName": "SJC-Test-Network"
        }
    },
    "radius": {
        "attributes": {
            "incoming": [
                {
                    "code": "1",
                    "name": "Username",
                    "value": "hosuk"
                }
            ],
            "outgoing": [
                {
                    "code": "1",
                    "name": "Username",
                    "value": "hosuk"
                }
            ]
        }
    }
}

---

license

Docs

Returns license usage data for a specific organization

Operation ID: getOrganizationNacLicenseUsage

PATH /organizations/{organizationId}/nac/license/usage

{
  "organizationId": "1284392014819",
  "type": "CoTerm",
  "timeRange": {
    "startDate": "2025-05-13",
    "endDate": "2025-07-11"
  },
  "licenseLimit": 100,
  "usageData": [
    {
      "date": "2025-08-21",
      "peakConcurrentSessions": 100
    }
  ],
  "summary": {
    "daysInPeriod": 60,
    "highestPeakConcurrentSessions": 145,
    "p90PeakConcurrentSessions": 120.5,
    "p95PeakConcurrentSessions": 135.2
  }
}

- Path added

- New endpoint

Returns license usage data for a specific organization

GET /organizations/{organizationId}/nac/license/usage

{
    "organizationId": "1284392014819",
    "type": "CoTerm",
    "timeRange": {
        "startDate": "2025-05-13",
        "endDate": "2025-07-11"
    },
    "licenseLimit": 100,
    "usageData": [
        {
            "date": "2025-08-21",
            "peakConcurrentSessions": 100
        }
    ],
    "summary": {
        "daysInPeriod": 60,
        "highestPeakConcurrentSessions": 145,
        "p90PeakConcurrentSessions": 120.5,
        "p95PeakConcurrentSessions": 135.2
    }
}

---

authorization

Docs

Get all nac authorization policies for this organization

Operation ID: getOrganizationNacAuthorizationPolicies

PATH /organizations/{organizationId}/nac/authorization/policies

[
  {
    "policyId": "1",
    "name": "auth_policy",
    "enabled": true,
    "rank": 5,
    "version": "20",
    "counts": {
      "hits": 10
    },
    "rules": [
      {
        "ruleId": "1",
        "name": "rule_name",
        "rank": 10,
        "enabled": true,
        "counts": {
          "hits": 20
        },
        "authorizationProfile": {
          "vlan": {
            "value": "123",
            "type": "Constant"
          },
          "adaptivePolicy": {
            "value": "Sample_Adaptive_Policy",
            "type": "Constant"
          },
          "voiceDomain": {
            "value": "true",
            "type": "Constant"
          },
          "groupPolicy": {
            "value": "Sample_Group_Policy",
            "type": "Constant"
          },
          "result": "PERMIT",
          "ipsk": {
            "value": "Moon@15",
            "type": "Moon@15"
          }
        }
      }
    ],
    "hasOutdatedCondition": false,
    "conditionTags": [
      "Client certificates: Issuer - Common Name = spa.meraki.com",
      "Networks: Network Name = Dev Test Network"
    ]
  }
]

- Path added

- New endpoint

Get all nac authorization policies for this organization

GET /organizations/{organizationId}/nac/authorization/policies

[
    {
        "policyId": "1",
        "name": "auth_policy",
        "enabled": true,
        "rank": 5,
        "version": "20",
        "counts": {
            "hits": 10
        },
        "rules": [
            {
                "ruleId": "1",
                "name": "rule_name",
                "rank": 10,
                "enabled": true,
                "counts": {
                    "hits": 20
                },
                "authorizationProfile": {
                    "vlan": {
                        "value": "123",
                        "type": "Constant"
                    },
                    "adaptivePolicy": {
                        "value": "Sample_Adaptive_Policy",
                        "type": "Constant"
                    },
                    "voiceDomain": {
                        "value": "true",
                        "type": "Constant"
                    },
                    "groupPolicy": {
                        "value": "Sample_Group_Policy",
                        "type": "Constant"
                    },
                    "result": "PERMIT",
                    "ipsk": {
                        "value": "Moon@15",
                        "type": "Moon@15"
                    }
                }
            }
        ],
        "hasOutdatedCondition": false,
        "conditionTags": [
            "Client certificates: Issuer - Common Name = spa.meraki.com",
            "Networks: Network Name = Dev Test Network"
        ]
    }
]

---

[ users ]

iam

Docs

List specific authorizations for the list of Meraki end users.

Operation ID: getOrganizationIamUsersAuthorizations

PATH /organizations/{organizationId}/iam/users/authorizations

{
  "items": [
    {
      "authorizationId": "1284392014819",
      "idpUserId": "1284392014819",
      "expiresAt": "2018-02-11T00:00:00Z",
      "startsAt": "2018-05-12T00:00:00Z",
      "selfRegistered": false,
      "status": "authorized",
      "authZone": {
        "id": "1284392014819",
        "name": "SFO"
      },
      "authorizer": {
        "name": "John Doe"
      },
      "createdAt": "2018-02-11T00:00:00Z",
      "lastUpdatedAt": "2018-05-12T00:00:00Z"
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

List specific authorizations for the list of Meraki end users.

GET /organizations/{organizationId}/iam/users/authorizations

{
    "items": [
        {
            "authorizationId": "1284392014819",
            "idpUserId": "1284392014819",
            "expiresAt": "2018-02-11T00:00:00Z",
            "startsAt": "2018-05-12T00:00:00Z",
            "selfRegistered": false,
            "status": "authorized",
            "authZone": {
                "id": "1284392014819",
                "name": "SFO"
            },
            "authorizer": {
                "name": "John Doe"
            },
            "createdAt": "2018-02-11T00:00:00Z",
            "lastUpdatedAt": "2018-05-12T00:00:00Z"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

- New endpoint

Authorize a Meraki end user for an auth zone.

POST /organizations/{organizationId}/iam/users/authorizations

{
    "authorizationId": "1284392014819",
    "idpUserId": "1284392014819",
    "expiresAt": "2018-02-11T00:00:00Z",
    "startsAt": "2018-05-12T00:00:00Z",
    "selfRegistered": false,
    "status": "authorized",
    "authZone": {
        "id": "1284392014819",
        "name": "SFO"
    },
    "authorizer": {
        "name": "John Doe"
    },
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

---

- New endpoint

Update a Meraki end user's access to an auth zone.

PUT /organizations/{organizationId}/iam/users/authorizations

{
    "authorizationId": "1284392014819",
    "idpUserId": "1284392014819",
    "expiresAt": "2018-02-11T00:00:00Z",
    "startsAt": "2018-05-12T00:00:00Z",
    "selfRegistered": false,
    "status": "authorized",
    "authZone": {
        "id": "1284392014819",
        "name": "SFO"
    },
    "authorizer": {
        "name": "John Doe"
    },
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

---

Docs

Revoke a Meraki end user's access to an auth zone.

Operation ID: revokeOrganizationIamUsersAuthorizationsAuthorization

PATH /organizations/{organizationId}/iam/users/authorizations/authorization/revoke

- Path added

- New endpoint

Revoke a Meraki end user's access to an auth zone.

POST /organizations/{organizationId}/iam/users/authorizations/authorization/revoke

---

Docs

List all of the available auth zones for an organization.

Operation ID: getOrganizationIamUsersAuthorizationsZones

PATH /organizations/{organizationId}/iam/users/authorizations/zones

{
  "items": [
    {
      "zoneId": "1284392014819",
      "name": "Main Office",
      "type": "Client VPN"
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

List all of the available auth zones for an organization.

GET /organizations/{organizationId}/iam/users/authorizations/zones

{
    "items": [
        {
            "zoneId": "1284392014819",
            "name": "Main Office",
            "type": "Client VPN"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

Docs

Delete an authorization for a Meraki end user.

Operation ID: deleteOrganizationIamUsersAuthorization

PATH /organizations/{organizationId}/iam/users/authorizations/{authorizationId}

- Path added

- New endpoint

Delete an authorization for a Meraki end user.

DELETE /organizations/{organizationId}/iam/users/authorizations/{authorizationId}

---

Docs

Create an identity provider for an organization

Operation ID: createOrganizationIamUsersIdp

PATH /organizations/{organizationId}/iam/users/idps

{
  "idpId": "1284392014819",
  "name": "My Entra ID",
  "description": "Some description",
  "type": "Azure AD",
  "syncable": true,
  "syncType": "proactive",
  "createdAt": "2018-02-11T00:00:00Z",
  "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

- Path added

- New endpoint

Create an identity provider for an organization. Only Entra ID(Azure AD) is supported at this time.

POST /organizations/{organizationId}/iam/users/idps

{
    "idpId": "1284392014819",
    "name": "My Entra ID",
    "description": "Some description",
    "type": "Azure AD",
    "syncable": true,
    "syncType": "proactive",
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

---

Docs

Search all IdP groups for an organization

Operation ID: searchOrganizationIdpGroups

PATH /organizations/{organizationId}/iam/users/idps/groups/search

{
  "items": [
    {
      "groupId": "1284392014819",
      "idpId": "1284392014819",
      "name": "sample idp group",
      "externalId": "f5a28b7d-e41c-41a2-8b0f-244a4123c5d7",
      "metadata": {
        "someKey": "value"
      },
      "idp": {
        "id": "1284392014819",
        "name": "Azure AD IdP",
        "type": "Azure AD"
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

Search all IdP groups for an organization. Filter by IdP IDs and Auth Zone. Parameters are assembled as an AND query.

POST /organizations/{organizationId}/iam/users/idps/groups/search

{
    "items": [
        {
            "groupId": "1284392014819",
            "idpId": "1284392014819",
            "name": "sample idp group",
            "externalId": "f5a28b7d-e41c-41a2-8b0f-244a4123c5d7",
            "metadata": {
                "someKey": "value"
            },
            "idp": {
                "id": "1284392014819",
                "name": "Azure AD IdP",
                "type": "Azure AD"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

Docs

List all available IdP Product Integration urls for the organization

Operation ID: getOrganizationIamUsersIdpsProductIntegrations

PATH /organizations/{organizationId}/iam/users/idps/productIntegrations

[
  {
    "productIntegrationId": "access_manager",
    "name": "Access Manager",
    "description": "Use this IdP in your policies to control access to your resources.",
    "url": ""
  }
]

- Path added

- New endpoint

List all available IdP Product Integration urls for the organization

GET /organizations/{organizationId}/iam/users/idps/productIntegrations

[
    {
        "productIntegrationId": "access_manager",
        "name": "Access Manager",
        "description": "Use this IdP in your policies to control access to your resources.",
        "url": ""
    }
]

---

Docs

Search all IdPs for an organization

Operation ID: createOrganizationIamUsersIdpsSearch

PATH /organizations/{organizationId}/iam/users/idps/search

{
  "items": [
    {
      "idpId": "1284392014819",
      "name": "My Entra ID",
      "description": "Some description",
      "type": "Azure AD",
      "syncable": true,
      "syncType": "proactive",
      "createdAt": "2018-02-11T00:00:00Z",
      "lastUpdatedAt": "2018-05-12T00:00:00Z"
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

Search all IdPs for an organization. Filter by IdP ID, IdP type, and Auth Zone. Parameters are assembled as an AND query.

POST /organizations/{organizationId}/iam/users/idps/search

{
    "items": [
        {
            "idpId": "1284392014819",
            "name": "My Entra ID",
            "description": "Some description",
            "type": "Azure AD",
            "syncable": true,
            "syncType": "proactive",
            "createdAt": "2018-02-11T00:00:00Z",
            "lastUpdatedAt": "2018-05-12T00:00:00Z"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

Docs

Get the IdP sync status records for an organization

Operation ID: getOrganizationIamUsersIdpsSyncHistory

PATH /organizations/{organizationId}/iam/users/idps/sync/history

{
  "items": [
    {
      "idpSyncId": "1284392014819",
      "idpId": "1284392014819",
      "status": "In Progress",
      "message": "sync was queued 10 minutes",
      "createdAt": "2018-02-11T00:00:00Z",
      "lastUpdatedAt": "2018-05-12T00:00:00Z"
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

Get the IdP sync status records for an organization. Only Entra ID(Azure AD) is supported at this time.

GET /organizations/{organizationId}/iam/users/idps/sync/history

{
    "items": [
        {
            "idpSyncId": "1284392014819",
            "idpId": "1284392014819",
            "status": "In Progress",
            "message": "sync was queued 10 minutes",
            "createdAt": "2018-02-11T00:00:00Z",
            "lastUpdatedAt": "2018-05-12T00:00:00Z"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

Docs

Get the latest IdP sync status records for all IdPs in an organization

Operation ID: getOrganizationIamUsersIdpsSyncLatest

PATH /organizations/{organizationId}/iam/users/idps/sync/latest

{
  "items": [
    {
      "idpSyncId": "1284392014819",
      "idpId": "1284392014819",
      "status": "In Progress",
      "message": "sync was queued 10 minutes",
      "syncedBy": "api",
      "createdAt": "2018-02-11T00:00:00Z",
      "lastUpdatedAt": "2018-05-12T00:00:00Z"
    }
  ]
}

- Path added

- New endpoint

Get the latest IdP sync status records for all IdPs in an organization. Only Entra ID(Azure AD) is supported at this time.

GET /organizations/{organizationId}/iam/users/idps/sync/latest

{
    "items": [
        {
            "idpSyncId": "1284392014819",
            "idpId": "1284392014819",
            "status": "In Progress",
            "message": "sync was queued 10 minutes",
            "syncedBy": "api",
            "createdAt": "2018-02-11T00:00:00Z",
            "lastUpdatedAt": "2018-05-12T00:00:00Z"
        }
    ]
}

---

Docs

Test connectivity to an Entra ID identity provider.

Operation ID: createOrganizationIamUsersIdpsTestConnectivity

PATH /organizations/{organizationId}/iam/users/idps/testConnectivity

{
  "result": "failure",
  "errors": [
    {
      "code": "AADSTS7000215",
      "message": "Invalid client secret provided."
    }
  ]
}

- Path added

- New endpoint

Test connectivity to an Entra ID identity provider.

POST /organizations/{organizationId}/iam/users/idps/testConnectivity

{
    "result": "failure",
    "errors": [
        {
            "code": "AADSTS7000215",
            "message": "Invalid client secret provided."
        }
    ]
}

---

Docs

Create a Meraki user

Operation ID: createOrganizationIamUsersIdpsUser

PATH /organizations/{organizationId}/iam/users/idps/users

{
  "idpUserId": "1284392014819",
  "idp": {
    "id": "1284392014819",
    "name": "Azure AD IdP",
    "type": "azure_ad"
  },
  "upn": "mdavis@meraki.com",
  "displayName": "Miles Davis",
  "externalId": "azure AD Id",
  "accessTypes": [
    "Wireless",
    "Client VPN"
  ],
  "createdAt": "2018-02-11T00:00:00Z",
  "lastUpdatedAt": "2018-05-12T00:00:00Z",
  "groups": [
    {
      "id": "1",
      "name": "Group name"
    }
  ]
}

- Path added

- New endpoint

Create a Meraki user

POST /organizations/{organizationId}/iam/users/idps/users

{
    "idpUserId": "1284392014819",
    "idp": {
        "id": "1284392014819",
        "name": "Azure AD IdP",
        "type": "azure_ad"
    },
    "upn": "mdavis@meraki.com",
    "displayName": "Miles Davis",
    "externalId": "azure AD Id",
    "accessTypes": [
        "Wireless",
        "Client VPN"
    ],
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z",
    "groups": [
        {
            "id": "1",
            "name": "Group name"
        }
    ]
}

---

Docs

Update a Meraki user

Operation ID: updateOrganizationIamUsersIdpsUser

PATH /organizations/{organizationId}/iam/users/idps/users/{id}

{
  "idpUserId": "1284392014819",
  "idp": {
    "id": "1284392014819",
    "name": "Azure AD IdP",
    "type": "azure_ad"
  },
  "upn": "mdavis@meraki.com",
  "displayName": "Miles Davis",
  "externalId": "azure AD Id",
  "accessTypes": [
    "Wireless",
    "Client VPN"
  ],
  "createdAt": "2018-02-11T00:00:00Z",
  "lastUpdatedAt": "2018-05-12T00:00:00Z",
  "groups": [
    {
      "id": "1",
      "name": "Group name"
    }
  ]
}

- Path added

- New endpoint

Update a Meraki user

PUT /organizations/{organizationId}/iam/users/idps/users/{id}

{
    "idpUserId": "1284392014819",
    "idp": {
        "id": "1284392014819",
        "name": "Azure AD IdP",
        "type": "azure_ad"
    },
    "upn": "mdavis@meraki.com",
    "displayName": "Miles Davis",
    "externalId": "azure AD Id",
    "accessTypes": [
        "Wireless",
        "Client VPN"
    ],
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z",
    "groups": [
        {
            "id": "1",
            "name": "Group name"
        }
    ]
}

---

- New endpoint

Delete a Meraki end user

DELETE /organizations/{organizationId}/iam/users/idps/users/{id}

---

Docs

Trigger an IdP sync for an identity provider

Operation ID: createOrganizationIamUsersIdpSync

PATH /organizations/{organizationId}/iam/users/idps/{idpId}/sync

{
  "idpSyncId": "1284392014819",
  "idpId": "1284392014819",
  "status": "In Progress",
  "message": "sync was queued 10 minutes",
  "syncedBy": "api",
  "createdAt": "2018-02-11T00:00:00Z",
  "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

- Path added

- New endpoint

Trigger an IdP sync for an identity provider. Only Entra ID(Azure AD) is supported at this time.

POST /organizations/{organizationId}/iam/users/idps/{idpId}/sync

{
    "idpSyncId": "1284392014819",
    "idpId": "1284392014819",
    "status": "In Progress",
    "message": "sync was queued 10 minutes",
    "syncedBy": "api",
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

---

Docs

Get the latest IdP sync status for an identity provider

Operation ID: getOrganizationIamUsersIdpSyncLatest

PATH /organizations/{organizationId}/iam/users/idps/{idpId}/sync/latest

{
  "idpSyncId": "1284392014819",
  "status": "In Progress",
  "message": "sync was queued 10 minutes",
  "createdAt": "2018-02-11T00:00:00Z",
  "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

- Path added

- New endpoint

Get the latest IdP sync status for an identity provider. Only Entra ID(Azure AD) is supported at this time.

GET /organizations/{organizationId}/iam/users/idps/{idpId}/sync/latest

{
    "idpSyncId": "1284392014819",
    "status": "In Progress",
    "message": "sync was queued 10 minutes",
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

---

Docs

Update an identity provider

Operation ID: updateOrganizationIamUsersIdp

PATH /organizations/{organizationId}/iam/users/idps/{id}

{
  "idpId": "1284392014819",
  "name": "My Entra ID",
  "description": "Some description",
  "type": "Azure AD",
  "syncable": true,
  "syncType": "proactive",
  "createdAt": "2018-02-11T00:00:00Z",
  "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

- Path added

- New endpoint

Update an identity provider. Only Entra ID(Azure AD) is supported at this time.

PUT /organizations/{organizationId}/iam/users/idps/{id}

{
    "idpId": "1284392014819",
    "name": "My Entra ID",
    "description": "Some description",
    "type": "Azure AD",
    "syncable": true,
    "syncType": "proactive",
    "createdAt": "2018-02-11T00:00:00Z",
    "lastUpdatedAt": "2018-05-12T00:00:00Z"
}

---

- New endpoint

Delete a identity provider from an organization. Only Entra ID(Azure AD) is supported at this time.

DELETE /organizations/{organizationId}/iam/users/idps/{id}

---

Docs

List all auth zones for an identity provider

Operation ID: getOrganizationIamUsersIdpAuthZones

PATH /organizations/{organizationId}/iam/users/idps/{id}/authZones

{
  "items": [
    {
      "id": "1284392014819",
      "name": "Main Office",
      "type": "node_group"
    }
  ]
}

- Path added

- New endpoint

List all auth zones for an identity provider

GET /organizations/{organizationId}/iam/users/idps/{id}/authZones

{
    "items": [
        {
            "id": "1284392014819",
            "name": "Main Office",
            "type": "node_group"
        }
    ]
}

---

Docs

List the end users and their associated identity providers for an organization.

Operation ID: searchOrganizationUsers

PATH /organizations/{organizationId}/iam/users/search

{
  "items": [
    {
      "userId": "1284392014819",
      "upn": "mdavis@meraki.com",
      "idpUsers": [
        {
          "id": "1284392014819",
          "idp": {
            "id": "1284392014819",
            "name": "Azure AD IdP",
            "type": "Azure AD"
          },
          "displayName": "Miles Davis",
          "email": "mdavis@meraki.com",
          "username": "mdavis",
          "externalId": "external-Id",
          "createdAt": "2018-02-11T00:00:00Z",
          "lastUpdatedAt": "2018-05-12T00:00:00Z",
          "groups": [
            {
              "id": "1",
              "name": "Group name"
            }
          ],
          "accessTypes": [
            "Wireless",
            "Client VPN"
          ]
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

List the end users and their associated identity providers for an organization.

POST /organizations/{organizationId}/iam/users/search

{
    "items": [
        {
            "userId": "1284392014819",
            "upn": "mdavis@meraki.com",
            "idpUsers": [
                {
                    "id": "1284392014819",
                    "idp": {
                        "id": "1284392014819",
                        "name": "Azure AD IdP",
                        "type": "Azure AD"
                    },
                    "displayName": "Miles Davis",
                    "email": "mdavis@meraki.com",
                    "username": "mdavis",
                    "externalId": "external-Id",
                    "createdAt": "2018-02-11T00:00:00Z",
                    "lastUpdatedAt": "2018-05-12T00:00:00Z",
                    "groups": [
                        {
                            "id": "1",
                            "name": "Group name"
                        }
                    ],
                    "accessTypes": [
                        "Wireless",
                        "Client VPN"
                    ]
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

Docs

Get the count of users and user groups for an organization.

Operation ID: getOrganizationIamUsersSummaryPanel

PATH /organizations/{organizationId}/iam/users/summaryPanel

{
  "userCount": 100,
  "userGroupCount": 10
}

- Path added

- New endpoint

Get the count of users and user groups for an organization.

GET /organizations/{organizationId}/iam/users/summaryPanel

{
    "userCount": 100,
    "userGroupCount": 10
}

---

[ camera ]

videoWalls

Docs

Create a new video wall.

Operation ID: createNetworkCameraVideoWall

PATH /networks/{networkId}/camera/videoWalls

{
  "id": "1284392014819",
  "name": "Building-A",
  "index": 0,
  "tiles": [
    {
      "id": "1284392014819",
      "serial": "Q234-ABCD-5678",
      "x": 1,
      "y": 1,
      "width": 2,
      "height": 1,
      "theta": 3.14,
      "phi": 1.2,
      "imagerId": 1
    }
  ]
}

- Path added

- New endpoint

Create a new video wall.

POST /networks/{networkId}/camera/videoWalls

{
    "id": "1284392014819",
    "name": "Building-A",
    "index": 0,
    "tiles": [
        {
            "id": "1284392014819",
            "serial": "Q234-ABCD-5678",
            "x": 1,
            "y": 1,
            "width": 2,
            "height": 1,
            "theta": 3.14,
            "phi": 1.2,
            "imagerId": 1
        }
    ]
}

---

Docs

Update the specified video wall.

Operation ID: updateNetworkCameraVideoWall

PATH /networks/{networkId}/camera/videoWalls/{id}

{
  "id": "1284392014819",
  "name": "Building-A",
  "index": 0,
  "tiles": [
    {
      "id": "1284392014819",
      "serial": "Q234-ABCD-5678",
      "x": 1,
      "y": 1,
      "width": 2,
      "height": 1,
      "theta": 3.14,
      "phi": 1.2,
      "imagerId": 1
    }
  ]
}

- Path added

- New endpoint

Update the specified video wall.

PUT /networks/{networkId}/camera/videoWalls/{id}

{
    "id": "1284392014819",
    "name": "Building-A",
    "index": 0,
    "tiles": [
        {
            "id": "1284392014819",
            "serial": "Q234-ABCD-5678",
            "x": 1,
            "y": 1,
            "width": 2,
            "height": 1,
            "theta": 3.14,
            "phi": 1.2,
            "imagerId": 1
        }
    ]
}

---

- New endpoint

Delete the specified video wall.

DELETE /networks/{networkId}/camera/videoWalls/{id}

---

Docs

Return a list of video walls.

Operation ID: getOrganizationCameraVideoWalls

PATH /organizations/{organizationId}/camera/videoWalls

[
  {
    "id": "1284392014819",
    "name": "Building-A",
    "index": 0,
    "tiles": [
      {
        "id": "1284392014819",
        "serial": "Q234-ABCD-5678",
        "x": 1,
        "y": 1,
        "width": 2,
        "height": 1,
        "theta": 3.14,
        "phi": 1.2,
        "imagerId": 1
      }
    ]
  }
]

- Path added

- New endpoint

Return a list of video walls.

GET /organizations/{organizationId}/camera/videoWalls

[
    {
        "id": "1284392014819",
        "name": "Building-A",
        "index": 0,
        "tiles": [
            {
                "id": "1284392014819",
                "serial": "Q234-ABCD-5678",
                "x": 1,
                "y": 1,
                "width": 2,
                "height": 1,
                "theta": 3.14,
                "phi": 1.2,
                "imagerId": 1
            }
        ]
    }
]

---

Docs

Return the specified video wall.

Operation ID: getOrganizationCameraVideoWall

PATH /organizations/{organizationId}/camera/videoWalls/{id}

{
  "id": "1284392014819",
  "name": "Building-A",
  "index": 0,
  "tiles": [
    {
      "id": "1284392014819",
      "serial": "Q234-ABCD-5678",
      "x": 1,
      "y": 1,
      "width": 2,
      "height": 1,
      "theta": 3.14,
      "phi": 1.2,
      "imagerId": 1
    }
  ]
}

- Path added

- New endpoint

Return the specified video wall.

GET /organizations/{organizationId}/camera/videoWalls/{id}

{
    "id": "1284392014819",
    "name": "Building-A",
    "index": 0,
    "tiles": [
        {
            "id": "1284392014819",
            "serial": "Q234-ABCD-5678",
            "x": 1,
            "y": 1,
            "width": 2,
            "height": 1,
            "theta": 3.14,
            "phi": 1.2,
            "imagerId": 1
        }
    ]
}

---

Docs

Returns video wall link to the specified video wall id

Operation ID: getOrganizationCameraVideoWallVideoLink

PATH /organizations/{organizationId}/camera/videoWalls/{id}/videoLink

[
  {
    "url": "https://nxx.meraki.com/office-cameras/n/bs0a1k/manage/video/video_wall/75290?timestamp=1535732570077",
    "visionUrl": "https://vision.meraki.com/n/6482158978508419/cameras/29048243992402?ts=1535732570077"
  }
]

- Path added

- New endpoint

Returns video wall link to the specified video wall id. If a timestamp is supplied, it links to that timestamp.

GET /organizations/{organizationId}/camera/videoWalls/{id}/videoLink

[
    {
        "url": "https://nxx.meraki.com/office-cameras/n/bs0a1k/manage/video/video_wall/75290?timestamp=1535732570077",
        "visionUrl": "https://vision.meraki.com/n/6482158978508419/cameras/29048243992402?ts=1535732570077"
    }
]

---

devices

Docs

Lists all the capabilities of cameras in this organization

Operation ID: getOrganizationCameraDevicesConfigurations

PATH /organizations/{organizationId}/camera/devices/configurations

[
  {
    "serial": "QWDE-OIJU-HIDB",
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    },
    "model": "MV63-HW",
    "category": "outdoor",
    "audio": {
      "isConfigurable": true,
      "enabled": true
    },
    "lens": {
      "isFisheye": true,
      "zoom": {
        "isConfigurable": true,
        "maximum": 100,
        "minimum": 0,
        "value": 65
      },
      "aperture": {
        "isConfigurable": true,
        "maximum": 100,
        "minimum": 0,
        "value": 65
      },
      "focus": {
        "isConfigurable": true,
        "maximum": 100,
        "minimum": 0,
        "value": 65
      }
    },
    "hdr": {
      "isConfigurable": true,
      "enabled": true
    },
    "sensorCrop": {
      "isConfigurable": true,
      "cropX": 0,
      "cropY": 0,
      "cropW": 0,
      "cropH": 0
    },
    "searchModels": [
      {
        "name": "Body/Vehicle",
        "enabled": true
      }
    ],
    "cloudArchive": {
      "isConfigurable": true,
      "enabled": true,
      "retentionDays": 90
    }
  }
]

- Path added

- New endpoint

Lists all the capabilities of cameras in this organization

GET /organizations/{organizationId}/camera/devices/configurations

[
    {
        "serial": "QWDE-OIJU-HIDB",
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        },
        "model": "MV63-HW",
        "category": "outdoor",
        "audio": {
            "isConfigurable": true,
            "enabled": true
        },
        "lens": {
            "isFisheye": true,
            "zoom": {
                "isConfigurable": true,
                "maximum": 100,
                "minimum": 0,
                "value": 65
            },
            "aperture": {
                "isConfigurable": true,
                "maximum": 100,
                "minimum": 0,
                "value": 65
            },
            "focus": {
                "isConfigurable": true,
                "maximum": 100,
                "minimum": 0,
                "value": 65
            }
        },
        "hdr": {
            "isConfigurable": true,
            "enabled": true
        },
        "sensorCrop": {
            "isConfigurable": true,
            "cropX": 0,
            "cropY": 0,
            "cropW": 0,
            "cropH": 0
        },
        "searchModels": [
            {
                "name": "Body/Vehicle",
                "enabled": true
            }
        ],
        "cloudArchive": {
            "isConfigurable": true,
            "enabled": true,
            "retentionDays": 90
        }
    }
]

---

[ devices ]

vrrpTable

Docs

Enqueue a job to perform a VRRP table request for the device

Operation ID: createDeviceLiveToolsVrrpTable

PATH /devices/{serial}/liveTools/vrrpTable

{
  "vrrpTableId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/vrrpTable/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to perform a VRRP table request for the device. This endpoint currently supports Catalyst switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/vrrpTable

{
    "vrrpTableId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/vrrpTable/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return an VRRP table live tool job.

Operation ID: getDeviceLiveToolsVrrpTable

PATH /devices/{serial}/liveTools/vrrpTable/{vrrpTableId}

{
  "vrrpTableId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/vrrpTable/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "entries": [
    {
      "group": 123,
      "protocol": "ipv4",
      "addresses": {
        "virtual": "10.0.0.1",
        "primary": "10.0.0.2"
      },
      "vlanId": 100,
      "priority": 100,
      "preemption": {
        "enabled": true
      },
      "status": {
        "value": "primary",
        "description": "Indicates that the virtual router is forwarding packets for IP addresses that are associated with this router",
        "primaryReason": {
          "value": "priority",
          "description": "Won the primary election due to higher priority"
        },
        "lastChange": {
          "ts": "2018-02-11T00:00:00.090210Z",
          "reason": {
            "value": "priority",
            "description": "Elected primary due to higher priority"
          }
        }
      }
    }
  ],
  "error": "The device is unreachable."
}

- Path added

- New endpoint

Return an VRRP table live tool job.

GET /devices/{serial}/liveTools/vrrpTable/{vrrpTableId}

{
    "vrrpTableId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/vrrpTable/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "entries": [
        {
            "group": 123,
            "protocol": "ipv4",
            "addresses": {
                "virtual": "10.0.0.1",
                "primary": "10.0.0.2"
            },
            "vlanId": 100,
            "priority": 100,
            "preemption": {
                "enabled": true
            },
            "status": {
                "value": "primary",
                "description": "Indicates that the virtual router is forwarding packets for IP addresses that are associated with this router",
                "primaryReason": {
                    "value": "priority",
                    "description": "Won the primary election due to higher priority"
                },
                "lastChange": {
                    "ts": "2018-02-11T00:00:00.090210Z",
                    "reason": {
                        "value": "priority",
                        "description": "Elected primary due to higher priority"
                    }
                }
            }
        }
    ],
    "error": "The device is unreachable."
}

---

traceRoute

Docs

Enqueue a job to run trace route in the device

Operation ID: createDeviceLiveToolsTraceRoute

PATH /devices/{serial}/liveTools/traceRoute

{
  "traceRouteId": "123",
  "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/traceroute/123",
  "request": {
    "serial": "Q234-ABCD-5678",
    "target": "www.cisco.com",
    "sourceInterface": "100.100.0.1"
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to run trace route in the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/traceRoute

{
    "traceRouteId": "123",
    "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/traceroute/123",
    "request": {
        "serial": "Q234-ABCD-5678",
        "target": "www.cisco.com",
        "sourceInterface": "100.100.0.1"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return a trace route job

Operation ID: getDeviceLiveToolsTraceRoute

PATH /devices/{serial}/liveTools/traceRoute/{traceRouteId}

{
  "traceRouteId": "123",
  "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/traceroute/123",
  "request": {
    "serial": "Q234-ABCD-5678",
    "target": "www.cisco.com",
    "sourceInterface": "100.100.0.1"
  },
  "status": "complete",
  "results": [
    {
      "hop": 0,
      "ip": "100.100.0.1",
      "rttAvg": 0.00005,
      "count": 3
    }
  ],
  "error": "The device is unreachable."
}

- Path added

- New endpoint

Return a trace route job

GET /devices/{serial}/liveTools/traceRoute/{traceRouteId}

{
    "traceRouteId": "123",
    "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/traceroute/123",
    "request": {
        "serial": "Q234-ABCD-5678",
        "target": "www.cisco.com",
        "sourceInterface": "100.100.0.1"
    },
    "status": "complete",
    "results": [
        {
            "hop": 0,
            "ip": "100.100.0.1",
            "rttAvg": 0.00005,
            "count": 3
        }
    ],
    "error": "The device is unreachable."
}

---

speedTest

Docs

Enqueue a job to execute a speed test from a device

Operation ID: createDeviceLiveToolsSpeedTest

PATH /devices/{serial}/liveTools/speedTest

{
  "speedTestId": "1284392014819",
  "url": "/devices/SERIAL/liveTools/speedTest/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678",
    "interface": "wan1"
  },
  "status": "complete",
  "results": {
    "speeds": {
      "average": 123.45
    }
  }
}

- Path added

- New endpoint

Enqueue a job to execute a speed test from a device

POST /devices/{serial}/liveTools/speedTest

{
    "speedTestId": "1284392014819",
    "url": "/devices/SERIAL/liveTools/speedTest/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "interface": "wan1"
    },
    "status": "complete",
    "results": {
        "speeds": {
            "average": 123.45
        }
    }
}

---

Docs

Returns a speed test result in megabits per second

Operation ID: getDeviceLiveToolsSpeedTest

PATH /devices/{serial}/liveTools/speedTest/{id}

{
  "speedTestId": "1284392014819",
  "url": "/devices/SERIAL/liveTools/speedTest/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678",
    "interface": "wan1"
  },
  "status": "complete",
  "results": {
    "speeds": {
      "average": 123.45
    }
  }
}

- Path added

- New endpoint

Returns a speed test result in megabits per second. If test is not complete, no results are present.

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

{
    "speedTestId": "1284392014819",
    "url": "/devices/SERIAL/liveTools/speedTest/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "interface": "wan1"
    },
    "status": "complete",
    "results": {
        "speeds": {
            "average": 123.45
        }
    }
}

---

routingTable

Docs

Enqueue a job to perform a routing table request for the device

Operation ID: createDeviceLiveToolsRoutingTable

PATH /devices/{serial}/liveTools/routingTable

{
  "routingTableId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/routingTable/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to perform a routing table request for the device. Only native Catalyst switches are supported. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/routingTable

{
    "routingTableId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/routingTable/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return an routing table live tool job.

Operation ID: getDeviceLiveToolsRoutingTable

PATH /devices/{serial}/liveTools/routingTable/{id}

{
  "routingTableId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/routingTable/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "entries": [
    {
      "type": "static",
      "subnet": "10.200.10.1/32",
      "staticGateway": "22.22.22.21",
      "ipVersion": "ipv4"
    }
  ],
  "error": "The device is unreachable"
}

- Path added

- New endpoint

Return an routing table live tool job.

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

{
    "routingTableId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/routingTable/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "entries": [
        {
            "type": "static",
            "subnet": "10.200.10.1/32",
            "staticGateway": "22.22.22.21",
            "ipVersion": "ipv4"
        }
    ],
    "error": "The device is unreachable"
}

---

ospfNeighbors

Docs

Enqueue a job to perform a OSPF neighbors request for the device

Operation ID: createDeviceLiveToolsOspfNeighbor

PATH /devices/{serial}/liveTools/ospfNeighbors

{
  "ospfNeighborsId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/ospfNeighbors/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to perform a OSPF neighbors request for the device. This endpoint currently supports switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/ospfNeighbors

{
    "ospfNeighborsId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/ospfNeighbors/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return an OSPF neighbors live tool job.

Operation ID: getDeviceLiveToolsOspfNeighbor

PATH /devices/{serial}/liveTools/ospfNeighbors/{ospfNeighborsId}

{
  "ospfNeighborsId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/ospfNeighbors/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "routers": [
    {
      "id": "1.2.3.4",
      "name": "My route",
      "ip": "10.0.0.0/24",
      "position": "DR",
      "state": "full",
      "vlanId": 100
    }
  ],
  "error": "The device is unreachable."
}

- Path added

- New endpoint

Return an OSPF neighbors live tool job.

GET /devices/{serial}/liveTools/ospfNeighbors/{ospfNeighborsId}

{
    "ospfNeighborsId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/ospfNeighbors/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "routers": [
        {
            "id": "1.2.3.4",
            "name": "My route",
            "ip": "10.0.0.0/24",
            "position": "DR",
            "state": "full",
            "vlanId": 100
        }
    ],
    "error": "The device is unreachable."
}

---

dhcpLeases

Docs

Enqueue a job to perform a DHCP leases request for the device

Operation ID: createDeviceLiveToolsDhcpLease

PATH /devices/{serial}/liveTools/dhcpLeases

{
  "dhcpLeasesId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/dhcpLeases/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to perform a DHCP leases request for the device. This endpoint currently supports all devices. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/dhcpLeases

{
    "dhcpLeasesId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/dhcpLeases/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return a DHCP leases live tool job.

Operation ID: getDeviceLiveToolsDhcpLease

PATH /devices/{serial}/liveTools/dhcpLeases/{dhcpLeasesId}

{
  "dhcpLeasesId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/dhcpLeases/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "dhcpLeases": [
    {
      "ip": "10.0.0.0/24",
      "mac": "00:11:22:33:44:55",
      "expiresAt": "2018-02-11T00:00:00.090210Z"
    }
  ],
  "error": "The device is unreachable."
}

- Path added

- New endpoint

Return a DHCP leases live tool job.

GET /devices/{serial}/liveTools/dhcpLeases/{dhcpLeasesId}

{
    "dhcpLeasesId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/dhcpLeases/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "dhcpLeases": [
        {
            "ip": "10.0.0.0/24",
            "mac": "00:11:22:33:44:55",
            "expiresAt": "2018-02-11T00:00:00.090210Z"
        }
    ],
    "error": "The device is unreachable."
}

---

cyclePort

Docs

Enqueue a job to perform a cycle port for the device on the specified ports

Operation ID: createDeviceLiveToolsCyclePort

PATH /devices/{serial}/liveTools/cyclePort

{
  "cyclePortId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/cyclePort/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678",
    "ports": [
      "2",
      "8"
    ]
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to perform a cycle port for the device on the specified ports. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/cyclePort

{
    "cyclePortId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/cyclePort/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "ports": [
            "2",
            "8"
        ]
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return a cycle port live tool job.

Operation ID: getDeviceLiveToolsCyclePort

PATH /devices/{serial}/liveTools/cyclePort/{id}

{
  "cyclePortId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/cyclePort/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678",
    "ports": [
      "2",
      "8"
    ]
  },
  "status": "complete",
  "error": "The device is unreachable."
}

- Path added

- New endpoint

Return a cycle port live tool job.

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

{
    "cyclePortId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/cyclePort/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "ports": [
            "2",
            "8"
        ]
    },
    "status": "complete",
    "error": "The device is unreachable."
}

---

aclHitCount

Docs

Enqueue a job to perform an ACL hit count for the device

Operation ID: createDeviceLiveToolsAclHitCount

PATH /devices/{serial}/liveTools/aclHitCount

{
  "aclHitCountId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/aclHitCount/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to perform an ACL hit count for the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/aclHitCount

{
    "aclHitCountId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/aclHitCount/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return an ACL hit count live tool job.

Operation ID: getDeviceLiveToolsAclHitCount

PATH /devices/{serial}/liveTools/aclHitCount/{id}

{
  "aclHitCountId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/aclHitCount/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "acls": [
    {
      "policy": "allow",
      "ipVersion": "any",
      "ipProtocol": {
        "type": "number",
        "number": 6,
        "objectGroup": "object-group-123"
      },
      "counts": {
        "total": 1234,
        "ipv4": 1234,
        "ipv6": 0
      },
      "source": {
        "address": "1.2.3.4",
        "port": {
          "operator": "equals",
          "ports": [
            80,
            443
          ]
        }
      },
      "destination": {
        "address": "2.3.4.5",
        "port": [
          {
            "operator": "range",
            "ports": [
              80,
              89
            ]
          }
        ]
      }
    }
  ],
  "error": "The device is unreachable."
}

- Path added

- New endpoint

Return an ACL hit count live tool job.

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

{
    "aclHitCountId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/aclHitCount/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "acls": [
        {
            "policy": "allow",
            "ipVersion": "any",
            "ipProtocol": {
                "type": "number",
                "number": 6,
                "objectGroup": "object-group-123"
            },
            "counts": {
                "total": 1234,
                "ipv4": 1234,
                "ipv6": 0
            },
            "source": {
                "address": "1.2.3.4",
                "port": {
                    "operator": "equals",
                    "ports": [
                        80,
                        443
                    ]
                }
            },
            "destination": {
                "address": "2.3.4.5",
                "port": [
                    {
                        "operator": "range",
                        "ports": [
                            80,
                            89
                        ]
                    }
                ]
            }
        }
    ],
    "error": "The device is unreachable."
}

---

clients

Docs

Enqueue a job to disconnect a client from an AP

Operation ID: createDeviceLiveToolsClientsDisconnect

PATH /devices/{serial}/liveTools/clients/disconnect

{
  "id": "abcd-1234-efgh-5678",
  "status": "queued",
  "request": {
    "mac": "00:11:22:33:44:55"
  },
  "url": "/api/v1/devices/serial/liveTools/disconnect",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to disconnect a client from an AP. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

POST /devices/{serial}/liveTools/clients/disconnect

{
    "id": "abcd-1234-efgh-5678",
    "status": "queued",
    "request": {
        "mac": "00:11:22:33:44:55"
    },
    "url": "/api/v1/devices/serial/liveTools/disconnect",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}

---

Docs

Return a client disconnect job.

Operation ID: getDeviceLiveToolsClientsDisconnect

PATH /devices/{serial}/liveTools/clients/disconnect/{id}

{
  "id": "abcd-1234-efgh-5678",
  "status": "queued",
  "request": {
    "mac": "00:11:22:33:44:55"
  },
  "url": "/api/v1/devices/serial/liveTools/disconnect",
  "results": {
    "success": true,
    "error": "Device (Access Point) took too long to respond."
  }
}

- Path added

- New endpoint

Return a client disconnect job.

GET /devices/{serial}/liveTools/clients/disconnect/{id}

{
    "id": "abcd-1234-efgh-5678",
    "status": "queued",
    "request": {
        "mac": "00:11:22:33:44:55"
    },
    "url": "/api/v1/devices/serial/liveTools/disconnect",
    "results": {
        "success": true,
        "error": "Device (Access Point) took too long to respond."
    }
}

---

[ licensing ]

subscription

Docs

Batch change networks to their desired feature tier for specified product types

Operation ID: batchAdministeredLicensingSubscriptionNetworksFeatureTiersUpdate

PATH /administered/licensing/subscription/networks/featureTiers/batchUpdate

{
  "items": [
    {
      "network": {
        "id": "N_1234",
        "productTypes": [
          {
            "productType": "wireless",
            "featureTier": "essentials"
          }
        ]
      }
    }
  ],
  "errors": [
    {
      "network": {
        "id": "N_1234",
        "productTypes": [
          {
            "productType": "wireless",
            "featureTier": "essentials",
            "error": "Insufficient entitlements"
          }
        ]
      },
      "error": "null"
    }
  ]
}

- Path added

- New endpoint

Batch change networks to their desired feature tier for specified product types

POST /administered/licensing/subscription/networks/featureTiers/batchUpdate

{
    "items": [
        {
            "network": {
                "id": "N_1234",
                "productTypes": [
                    {
                        "productType": "wireless",
                        "featureTier": "essentials"
                    }
                ]
            }
        }
    ],
    "errors": [
        {
            "network": {
                "id": "N_1234",
                "productTypes": [
                    {
                        "productType": "wireless",
                        "featureTier": "essentials",
                        "error": "Insufficient entitlements"
                    }
                ]
            },
            "error": "null"
        }
    ]
}

---

[ insight ]

webApps

Docs

Lists all default web applications rules with counter set rule ids

Operation ID: getOrganizationInsightWebApps

PATH /organizations/{organizationId}/insight/webApps

[
  {
    "counterSetRuleId": "12345",
    "name": "Meraki HTTPS",
    "category": "Remote monitoring & management",
    "thresholds": {
      "goodput": "20000",
      "responseDelay": "3000"
    },
    "expression": "http_host[*.example.com] or http_host",
    "signature": {
      "signatureType": "custom_host",
      "host": "exampled.com",
      "port": "123",
      "net": "10.0.2.1/20"
    }
  }
]

- Path added

- New endpoint

Lists all default web applications rules with counter set rule ids

GET /organizations/{organizationId}/insight/webApps

[
    {
        "counterSetRuleId": "12345",
        "name": "Meraki HTTPS",
        "category": "Remote monitoring & management",
        "thresholds": {
            "goodput": "20000",
            "responseDelay": "3000"
        },
        "expression": "http_host[*.example.com] or http_host",
        "signature": {
            "signatureType": "custom_host",
            "host": "exampled.com",
            "port": "123",
            "net": "10.0.2.1/20"
        }
    }
]

---

- New endpoint

Add a custom web application for Insight to be able to track

POST /organizations/{organizationId}/insight/webApps

{
    "counterSetRuleId": "12345",
    "name": "Meraki HTTPS",
    "category": "Remote monitoring & management",
    "thresholds": {
        "goodput": "20000",
        "responseDelay": "3000"
    },
    "expression": "http_host[*.example.com] or http_host",
    "signature": {
        "signatureType": "custom_host",
        "host": "exampled.com"
    }
}

---

Docs

Update a custom web application for Insight to be able to track

Operation ID: updateOrganizationInsightWebApp

PATH /organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}

{
  "counterSetRuleId": "12345",
  "name": "Meraki HTTPS",
  "category": "Remote monitoring & management",
  "thresholds": {
    "goodput": "20000",
    "responseDelay": "3000"
  },
  "expression": "http_host[*.example.com] or http_host",
  "signature": {
    "signatureType": "custom_host",
    "host": "exampled.com"
  }
}

- Path added

- New endpoint

Update a custom web application for Insight to be able to track

PUT /organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}

{
    "counterSetRuleId": "12345",
    "name": "Meraki HTTPS",
    "category": "Remote monitoring & management",
    "thresholds": {
        "goodput": "20000",
        "responseDelay": "3000"
    },
    "expression": "http_host[*.example.com] or http_host",
    "signature": {
        "signatureType": "custom_host",
        "host": "exampled.com"
    }
}

---

- New endpoint

Delete a custom web application by counter set rule id.

DELETE /organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}

---

speedTestResults

Docs

List the speed tests for the given devices under this organization

Operation ID: getOrganizationInsightSpeedTestResults

PATH /organizations/{organizationId}/insight/speedTestResults

[
  {
    "speedTestId": "1284392014819",
    "networkId": "N_24329156",
    "request": {
      "serial": "Q234-ABCD-5678",
      "interface": "wan1"
    },
    "results": {
      "speeds": {
        "average": 247.279
      }
    },
    "startedAt": "2021-12-08T20:07:13Z"
  }
]

- Path added

- New endpoint

List the speed tests for the given devices under this organization. Only valid for organizations with Meraki Insight.

GET /organizations/{organizationId}/insight/speedTestResults

[
    {
        "speedTestId": "1284392014819",
        "networkId": "N_24329156",
        "request": {
            "serial": "Q234-ABCD-5678",
            "interface": "wan1"
        },
        "results": {
            "speeds": {
                "average": 247.279
            }
        },
        "startedAt": "2021-12-08T20:07:13Z"
    }
]

---

applications

Docs

Update an Insight tracked application

Operation ID: updateOrganizationInsightApplication

PATH /organizations/{organizationId}/insight/applications/{applicationId}

{
  "applicationId": "19.12",
  "name": "Meraki HTTPS",
  "thresholds": {
    "type": "smart",
    "byNetwork": [
      {
        "networkId": "N_12345678",
        "goodput": 50000,
        "responseDuration": 1000
      }
    ]
  }
}

- Path added

- New endpoint

Update an Insight tracked application

PUT /organizations/{organizationId}/insight/applications/{applicationId}

{
    "applicationId": "19.12",
    "name": "Meraki HTTPS",
    "thresholds": {
        "type": "smart",
        "byNetwork": [
            {
                "networkId": "N_12345678",
                "goodput": 50000,
                "responseDuration": 1000
            }
        ]
    }
}

---

- New endpoint

Delete an Insight tracked application

DELETE /organizations/{organizationId}/insight/applications/{applicationId}

---

[ organizations ]

webhooks

Docs

List the HTTP servers for this organization

Operation ID: getOrganizationWebhooksHttpServers

PATH /organizations/{organizationId}/webhooks/httpServers

[
  {
    "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
    "name": "Example Webhook Server",
    "organizationId": "2930418",
    "url": "https://www.example.com/my_custom_webhook",
    "payloadTemplate": {
      "id": "wpt_00001",
      "name": "Meraki (included)"
    }
  }
]

- Path added

- New endpoint

List the HTTP servers for this organization

GET /organizations/{organizationId}/webhooks/httpServers

[
    {
        "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
        "name": "Example Webhook Server",
        "organizationId": "2930418",
        "url": "https://www.example.com/my_custom_webhook",
        "payloadTemplate": {
            "id": "wpt_00001",
            "name": "Meraki (included)"
        }
    }
]

---

- New endpoint

Add an HTTP server to an organization

POST /organizations/{organizationId}/webhooks/httpServers

{
    "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
    "name": "Example Webhook Server",
    "organizationId": "2930418",
    "url": "https://www.example.com/my_custom_webhook",
    "payloadTemplate": {
        "id": "wpt_00001",
        "name": "Meraki (included)"
    }
}

---

Docs

Return an HTTP server for an organization

Operation ID: getOrganizationWebhooksHttpServer

PATH /organizations/{organizationId}/webhooks/httpServers/{id}

{
  "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
  "name": "Example Webhook Server",
  "organizationId": "2930418",
  "url": "https://www.example.com/my_custom_webhook",
  "payloadTemplate": {
    "id": "wpt_00001",
    "name": "Meraki (included)"
  }
}

- Path added

- New endpoint

Return an HTTP server for an organization

GET /organizations/{organizationId}/webhooks/httpServers/{id}

{
    "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
    "name": "Example Webhook Server",
    "organizationId": "2930418",
    "url": "https://www.example.com/my_custom_webhook",
    "payloadTemplate": {
        "id": "wpt_00001",
        "name": "Meraki (included)"
    }
}

---

- New endpoint

Update an HTTP server for an organization

PUT /organizations/{organizationId}/webhooks/httpServers/{id}

{
    "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
    "name": "Example Webhook Server",
    "organizationId": "2930418",
    "url": "https://www.example.com/my_custom_webhook",
    "payloadTemplate": {
        "id": "wpt_00001",
        "name": "Meraki (included)"
    }
}

---

- New endpoint

Delete an HTTP server from an organization

DELETE /organizations/{organizationId}/webhooks/httpServers/{id}

---

Docs

List the webhook payload templates for an organization

Operation ID: getOrganizationWebhooksPayloadTemplates

PATH /organizations/{organizationId}/webhooks/payloadTemplates

[
  {
    "payloadTemplateId": "wpt_343",
    "type": "custom",
    "name": "Custom Template",
    "headers": [
      {
        "name": "Authorization",
        "template": "Bearer {{sharedSecret}}"
      }
    ],
    "body": "{\"event_type\":\"{{alertTypeId}}\",\"client_payload\":{\"text\":\"{{alertData}}\"}}",
    "sharing": {
      "byNetwork": {
        "withAll": true,
        "adminsCanModify": true,
        "ids": [
          "N_1234",
          "L_5678"
        ]
      }
    }
  }
]

- Path added

- New endpoint

List the webhook payload templates for an organization

GET /organizations/{organizationId}/webhooks/payloadTemplates

[
    {
        "payloadTemplateId": "wpt_343",
        "type": "custom",
        "name": "Custom Template",
        "headers": [
            {
                "name": "Authorization",
                "template": "Bearer {{sharedSecret}}"
            }
        ],
        "body": "{\"event_type\":\"{{alertTypeId}}\",\"client_payload\":{\"text\":\"{{alertData}}\"}}",
        "sharing": {
            "byNetwork": {
                "withAll": true,
                "adminsCanModify": true,
                "ids": [
                    "N_1234",
                    "L_5678"
                ]
            }
        }
    }
]

---

- New endpoint

Create a webhook payload template for an organization

POST /organizations/{organizationId}/webhooks/payloadTemplates

{
    "payloadTemplateId": "wpt_343",
    "type": "custom",
    "name": "Custom Template",
    "headers": [
        {
            "name": "Authorization",
            "template": "Bearer {{sharedSecret}}"
        }
    ],
    "body": "{\"event_type\":\"{{alertTypeId}}\",\"client_payload\":{\"text\":\"{{alertData}}\"}}",
    "sharing": {
        "byNetwork": {
            "withAll": true,
            "adminsCanModify": true,
            "ids": [
                "N_1234",
                "L_5678"
            ]
        }
    }
}

---

Docs

Get the webhook payload template for an organization

Operation ID: getOrganizationWebhooksPayloadTemplate

PATH /organizations/{organizationId}/webhooks/payloadTemplates/{payloadTemplateId}

{
  "payloadTemplateId": "wpt_343",
  "type": "custom",
  "name": "Custom Template",
  "headers": [
    {
      "name": "Authorization",
      "template": "Bearer {{sharedSecret}}"
    }
  ],
  "body": "{\"event_type\":\"{{alertTypeId}}\",\"client_payload\":{\"text\":\"{{alertData}}\"}}",
  "sharing": {
    "byNetwork": {
      "withAll": true,
      "adminsCanModify": true,
      "ids": [
        "N_1234",
        "L_5678"
      ]
    }
  }
}

- Path added

- New endpoint

Get the webhook payload template for an organization

GET /organizations/{organizationId}/webhooks/payloadTemplates/{payloadTemplateId}

{
    "payloadTemplateId": "wpt_343",
    "type": "custom",
    "name": "Custom Template",
    "headers": [
        {
            "name": "Authorization",
            "template": "Bearer {{sharedSecret}}"
        }
    ],
    "body": "{\"event_type\":\"{{alertTypeId}}\",\"client_payload\":{\"text\":\"{{alertData}}\"}}",
    "sharing": {
        "byNetwork": {
            "withAll": true,
            "adminsCanModify": true,
            "ids": [
                "N_1234",
                "L_5678"
            ]
        }
    }
}

---

- New endpoint

Update a webhook payload template for an organization

PUT /organizations/{organizationId}/webhooks/payloadTemplates/{payloadTemplateId}

{
    "payloadTemplateId": "wpt_343",
    "type": "custom",
    "name": "Custom Template",
    "headers": [
        {
            "name": "Authorization",
            "template": "Bearer {{sharedSecret}}"
        }
    ],
    "body": "{\"event_type\":\"{{alertTypeId}}\",\"client_payload\":{\"text\":\"{{alertData}}\"}}",
    "sharing": {
        "byNetwork": {
            "withAll": true,
            "adminsCanModify": true,
            "ids": [
                "N_1234",
                "L_5678"
            ]
        }
    }
}

---

- New endpoint

Destroy a webhook payload template for an organization. Does not work for included templates ('wpt_00001', 'wpt_00002', 'wpt_00003', 'wpt_00004', 'wpt_00005', 'wpt_00006' or 'wpt_00007')

DELETE /organizations/{organizationId}/webhooks/payloadTemplates/{payloadTemplateId}

---

Docs

Send a test webhook for an organization

Operation ID: createOrganizationWebhooksWebhookTest

PATH /organizations/{organizationId}/webhooks/webhookTests

{
  "id": "1234",
  "url": "https://www.example.com/path",
  "status": "enqueued"
}

- Path added

- New endpoint

Send a test webhook for an organization

POST /organizations/{organizationId}/webhooks/webhookTests

{
    "id": "1234",
    "url": "https://www.example.com/path",
    "status": "enqueued"
}

---

Docs

Return the status of a webhook test for an organization

Operation ID: getOrganizationWebhooksWebhookTest

PATH /organizations/{organizationId}/webhooks/webhookTests/{webhookTestId}

{
  "id": "1234",
  "url": "https://www.example.com/path",
  "status": "enqueued"
}

- Path added

- New endpoint

Return the status of a webhook test for an organization

GET /organizations/{organizationId}/webhooks/webhookTests/{webhookTestId}

{
    "id": "1234",
    "url": "https://www.example.com/path",
    "status": "enqueued"
}

---

policy

Docs

List all layer 7 CASI categories and applications that can be used with Org Wide Policies

Operation ID: getOrganizationPolicyGroupPolicyApplicationCategoriesV2

PATH /organizations/{organizationId}/policy/groupPolicy/applicationCategories/v2

{
  "categories": [
    {
      "casiId": "6",
      "name": "Cloud Storage",
      "apps": [
        {
          "casiId": "11",
          "name": "4shared",
          "enforcements": [
            "meraki",
            "secureAccess"
          ]
        }
      ]
    }
  ]
}

- Path added

- New endpoint

List all layer 7 CASI categories and applications that can be used with Org Wide Policies

GET /organizations/{organizationId}/policy/groupPolicy/applicationCategories/v2

{
    "categories": [
        {
            "casiId": "6",
            "name": "Cloud Storage",
            "apps": [
                {
                    "casiId": "11",
                    "name": "4shared",
                    "enforcements": [
                        "meraki",
                        "secureAccess"
                    ]
                }
            ]
        }
    ]
}

---

Docs

List Organization-Wide Policy Firewall Profiles

Operation ID: getOrganizationPolicyGroupPolicyFirewallProfiles

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/profiles

{
  "items": [
    {
      "id": "123",
      "name": "Block Social Media",
      "iname": "block-social-media",
      "description": "Block all Social Media",
      "reserved": false,
      "deleted": false,
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "counts": {
      "total": 12,
      "remaining": 2
    }
  }
}

- Path added

- New endpoint

List Organization-Wide Policy Firewall Profiles

GET /organizations/{organizationId}/policy/groupPolicy/firewall/profiles

{
    "items": [
        {
            "id": "123",
            "name": "Block Social Media",
            "iname": "block-social-media",
            "description": "Block all Social Media",
            "reserved": false,
            "deleted": false,
            "createdAt": "2021-01-01T00:00:00Z",
            "updatedAt": "2021-01-01T00:00:00Z"
        }
    ],
    "meta": {
        "counts": {
            "total": 12,
            "remaining": 2
        }
    }
}

---

- New endpoint

Create an Organization-Wide Policy Firewall Profile

POST /organizations/{organizationId}/policy/groupPolicy/firewall/profiles

{
    "id": "123",
    "name": "Block Social Media",
    "iname": "block-social-media",
    "description": "Block all Social Media",
    "reserved": false,
    "deleted": false,
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z"
}

---

Docs

Provision default Organization-Wide Policy Firewall Profiles

Operation ID: createOrganizationPolicyGroupPolicyFirewallProfilesProvisionDefault

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/profiles/provisionDefaults

{}

- Path added

- New endpoint

Provision default Organization-Wide Policy Firewall Profiles

POST /organizations/{organizationId}/policy/groupPolicy/firewall/profiles/provisionDefaults

{}

---

Docs

Update an Organization-Wide Policy Firewall Profile

Operation ID: updateOrganizationPolicyGroupPolicyFirewallProfile

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/profiles/{profileId}

{
  "id": "123",
  "name": "Block Social Media",
  "iname": "block-social-media",
  "description": "Block all Social Media",
  "reserved": false,
  "deleted": false,
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

- Path added

- New endpoint

Update an Organization-Wide Policy Firewall Profile

PUT /organizations/{organizationId}/policy/groupPolicy/firewall/profiles/{profileId}

{
    "id": "123",
    "name": "Block Social Media",
    "iname": "block-social-media",
    "description": "Block all Social Media",
    "reserved": false,
    "deleted": false,
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z"
}

---

- New endpoint

Delete an Organization-Wide Policy Firewall Profile

DELETE /organizations/{organizationId}/policy/groupPolicy/firewall/profiles/{profileId}

---

Docs

Delete multiple Organization-Wide Policy Firewall Rules

Operation ID: deleteOrganizationPolicyGroupPolicyFirewallRules

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/rules

- Path added

- New endpoint

Delete multiple Organization-Wide Policy Firewall Rules

DELETE /organizations/{organizationId}/policy/groupPolicy/firewall/rules

---

Docs

Change Rules definition

Operation ID: createOrganizationPolicyGroupPolicyFirewallRulesChange

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/rules/change

{
  "id": "123",
  "name": "Rule 1",
  "iname": "rule-1",
  "action": "deny",
  "enabled": true,
  "logging": {
    "enabled": false
  },
  "tier": "deny-layer3",
  "description": "Rule 1",
  "deleted": false,
  "profileId": "1",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "status": "active",
  "sources": [
    {
      "matchCriteria": [
        "ipRanges",
        "ports",
        "vlanIds",
        "policyObjectIds",
        "policyObjectGroupIds",
        "scopeIds",
        "any"
      ],
      "criteria": {
        "vlanIds": [
          "1",
          "2",
          "3"
        ],
        "ipRanges": [
          "1.1.1.0/24"
        ],
        "cloudFirewallUserGroups": [
          "1",
          "2"
        ],
        "policyObjectIds": [
          "1",
          "2"
        ],
        "policyObjectGroupIds": [
          "1",
          "2"
        ],
        "ports": [
          "8080",
          "10000-10010"
        ]
      }
    }
  ],
  "destinations": [
    {
      "matchCriteria": [
        "ipRanges",
        "services",
        "vlanIds",
        "policyObjectIds",
        "policyObjectGroupIds",
        "casiApplicationIds",
        "casiCategoryIds",
        "saPrivateResourceIds",
        "saPrivateResourceTypes",
        "saApplicationProtocolIds",
        "saDestinationListIds",
        "scopeIds",
        "any"
      ],
      "criteria": {
        "vlanIds": [
          "1",
          "2",
          "3"
        ],
        "ipRanges": [
          "1.1.1.0/24"
        ],
        "policyObjectIds": [
          "1",
          "2"
        ],
        "policyObjectGroupIds": [
          "1",
          "2"
        ],
        "ports": [
          "8080",
          "10000-10010"
        ],
        "casiApplicationIds": [
          "1",
          "11"
        ],
        "casiCategoryIds": [
          "40",
          "6"
        ],
        "service": [
          {
            "protocol": "tcp",
            "ports": [
              "8080",
              "10000-10010"
            ]
          }
        ]
      }
    }
  ]
}

- Path added

- New endpoint

Change Rules definition

POST /organizations/{organizationId}/policy/groupPolicy/firewall/rules/change

{
    "id": "123",
    "name": "Rule 1",
    "iname": "rule-1",
    "action": "deny",
    "enabled": true,
    "logging": {
        "enabled": false
    },
    "tier": "deny-layer3",
    "description": "Rule 1",
    "deleted": false,
    "profileId": "1",
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z",
    "status": "active",
    "sources": [
        {
            "matchCriteria": [
                "ipRanges",
                "ports",
                "vlanIds",
                "policyObjectIds",
                "policyObjectGroupIds",
                "scopeIds",
                "any"
            ],
            "criteria": {
                "vlanIds": [
                    "1",
                    "2",
                    "3"
                ],
                "ipRanges": [
                    "1.1.1.0/24"
                ],
                "cloudFirewallUserGroups": [
                    "1",
                    "2"
                ],
                "policyObjectIds": [
                    "1",
                    "2"
                ],
                "policyObjectGroupIds": [
                    "1",
                    "2"
                ],
                "ports": [
                    "8080",
                    "10000-10010"
                ]
            }
        }
    ],
    "destinations": [
        {
            "matchCriteria": [
                "ipRanges",
                "services",
                "vlanIds",
                "policyObjectIds",
                "policyObjectGroupIds",
                "casiApplicationIds",
                "casiCategoryIds",
                "saPrivateResourceIds",
                "saPrivateResourceTypes",
                "saApplicationProtocolIds",
                "saDestinationListIds",
                "scopeIds",
                "any"
            ],
            "criteria": {
                "vlanIds": [
                    "1",
                    "2",
                    "3"
                ],
                "ipRanges": [
                    "1.1.1.0/24"
                ],
                "policyObjectIds": [
                    "1",
                    "2"
                ],
                "policyObjectGroupIds": [
                    "1",
                    "2"
                ],
                "ports": [
                    "8080",
                    "10000-10010"
                ],
                "casiApplicationIds": [
                    "1",
                    "11"
                ],
                "casiCategoryIds": [
                    "40",
                    "6"
                ],
                "service": [
                    {
                        "protocol": "tcp",
                        "ports": [
                            "8080",
                            "10000-10010"
                        ]
                    }
                ]
            }
        }
    ]
}

---

Docs

Get Organization-Wide Policy Firewall Rules Errors

Operation ID: getOrganizationPolicyGroupPolicyFirewallRulesErrors

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/rules/errors

{
  "items": {
    "1": {
      "error": "Sync error",
      "failedAt": "2021-01-01T00:00:00Z"
    }
  }
}

- Path added

- New endpoint

Get Organization-Wide Policy Firewall Rules Errors

GET /organizations/{organizationId}/policy/groupPolicy/firewall/rules/errors

{
    "items": {
        "1": {
            "error": "Sync error",
            "failedAt": "2021-01-01T00:00:00Z"
        }
    }
}

---

Docs

List Organization-Wide Policy Firewall Rules

Operation ID: createOrganizationPolicyGroupPolicyFirewallRulesFilter

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/rules/filter

{
  "items": [
    {
      "id": "123",
      "name": "Rule 1",
      "iname": "rule-1",
      "action": "deny",
      "enabled": true,
      "logging": {
        "enabled": false
      },
      "tier": "deny-layer3",
      "description": "Rule 1",
      "deleted": false,
      "profileId": "1",
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z",
      "status": "active",
      "sources": [
        {
          "matchCriteria": [
            "ipRanges",
            "ports",
            "vlanIds",
            "policyObjectIds",
            "policyObjectGroupIds",
            "scopeIds",
            "any"
          ],
          "criteria": {
            "vlanIds": [
              "1",
              "2",
              "3"
            ],
            "ipRanges": [
              "1.1.1.0/24"
            ],
            "cloudFirewallUserGroups": [
              "1",
              "2"
            ],
            "policyObjectIds": [
              "1",
              "2"
            ],
            "policyObjectGroupIds": [
              "1",
              "2"
            ],
            "ports": [
              "8080",
              "10000-10010"
            ]
          }
        }
      ],
      "destinations": [
        {
          "matchCriteria": [
            "ipRanges",
            "services",
            "vlanIds",
            "policyObjectIds",
            "policyObjectGroupIds",
            "casiApplicationIds",
            "casiCategoryIds",
            "saPrivateResourceIds",
            "saPrivateResourceTypes",
            "saApplicationProtocolIds",
            "saDestinationListIds",
            "scopeIds",
            "any"
          ],
          "criteria": {
            "vlanIds": [
              "1",
              "2",
              "3"
            ],
            "ipRanges": [
              "1.1.1.0/24"
            ],
            "policyObjectIds": [
              "1",
              "2"
            ],
            "policyObjectGroupIds": [
              "1",
              "2"
            ],
            "ports": [
              "8080",
              "10000-10010"
            ],
            "casiApplicationIds": [
              "1",
              "11"
            ],
            "casiCategoryIds": [
              "40",
              "6"
            ],
            "service": [
              {
                "protocol": "tcp",
                "ports": [
                  "8080",
                  "10000-10010"
                ]
              }
            ]
          }
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "total": 12,
      "remaining": 2
    }
  }
}

- Path added

- New endpoint

List Organization-Wide Policy Firewall Rules

POST /organizations/{organizationId}/policy/groupPolicy/firewall/rules/filter

{
    "items": [
        {
            "id": "123",
            "name": "Rule 1",
            "iname": "rule-1",
            "action": "deny",
            "enabled": true,
            "logging": {
                "enabled": false
            },
            "tier": "deny-layer3",
            "description": "Rule 1",
            "deleted": false,
            "profileId": "1",
            "createdAt": "2021-01-01T00:00:00Z",
            "updatedAt": "2021-01-01T00:00:00Z",
            "status": "active",
            "sources": [
                {
                    "matchCriteria": [
                        "ipRanges",
                        "ports",
                        "vlanIds",
                        "policyObjectIds",
                        "policyObjectGroupIds",
                        "scopeIds",
                        "any"
                    ],
                    "criteria": {
                        "vlanIds": [
                            "1",
                            "2",
                            "3"
                        ],
                        "ipRanges": [
                            "1.1.1.0/24"
                        ],
                        "cloudFirewallUserGroups": [
                            "1",
                            "2"
                        ],
                        "policyObjectIds": [
                            "1",
                            "2"
                        ],
                        "policyObjectGroupIds": [
                            "1",
                            "2"
                        ],
                        "ports": [
                            "8080",
                            "10000-10010"
                        ]
                    }
                }
            ],
            "destinations": [
                {
                    "matchCriteria": [
                        "ipRanges",
                        "services",
                        "vlanIds",
                        "policyObjectIds",
                        "policyObjectGroupIds",
                        "casiApplicationIds",
                        "casiCategoryIds",
                        "saPrivateResourceIds",
                        "saPrivateResourceTypes",
                        "saApplicationProtocolIds",
                        "saDestinationListIds",
                        "scopeIds",
                        "any"
                    ],
                    "criteria": {
                        "vlanIds": [
                            "1",
                            "2",
                            "3"
                        ],
                        "ipRanges": [
                            "1.1.1.0/24"
                        ],
                        "policyObjectIds": [
                            "1",
                            "2"
                        ],
                        "policyObjectGroupIds": [
                            "1",
                            "2"
                        ],
                        "ports": [
                            "8080",
                            "10000-10010"
                        ],
                        "casiApplicationIds": [
                            "1",
                            "11"
                        ],
                        "casiCategoryIds": [
                            "40",
                            "6"
                        ],
                        "service": [
                            {
                                "protocol": "tcp",
                                "ports": [
                                    "8080",
                                    "10000-10010"
                                ]
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "total": 12,
            "remaining": 2
        }
    }
}

---

Docs

Search for Organization-wide Firewall Rules by source and destination IPs

Operation ID: createOrganizationPolicyGroupPolicyFirewallRulesSearchRulesExactMatch

PATH /organizations/{organizationId}/policy/groupPolicy/firewall/rules/searchRulesExactMatch

{
  "items": "Hello, World!"
}

- Path added

- New endpoint

Search for Organization-wide Firewall Rules by source and destination IPs

POST /organizations/{organizationId}/policy/groupPolicy/firewall/rules/searchRulesExactMatch

{
    "items": "Hello, World!"
}

---

Docs

List Organization-Wide Policies

Operation ID: getOrganizationPolicyGroupPolicyPolicies

PATH /organizations/{organizationId}/policy/groupPolicy/policies

{
  "items": [
    {
      "id": "123",
      "name": "All Vlan Policy",
      "iname": "all-vlan-policy",
      "description": "Policy that applies to all VLANs",
      "zone": {
        "id": "123",
        "name": "Block Social Media",
        "iname": "block-social-media",
        "kind": "block-social-media",
        "createdAt": "2021-01-01T00:00:00Z",
        "updatedAt": "2021-01-01T00:00:00Z"
      },
      "profiles": [
        {
          "id": "123",
          "name": "Block Social Media",
          "iname": "block-social-media",
          "description": "Block all Social Media",
          "reserved": false,
          "deleted": false,
          "createdAt": "2021-01-01T00:00:00Z",
          "updatedAt": "2021-01-01T00:00:00Z"
        }
      ],
      "status": "active",
      "deleted": false,
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "counts": {
      "total": 12,
      "remaining": 2
    }
  }
}

- Path added

- New endpoint

List Organization-Wide Policies

GET /organizations/{organizationId}/policy/groupPolicy/policies

{
    "items": [
        {
            "id": "123",
            "name": "All Vlan Policy",
            "iname": "all-vlan-policy",
            "description": "Policy that applies to all VLANs",
            "zone": {
                "id": "123",
                "name": "Block Social Media",
                "iname": "block-social-media",
                "kind": "block-social-media",
                "createdAt": "2021-01-01T00:00:00Z",
                "updatedAt": "2021-01-01T00:00:00Z"
            },
            "profiles": [
                {
                    "id": "123",
                    "name": "Block Social Media",
                    "iname": "block-social-media",
                    "description": "Block all Social Media",
                    "reserved": false,
                    "deleted": false,
                    "createdAt": "2021-01-01T00:00:00Z",
                    "updatedAt": "2021-01-01T00:00:00Z"
                }
            ],
            "status": "active",
            "deleted": false,
            "createdAt": "2021-01-01T00:00:00Z",
            "updatedAt": "2021-01-01T00:00:00Z"
        }
    ],
    "meta": {
        "counts": {
            "total": 12,
            "remaining": 2
        }
    }
}

---

Docs

Change Policy definition

Operation ID: createOrganizationPolicyGroupPolicyPoliciesChange

PATH /organizations/{organizationId}/policy/groupPolicy/policies/change

{
  "id": "123",
  "name": "All Vlan Policy",
  "iname": "all-vlan-policy",
  "description": "Policy that applies to all VLANs",
  "zone": {
    "id": "123",
    "name": "Block Social Media",
    "iname": "block-social-media",
    "kind": "block-social-media",
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z"
  },
  "profiles": [
    {
      "id": "123",
      "name": "Block Social Media",
      "iname": "block-social-media",
      "description": "Block all Social Media",
      "reserved": false,
      "deleted": false,
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z"
    }
  ],
  "status": "active",
  "deleted": false,
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

- Path added

- New endpoint

Change Policy definition

POST /organizations/{organizationId}/policy/groupPolicy/policies/change

{
    "id": "123",
    "name": "All Vlan Policy",
    "iname": "all-vlan-policy",
    "description": "Policy that applies to all VLANs",
    "zone": {
        "id": "123",
        "name": "Block Social Media",
        "iname": "block-social-media",
        "kind": "block-social-media",
        "createdAt": "2021-01-01T00:00:00Z",
        "updatedAt": "2021-01-01T00:00:00Z"
    },
    "profiles": [
        {
            "id": "123",
            "name": "Block Social Media",
            "iname": "block-social-media",
            "description": "Block all Social Media",
            "reserved": false,
            "deleted": false,
            "createdAt": "2021-01-01T00:00:00Z",
            "updatedAt": "2021-01-01T00:00:00Z"
        }
    ],
    "status": "active",
    "deleted": false,
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z"
}

---

Docs

Delete an Organization-Wide Policy

Operation ID: deleteOrganizationPolicyGroupPolicyPolicy

PATH /organizations/{organizationId}/policy/groupPolicy/policies/{policyId}

- Path added

- New endpoint

Delete an Organization-Wide Policy

DELETE /organizations/{organizationId}/policy/groupPolicy/policies/{policyId}

---

Docs

List Organization-Wide Policy Vlans

Operation ID: getOrganizationPolicyGroupPolicyVlans

PATH /organizations/{organizationId}/policy/groupPolicy/vlans

{
  "items": [
    {
      "id": "123",
      "name": "Vlan 10",
      "subnet": "10.0.0.0/24",
      "vlanId": "1",
      "networkName": "Home network",
      "zoneIds": [
        "1",
        "2",
        "3"
      ]
    }
  ],
  "meta": {
    "counts": {
      "total": 12,
      "remaining": 2
    }
  }
}

- Path added

- New endpoint

List Organization-Wide Policy Vlans

GET /organizations/{organizationId}/policy/groupPolicy/vlans

{
    "items": [
        {
            "id": "123",
            "name": "Vlan 10",
            "subnet": "10.0.0.0/24",
            "vlanId": "1",
            "networkName": "Home network",
            "zoneIds": [
                "1",
                "2",
                "3"
            ]
        }
    ],
    "meta": {
        "counts": {
            "total": 12,
            "remaining": 2
        }
    }
}

---

Docs

List Organization-Wide Policy Zones

Operation ID: getOrganizationPolicyGroupPolicyZones

PATH /organizations/{organizationId}/policy/groupPolicy/zones

{
  "items": [
    {
      "id": "123",
      "name": "Block Social Media",
      "iname": "block-social-media",
      "kind": "block-social-media",
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "counts": {
      "total": 12,
      "remaining": 2
    }
  }
}

- Path added

- New endpoint

List Organization-Wide Policy Zones

GET /organizations/{organizationId}/policy/groupPolicy/zones

{
    "items": [
        {
            "id": "123",
            "name": "Block Social Media",
            "iname": "block-social-media",
            "kind": "block-social-media",
            "createdAt": "2021-01-01T00:00:00Z",
            "updatedAt": "2021-01-01T00:00:00Z"
        }
    ],
    "meta": {
        "counts": {
            "total": 12,
            "remaining": 2
        }
    }
}

---

- New endpoint

Create an Organization-Wide Policy Zone

POST /organizations/{organizationId}/policy/groupPolicy/zones

{
    "id": "123",
    "name": "Block Social Media",
    "iname": "block-social-media",
    "kind": "block-social-media",
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z"
}

---

Docs

Get Enforcement details

Operation ID: getOrganizationPolicyGroupPolicyZonesDetails

PATH /organizations/{organizationId}/policy/groupPolicy/zones/details

{
  "items": {
    "1": {
      "policy": {
        "id": "123",
        "name": "Policy 123"
      },
      "enforcements": {
        "vlansOverview": [
          {
            "id": "123",
            "name": "Vlan 123"
          }
        ],
        "vlansCount": 3,
        "adaptivePolicyGroups": [
          "7"
        ]
      }
    }
  }
}

- Path added

- New endpoint

Get Enforcement details

GET /organizations/{organizationId}/policy/groupPolicy/zones/details

{
    "items": {
        "1": {
            "policy": {
                "id": "123",
                "name": "Policy 123"
            },
            "enforcements": {
                "vlansOverview": [
                    {
                        "id": "123",
                        "name": "Vlan 123"
                    }
                ],
                "vlansCount": 3,
                "adaptivePolicyGroups": [
                    "7"
                ]
            }
        }
    }
}

---

Docs

Update an Organization-Wide Policy Zone

Operation ID: updateOrganizationPolicyGroupPolicyZone

PATH /organizations/{organizationId}/policy/groupPolicy/zones/{zoneId}

{
  "id": "123",
  "name": "Block Social Media",
  "iname": "block-social-media",
  "kind": "block-social-media",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

- Path added

- New endpoint

Update an Organization-Wide Policy Zone

PUT /organizations/{organizationId}/policy/groupPolicy/zones/{zoneId}

{
    "id": "123",
    "name": "Block Social Media",
    "iname": "block-social-media",
    "kind": "block-social-media",
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z"
}

---

- New endpoint

Delete an Organization-Wide Policy Zone

DELETE /organizations/{organizationId}/policy/groupPolicy/zones/{zoneId}

---

Docs

Assign VLANs to a given Zone

Operation ID: createOrganizationPolicyGroupPolicyZoneVlansAssign

PATH /organizations/{organizationId}/policy/groupPolicy/zones/{zoneId}/vlans/assign

{
  "message": "VLANs assigned successfully"
}

- Path added

- New endpoint

Assign VLANs to a given Zone

POST /organizations/{organizationId}/policy/groupPolicy/zones/{zoneId}/vlans/assign

{
    "message": "VLANs assigned successfully"
}

---

Docs

Remove VLANs from a given Zone

Operation ID: createOrganizationPolicyGroupPolicyZoneVlansRemove

PATH /organizations/{organizationId}/policy/groupPolicy/zones/{zoneId}/vlans/remove

{
  "message": "VLANs removed successfully"
}

- Path added

- New endpoint

Remove VLANs from a given Zone

POST /organizations/{organizationId}/policy/groupPolicy/zones/{zoneId}/vlans/remove

{
    "message": "VLANs removed successfully"
}

---

networks

Docs

Move networks from one organization to another

Operation ID: createNetworkMove

PATH /organizations/{organizationId}/networks/moves

{
  "networkMoveId": "456",
  "url": "/api/v1/organizations/123/networks/moves?networkMoveId=456"
}

- Path added

- New endpoint

Return a list of network move operations in the organization

GET /organizations/{organizationId}/networks/moves

{
    "initiator": {
        "admin": {
            "id": "8590064780"
        }
    },
    "organizations": {
        "source": {
            "id": "146307"
        },
        "target": {
            "id": "146308"
        }
    },
    "network": {
        "id": "N_569142402909112097"
    },
    "createdAt": "1970-01-20T15:57:36.000Z",
    "lastUpdatedAt": "1970-01-20T15:57:36.000Z",
    "status": "failed"
}

---

- New endpoint

Move networks from one organization to another. Note that as this is an Early Access feature it may result in unexpected behavior and is best tested with non-critical networks. For more information and caveats around network move limitations see Network Portability

POST /organizations/{organizationId}/networks/moves

{
    "networkMoveId": "456",
    "url": "/api/v1/organizations/123/networks/moves?networkMoveId=456"
}

---

Docs

Return details on the specified network move operation

Operation ID: getNetworkMove

PATH /organizations/{organizationId}/networks/moves/{networkMoveId}

{
  "initiator": {
    "admin": {
      "id": "8590064780"
    }
  },
  "organizations": {
    "source": {
      "id": "146307"
    },
    "target": {
      "id": "146308"
    }
  },
  "network": {
    "id": "N_569142402909112097"
  },
  "createdAt": "1970-01-20T15:57:36.000Z",
  "lastUpdatedAt": "1970-01-20T15:57:36.000Z",
  "status": "failed"
}

- Path added

- New endpoint

Return details on the specified network move operation

GET /organizations/{organizationId}/networks/moves/{networkMoveId}

{
    "initiator": {
        "admin": {
            "id": "8590064780"
        }
    },
    "organizations": {
        "source": {
            "id": "146307"
        },
        "target": {
            "id": "146308"
        }
    },
    "network": {
        "id": "N_569142402909112097"
    },
    "createdAt": "1970-01-20T15:57:36.000Z",
    "lastUpdatedAt": "1970-01-20T15:57:36.000Z",
    "status": "failed"
}

---

inventory

Docs

Claim an order by the secure unique order claim number, the order claim id

Operation ID: claimOrganizationInventoryOrders

PATH /organizations/{organizationId}/inventory/orders/claim

{
  "claimId": "ABCDEFG12345",
  "number": "97001888",
  "serials": [
    "1234-ABCD-4567"
  ],
  "subscriptions": [
    {
      "subscriptionId": "1234",
      "name": "My UNX Subscription",
      "description": "Wireless Networking Subscription",
      "startDate": "2020-06-30T00:00:00Z",
      "endDate": "2025-06-30T00:00:00Z",
      "isClaimed": false,
      "counts": {
        "seats": {
          "limit": 1
        }
      }
    }
  ]
}

- Path added

- New endpoint

Claim an order by the secure unique order claim number, the order claim id

POST /organizations/{organizationId}/inventory/orders/claim

{
    "claimId": "ABCDEFG12345",
    "number": "97001888",
    "serials": [
        "1234-ABCD-4567"
    ],
    "subscriptions": [
        {
            "subscriptionId": "1234",
            "name": "My UNX Subscription",
            "description": "Wireless Networking Subscription",
            "startDate": "2020-06-30T00:00:00Z",
            "endDate": "2025-06-30T00:00:00Z",
            "isClaimed": false,
            "counts": {
                "seats": {
                    "limit": 1
                }
            }
        }
    ]
}

---

Docs

Preview the results and status of an order claim by the secure order id

Operation ID: previewOrganizationInventoryOrders

PATH /organizations/{organizationId}/inventory/orders/preview

{
  "claimId": "ABCD1EFGH4IJ",
  "number": "97001888",
  "shipping": {
    "shipments": [
      {
        "shippedAt": "2024-06-30T00:00:00Z",
        "number": 1,
        "devices": [
          {
            "quantity": 5,
            "sku": "MR70-HW",
            "description": "Meraki MR70 Cloud Managed AP"
          }
        ]
      }
    ],
    "pending": {
      "devices": [
        {
          "quantity": 1,
          "sku": "MR70-HW",
          "description": "Meraki MX90 Cloud Managed Security Appliance"
        }
      ]
    }
  },
  "subscriptions": [
    {
      "subscriptionId": "1234",
      "name": "My UNX Subscription",
      "description": "Wireless Networking Subscription",
      "startDate": "2020-06-30T00:00:00Z",
      "endDate": "2025-06-30T00:00:00Z",
      "isClaimed": false,
      "counts": {
        "seats": {
          "limit": 1
        }
      }
    }
  ]
}

- Path added

- New endpoint

Preview the results and status of an order claim by the secure order id

POST /organizations/{organizationId}/inventory/orders/preview

{
    "claimId": "ABCD1EFGH4IJ",
    "number": "97001888",
    "shipping": {
        "shipments": [
            {
                "shippedAt": "2024-06-30T00:00:00Z",
                "number": 1,
                "devices": [
                    {
                        "quantity": 5,
                        "sku": "MR70-HW",
                        "description": "Meraki MR70 Cloud Managed AP"
                    }
                ]
            }
        ],
        "pending": {
            "devices": [
                {
                    "quantity": 1,
                    "sku": "MR70-HW",
                    "description": "Meraki MX90 Cloud Managed Security Appliance"
                }
            ]
        }
    },
    "subscriptions": [
        {
            "subscriptionId": "1234",
            "name": "My UNX Subscription",
            "description": "Wireless Networking Subscription",
            "startDate": "2020-06-30T00:00:00Z",
            "endDate": "2025-06-30T00:00:00Z",
            "isClaimed": false,
            "counts": {
                "seats": {
                    "limit": 1
                }
            }
        }
    ]
}

---

extensions

Docs

Update name and status of an Interconnect

Operation ID: updateOrganizationExtensionsSdwanmanagerInterconnect

PATH /organizations/{organizationId}/extensions/sdwanmanager/interconnects/{interconnectId}

{
  "id": "12345",
  "name": "My Interconnect",
  "status": "active",
  "type": "Catalyst SD-WAN",
  "vpnCount": 1,
  "tunnelCount": 4,
  "asNum": 12345,
  "networkId": "N_12345",
  "wiredId": "123456",
  "networkLocaleId": "L_12345",
  "createdAt": "2024-02-11T00:00:00Z",
  "internalSubnets": [
    "169.254.250.0/30",
    "169.254.250.4/30"
  ]
}

- Path added

- New endpoint

Update name and status of an Interconnect

PUT /organizations/{organizationId}/extensions/sdwanmanager/interconnects/{interconnectId}

{
    "id": "12345",
    "name": "My Interconnect",
    "status": "active",
    "type": "Catalyst SD-WAN",
    "vpnCount": 1,
    "tunnelCount": 4,
    "asNum": 12345,
    "networkId": "N_12345",
    "wiredId": "123456",
    "networkLocaleId": "L_12345",
    "createdAt": "2024-02-11T00:00:00Z",
    "internalSubnets": [
        "169.254.250.0/30",
        "169.254.250.4/30"
    ]
}

---

Docs

List the ThousandEyes agent configurations under this organization

Operation ID: getOrganizationExtensionsThousandEyesNetworks

PATH /organizations/{organizationId}/extensions/thousandEyes/networks

[
  {
    "networkId": "N_24329156",
    "enabled": true,
    "agentId": "12345"
  }
]

- Path added

- New endpoint

List the ThousandEyes agent configurations under this organization. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.

GET /organizations/{organizationId}/extensions/thousandEyes/networks

[
    {
        "networkId": "N_24329156",
        "enabled": true,
        "agentId": "12345"
    }
]

---

- New endpoint

Add a ThousandEyes agent for this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.

POST /organizations/{organizationId}/extensions/thousandEyes/networks

{
    "networkId": "N_24329156",
    "enabled": true,
    "agentId": "12345"
}

---

Docs

List all the networks eligible for ThousandEyes agent activation under this organization.

Operation ID: getOrganizationExtensionsThousandEyesNetworksSupported

PATH /organizations/{organizationId}/extensions/thousandEyes/networks/supported

[
  {
    "networkId": "N_24329156",
    "name": "Main Office",
    "tags": [
      "tag1",
      "tag2"
    ],
    "device": {
      "model": "MX105",
      "firmware": {
        "currentVersion": {
          "shortName": "MX 18.104"
        }
      },
      "agent": {
        "isInstalled": false
      }
    }
  }
]

- Path added

- New endpoint

List all the networks eligible for ThousandEyes agent activation under this organization.

GET /organizations/{organizationId}/extensions/thousandEyes/networks/supported

[
    {
        "networkId": "N_24329156",
        "name": "Main Office",
        "tags": [
            "tag1",
            "tag2"
        ],
        "device": {
            "model": "MX105",
            "firmware": {
                "currentVersion": {
                    "shortName": "MX 18.104"
                }
            },
            "agent": {
                "isInstalled": false
            }
        }
    }
]

---

Docs

List the ThousandEyes agent configuration under this network

Operation ID: getOrganizationExtensionsThousandEyesNetwork

PATH /organizations/{organizationId}/extensions/thousandEyes/networks/{networkId}

{
  "networkId": "N_24329156",
  "enabled": true,
  "agentId": "12345"
}

- Path added

- New endpoint

List the ThousandEyes agent configuration under this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.

GET /organizations/{organizationId}/extensions/thousandEyes/networks/{networkId}

{
    "networkId": "N_24329156",
    "enabled": true,
    "agentId": "12345"
}

---

- New endpoint

Update a ThousandEyes agent from this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.

PUT /organizations/{organizationId}/extensions/thousandEyes/networks/{networkId}

{
    "networkId": "N_24329156",
    "enabled": true,
    "agentId": "12345"
}

---

- New endpoint

Delete a ThousandEyes agent from this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.

DELETE /organizations/{organizationId}/extensions/thousandEyes/networks/{networkId}

---

Docs

Create a ThousandEyes test based on a provided test template

Operation ID: createOrganizationExtensionsThousandEyesTest

PATH /organizations/{organizationId}/extensions/thousandEyes/tests

{
  "jobStatus": "new",
  "pccBackgroundJob": "13289785"
}

- Path added

- New endpoint

Create a ThousandEyes test based on a provided test template. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.

POST /organizations/{organizationId}/extensions/thousandEyes/tests

{
    "jobStatus": "new",
    "pccBackgroundJob": "13289785"
}

---

cloud

Docs

List of source/destination traffic rules

Operation ID: getOrganizationCloudConnectivityRequirements

PATH /organizations/{organizationId}/cloud/connectivity/requirements

[
  {
    "description": "Meraki cloud communication",
    "productTypes": [
      "appliance",
      "wireless",
      "camera",
      "switch"
    ],
    "rule": {
      "sources": {
        "includeAddressesInYourNetworks": false,
        "addresses": [
          {
            "type": "ipv4",
            "address": "209.206.48.0/20"
          }
        ]
      },
      "destinations": {
        "includeAddressesInYourNetworks": false,
        "includeAnyAddress": false,
        "addresses": [
          {
            "type": "fqdn",
            "address": "webhook.site"
          }
        ]
      },
      "ports": [
        {
          "port": "443",
          "protocols": [
            "TCP"
          ]
        }
      ]
    }
  }
]

- Path added

- New endpoint

List of source/destination traffic rules

GET /organizations/{organizationId}/cloud/connectivity/requirements

[
    {
        "description": "Meraki cloud communication",
        "productTypes": [
            "appliance",
            "wireless",
            "camera",
            "switch"
        ],
        "rule": {
            "sources": {
                "includeAddressesInYourNetworks": false,
                "addresses": [
                    {
                        "type": "ipv4",
                        "address": "209.206.48.0/20"
                    }
                ]
            },
            "destinations": {
                "includeAddressesInYourNetworks": false,
                "includeAnyAddress": false,
                "addresses": [
                    {
                        "type": "fqdn",
                        "address": "webhook.site"
                    }
                ]
            },
            "ports": [
                {
                    "port": "443",
                    "protocols": [
                        "TCP"
                    ]
                }
            ]
        }
    }
]

---

certificates

Docs

Gets all or specific certificates for an organization

Operation ID: getOrganizationCertificates

PATH /organizations/{organizationId}/certificates

{
  "certificateId": "1284392014819",
  "description": "friendly description",
  "parentCertificateId": "1284392014818",
  "source": "NAC",
  "fields": {
    "validity": {
      "start": "2022-09-01T12:00:00Z",
      "end": "2022-10-01T12:00:00Z"
    },
    "subject": {
      "commonName": "subjectRoot",
      "organizationalUnit": "CloudNAC",
      "organization": "Cisco Systems",
      "locality": "Bangalore",
      "state": "KA",
      "country": "IN"
    },
    "subjectAlternativeName": "AAA Certificate Services Hidden Certificate",
    "issuer": {
      "commonName": "issuerRoot",
      "organizationalUnit": "CloudNAC",
      "organization": "Cisco Systems",
      "locality": "Bangalore",
      "state": "KA",
      "country": "IN"
    },
    "serial": "7C 08 29 E8 CC",
    "policy": "policy string here",
    "version": "1.2.3.4",
    "signatureAlgorithmId": "SHA256withRSA",
    "publicKeyAlgorithm": "RSA",
    "keyUsage": {
      "isCritical": false,
      "data": [
        "Digital Signature",
        "Key Encipherment"
      ]
    },
    "hashes": [
      {
        "algorithm": "SHA1",
        "hash": "hash text here"
      }
    ]
  }
}

- Path added

- New endpoint

Gets all or specific certificates for an organization

GET /organizations/{organizationId}/certificates

{
    "certificateId": "1284392014819",
    "description": "friendly description",
    "parentCertificateId": "1284392014818",
    "source": "NAC",
    "fields": {
        "validity": {
            "start": "2022-09-01T12:00:00Z",
            "end": "2022-10-01T12:00:00Z"
        },
        "subject": {
            "commonName": "subjectRoot",
            "organizationalUnit": "CloudNAC",
            "organization": "Cisco Systems",
            "locality": "Bangalore",
            "state": "KA",
            "country": "IN"
        },
        "subjectAlternativeName": "AAA Certificate Services Hidden Certificate",
        "issuer": {
            "commonName": "issuerRoot",
            "organizationalUnit": "CloudNAC",
            "organization": "Cisco Systems",
            "locality": "Bangalore",
            "state": "KA",
            "country": "IN"
        },
        "serial": "7C 08 29 E8 CC",
        "policy": "policy string here",
        "version": "1.2.3.4",
        "signatureAlgorithmId": "SHA256withRSA",
        "publicKeyAlgorithm": "RSA",
        "keyUsage": {
            "isCritical": false,
            "data": [
                "Digital Signature",
                "Key Encipherment"
            ]
        },
        "hashes": [
            {
                "algorithm": "SHA1",
                "hash": "hash text here"
            }
        ]
    }
}

---

Docs

Import certificate for this organization

Operation ID: createOrganizationCertificatesImport

PATH /organizations/{organizationId}/certificates/import

{
  "certificateId": "1284392014819",
  "description": "friendly description",
  "parentCertificateId": "1284392014818",
  "source": "NAC",
  "fields": {
    "validity": {
      "start": "2022-09-01T12:00:00Z",
      "end": "2022-10-01T12:00:00Z"
    },
    "subject": {
      "commonName": "subjectRoot",
      "organizationalUnit": "CloudNAC",
      "organization": "Cisco Systems",
      "locality": "Bangalore",
      "state": "KA",
      "country": "IN"
    },
    "subjectAlternativeName": "AAA Certificate Services Hidden Certificate",
    "issuer": {
      "commonName": "issuerRoot",
      "organizationalUnit": "CloudNAC",
      "organization": "Cisco Systems",
      "locality": "Bangalore",
      "state": "KA",
      "country": "IN"
    },
    "serial": "7C 08 29 E8 CC",
    "policy": "policy string here",
    "version": "1.2.3.4",
    "signatureAlgorithmId": "SHA256withRSA",
    "publicKeyAlgorithm": "RSA",
    "keyUsage": {
      "isCritical": false,
      "data": [
        "Digital Signature",
        "Key Encipherment"
      ]
    },
    "hashes": [
      {
        "algorithm": "SHA1",
        "hash": "hash text here"
      }
    ]
  }
}

- Path added

- New endpoint

Import certificate for this organization

POST /organizations/{organizationId}/certificates/import

{
    "certificateId": "1284392014819",
    "description": "friendly description",
    "parentCertificateId": "1284392014818",
    "source": "NAC",
    "fields": {
        "validity": {
            "start": "2022-09-01T12:00:00Z",
            "end": "2022-10-01T12:00:00Z"
        },
        "subject": {
            "commonName": "subjectRoot",
            "organizationalUnit": "CloudNAC",
            "organization": "Cisco Systems",
            "locality": "Bangalore",
            "state": "KA",
            "country": "IN"
        },
        "subjectAlternativeName": "AAA Certificate Services Hidden Certificate",
        "issuer": {
            "commonName": "issuerRoot",
            "organizationalUnit": "CloudNAC",
            "organization": "Cisco Systems",
            "locality": "Bangalore",
            "state": "KA",
            "country": "IN"
        },
        "serial": "7C 08 29 E8 CC",
        "policy": "policy string here",
        "version": "1.2.3.4",
        "signatureAlgorithmId": "SHA256withRSA",
        "publicKeyAlgorithm": "RSA",
        "keyUsage": {
            "isCritical": false,
            "data": [
                "Digital Signature",
                "Key Encipherment"
            ]
        },
        "hashes": [
            {
                "algorithm": "SHA1",
                "hash": "hash text here"
            }
        ]
    }
}

---

Docs

Delete a certificate for an organization

Operation ID: deleteOrganizationCertificate

PATH /organizations/{organizationId}/certificates/{certificateId}

- Path added

- New endpoint

Update a certificate's description for an organization

PUT /organizations/{organizationId}/certificates/{certificateId}

{
    "certificateId": "1284392014819",
    "description": "friendly description",
    "parentCertificateId": "1284392014818",
    "source": "NAC",
    "fields": {
        "validity": {
            "start": "2022-09-01T12:00:00Z",
            "end": "2022-10-01T12:00:00Z"
        },
        "subject": {
            "commonName": "subjectRoot",
            "organizationalUnit": "CloudNAC",
            "organization": "Cisco Systems",
            "locality": "Bangalore",
            "state": "KA",
            "country": "IN"
        },
        "subjectAlternativeName": "AAA Certificate Services Hidden Certificate",
        "issuer": {
            "commonName": "issuerRoot",
            "organizationalUnit": "CloudNAC",
            "organization": "Cisco Systems",
            "locality": "Bangalore",
            "state": "KA",
            "country": "IN"
        },
        "serial": "7C 08 29 E8 CC",
        "policy": "policy string here",
        "version": "1.2.3.4",
        "signatureAlgorithmId": "SHA256withRSA",
        "publicKeyAlgorithm": "RSA",
        "keyUsage": {
            "isCritical": false,
            "data": [
                "Digital Signature",
                "Key Encipherment"
            ]
        },
        "hashes": [
            {
                "algorithm": "SHA1",
                "hash": "hash text here"
            }
        ]
    }
}

---

- New endpoint

Delete a certificate for an organization

DELETE /organizations/{organizationId}/certificates/{certificateId}

---

Docs

Download the trusted certificate by certificate id.

Operation ID: getOrganizationCertificateContents

PATH /organizations/{organizationId}/certificates/{certificateId}/contents

{
  "contents": "-----BEGIN CERTIFICATE-----MIIHvjCCBqagAwIBAgIQB4CbtQD3es3UQ988CCKGPjANBgkqhkiG9w0BAQsFADBPMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMSkwJwYDVQQDEyBEaWdpQ2VydCBUTFMgUlNBIFNIQTI1NiAyMDIwIENBMTAeFw0yMjA4MTAwMDAwMDBaFw0yMzA4MDkyMzU5NTlaMG4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNpc2NvMRMwEQYDVQQKEwpNZXJha2kgTExDMR0wGwYDVQQDExRyYWRpdXMuZGV2LmlrYXJlbS5pbzCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBANSxcK8g9J3nRwDqNurYbXDieo5vHw5wWO4m3uJSvWtQ+zDMZzjEhA6ix3VfftGLLE+0C99a9B2oOubZgO/sAIJmLD6Oz25bUinAtzuEmOQiqZ8OZjYZd//emPOty7POZSU5C3rGUX0ESzrStL20iJoGzyA0U9clI+14yZCyXY1+Th3VSQCvGs/DmOMPn+MdBoMXIgzVk7+wjMr53fN6H8Q26y52NlLTmAxum2L7ag4owTecURzC6-----END CERTIFICATE-----"
}

- Path added

- New endpoint

Download the trusted certificate by certificate id.

GET /organizations/{organizationId}/certificates/{certificateId}/contents

{
    "contents": "-----BEGIN CERTIFICATE-----MIIHvjCCBqagAwIBAgIQB4CbtQD3es3UQ988CCKGPjANBgkqhkiG9w0BAQsFADBPMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMSkwJwYDVQQDEyBEaWdpQ2VydCBUTFMgUlNBIFNIQTI1NiAyMDIwIENBMTAeFw0yMjA4MTAwMDAwMDBaFw0yMzA4MDkyMzU5NTlaMG4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNpc2NvMRMwEQYDVQQKEwpNZXJha2kgTExDMR0wGwYDVQQDExRyYWRpdXMuZGV2LmlrYXJlbS5pbzCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBANSxcK8g9J3nRwDqNurYbXDieo5vHw5wWO4m3uJSvWtQ+zDMZzjEhA6ix3VfftGLLE+0C99a9B2oOubZgO/sAIJmLD6Oz25bUinAtzuEmOQiqZ8OZjYZd//emPOty7POZSU5C3rGUX0ESzrStL20iJoGzyA0U9clI+14yZCyXY1+Th3VSQCvGs/DmOMPn+MdBoMXIgzVk7+wjMr53fN6H8Q26y52NlLTmAxum2L7ag4owTecURzC6-----END CERTIFICATE-----"
}

---

auth

Docs

List the organization-wide RADIUS servers in the organization

Operation ID: getOrganizationAuthRadiusServers

PATH /organizations/{organizationId}/auth/radius/servers

[
  {
    "serverId": "42",
    "name": "HQ RADIUS server",
    "address": "1.2.3.4",
    "modes": [
      {
        "mode": "auth",
        "port": 1812
      }
    ]
  }
]

- Path added

- New endpoint

List the organization-wide RADIUS servers in the organization

GET /organizations/{organizationId}/auth/radius/servers

[
    {
        "serverId": "42",
        "name": "HQ RADIUS server",
        "address": "1.2.3.4",
        "modes": [
            {
                "mode": "auth",
                "port": 1812
            }
        ]
    }
]

---

- New endpoint

Add an organization-wide RADIUS server

POST /organizations/{organizationId}/auth/radius/servers

{
    "serverId": "42",
    "name": "HQ RADIUS server",
    "address": "1.2.3.4",
    "modes": [
        {
            "mode": "auth",
            "port": 1812
        }
    ]
}

---

Docs

Return list of network and policies that organization-wide RADIUS servers are bing used

Operation ID: getOrganizationAuthRadiusServersAssignments

PATH /organizations/{organizationId}/auth/radius/servers/assignments

{
  "serverId": "42",
  "name": "HQ RADIUS server",
  "assignments": [
    {
      "network": {
        "id": "L_1234",
        "eid": "L_1234",
        "tag": "San-Francisco",
        "name": "San Francisco Office",
        "dashboardUrl": "https://n1.meraki.dev.ikram.io/tag/n/1234/manage/nodes/list"
      },
      "assignee": {
        "type": "Access policy",
        "id": "42",
        "name": "Access policy #42",
        "dashboardUrl": "https://n1.meraki.dev.ikram.io/tag/n/1234/manage/configure/switch_access"
      }
    }
  ]
}

- Path added

- New endpoint

Return list of network and policies that organization-wide RADIUS servers are bing used

GET /organizations/{organizationId}/auth/radius/servers/assignments

{
    "serverId": "42",
    "name": "HQ RADIUS server",
    "assignments": [
        {
            "network": {
                "id": "L_1234",
                "eid": "L_1234",
                "tag": "San-Francisco",
                "name": "San Francisco Office",
                "dashboardUrl": "https://n1.meraki.dev.ikram.io/tag/n/1234/manage/nodes/list"
            },
            "assignee": {
                "type": "Access policy",
                "id": "42",
                "name": "Access policy #42",
                "dashboardUrl": "https://n1.meraki.dev.ikram.io/tag/n/1234/manage/configure/switch_access"
            }
        }
    ]
}

---

Docs

Return an organization-wide RADIUS server

Operation ID: getOrganizationAuthRadiusServer

PATH /organizations/{organizationId}/auth/radius/servers/{serverId}

{
  "serverId": "42",
  "name": "HQ RADIUS server",
  "address": "1.2.3.4",
  "modes": [
    {
      "mode": "auth",
      "port": 1812
    }
  ]
}

- Path added

- New endpoint

Return an organization-wide RADIUS server

GET /organizations/{organizationId}/auth/radius/servers/{serverId}

{
    "serverId": "42",
    "name": "HQ RADIUS server",
    "address": "1.2.3.4",
    "modes": [
        {
            "mode": "auth",
            "port": 1812
        }
    ]
}

---

- New endpoint

Update an organization-wide RADIUS server

PUT /organizations/{organizationId}/auth/radius/servers/{serverId}

{
    "serverId": "42",
    "name": "HQ RADIUS server",
    "address": "1.2.3.4",
    "modes": [
        {
            "mode": "auth",
            "port": 1812
        }
    ]
}

---

- New endpoint

Delete an organization-wide RADIUS server from a organization

DELETE /organizations/{organizationId}/auth/radius/servers/{serverId}

---

workflows

Docs

Return workflows filtered by organization ID, network ID, type, and category

Operation ID: getOrganizationAssuranceWorkflows

PATH /organizations/{organizationId}/assurance/workflows

[
  {
    "id": "workflow1",
    "organizationId": "org1",
    "network": {
      "id": "L_123456",
      "name": "Network 1"
    },
    "scopeId": "scope123",
    "type": "type1",
    "categoryType": "category1",
    "scopeType": "scope1",
    "workflowState": "active",
    "timestamp": "2025-04-14T12:00:00Z",
    "networkTags": [
      "tag1",
      "tag2"
    ],
    "clientTags": [
      "clientTag1",
      "clientTag2"
    ],
    "nodeTags": [
      "nodeTag1",
      "nodeTag2"
    ],
    "resolvedAt": "2018-02-11T00:00:00.090210Z"
  }
]

- Path added

- New endpoint

Return workflows filtered by organization ID, network ID, type, and category

GET /organizations/{organizationId}/assurance/workflows

[
    {
        "id": "workflow1",
        "organizationId": "org1",
        "network": {
            "id": "L_123456",
            "name": "Network 1"
        },
        "scopeId": "scope123",
        "type": "type1",
        "categoryType": "category1",
        "scopeType": "scope1",
        "workflowState": "active",
        "timestamp": "2025-04-14T12:00:00Z",
        "networkTags": [
            "tag1",
            "tag2"
        ],
        "clientTags": [
            "clientTag1",
            "clientTag2"
        ],
        "nodeTags": [
            "nodeTag1",
            "nodeTag2"
        ],
        "resolvedAt": "2018-02-11T00:00:00.090210Z"
    }
]

---

productAnnouncements

Docs

Gets relevant product announcements for a user

Operation ID: getOrganizationAssuranceProductAnnouncements

PATH /organizations/{organizationId}/assurance/productAnnouncements

{
  "items": [
    {
      "id": "123",
      "boardId": "new-features",
      "title": "Cisco Meraki India Region cloud now in GA",
      "url": "https://community.meraki.com/t5/Feature-Announcements/Cisco-Meraki-India-Region-cloud-now-in-GA/ba-p/259490",
      "snippet": "As part of our ongoing commitment to the cloud and helping customers meet their local data storage needs, we are excited to announce that Cisco Meraki India Region cloud is now released in GA (Genera...",
      "publishedAt": "2018-02-11T00:00:00.090210Z",
      "editedAt": "2018-02-11T00:00:00.090210Z",
      "labels": [
        {
          "id": "1",
          "name": "Features"
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1
      }
    }
  }
}

- Path added

- New endpoint

Gets relevant product announcements for a user

GET /organizations/{organizationId}/assurance/productAnnouncements

{
    "items": [
        {
            "id": "123",
            "boardId": "new-features",
            "title": "Cisco Meraki India Region cloud now in GA",
            "url": "https://community.meraki.com/t5/Feature-Announcements/Cisco-Meraki-India-Region-cloud-now-in-GA/ba-p/259490",
            "snippet": "As part of our ongoing commitment to the cloud and helping customers meet their local data storage needs, we are excited to announce that Cisco Meraki India Region cloud is now released in GA (Genera...",
            "publishedAt": "2018-02-11T00:00:00.090210Z",
            "editedAt": "2018-02-11T00:00:00.090210Z",
            "labels": [
                {
                    "id": "1",
                    "name": "Features"
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1
            }
        }
    }
}

---

snmp

Docs

Retrieve the SNMP trap configuration for the networks in an organization

Operation ID: getOrganizationSnmpTrapsByNetwork

PATH /organizations/{organizationId}/snmp/traps/byNetwork

[
  {
    "network": {
      "id": "N_12345678",
      "name": "networkName"
    },
    "mode": "v3",
    "receiver": {
      "address": "1.1.1.1",
      "port": "1234"
    },
    "v2": {
      "community": "public"
    },
    "v3": {
      "users": [
        {
          "name": "merakian"
        }
      ]
    }
  }
]

- Path added

- New endpoint

Retrieve the SNMP trap configuration for the networks in an organization

GET /organizations/{organizationId}/snmp/traps/byNetwork

[
    {
        "network": {
            "id": "N_12345678",
            "name": "networkName"
        },
        "mode": "v3",
        "receiver": {
            "address": "1.1.1.1",
            "port": "1234"
        },
        "v2": {
            "community": "public"
        },
        "v3": {
            "users": [
                {
                    "name": "merakian"
                }
            ]
        }
    }
]

---

devices

Docs

Returns the history of device boots in reverse chronological order (most recent first)

Operation ID: getOrganizationDevicesBootsHistory

PATH /organizations/{organizationId}/devices/boots/history

[
  {
    "serial": "Q234-ABCD-5678",
    "network": {
      "id": "N_24329156"
    },
    "start": {
      "bootedAt": "2018-02-11T00:00:00.090210Z"
    }
  }
]

- Path added

- New endpoint

Returns the history of device boots in reverse chronological order (most recent first). Currently supported for MS devices only.

GET /organizations/{organizationId}/devices/boots/history

[
    {
        "serial": "Q234-ABCD-5678",
        "network": {
            "id": "N_24329156"
        },
        "start": {
            "bootedAt": "2018-02-11T00:00:00.090210Z"
        }
    }
]

---

Docs

Delete packet capture schedules

Operation ID: bulkOrganizationDevicesPacketCaptureSchedulesDelete

PATH /organizations/{organizationId}/devices/packetCapture/schedules/bulkDelete

- Path added

- New endpoint

Delete packet capture schedules

POST /organizations/{organizationId}/devices/packetCapture/schedules/bulkDelete

---

Docs

Enqueues a task for a specific packet capture

Operation ID: tasksOrganizationDevicesPacketCapture

PATH /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks

{
  "task": "analysis",
  "taskId": "123456",
  "status": "pending"
}

- Path added

- New endpoint

Enqueues a task for a specific packet capture. This endpoint has a sustained rate limit of one request every 60 seconds.

POST /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks

{
    "task": "analysis",
    "taskId": "123456",
    "status": "pending"
}

---

Docs

Retrieves packet capture analysis result for a specific packet capture task.

Operation ID: getOrganizationDevicesPacketCaptureTask

PATH /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks/{id}

{
  "task": "analysis",
  "status": "completed",
  "summary": {
    "counts": {
      "total": 1,
      "successes": 0,
      "failures": 1
    },
    "macs": [
      "00:11:22:33:44:55"
    ],
    "ips": [
      "1.2.3.4"
    ],
    "devices": [
      {
        "name": "My AP",
        "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000"
      }
    ]
  },
  "analyzers": {
    "analyzer": {
      "present": true,
      "macs": [
        "00:11:22:33:44:55"
      ],
      "ips": [
        "1.2.3.4"
      ],
      "devices": [
        "My AP"
      ],
      "testCounts": {
        "total": 1,
        "successes": 0,
        "failures": 1
      },
      "testResults": [
        {
          "passed": [
            {
              "name": "Test",
              "status": false,
              "details": []
            }
          ],
          "failed": [
            {
              "name": "Test",
              "status": false,
              "details": [
                {
                  "subCategory": "DHCP Request not seen",
                  "failureCount": 3,
                  "packets": [
                    5,
                    6,
                    7
                  ],
                  "detailMessage": "Failed",
                  "macs": [
                    "00:11:22:33:44:55"
                  ],
                  "ips": [
                    "1.2.3.4"
                  ],
                  "devices": [
                    "My AP"
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "fileName": "sample.pcap",
  "filePathUrl": "https://www.meraki.com"
}

- Path added

- New endpoint

Retrieves packet capture analysis result for a specific packet capture task.

GET /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks/{id}

{
    "task": "analysis",
    "status": "completed",
    "summary": {
        "counts": {
            "total": 1,
            "successes": 0,
            "failures": 1
        },
        "macs": [
            "00:11:22:33:44:55"
        ],
        "ips": [
            "1.2.3.4"
        ],
        "devices": [
            {
                "name": "My AP",
                "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000"
            }
        ]
    },
    "analyzers": {
        "analyzer": {
            "present": true,
            "macs": [
                "00:11:22:33:44:55"
            ],
            "ips": [
                "1.2.3.4"
            ],
            "devices": [
                "My AP"
            ],
            "testCounts": {
                "total": 1,
                "successes": 0,
                "failures": 1
            },
            "testResults": [
                {
                    "passed": [
                        {
                            "name": "Test",
                            "status": false,
                            "details": []
                        }
                    ],
                    "failed": [
                        {
                            "name": "Test",
                            "status": false,
                            "details": [
                                {
                                    "subCategory": "DHCP Request not seen",
                                    "failureCount": 3,
                                    "packets": [
                                        5,
                                        6,
                                        7
                                    ],
                                    "detailMessage": "Failed",
                                    "macs": [
                                        "00:11:22:33:44:55"
                                    ],
                                    "ips": [
                                        "1.2.3.4"
                                    ],
                                    "devices": [
                                        "My AP"
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    },
    "fileName": "sample.pcap",
    "filePathUrl": "https://www.meraki.com"
}

---

Docs

Returns syslog servers configured for the networks within an organization.

Operation ID: getOrganizationDevicesSyslogServersByNetwork

PATH /organizations/{organizationId}/devices/syslog/servers/byNetwork

{
  "items": [
    {
      "network": {
        "id": "N_123456789012345678"
      },
      "servers": [
        {
          "host": "1.2.3.4",
          "port": "443",
          "roles": [
            "Wireless event log",
            "Appliance URLs"
          ],
          "transportProtocol": "UDP",
          "encryption": {
            "enabled": true,
            "certificate": {
              "id": "1637"
            }
          }
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

Returns syslog servers configured for the networks within an organization.

GET /organizations/{organizationId}/devices/syslog/servers/byNetwork

{
    "items": [
        {
            "network": {
                "id": "N_123456789012345678"
            },
            "servers": [
                {
                    "host": "1.2.3.4",
                    "port": "443",
                    "roles": [
                        "Wireless event log",
                        "Appliance URLs"
                    ],
                    "transportProtocol": "UDP",
                    "encryption": {
                        "enabled": true,
                        "certificate": {
                            "id": "1637"
                        }
                    }
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1,
                "remaining": 0
            }
        }
    }
}

---

Docs

Returns roles that can be assigned to a syslog server for a given network.

Operation ID: getOrganizationDevicesSyslogServersRolesByNetwork

PATH /organizations/{organizationId}/devices/syslog/servers/roles/byNetwork

{
  "items": [
    {
      "network": {
        "id": "N_123456789012345678"
      },
      "availableRoles": [
        {
          "name": "Wireless Event Log",
          "value": "wireless_event_log"
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 2
      }
    }
  }
}

- Path added

- New endpoint

Returns roles that can be assigned to a syslog server for a given network.

GET /organizations/{organizationId}/devices/syslog/servers/roles/byNetwork

{
    "items": [
        {
            "network": {
                "id": "N_123456789012345678"
            },
            "availableRoles": [
                {
                    "name": "Wireless Event Log",
                    "value": "wireless_event_log"
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 2
            }
        }
    }
}

---

[ networks ]

snmp

Docs

Update the SNMP trap configuration for the specified network

Operation ID: updateNetworkSnmpTraps

PATH /networks/{networkId}/snmp/traps

{
  "network": {
    "id": "N_12345678",
    "name": "networkName"
  },
  "mode": "v3",
  "receiver": {
    "address": "1.1.1.1",
    "port": "1234"
  },
  "v2": {
    "community": "public"
  },
  "v3": {
    "users": [
      {
        "name": "merakian"
      }
    ]
  }
}

- Path added

- New endpoint

Update the SNMP trap configuration for the specified network

PUT /networks/{networkId}/snmp/traps

{
    "network": {
        "id": "N_12345678",
        "name": "networkName"
    },
    "mode": "v3",
    "receiver": {
        "address": "1.1.1.1",
        "port": "1234"
    },
    "v2": {
        "community": "public"
    },
    "v3": {
        "users": [
            {
                "name": "merakian"
            }
        ]
    }
}

---

locationScanning

Docs

Return scanning API settings

Operation ID: getNetworkLocationScanning

PATH /networks/{networkId}/locationScanning

{
  "analyticsEnabled": true,
  "scanningApiEnabled": true,
  "validator": "xxyzzy"
}

- Path added

- New endpoint

Return scanning API settings

GET /networks/{networkId}/locationScanning

{
    "analyticsEnabled": true,
    "scanningApiEnabled": true,
    "validator": "xxyzzy"
}

---

- New endpoint

Change scanning API settings

PUT /networks/{networkId}/locationScanning

{
    "analyticsEnabled": true,
    "scanningApiEnabled": true,
    "validator": "xxyzzy"
}

---

Docs

Return list of scanning API receivers

Operation ID: getNetworkLocationScanningHttpServers

PATH /networks/{networkId}/locationScanning/httpServers

[
  {
    "endpoints": [
      {
        "httpServer": {
          "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
          "name": "Example Webhook Server",
          "networkId": "N_12345678",
          "url": "https://www.example.com/my_custom_webhook",
          "sharedSecret": "******",
          "validator": "xxx",
          "validatedAt": "2018-02-11T00:00:00Z"
        },
        "scanningApiVersion": 123,
        "radioType": "WiFi",
        "successAt": "2018-05-12T00:00:00Z",
        "errorAt": "2018-02-11T00:00:00Z",
        "postErrors": "[{\"code\":200,\"delay\":{\"inMillis\":612},\"timestamp\":{\"millisFromEpoch\":1597255325467}}]"
      }
    ]
  }
]

- Path added

- New endpoint

Return list of scanning API receivers

GET /networks/{networkId}/locationScanning/httpServers

[
    {
        "endpoints": [
            {
                "httpServer": {
                    "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
                    "name": "Example Webhook Server",
                    "networkId": "N_12345678",
                    "url": "https://www.example.com/my_custom_webhook",
                    "sharedSecret": "******",
                    "validator": "xxx",
                    "validatedAt": "2018-02-11T00:00:00Z"
                },
                "scanningApiVersion": 123,
                "radioType": "WiFi",
                "successAt": "2018-05-12T00:00:00Z",
                "errorAt": "2018-02-11T00:00:00Z",
                "postErrors": "[{\"code\":200,\"delay\":{\"inMillis\":612},\"timestamp\":{\"millisFromEpoch\":1597255325467}}]"
            }
        ]
    }
]

---

- New endpoint

Set the list of scanning API receivers. Old receivers will be removed

PUT /networks/{networkId}/locationScanning/httpServers

{
    "endpoints": [
        {
            "httpServer": {
                "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
                "name": "Example Webhook Server",
                "networkId": "N_12345678",
                "url": "https://www.example.com/my_custom_webhook",
                "sharedSecret": "******",
                "validator": "xxx",
                "validatedAt": "2018-02-11T00:00:00Z"
            },
            "scanningApiVersion": 123,
            "radioType": "WiFi",
            "successAt": "2018-05-12T00:00:00Z",
            "errorAt": "2018-02-11T00:00:00Z",
            "postErrors": "[{\"code\":200,\"delay\":{\"inMillis\":612},\"timestamp\":{\"millisFromEpoch\":1597255325467}}]"
        }
    ]
}

---

devices

Docs

Updates the syslog servers configuration for a network.

Operation ID: updateNetworkDevicesSyslogServers

PATH /networks/{networkId}/devices/syslog/servers

{
  "network": {
    "id": "N_123456789012345678"
  },
  "servers": [
    {
      "host": "1.2.3.4",
      "port": "443",
      "roles": [
        "Wireless event log",
        "Appliance URLs"
      ],
      "transportProtocol": "UDP",
      "encryption": {
        "enabled": true,
        "certificate": {
          "id": "1637"
        }
      }
    }
  ]
}

- Path added

- New endpoint

Updates the syslog servers configuration for a network.

PUT /networks/{networkId}/devices/syslog/servers

{
    "network": {
        "id": "N_123456789012345678"
    },
    "servers": [
        {
            "host": "1.2.3.4",
            "port": "443",
            "roles": [
                "Wireless event log",
                "Appliance URLs"
            ],
            "transportProtocol": "UDP",
            "encryption": {
                "enabled": true,
                "certificate": {
                    "id": "1637"
                }
            }
        }
    ]
}

---

[ wireless ]

mqtt

Docs

Return MQTT Settings for networks

Operation ID: getOrganizationWirelessMqttSettings

PATH /organizations/{organizationId}/wireless/mqtt/settings

{
  "items": [
    {
      "network": {
        "id": "L_1234",
        "name": "My Network"
      },
      "mqtt": {
        "settingsId": "1234567",
        "enabled": true,
        "topic": "Test Topic",
        "messageFields": [
          "RSSI",
          "AP MAC address",
          "Client MAC address",
          "Timestamp",
          "Radio",
          "Network ID",
          "Beacon type",
          "Raw payload",
          "Client UUID",
          "Client Major value",
          "Client Minor value",
          "Signal power",
          "Band",
          "Slot ID"
        ],
        "publishing": {
          "frequency": 1,
          "qos": 1
        },
        "broker": {
          "id": "1234",
          "name": "My Broker"
        }
      },
      "ble": {
        "enabled": false,
        "type": "ibeacon",
        "flush": {
          "frequency": 60
        },
        "allowLists": {
          "uuids": [],
          "macs": []
        },
        "hysteresis": {
          "enabled": true,
          "threshold": 1
        }
      },
      "wifi": {
        "enabled": false,
        "type": "associated",
        "flush": {
          "frequency": 60
        },
        "allowLists": {
          "macs": []
        },
        "hysteresis": {
          "enabled": false,
          "threshold": 1
        }
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

Return MQTT Settings for networks

GET /organizations/{organizationId}/wireless/mqtt/settings

{
    "items": [
        {
            "network": {
                "id": "L_1234",
                "name": "My Network"
            },
            "mqtt": {
                "settingsId": "1234567",
                "enabled": true,
                "topic": "Test Topic",
                "messageFields": [
                    "RSSI",
                    "AP MAC address",
                    "Client MAC address",
                    "Timestamp",
                    "Radio",
                    "Network ID",
                    "Beacon type",
                    "Raw payload",
                    "Client UUID",
                    "Client Major value",
                    "Client Minor value",
                    "Signal power",
                    "Band",
                    "Slot ID"
                ],
                "publishing": {
                    "frequency": 1,
                    "qos": 1
                },
                "broker": {
                    "id": "1234",
                    "name": "My Broker"
                }
            },
            "ble": {
                "enabled": false,
                "type": "ibeacon",
                "flush": {
                    "frequency": 60
                },
                "allowLists": {
                    "uuids": [],
                    "macs": []
                },
                "hysteresis": {
                    "enabled": true,
                    "threshold": 1
                }
            },
            "wifi": {
                "enabled": false,
                "type": "associated",
                "flush": {
                    "frequency": 60
                },
                "allowLists": {
                    "macs": []
                },
                "hysteresis": {
                    "enabled": false,
                    "threshold": 1
                }
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

---

- New endpoint

Add new broker config for wireless MQTT

PUT /organizations/{organizationId}/wireless/mqtt/settings

{
    "network": {
        "id": "L_1234",
        "name": "My Network"
    },
    "mqtt": {
        "settingsId": "1234567",
        "enabled": true,
        "topic": "Test Topic",
        "messageFields": [
            "RSSI",
            "AP MAC address",
            "Client MAC address",
            "Timestamp",
            "Radio",
            "Network ID",
            "Beacon type",
            "Raw payload",
            "Client UUID",
            "Client Major value",
            "Client Minor value",
            "Signal power",
            "Band",
            "Slot ID"
        ],
        "publishing": {
            "frequency": 1,
            "qos": 1
        },
        "broker": {
            "id": "1234",
            "name": "My Broker"
        }
    },
    "ble": {
        "enabled": false,
        "type": "ibeacon",
        "flush": {
            "frequency": 60
        },
        "allowLists": {
            "uuids": [],
            "macs": []
        },
        "hysteresis": {
            "enabled": true,
            "threshold": 1
        }
    },
    "wifi": {
        "enabled": false,
        "type": "associated",
        "flush": {
            "frequency": 60
        },
        "allowLists": {
            "macs": []
        },
        "hysteresis": {
            "enabled": false,
            "threshold": 1
        }
    }
}

---

certificates

Docs

Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs).

Operation ID: getOrganizationWirelessCertificatesOpenRoamingCertificateAuthority

PATH /organizations/{organizationId}/wireless/certificates/openRoaming/certificateAuthority

{
  "status": "trusted",
  "contents": "-----BEGIN CERTIFICATE-----\n\n        MIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n\n        umkqeYeO30g1uYvDuWLXVA==\n\n        -----END CERTIFICATE-----\n"
}

- Path added

- New endpoint

Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs).

GET /organizations/{organizationId}/wireless/certificates/openRoaming/certificateAuthority

{
    "status": "trusted",
    "contents": "-----BEGIN CERTIFICATE-----\n\n        MIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n\n        umkqeYeO30g1uYvDuWLXVA==\n\n        -----END CERTIFICATE-----\n"
}

---

ssids

Docs

Update the client exclusion status configuration for a given SSID

Operation ID: updateNetworkWirelessSsidPoliciesClientExclusion

PATH /networks/{networkId}/wireless/ssids/{number}/policies/clientExclusion

{
  "ssid": {
    "id": "12312333",
    "number": 1,
    "name": "My SSID"
  },
  "network": {
    "id": "N_1234",
    "name": "MR wireless 1"
  },
  "static": {
    "enabled": true
  }
}

- Path added

- New endpoint

Update the client exclusion status configuration for a given SSID

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

{
    "ssid": {
        "id": "12312333",
        "number": 1,
        "name": "My SSID"
    },
    "network": {
        "id": "N_1234",
        "name": "MR wireless 1"
    },
    "static": {
        "enabled": true
    }
}

---

Docs

Set the static client exclusion list for the given SSID

Operation ID: updateNetworkWirelessSsidPoliciesClientExclusionStaticExclusions

PATH /networks/{networkId}/wireless/ssids/{number}/policies/clientExclusion/static/exclusions

{
  "ssid": {
    "id": "12312333",
    "number": 1,
    "name": "My SSID"
  },
  "network": {
    "id": "N_1234",
    "name": "MR wireless 1"
  },
  "macs": [
    "00:11:22:33:44:55",
    "aa:bb:cc:dd:ee:ff"
  ]
}

- Path added

- New endpoint

Set the static client exclusion list for the given SSID

PUT /networks/{networkId}/wireless/ssids/{number}/policies/clientExclusion/static/exclusions

{
    "ssid": {
        "id": "12312333",
        "number": 1,
        "name": "My SSID"
    },
    "network": {
        "id": "N_1234",
        "name": "MR wireless 1"
    },
    "macs": [
        "00:11:22:33:44:55",
        "aa:bb:cc:dd:ee:ff"
    ]
}

---

Docs

Add a list of MAC addresses to the static client exclusion list for the given SSID

Operation ID: createNetworkWirelessSsidPoliciesClientExclusionStaticExclusionsBulkAdd

PATH /networks/{networkId}/wireless/ssids/{number}/policies/clientExclusion/static/exclusions/bulkAdd

{
  "ssid": {
    "id": "12312333",
    "number": 1,
    "name": "My SSID"
  },
  "network": {
    "id": "N_1234",
    "name": "MR wireless 1"
  },
  "macs": [
    "00:11:22:33:44:55",
    "aa:bb:cc:dd:ee:ff"
  ]
}

- Path added

- New endpoint

Add a list of MAC addresses to the static client exclusion list for the given SSID

POST /networks/{networkId}/wireless/ssids/{number}/policies/clientExclusion/static/exclusions/bulkAdd

{
    "ssid": {
        "id": "12312333",
        "number": 1,
        "name": "My SSID"
    },
    "network": {
        "id": "N_1234",
        "name": "MR wireless 1"
    },
    "macs": [
        "00:11:22:33:44:55",
        "aa:bb:cc:dd:ee:ff"
    ]
}

---

Docs

Delete a list of MAC addresses from the static client exclusion list for the given SSID

Operation ID: createNetworkWirelessSsidPoliciesClientExclusionStaticExclusionsBulkRemove

PATH /networks/{networkId}/wireless/ssids/{number}/policies/clientExclusion/static/exclusions/bulkRemove

- Path added

- New endpoint

Delete a list of MAC addresses from the static client exclusion list for the given SSID

POST /networks/{networkId}/wireless/ssids/{number}/policies/clientExclusion/static/exclusions/bulkRemove

---

Docs

Returns an array of objects, each containing client exclusion enablement statuses for one SSID

Operation ID: getOrganizationWirelessSsidsPoliciesClientExclusionBySsid

PATH /organizations/{organizationId}/wireless/ssids/policies/clientExclusion/bySsid

{
  "items": [
    {
      "ssid": {
        "id": "12312333",
        "number": 1,
        "name": "My SSID"
      },
      "network": {
        "id": "N_1234",
        "name": "MR wireless 1"
      },
      "static": {
        "enabled": true
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 105,
        "remaining": 25
      }
    }
  }
}

- Path added

- New endpoint

Returns an array of objects, each containing client exclusion enablement statuses for one SSID

GET /organizations/{organizationId}/wireless/ssids/policies/clientExclusion/bySsid

{
    "items": [
        {
            "ssid": {
                "id": "12312333",
                "number": 1,
                "name": "My SSID"
            },
            "network": {
                "id": "N_1234",
                "name": "MR wireless 1"
            },
            "static": {
                "enabled": true
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 105,
                "remaining": 25
            }
        }
    }
}

---

Docs

Returns an array of objects, each containing a list of MAC's excluded from a given SSID

Operation ID: getOrganizationWirelessSsidsPoliciesClientExclusionStaticExclusionsBySsid

PATH /organizations/{organizationId}/wireless/ssids/policies/clientExclusion/static/exclusions/bySsid

{
  "items": [
    {
      "ssid": {
        "id": "12312333",
        "number": 1,
        "name": "My SSID"
      },
      "network": {
        "id": "N_1234",
        "name": "MR wireless 1"
      },
      "macs": [
        "00:11:22:33:44:55",
        "aa:bb:cc:dd:ee:ff"
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 105,
        "remaining": 25
      }
    }
  }
}

- Path added

- New endpoint

Returns an array of objects, each containing a list of MAC's excluded from a given SSID

GET /organizations/{organizationId}/wireless/ssids/policies/clientExclusion/static/exclusions/bySsid

{
    "items": [
        {
            "ssid": {
                "id": "12312333",
                "number": 1,
                "name": "My SSID"
            },
            "network": {
                "id": "N_1234",
                "name": "MR wireless 1"
            },
            "macs": [
                "00:11:22:33:44:55",
                "aa:bb:cc:dd:ee:ff"
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 105,
                "remaining": 25
            }
        }
    }
}

---

opportunisticPcap

Docs

Update the Opportunistic Pcap settings for a wireless network

Operation ID: updateNetworkWirelessOpportunisticPcap

PATH /networks/{networkId}/wireless/opportunisticPcap

{
  "networkId": "L_12345",
  "name": "My Network",
  "enablement": {
    "networkWide": 0,
    "serials": [
      "Q234-ABCD-5678"
    ],
    "tags": [
      "tag1",
      "tag2"
    ]
  }
}

- Path added

- New endpoint

Update the Opportunistic Pcap settings for a wireless network

PUT /networks/{networkId}/wireless/opportunisticPcap

{
    "networkId": "L_12345",
    "name": "My Network",
    "enablement": {
        "networkWide": 0,
        "serials": [
            "Q234-ABCD-5678"
        ],
        "tags": [
            "tag1",
            "tag2"
        ]
    }
}

---

Docs

List the Opportunistic Pcap settings of an organization by network

Operation ID: getOrganizationWirelessOpportunisticPcapByNetwork

PATH /organizations/{organizationId}/wireless/opportunisticPcap/byNetwork

[
  {
    "networkId": "L_12345",
    "name": "My Network",
    "enablement": {
      "networkWide": 0,
      "serials": [
        "Q234-ABCD-5678"
      ],
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  }
]

- Path added

- New endpoint

List the Opportunistic Pcap settings of an organization by network

GET /organizations/{organizationId}/wireless/opportunisticPcap/byNetwork

[
    {
        "networkId": "L_12345",
        "name": "My Network",
        "enablement": {
            "networkWide": 0,
            "serials": [
                "Q234-ABCD-5678"
            ],
            "tags": [
                "tag1",
                "tag2"
            ]
        }
    }
]

---

Docs

Check the Opportunistic Pcap license status of an organization by network

Operation ID: byOrganizationWirelessOpportunisticPcapLicenseNetwork

PATH /organizations/{organizationId}/wireless/opportunisticPcap/license/byNetwork

[
  {
    "networkId": "L_12345",
    "name": "My Network",
    "licensed": true
  }
]

- Path added

- New endpoint

Check the Opportunistic Pcap license status of an organization by network

GET /organizations/{organizationId}/wireless/opportunisticPcap/license/byNetwork

[
    {
        "networkId": "L_12345",
        "name": "My Network",
        "licensed": true
    }
]

---

radio

Docs

Return the position for a wireless device

Operation ID: getDeviceWirelessRadioAfcPosition

PATH /devices/{serial}/wireless/radio/afc/position

{
  "name": "Some MR",
  "network": {
    "id": "N_24329156"
  },
  "serial": "Q234-ABCD-5678",
  "elevation": {
    "height": 10,
    "uncertainty": 1
  },
  "gps": {
    "antenna": {
      "cableLength": 10
    }
  }
}

- Path added

- New endpoint

Return the position for a wireless device

GET /devices/{serial}/wireless/radio/afc/position

{
    "name": "Some MR",
    "network": {
        "id": "N_24329156"
    },
    "serial": "Q234-ABCD-5678",
    "elevation": {
        "height": 10,
        "uncertainty": 1
    },
    "gps": {
        "antenna": {
            "cableLength": 10
        }
    }
}

---

- New endpoint

Update the position attributes for this device

PUT /devices/{serial}/wireless/radio/afc/position

{
    "name": "Some MR",
    "network": {
        "id": "N_24329156"
    },
    "serial": "Q234-ABCD-5678",
    "elevation": {
        "height": 10,
        "uncertainty": 1
    },
    "gps": {
        "antenna": {
            "cableLength": 10
        }
    }
}

---

Docs

Return the AFC power limits for a wireless device

Operation ID: getDeviceWirelessRadioAfcPowerLimits

PATH /devices/{serial}/wireless/radio/afc/powerLimits

{
  "name": "Device_name",
  "network": {
    "id": "N_12345"
  },
  "serial": "Q2KN-6CN7-EC4X",
  "expiresAt": "2023-01-27T19:36:32Z",
  "lastUpdatedAt": "2023-01-26T19:36:32Z",
  "lastSuccessAt": "2023-01-26T19:36:32Z",
  "byChannel": [
    {
      "channel": 11,
      "channelWidth": 20,
      "limit": 30
    }
  ],
  "status": "SUCCESS",
  "location": {
    "lat": 37.4180951010362,
    "lng": -122.098531723022,
    "uncertainty": 10,
    "type": "GPS"
  }
}

- Path added

- New endpoint

Return the AFC power limits for a wireless device

GET /devices/{serial}/wireless/radio/afc/powerLimits

{
    "name": "Device_name",
    "network": {
        "id": "N_12345"
    },
    "serial": "Q2KN-6CN7-EC4X",
    "expiresAt": "2023-01-27T19:36:32Z",
    "lastUpdatedAt": "2023-01-26T19:36:32Z",
    "lastSuccessAt": "2023-01-26T19:36:32Z",
    "byChannel": [
        {
            "channel": 11,
            "channelWidth": 20,
            "limit": 30
        }
    ],
    "status": "SUCCESS",
    "location": {
        "lat": 37.4180951010362,
        "lng": -122.098531723022,
        "uncertainty": 10,
        "type": "GPS"
    }
}

---

Docs

Show the status of this device's radios

Operation ID: getDeviceWirelessRadioStatus

PATH /devices/{serial}/wireless/radio/status

[
  {
    "band": 6,
    "channelSettings": {
      "channel": 2,
      "width": 80,
      "dfs": {
        "radarDetected": false
      }
    },
    "powerSettings": {
      "transmitPower": 18,
      "mode": "lpi"
    },
    "status": "Up"
  }
]

- Path added

- New endpoint

Show the status of this device's radios

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

[
    {
        "band": 6,
        "channelSettings": {
            "channel": 2,
            "width": 80,
            "dfs": {
                "radarDetected": false
            }
        },
        "powerSettings": {
            "transmitPower": 18,
            "mode": "lpi"
        },
        "status": "Up"
    }
]

---

Docs

Update the AutoRF settings for a wireless network

Operation ID: updateNetworkWirelessRadioAutoRf

PATH /networks/{networkId}/wireless/radio/autoRf

{
  "networkId": "L_12345",
  "name": "My Network",
  "timeZone": "America/Los_Angeles",
  "busyHour": {
    "schedule": {
      "mode": "automatic",
      "automatic": {
        "start": "08:00",
        "end": "17:00"
      },
      "manual": {
        "start": "10:00",
        "end": "15:00"
      }
    },
    "minimizeChanges": {
      "enabled": true
    }
  },
  "channel": {
    "avoidance": {
      "enabled": true
    }
  },
  "fra": {
    "enabled": false
  },
  "aiRrm": {
    "enabled": true,
    "enablementDate": "2025-08-03T08:01:28Z"
  }
}

- Path added

- New endpoint

Update the AutoRF settings for a wireless network

PUT /networks/{networkId}/wireless/radio/autoRf

{
    "networkId": "L_12345",
    "name": "My Network",
    "timeZone": "America/Los_Angeles",
    "busyHour": {
        "schedule": {
            "mode": "automatic",
            "automatic": {
                "start": "08:00",
                "end": "17:00"
            },
            "manual": {
                "start": "10:00",
                "end": "15:00"
            }
        },
        "minimizeChanges": {
            "enabled": true
        }
    },
    "channel": {
        "avoidance": {
            "enabled": true
        }
    },
    "fra": {
        "enabled": false
    },
    "aiRrm": {
        "enabled": true,
        "enablementDate": "2025-08-03T08:01:28Z"
    }
}

---

Docs

Update the AutoRF settings for a wireless network

Operation ID: updateNetworkWirelessRadioRrm

PATH /networks/{networkId}/wireless/radio/rrm

{
  "networkId": "L_12345",
  "name": "My Network",
  "timeZone": "America/Los_Angeles",
  "busyHour": {
    "schedule": {
      "mode": "automatic",
      "automatic": {
        "start": "08:00",
        "end": "17:00"
      },
      "manual": {
        "start": "10:00",
        "end": "15:00"
      }
    },
    "minimizeChanges": {
      "enabled": true
    }
  },
  "channel": {
    "avoidance": {
      "enabled": true
    }
  },
  "fra": {
    "enabled": false
  },
  "aiRrm": {
    "enabled": true,
    "enablementDate": "2025-08-03T08:01:28Z"
  }
}

- Path added

- New endpoint

Update the AutoRF settings for a wireless network

PUT /networks/{networkId}/wireless/radio/rrm

{
    "networkId": "L_12345",
    "name": "My Network",
    "timeZone": "America/Los_Angeles",
    "busyHour": {
        "schedule": {
            "mode": "automatic",
            "automatic": {
                "start": "08:00",
                "end": "17:00"
            },
            "manual": {
                "start": "10:00",
                "end": "15:00"
            }
        },
        "minimizeChanges": {
            "enabled": true
        }
    },
    "channel": {
        "avoidance": {
            "enabled": true
        }
    },
    "fra": {
        "enabled": false
    },
    "aiRrm": {
        "enabled": true,
        "enablementDate": "2025-08-03T08:01:28Z"
    }
}

---

Docs

List the AFC power limits of an organization by device

Operation ID: getOrganizationWirelessRadioAfcPositionByDevice

PATH /organizations/{organizationId}/wireless/radio/afc/position/byDevice

[
  {
    "name": "Some MR",
    "network": {
      "id": "N_24329156"
    },
    "serial": "Q234-ABCD-5678",
    "elevation": {
      "height": 10,
      "uncertainty": 1
    },
    "gps": {
      "antenna": {
        "cableLength": 10
      }
    }
  }
]

- Path added

- New endpoint

List the AFC power limits of an organization by device

GET /organizations/{organizationId}/wireless/radio/afc/position/byDevice

[
    {
        "name": "Some MR",
        "network": {
            "id": "N_24329156"
        },
        "serial": "Q234-ABCD-5678",
        "elevation": {
            "height": 10,
            "uncertainty": 1
        },
        "gps": {
            "antenna": {
                "cableLength": 10
            }
        }
    }
]

---

Docs

List the AFC power limits of an organization by device

Operation ID: getOrganizationWirelessRadioAfcPowerLimitsByDevice

PATH /organizations/{organizationId}/wireless/radio/afc/powerLimits/byDevice

[
  {
    "name": "Device_name",
    "network": {
      "id": "N_12345"
    },
    "serial": "Q2KN-6CN7-EC4X",
    "expiresAt": "2023-01-27T19:36:32Z",
    "lastUpdatedAt": "2023-01-26T19:36:32Z",
    "lastSuccessAt": "2023-01-26T19:36:32Z",
    "byChannel": [
      {
        "channel": 11,
        "channelWidth": 20,
        "limit": 30
      }
    ],
    "status": "SUCCESS",
    "location": {
      "lat": 37.4180951010362,
      "lng": -122.098531723022,
      "uncertainty": 10,
      "type": "GPS"
    }
  }
]

- Path added

- New endpoint

List the AFC power limits of an organization by device

GET /organizations/{organizationId}/wireless/radio/afc/powerLimits/byDevice

[
    {
        "name": "Device_name",
        "network": {
            "id": "N_12345"
        },
        "serial": "Q2KN-6CN7-EC4X",
        "expiresAt": "2023-01-27T19:36:32Z",
        "lastUpdatedAt": "2023-01-26T19:36:32Z",
        "lastSuccessAt": "2023-01-26T19:36:32Z",
        "byChannel": [
            {
                "channel": 11,
                "channelWidth": 20,
                "limit": 30
            }
        ],
        "status": "SUCCESS",
        "location": {
            "lat": 37.4180951010362,
            "lng": -122.098531723022,
            "uncertainty": 10,
            "type": "GPS"
        }
    }
]

---

Docs

List the AutoRF settings of an organization by network

Operation ID: getOrganizationWirelessRadioAutoRfByNetwork

PATH /organizations/{organizationId}/wireless/radio/autoRf/byNetwork

[
  {
    "networkId": "L_12345",
    "name": "My Network",
    "timeZone": "America/Los_Angeles",
    "busyHour": {
      "schedule": {
        "mode": "automatic",
        "automatic": {
          "start": "08:00",
          "end": "17:00"
        },
        "manual": {
          "start": "10:00",
          "end": "15:00"
        }
      },
      "minimizeChanges": {
        "enabled": true
      }
    },
    "channel": {
      "avoidance": {
        "enabled": true
      }
    },
    "fra": {
      "enabled": false
    },
    "aiRrm": {
      "enabled": true,
      "enablementDate": "2025-08-03T08:01:28Z"
    }
  }
]

- Path added

- New endpoint

List the AutoRF settings of an organization by network

GET /organizations/{organizationId}/wireless/radio/autoRf/byNetwork

[
    {
        "networkId": "L_12345",
        "name": "My Network",
        "timeZone": "America/Los_Angeles",
        "busyHour": {
            "schedule": {
                "mode": "automatic",
                "automatic": {
                    "start": "08:00",
                    "end": "17:00"
                },
                "manual": {
                    "start": "10:00",
                    "end": "15:00"
                }
            },
            "minimizeChanges": {
                "enabled": true
            }
        },
        "channel": {
            "avoidance": {
                "enabled": true
            }
        },
        "fra": {
            "enabled": false
        },
        "aiRrm": {
            "enabled": true,
            "enablementDate": "2025-08-03T08:01:28Z"
        }
    }
]

---

Docs

List the channel planning activities of an organization

Operation ID: getOrganizationWirelessRadioAutoRfChannelsPlanningActivities

PATH /organizations/{organizationId}/wireless/radio/autoRf/channels/planning/activities

[
  {
    "startedAt": "2018-02-11T00:00:00Z",
    "endsAt": "2018-05-12T00:00:00Z",
    "type": "avoid",
    "reason": "dfs",
    "band": "5",
    "channel": 44,
    "severity": 6,
    "network": {
      "id": "N_24329156",
      "name": "Main Office",
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    "device": {
      "name": "My AP",
      "serial": "Q234-ABCD-5678",
      "mac": "00:11:22:33:44:55",
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  }
]

- Path added

- New endpoint

List the channel planning activities of an organization

GET /organizations/{organizationId}/wireless/radio/autoRf/channels/planning/activities

[
    {
        "startedAt": "2018-02-11T00:00:00Z",
        "endsAt": "2018-05-12T00:00:00Z",
        "type": "avoid",
        "reason": "dfs",
        "band": "5",
        "channel": 44,
        "severity": 6,
        "network": {
            "id": "N_24329156",
            "name": "Main Office",
            "tags": [
                "tag1",
                "tag2"
            ]
        },
        "device": {
            "name": "My AP",
            "serial": "Q234-ABCD-5678",
            "mac": "00:11:22:33:44:55",
            "tags": [
                "tag1",
                "tag2"
            ]
        }
    }
]

---

Docs

List the AutoRF settings of an organization by network

Operation ID: getOrganizationWirelessRadioRrmByNetwork

PATH /organizations/{organizationId}/wireless/radio/rrm/byNetwork

[
  {
    "networkId": "L_12345",
    "name": "My Network",
    "timeZone": "America/Los_Angeles",
    "busyHour": {
      "schedule": {
        "mode": "automatic",
        "automatic": {
          "start": "08:00",
          "end": "17:00"
        },
        "manual": {
          "start": "10:00",
          "end": "15:00"
        }
      },
      "minimizeChanges": {
        "enabled": true
      }
    },
    "channel": {
      "avoidance": {
        "enabled": true
      }
    },
    "fra": {
      "enabled": false
    },
    "aiRrm": {
      "enabled": true,
      "enablementDate": "2025-08-03T08:01:28Z"
    }
  }
]

- Path added

- New endpoint

List the AutoRF settings of an organization by network

GET /organizations/{organizationId}/wireless/radio/rrm/byNetwork

[
    {
        "networkId": "L_12345",
        "name": "My Network",
        "timeZone": "America/Los_Angeles",
        "busyHour": {
            "schedule": {
                "mode": "automatic",
                "automatic": {
                    "start": "08:00",
                    "end": "17:00"
                },
                "manual": {
                    "start": "10:00",
                    "end": "15:00"
                }
            },
            "minimizeChanges": {
                "enabled": true
            }
        },
        "channel": {
            "avoidance": {
                "enabled": true
            }
        },
        "fra": {
            "enabled": false
        },
        "aiRrm": {
            "enabled": true,
            "enablementDate": "2025-08-03T08:01:28Z"
        }
    }
]

---

Docs

Show the status of this organization's radios, categorized by network and device

Operation ID: getOrganizationWirelessRadioStatusByNetwork

PATH /organizations/{organizationId}/wireless/radio/status/byNetwork

[
  {
    "network": {
      "id": "N_1234",
      "name": "MyNetwork"
    },
    "data": {
      "byDevice": [
        {
          "serial": "ABC-123",
          "radios": [
            {
              "band": 6,
              "channelSettings": {
                "channel": 2,
                "width": 80,
                "dfs": {
                  "radarDetected": false
                }
              },
              "powerSettings": {
                "transmitPower": 18,
                "mode": "lpi"
              },
              "status": "Up"
            }
          ]
        }
      ]
    }
  }
]

- Path added

- New endpoint

Show the status of this organization's radios, categorized by network and device

GET /organizations/{organizationId}/wireless/radio/status/byNetwork

[
    {
        "network": {
            "id": "N_1234",
            "name": "MyNetwork"
        },
        "data": {
            "byDevice": [
                {
                    "serial": "ABC-123",
                    "radios": [
                        {
                            "band": 6,
                            "channelSettings": {
                                "channel": 2,
                                "width": 80,
                                "dfs": {
                                    "radarDetected": false
                                }
                            },
                            "powerSettings": {
                                "transmitPower": 18,
                                "mode": "lpi"
                            },
                            "status": "Up"
                        }
                    ]
                }
            ]
        }
    }
]

---

healthScores

Docs

Fetch the health scores for a given AP on this network

Operation ID: getDeviceWirelessHealthScores

PATH /devices/{serial}/wireless/healthScores

{
  "device": {
    "serial": "Q234-ABCD-5678"
  },
  "performance": {
    "latest": 80
  },
  "onboarding": {
    "latest": 20
  }
}

- Path added

- New endpoint

Fetch the health scores for a given AP on this network

GET /devices/{serial}/wireless/healthScores

{
    "device": {
        "serial": "Q234-ABCD-5678"
    },
    "performance": {
        "latest": 80
    },
    "onboarding": {
        "latest": 20
    }
}

---

devices

Docs

Fetch the health scores of all APs on this network

Operation ID: getNetworkWirelessDevicesHealthScores

PATH /networks/{networkId}/wireless/devices/healthScores

[
  {
    "device": {
      "serial": "Q234-ABCD-5678"
    },
    "performance": {
      "latest": 80
    },
    "onboarding": {
      "latest": 20
    }
  }
]

- Path added

- New endpoint

Fetch the health scores of all APs on this network

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

[
    {
        "device": {
            "serial": "Q234-ABCD-5678"
        },
        "performance": {
            "latest": 80
        },
        "onboarding": {
            "latest": 20
        }
    }
]

---

Docs

List the most recent AP accelerometer status information for wireless devices that support it.

Operation ID: getOrganizationWirelessDevicesAccelerometerStatuses

PATH /organizations/{organizationId}/wireless/devices/accelerometer/statuses

[
  {
    "serial": "Q234-ABCD-5678",
    "name": "My appliance",
    "network": {
      "id": "N_24329156"
    },
    "status": {
      "titleAngle": 0,
      "status": "Active",
      "errorReason": "No error"
    }
  }
]

- Path added

- New endpoint

List the most recent AP accelerometer status information for wireless devices that support it.

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

[
    {
        "serial": "Q234-ABCD-5678",
        "name": "My appliance",
        "network": {
            "id": "N_24329156"
        },
        "status": {
            "titleAngle": 0,
            "status": "Active",
            "errorReason": "No error"
        }
    }
]

---

Docs

Get latency summaries for all wireless devices in an organization.

Operation ID: getOrganizationWirelessDevicesLatencyByClient

PATH /organizations/{organizationId}/wireless/devices/latency/byClient

[
  {
    "overall": {
      "frames": 1439,
      "average": 24.73
    },
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    },
    "device": {
      "name": "My AP",
      "serial": "Q234-ABCD-5678",
      "mac": "00:11:22:33:44:55"
    }
  }
]

- Path added

- New endpoint

Get latency summaries for all wireless devices in an organization.

GET /organizations/{organizationId}/wireless/devices/latency/byClient

[
    {
        "overall": {
            "frames": 1439,
            "average": 24.73
        },
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        },
        "device": {
            "name": "My AP",
            "serial": "Q234-ABCD-5678",
            "mac": "00:11:22:33:44:55"
        }
    }
]

---

Docs

Get latency summaries for all wireless devices in an organization.

Operation ID: getOrganizationWirelessDevicesLatencyByDevice

PATH /organizations/{organizationId}/wireless/devices/latency/byDevice

[
  {
    "overall": {
      "frames": 1439,
      "average": 24.73
    },
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    },
    "device": {
      "name": "My AP",
      "serial": "Q234-ABCD-5678",
      "mac": "00:11:22:33:44:55"
    }
  }
]

- Path added

- New endpoint

Get latency summaries for all wireless devices in an organization.

GET /organizations/{organizationId}/wireless/devices/latency/byDevice

[
    {
        "overall": {
            "frames": 1439,
            "average": 24.73
        },
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        },
        "device": {
            "name": "My AP",
            "serial": "Q234-ABCD-5678",
            "mac": "00:11:22:33:44:55"
        }
    }
]

---

Docs

Get per-network latency summaries for all wireless networks in an organization.

Operation ID: getOrganizationWirelessDevicesLatencyByNetwork

PATH /organizations/{organizationId}/wireless/devices/latency/byNetwork

[
  {
    "overall": {
      "frames": 1439,
      "average": 24.73
    },
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    }
  }
]

- Path added

- New endpoint

Get per-network latency summaries for all wireless networks in an organization.

GET /organizations/{organizationId}/wireless/devices/latency/byNetwork

[
    {
        "overall": {
            "frames": 1439,
            "average": 24.73
        },
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        }
    }
]

---

Docs

Get average signal quality for all clients in the organization

Operation ID: getOrganizationWirelessDevicesSignalQualityByClient

PATH /organizations/{organizationId}/wireless/devices/signalQuality/byClient

[
  {
    "snr": 37,
    "rssi": -58,
    "client": {
      "id": "k74272e",
      "mac": "22:33:44:55:66:77"
    },
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    }
  }
]

- Path added

- New endpoint

Get average signal quality for all clients in the organization

GET /organizations/{organizationId}/wireless/devices/signalQuality/byClient

[
    {
        "snr": 37,
        "rssi": -58,
        "client": {
            "id": "k74272e",
            "mac": "22:33:44:55:66:77"
        },
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        }
    }
]

---

Docs

Get average signal quality for all devices in the organization

Operation ID: getOrganizationWirelessDevicesSignalQualityByDevice

PATH /organizations/{organizationId}/wireless/devices/signalQuality/byDevice

[
  {
    "snr": 37,
    "rssi": -58,
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    }
  }
]

- Path added

- New endpoint

Get average signal quality for all devices in the organization

GET /organizations/{organizationId}/wireless/devices/signalQuality/byDevice

[
    {
        "snr": 37,
        "rssi": -58,
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        }
    }
]

---

Docs

Get average signal quality for all networks in the organization

Operation ID: getOrganizationWirelessDevicesSignalQualityByNetwork

PATH /organizations/{organizationId}/wireless/devices/signalQuality/byNetwork

[
  {
    "snr": 37,
    "rssi": -58,
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    }
  }
]

- Path added

- New endpoint

Get average signal quality for all networks in the organization

GET /organizations/{organizationId}/wireless/devices/signalQuality/byNetwork

[
    {
        "snr": 37,
        "rssi": -58,
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        }
    }
]

---

clients

Docs

Fetch the health scores for all clients on this network

Operation ID: getNetworkWirelessClientsHealthScores

PATH /networks/{networkId}/wireless/clients/healthScores

[
  {
    "mac": "22:33:44:55:66:77",
    "clientId": "k74272e",
    "performance": {
      "latest": 80,
      "currentConnection": 100
    },
    "onboarding": {
      "latest": 100
    }
  },
  {
    "mac": "22:33:44:55:66:77",
    "clientId": "k74272e",
    "performance": {
      "latest": 30,
      "currentConnection": 50
    },
    "onboarding": {
      "latest": 70
    }
  }
]

- Path added

- New endpoint

Fetch the health scores for all clients on this network

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

[
    {
        "mac": "22:33:44:55:66:77",
        "clientId": "k74272e",
        "performance": {
            "latest": 80,
            "currentConnection": 100
        },
        "onboarding": {
            "latest": 100
        }
    },
    {
        "mac": "22:33:44:55:66:77",
        "clientId": "k74272e",
        "performance": {
            "latest": 30,
            "currentConnection": 50
        },
        "onboarding": {
            "latest": 70
        }
    }
]

---

Docs

Return counts of distinct wireless clients connecting to a network over time

Operation ID: getNetworkWirelessClientsOnboardingHistory

PATH /networks/{networkId}/wireless/clients/onboardingHistory

[
  {
    "startTs": "2020-01-01T00:00:00Z",
    "endTs": "2020-01-01T00:05:00Z",
    "clientCounts": {
      "summary": {
        "prospective": 100,
        "successful": 75,
        "failed": 25
      },
      "connectionSteps": {
        "association": {
          "prospective": 100,
          "successful": 97,
          "failed": 3
        },
        "authentication": {
          "prospective": 97,
          "successful": 81,
          "failed": 16
        },
        "dhcp": {
          "prospective": 81,
          "successful": 75,
          "failed": 6
        },
        "dns": {
          "prospective": 75,
          "successful": 75,
          "failed": 0
        }
      }
    }
  }
]

- Path added

- New endpoint

Return counts of distinct wireless clients connecting to a network over time

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

[
    {
        "startTs": "2020-01-01T00:00:00Z",
        "endTs": "2020-01-01T00:05:00Z",
        "clientCounts": {
            "summary": {
                "prospective": 100,
                "successful": 75,
                "failed": 25
            },
            "connectionSteps": {
                "association": {
                    "prospective": 100,
                    "successful": 97,
                    "failed": 3
                },
                "authentication": {
                    "prospective": 97,
                    "successful": 81,
                    "failed": 16
                },
                "dhcp": {
                    "prospective": 81,
                    "successful": 75,
                    "failed": 6
                },
                "dns": {
                    "prospective": 75,
                    "successful": 75,
                    "failed": 0
                }
            }
        }
    }
]

---

Docs

Fetch the health scores for a given client on this network

Operation ID: getNetworkWirelessClientHealthScores

PATH /networks/{networkId}/wireless/clients/{clientId}/healthScores

{
  "mac": "22:33:44:55:66:77",
  "clientId": "k74272e",
  "performance": {
    "latest": 80,
    "currentConnection": 100
  },
  "onboarding": {
    "latest": 100
  }
}

- Path added

- New endpoint

Fetch the health scores for a given client on this network. Clients are identified by their MAC or ID

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

{
    "mac": "22:33:44:55:66:77",
    "clientId": "k74272e",
    "performance": {
        "latest": 80,
        "currentConnection": 100
    },
    "onboarding": {
        "latest": 100
    }
}

---

[ switch ]

configTemplates

Docs

list the port mirror configurations in an organization by switch profile

Operation ID: getOrganizationConfigTemplatesSwitchProfilesPortsMirrorsBySwitchProfile

PATH /organizations/{organizationId}/configTemplates/switch/profiles/ports/mirrors/bySwitchProfile

{
  "items": [
    {
      "profileId": "1098",
      "configTemplate": {
        "id": "N_23952905",
        "name": "Main Office"
      },
      "mirror": {
        "source": {
          "ports": [
            {
              "number": 2,
              "module": {
                "type": "C9800-2X40GE",
                "slot": 1
              }
            }
          ],
          "filter": {
            "vlans": "100, 200-210",
            "hasTransitVlan": true
          }
        },
        "destination": {
          "port": {
            "number": 7,
            "module": {
              "type": "C9800-2X40GE",
              "slot": 1
            }
          },
          "vlan": "10"
        },
        "role": "source",
        "comment": "My pretty comment",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "warnings": [
        "sample warning message"
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1
      }
    }
  }
}

- Path added

- New endpoint

list the port mirror configurations in an organization by switch profile

GET /organizations/{organizationId}/configTemplates/switch/profiles/ports/mirrors/bySwitchProfile

{
    "items": [
        {
            "profileId": "1098",
            "configTemplate": {
                "id": "N_23952905",
                "name": "Main Office"
            },
            "mirror": {
                "source": {
                    "ports": [
                        {
                            "number": 2,
                            "module": {
                                "type": "C9800-2X40GE",
                                "slot": 1
                            }
                        }
                    ],
                    "filter": {
                        "vlans": "100, 200-210",
                        "hasTransitVlan": true
                    }
                },
                "destination": {
                    "port": {
                        "number": 7,
                        "module": {
                            "type": "C9800-2X40GE",
                            "slot": 1
                        }
                    },
                    "vlan": "10"
                },
                "role": "source",
                "comment": "My pretty comment",
                "tags": [
                    "tag1",
                    "tag2"
                ]
            },
            "warnings": [
                "sample warning message"
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1
            }
        }
    }
}

---

Docs

Update a port mirror

Operation ID: updateOrganizationConfigTemplateSwitchProfilePortsMirror

PATH /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/mirror

{
  "profileId": "1098",
  "configTemplate": {
    "id": "N_23952905",
    "name": "Main Office"
  },
  "mirror": {
    "source": {
      "ports": [
        {
          "number": 2,
          "module": {
            "type": "C9800-2X40GE",
            "slot": 1
          }
        }
      ],
      "filter": {
        "vlans": "100, 200-210",
        "hasTransitVlan": true
      }
    },
    "destination": {
      "port": {
        "number": 7,
        "module": {
          "type": "C9800-2X40GE",
          "slot": 1
        }
      },
      "vlan": "10"
    },
    "role": "source",
    "comment": "My pretty comment",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "warnings": [
    "sample warning message"
  ]
}

- Path added

- New endpoint

Update a port mirror

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

{
    "profileId": "1098",
    "configTemplate": {
        "id": "N_23952905",
        "name": "Main Office"
    },
    "mirror": {
        "source": {
            "ports": [
                {
                    "number": 2,
                    "module": {
                        "type": "C9800-2X40GE",
                        "slot": 1
                    }
                }
            ],
            "filter": {
                "vlans": "100, 200-210",
                "hasTransitVlan": true
            }
        },
        "destination": {
            "port": {
                "number": 7,
                "module": {
                    "type": "C9800-2X40GE",
                    "slot": 1
                }
            },
            "vlan": "10"
        },
        "role": "source",
        "comment": "My pretty comment",
        "tags": [
            "tag1",
            "tag2"
        ]
    },
    "warnings": [
        "sample warning message"
    ]
}

---

raGuardPolicy

Docs

Return RA Guard settings

Operation ID: getNetworkSwitchRaGuardPolicy

PATH /networks/{networkId}/switch/raGuardPolicy

{
  "defaultPolicy": "allowed",
  "blockedServers": [
    "00:50:56:00:00:03",
    "00:50:56:00:00:04"
  ],
  "allowedServers": [
    "00:50:56:00:00:01",
    "00:50:56:00:00:02"
  ]
}

- Path added

- New endpoint

Return RA Guard settings. Blocked servers are applied when default policy is allowed, and vice versa for allowed servers and blocked default policy.

GET /networks/{networkId}/switch/raGuardPolicy

{
    "defaultPolicy": "allowed",
    "blockedServers": [
        "00:50:56:00:00:03",
        "00:50:56:00:00:04"
    ],
    "allowedServers": [
        "00:50:56:00:00:01",
        "00:50:56:00:00:02"
    ]
}

---

- New endpoint

Update RA Guard settings

PUT /networks/{networkId}/switch/raGuardPolicy

{
    "defaultPolicy": "allowed",
    "blockedServers": [
        "00:50:56:00:00:03",
        "00:50:56:00:00:04"
    ],
    "allowedServers": [
        "00:50:56:00:00:01",
        "00:50:56:00:00:02"
    ]
}

---

devices

Docs

Return a historical record of packet transmission and loss, broken down by protocol, for insight into switch device health.

Operation ID: getOrganizationSwitchDevicesSystemQueuesHistoryBySwitchByInterval

PATH /organizations/{organizationId}/switch/devices/system/queues/history/bySwitch/byInterval

{
  "items": [
    {
      "serial": "Q234-ABCD-0001",
      "model": "MS",
      "name": "My switch",
      "mac": "00:11:22:33:44:55",
      "tags": [
        "tag1",
        "tag2"
      ],
      "network": {
        "id": "N_24329156",
        "name": "Main Office",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "history": [
        {
          "startTs": "2018-02-11T00:00:00.090210Z",
          "endTs": "2018-02-11T00:00:00.090210Z",
          "counts": {
            "processed": {
              "total": 9,
              "byProtocol": {
                "stp": 1,
                "ospf": 1,
                "lacp": 1,
                "arp": 1,
                "management": 5
              }
            },
            "dropped": {
              "total": 3,
              "byProtocol": {
                "stp": 0,
                "ospf": 1,
                "lacp": 0,
                "arp": 2,
                "management": 0
              }
            }
          }
        }
      ],
      "stack": {
        "id": "Stack ID",
        "name": "Stack name",
        "members": [
          {
            "serial": "Q234-ABCD-0001",
            "model": "MS",
            "name": "My switch",
            "mac": "00:11:22:33:44:55",
            "tags": [
              "tag1",
              "tag2"
            ],
            "history": [
              {
                "startTs": "2018-02-11T00:00:00.090210Z",
                "endTs": "2018-02-11T00:00:00.090210Z",
                "counts": {
                  "processed": {
                    "total": 8,
                    "byProtocol": {
                      "arp": 2,
                      "management": 6
                    }
                  },
                  "dropped": {
                    "total": 3,
                    "byProtocol": {
                      "arp": 1,
                      "management": 2
                    }
                  }
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 4,
        "remaining": 2
      }
    }
  }
}

- Path added

- New endpoint

Return a historical record of packet transmission and loss, broken down by protocol, for insight into switch device health.

GET /organizations/{organizationId}/switch/devices/system/queues/history/bySwitch/byInterval

{
    "items": [
        {
            "serial": "Q234-ABCD-0001",
            "model": "MS",
            "name": "My switch",
            "mac": "00:11:22:33:44:55",
            "tags": [
                "tag1",
                "tag2"
            ],
            "network": {
                "id": "N_24329156",
                "name": "Main Office",
                "tags": [
                    "tag1",
                    "tag2"
                ]
            },
            "history": [
                {
                    "startTs": "2018-02-11T00:00:00.090210Z",
                    "endTs": "2018-02-11T00:00:00.090210Z",
                    "counts": {
                        "processed": {
                            "total": 9,
                            "byProtocol": {
                                "stp": 1,
                                "ospf": 1,
                                "lacp": 1,
                                "arp": 1,
                                "management": 5
                            }
                        },
                        "dropped": {
                            "total": 3,
                            "byProtocol": {
                                "stp": 0,
                                "ospf": 1,
                                "lacp": 0,
                                "arp": 2,
                                "management": 0
                            }
                        }
                    }
                }
            ],
            "stack": {
                "id": "Stack ID",
                "name": "Stack name",
                "members": [
                    {
                        "serial": "Q234-ABCD-0001",
                        "model": "MS",
                        "name": "My switch",
                        "mac": "00:11:22:33:44:55",
                        "tags": [
                            "tag1",
                            "tag2"
                        ],
                        "history": [
                            {
                                "startTs": "2018-02-11T00:00:00.090210Z",
                                "endTs": "2018-02-11T00:00:00.090210Z",
                                "counts": {
                                    "processed": {
                                        "total": 8,
                                        "byProtocol": {
                                            "arp": 2,
                                            "management": 6
                                        }
                                    },
                                    "dropped": {
                                        "total": 3,
                                        "byProtocol": {
                                            "arp": 1,
                                            "management": 2
                                        }
                                    }
                                }
                            }
                        ]
                    }
                ]
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 4,
                "remaining": 2
            }
        }
    }
}

---

stacks

Docs

Update switch port mirrors for switch stacks

Operation ID: updateNetworkSwitchStackPortsMirror

PATH /networks/{networkId}/switch/stacks/{switchStackId}/ports/mirror

{
  "switchStackId": "123456",
  "network": {
    "id": "N_24329156",
    "name": "Main Office"
  },
  "mirror": {
    "source": {
      "ports": [
        {
          "serial": "Q234-ABCD-5678",
          "number": 2,
          "module": {
            "type": "C9800-2X40GE",
            "slot": 1
          }
        }
      ],
      "filter": {
        "vlans": "100, 200-210",
        "hasTransitVlan": true
      }
    },
    "destination": {
      "port": {
        "serial": "Q234-ABCD-5670",
        "number": 7,
        "module": {
          "type": "C9800-2X40GE",
          "slot": 2
        }
      },
      "vlan": "10"
    },
    "role": "source",
    "comment": "My pretty comment",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "warnings": [
    "Warnings from traffic mirror configuration changes"
  ]
}

- Path added

- New endpoint

Update switch port mirrors for switch stacks

PUT /networks/{networkId}/switch/stacks/{switchStackId}/ports/mirror

{
    "switchStackId": "123456",
    "network": {
        "id": "N_24329156",
        "name": "Main Office"
    },
    "mirror": {
        "source": {
            "ports": [
                {
                    "serial": "Q234-ABCD-5678",
                    "number": 2,
                    "module": {
                        "type": "C9800-2X40GE",
                        "slot": 1
                    }
                }
            ],
            "filter": {
                "vlans": "100, 200-210",
                "hasTransitVlan": true
            }
        },
        "destination": {
            "port": {
                "serial": "Q234-ABCD-5670",
                "number": 7,
                "module": {
                    "type": "C9800-2X40GE",
                    "slot": 2
                }
            },
            "vlan": "10"
        },
        "role": "source",
        "comment": "My pretty comment",
        "tags": [
            "tag1",
            "tag2"
        ]
    },
    "warnings": [
        "Warnings from traffic mirror configuration changes"
    ]
}

---

Docs

List the port mirror configurations in an organization by switch

Operation ID: getOrganizationSwitchStacksPortsMirrorsByStack

PATH /organizations/{organizationId}/switch/stacks/ports/mirrors/byStack

[
  {
    "items": [
      {
        "switchStackId": "123456",
        "network": {
          "id": "N_24329156",
          "name": "Main Office"
        },
        "mirror": {
          "source": {
            "ports": [
              {
                "serial": "Q234-ABCD-5678",
                "number": 2,
                "module": {
                  "type": "C9800-2X40GE",
                  "slot": 1
                }
              }
            ],
            "filter": {
              "vlans": "100, 200-210",
              "hasTransitVlan": true
            }
          },
          "destination": {
            "port": {
              "serial": "Q234-ABCD-5670",
              "number": 7,
              "module": {
                "type": "C9800-2X40GE",
                "slot": 2
              }
            },
            "vlan": "10"
          },
          "role": "source",
          "comment": "My pretty comment",
          "tags": [
            "tag1",
            "tag2"
          ]
        },
        "warnings": [
          "Warnings from traffic mirror configuration changes"
        ]
      }
    ],
    "meta": {
      "counts": {
        "items": {
          "total": 1
        }
      }
    }
  }
]

- Path added

- New endpoint

List the port mirror configurations in an organization by switch

GET /organizations/{organizationId}/switch/stacks/ports/mirrors/byStack

[
    {
        "items": [
            {
                "switchStackId": "123456",
                "network": {
                    "id": "N_24329156",
                    "name": "Main Office"
                },
                "mirror": {
                    "source": {
                        "ports": [
                            {
                                "serial": "Q234-ABCD-5678",
                                "number": 2,
                                "module": {
                                    "type": "C9800-2X40GE",
                                    "slot": 1
                                }
                            }
                        ],
                        "filter": {
                            "vlans": "100, 200-210",
                            "hasTransitVlan": true
                        }
                    },
                    "destination": {
                        "port": {
                            "serial": "Q234-ABCD-5670",
                            "number": 7,
                            "module": {
                                "type": "C9800-2X40GE",
                                "slot": 2
                            }
                        },
                        "vlan": "10"
                    },
                    "role": "source",
                    "comment": "My pretty comment",
                    "tags": [
                        "tag1",
                        "tag2"
                    ]
                },
                "warnings": [
                    "Warnings from traffic mirror configuration changes"
                ]
            }
        ],
        "meta": {
            "counts": {
                "items": {
                    "total": 1
                }
            }
        }
    }
]

---

ports

Docs

Update a port mirror

Operation ID: updateDeviceSwitchPortsMirror

PATH /devices/{serial}/switch/ports/mirror

{
  "serial": "Q234-ABCD-5678",
  "network": {
    "id": "N_24329156",
    "name": "Main Office"
  },
  "mirror": {
    "source": {
      "ports": [
        {
          "number": 2,
          "module": {
            "type": "C9800-2X40GE",
            "slot": 2
          }
        }
      ],
      "filter": {
        "vlans": "100, 200-210",
        "hasTransitVlan": true
      }
    },
    "destination": {
      "port": {
        "number": 7,
        "module": {
          "type": "C9800-2X40GE",
          "slot": 1
        }
      },
      "vlan": "10"
    },
    "role": "source",
    "comment": "My pretty comment",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "warnings": [
    "Warnings from traffic mirror configuration changes"
  ]
}

- Path added

- New endpoint

Update a port mirror

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

{
    "serial": "Q234-ABCD-5678",
    "network": {
        "id": "N_24329156",
        "name": "Main Office"
    },
    "mirror": {
        "source": {
            "ports": [
                {
                    "number": 2,
                    "module": {
                        "type": "C9800-2X40GE",
                        "slot": 2
                    }
                }
            ],
            "filter": {
                "vlans": "100, 200-210",
                "hasTransitVlan": true
            }
        },
        "destination": {
            "port": {
                "number": 7,
                "module": {
                    "type": "C9800-2X40GE",
                    "slot": 1
                }
            },
            "vlan": "10"
        },
        "role": "source",
        "comment": "My pretty comment",
        "tags": [
            "tag1",
            "tag2"
        ]
    },
    "warnings": [
        "Warnings from traffic mirror configuration changes"
    ]
}

---

Docs

List the port profiles in a network

Operation ID: getNetworkSwitchPortsProfiles

PATH /networks/{networkId}/switch/ports/profiles

[
  {
    "profileId": "1284392014819",
    "networkId": "N_24329156",
    "name": "Phone",
    "description": "IP Phones for all office workers",
    "tags": [
      "tag1",
      "tag2"
    ],
    "associatedPorts": [
      {
        "portId": "8",
        "portNum": 8,
        "portName": "Dev - Cheshire Cat / 8",
        "serial": "Q234-ABCD-5678",
        "profile": {
          "enabled": true,
          "id": "1284392014819"
        }
      }
    ],
    "associatedSwitches": [
      {
        "switchId": 247165647951894,
        "name": "Dev - Cheshire Cat",
        "mac": "e0:cb:bc:a5:98:16",
        "serial": "Q234-ABCD-5678",
        "model": "MS120-48FP"
      }
    ],
    "assignedSwitchports": [
      {
        "portIds": [
          "1",
          "2",
          "3",
          "1_C3850-NM-8-10G_1",
          "1_C3850-NM-8-10G_2"
        ],
        "switch": {
          "serial": "Q234-ABCD-5678"
        },
        "template": {
          "id": 1983748489
        }
      }
    ],
    "createdAt": "2022-09-16T09:18:38Z",
    "updatedAt": "2022-09-16T09:18:38Z",
    "port": {
      "type": "access",
      "vlan": 10,
      "voiceVlan": 20,
      "allowedVlans": "1-100",
      "poeEnabled": true,
      "isolationEnabled": false,
      "rstpEnabled": true,
      "stpGuard": "disabled",
      "udld": "Alert only",
      "accessPolicyType": "Sticky MAC allow list",
      "accessPolicyNumber": 3,
      "macAllowList": [
        "34:56:fe:ce:8e:b0",
        "34:56:fe:ce:8e:b1"
      ],
      "stickyMacAllowList": [
        "34:56:fe:ce:8e:b0",
        "34:56:fe:ce:8e:b1"
      ],
      "stickyMacAllowListLimit": 5,
      "stormControlEnabled": true,
      "adaptivePolicyGroupId": "1284392014819",
      "peerSgtCapable": false,
      "daiTrusted": false
    },
    "isOrganizationWide": false,
    "networks": {
      "values": [
        {
          "id": "N_11865",
          "name": "Wonderland-Dev"
        }
      ],
      "type": "included"
    },
    "automations": [
      {
        "id": "N_11865",
        "name": "RYOFXAPO"
      }
    ],
    "access": "full"
  }
]

- Path added

- New endpoint

List the port profiles in a network

GET /networks/{networkId}/switch/ports/profiles

[
    {
        "profileId": "1284392014819",
        "networkId": "N_24329156",
        "name": "Phone",
        "description": "IP Phones for all office workers",
        "tags": [
            "tag1",
            "tag2"
        ],
        "associatedPorts": [
            {
                "portId": "8",
                "portNum": 8,
                "portName": "Dev - Cheshire Cat / 8",
                "serial": "Q234-ABCD-5678",
                "profile": {
                    "enabled": true,
                    "id": "1284392014819"
                }
            }
        ],
        "associatedSwitches": [
            {
                "switchId": 247165647951894,
                "name": "Dev - Cheshire Cat",
                "mac": "e0:cb:bc:a5:98:16",
                "serial": "Q234-ABCD-5678",
                "model": "MS120-48FP"
            }
        ],
        "assignedSwitchports": [
            {
                "portIds": [
                    "1",
                    "2",
                    "3",
                    "1_C3850-NM-8-10G_1",
                    "1_C3850-NM-8-10G_2"
                ],
                "switch": {
                    "serial": "Q234-ABCD-5678"
                },
                "template": {
                    "id": 1983748489
                }
            }
        ],
        "createdAt": "2022-09-16T09:18:38Z",
        "updatedAt": "2022-09-16T09:18:38Z",
        "port": {
            "type": "access",
            "vlan": 10,
            "voiceVlan": 20,
            "allowedVlans": "1-100",
            "poeEnabled": true,
            "isolationEnabled": false,
            "rstpEnabled": true,
            "stpGuard": "disabled",
            "udld": "Alert only",
            "accessPolicyType": "Sticky MAC allow list",
            "accessPolicyNumber": 3,
            "macAllowList": [
                "34:56:fe:ce:8e:b0",
                "34:56:fe:ce:8e:b1"
            ],
            "stickyMacAllowList": [
                "34:56:fe:ce:8e:b0",
                "34:56:fe:ce:8e:b1"
            ],
            "stickyMacAllowListLimit": 5,
            "stormControlEnabled": true,
            "adaptivePolicyGroupId": "1284392014819",
            "peerSgtCapable": false,
            "daiTrusted": false
        },
        "isOrganizationWide": false,
        "networks": {
            "values": [
                {
                    "id": "N_11865",
                    "name": "Wonderland-Dev"
                }
            ],
            "type": "included"
        },
        "automations": [
            {
                "id": "N_11865",
                "name": "RYOFXAPO"
            }
        ],
        "access": "full"
    }
]

---

- New endpoint

Create a port profile in a network

POST /networks/{networkId}/switch/ports/profiles

{
    "profileId": "1284392014819",
    "networkId": "N_24329156",
    "name": "Phone",
    "description": "IP Phones for all office workers",
    "tags": [
        "tag1",
        "tag2"
    ],
    "associatedPorts": [
        {
            "portId": "8",
            "portNum": 8,
            "portName": "Dev - Cheshire Cat / 8",
            "serial": "Q234-ABCD-5678",
            "profile": {
                "enabled": true,
                "id": "1284392014819"
            }
        }
    ],
    "associatedSwitches": [
        {
            "switchId": 247165647951894,
            "name": "Dev - Cheshire Cat",
            "mac": "e0:cb:bc:a5:98:16",
            "serial": "Q234-ABCD-5678",
            "model": "MS120-48FP"
        }
    ],
    "assignedSwitchports": [
        {
            "portIds": [
                "1",
                "2",
                "3",
                "1_C3850-NM-8-10G_1",
                "1_C3850-NM-8-10G_2"
            ],
            "switch": {
                "serial": "Q234-ABCD-5678"
            },
            "template": {
                "id": 1983748489
            }
        }
    ],
    "createdAt": "2022-09-16T09:18:38Z",
    "updatedAt": "2022-09-16T09:18:38Z",
    "port": {
        "type": "access",
        "vlan": 10,
        "voiceVlan": 20,
        "allowedVlans": "1-100",
        "poeEnabled": true,
        "isolationEnabled": false,
        "rstpEnabled": true,
        "stpGuard": "disabled",
        "udld": "Alert only",
        "accessPolicyType": "Sticky MAC allow list",
        "accessPolicyNumber": 3,
        "macAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowListLimit": 5,
        "stormControlEnabled": true,
        "adaptivePolicyGroupId": "1284392014819",
        "peerSgtCapable": false,
        "daiTrusted": false
    },
    "isOrganizationWide": false,
    "networks": {
        "values": [
            {
                "id": "N_11865",
                "name": "Wonderland-Dev"
            }
        ],
        "type": "included"
    },
    "automations": [
        {
            "id": "N_11865",
            "name": "RYOFXAPO"
        }
    ],
    "access": "full"
}

---

Docs

Update a port profile in a network

Operation ID: updateNetworkSwitchPortsProfile

PATH /networks/{networkId}/switch/ports/profiles/{id}

{
  "profileId": "1284392014819",
  "networkId": "N_24329156",
  "name": "Phone",
  "description": "IP Phones for all office workers",
  "tags": [
    "tag1",
    "tag2"
  ],
  "associatedPorts": [
    {
      "portId": "8",
      "portNum": 8,
      "portName": "Dev - Cheshire Cat / 8",
      "serial": "Q234-ABCD-5678",
      "profile": {
        "enabled": true,
        "id": "1284392014819"
      }
    }
  ],
  "associatedSwitches": [
    {
      "switchId": 247165647951894,
      "name": "Dev - Cheshire Cat",
      "mac": "e0:cb:bc:a5:98:16",
      "serial": "Q234-ABCD-5678",
      "model": "MS120-48FP"
    }
  ],
  "assignedSwitchports": [
    {
      "portIds": [
        "1",
        "2",
        "3",
        "1_C3850-NM-8-10G_1",
        "1_C3850-NM-8-10G_2"
      ],
      "switch": {
        "serial": "Q234-ABCD-5678"
      },
      "template": {
        "id": 1983748489
      }
    }
  ],
  "createdAt": "2022-09-16T09:18:38Z",
  "updatedAt": "2022-09-16T09:18:38Z",
  "port": {
    "type": "access",
    "vlan": 10,
    "voiceVlan": 20,
    "allowedVlans": "1-100",
    "poeEnabled": true,
    "isolationEnabled": false,
    "rstpEnabled": true,
    "stpGuard": "disabled",
    "udld": "Alert only",
    "accessPolicyType": "Sticky MAC allow list",
    "accessPolicyNumber": 3,
    "macAllowList": [
      "34:56:fe:ce:8e:b0",
      "34:56:fe:ce:8e:b1"
    ],
    "stickyMacAllowList": [
      "34:56:fe:ce:8e:b0",
      "34:56:fe:ce:8e:b1"
    ],
    "stickyMacAllowListLimit": 5,
    "stormControlEnabled": true,
    "adaptivePolicyGroupId": "1284392014819",
    "peerSgtCapable": false,
    "daiTrusted": false
  },
  "isOrganizationWide": false,
  "networks": {
    "values": [
      {
        "id": "N_11865",
        "name": "Wonderland-Dev"
      }
    ],
    "type": "included"
  },
  "automations": [
    {
      "id": "N_11865",
      "name": "RYOFXAPO"
    }
  ],
  "access": "full"
}

- Path added

- New endpoint

Update a port profile in a network

PUT /networks/{networkId}/switch/ports/profiles/{id}

{
    "profileId": "1284392014819",
    "networkId": "N_24329156",
    "name": "Phone",
    "description": "IP Phones for all office workers",
    "tags": [
        "tag1",
        "tag2"
    ],
    "associatedPorts": [
        {
            "portId": "8",
            "portNum": 8,
            "portName": "Dev - Cheshire Cat / 8",
            "serial": "Q234-ABCD-5678",
            "profile": {
                "enabled": true,
                "id": "1284392014819"
            }
        }
    ],
    "associatedSwitches": [
        {
            "switchId": 247165647951894,
            "name": "Dev - Cheshire Cat",
            "mac": "e0:cb:bc:a5:98:16",
            "serial": "Q234-ABCD-5678",
            "model": "MS120-48FP"
        }
    ],
    "assignedSwitchports": [
        {
            "portIds": [
                "1",
                "2",
                "3",
                "1_C3850-NM-8-10G_1",
                "1_C3850-NM-8-10G_2"
            ],
            "switch": {
                "serial": "Q234-ABCD-5678"
            },
            "template": {
                "id": 1983748489
            }
        }
    ],
    "createdAt": "2022-09-16T09:18:38Z",
    "updatedAt": "2022-09-16T09:18:38Z",
    "port": {
        "type": "access",
        "vlan": 10,
        "voiceVlan": 20,
        "allowedVlans": "1-100",
        "poeEnabled": true,
        "isolationEnabled": false,
        "rstpEnabled": true,
        "stpGuard": "disabled",
        "udld": "Alert only",
        "accessPolicyType": "Sticky MAC allow list",
        "accessPolicyNumber": 3,
        "macAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowListLimit": 5,
        "stormControlEnabled": true,
        "adaptivePolicyGroupId": "1284392014819",
        "peerSgtCapable": false,
        "daiTrusted": false
    },
    "isOrganizationWide": false,
    "networks": {
        "values": [
            {
                "id": "N_11865",
                "name": "Wonderland-Dev"
            }
        ],
        "type": "included"
    },
    "automations": [
        {
            "id": "N_11865",
            "name": "RYOFXAPO"
        }
    ],
    "access": "full"
}

---

- New endpoint

Delete a port profile from a network

DELETE /networks/{networkId}/switch/ports/profiles/{id}

---

Docs

list the port mirror configurations in an organization by switch

Operation ID: getOrganizationSwitchPortsMirrorsBySwitch

PATH /organizations/{organizationId}/switch/ports/mirrors/bySwitch

{
  "items": [
    {
      "serial": "Q234-ABCD-5678",
      "network": {
        "id": "N_24329156",
        "name": "Main Office"
      },
      "mirror": {
        "source": {
          "ports": [
            {
              "number": 2,
              "module": {
                "type": "C9800-2X40GE",
                "slot": 2
              }
            }
          ],
          "filter": {
            "vlans": "100, 200-210",
            "hasTransitVlan": true
          }
        },
        "destination": {
          "port": {
            "number": 7,
            "module": {
              "type": "C9800-2X40GE",
              "slot": 1
            }
          },
          "vlan": "10"
        },
        "role": "source",
        "comment": "My pretty comment",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "warnings": [
        "Warnings from traffic mirror configuration changes"
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1
      }
    }
  }
}

- Path added

- New endpoint

list the port mirror configurations in an organization by switch

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

{
    "items": [
        {
            "serial": "Q234-ABCD-5678",
            "network": {
                "id": "N_24329156",
                "name": "Main Office"
            },
            "mirror": {
                "source": {
                    "ports": [
                        {
                            "number": 2,
                            "module": {
                                "type": "C9800-2X40GE",
                                "slot": 2
                            }
                        }
                    ],
                    "filter": {
                        "vlans": "100, 200-210",
                        "hasTransitVlan": true
                    }
                },
                "destination": {
                    "port": {
                        "number": 7,
                        "module": {
                            "type": "C9800-2X40GE",
                            "slot": 1
                        }
                    },
                    "vlan": "10"
                },
                "role": "source",
                "comment": "My pretty comment",
                "tags": [
                    "tag1",
                    "tag2"
                ]
            },
            "warnings": [
                "Warnings from traffic mirror configuration changes"
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1
            }
        }
    }
}

---

Docs

List the port profiles in an organization

Operation ID: getOrganizationSwitchPortsProfiles

PATH /organizations/{organizationId}/switch/ports/profiles

[
  {
    "profileId": "1284392014819",
    "name": "Phone",
    "description": "IP Phones for all office workers",
    "createdAt": "2018-02-11T00:00:00.090210Z",
    "updatedAt": "2018-02-11T00:00:00.090210Z",
    "network": {
      "id": "N_24329156"
    },
    "counts": {
      "assigned": {
        "ports": 4,
        "switches": 2,
        "automations": 6
      },
      "networksCount": {
        "included": 40,
        "excluded": 20
      }
    },
    "isOrganizationWide": false,
    "networks": {
      "values": [
        {
          "id": "N_11865",
          "name": "Wonderland-Dev"
        }
      ],
      "type": "included"
    },
    "access": "full"
  }
]

- Path added

- New endpoint

List the port profiles in an organization

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

[
    {
        "profileId": "1284392014819",
        "name": "Phone",
        "description": "IP Phones for all office workers",
        "createdAt": "2018-02-11T00:00:00.090210Z",
        "updatedAt": "2018-02-11T00:00:00.090210Z",
        "network": {
            "id": "N_24329156"
        },
        "counts": {
            "assigned": {
                "ports": 4,
                "switches": 2,
                "automations": 6
            },
            "networksCount": {
                "included": 40,
                "excluded": 20
            }
        },
        "isOrganizationWide": false,
        "networks": {
            "values": [
                {
                    "id": "N_11865",
                    "name": "Wonderland-Dev"
                }
            ],
            "type": "included"
        },
        "access": "full"
    }
]

---

- New endpoint

Create a port profile in an organization

POST /organizations/{organizationId}/switch/ports/profiles

{
    "profileId": "1284392014819",
    "networkId": "N_24329156",
    "name": "Phone",
    "description": "IP Phones for all office workers",
    "tags": [
        "tag1",
        "tag2"
    ],
    "associatedPorts": [
        {
            "portId": "8",
            "portNum": 8,
            "portName": "Dev - Cheshire Cat / 8",
            "serial": "Q234-ABCD-5678",
            "profile": {
                "enabled": true,
                "id": "1284392014819"
            }
        }
    ],
    "associatedSwitches": [
        {
            "switchId": 247165647951894,
            "name": "Dev - Cheshire Cat",
            "mac": "e0:cb:bc:a5:98:16",
            "serial": "Q234-ABCD-5678",
            "model": "MS120-48FP"
        }
    ],
    "assignedSwitchports": [
        {
            "portIds": [
                "1",
                "2",
                "3",
                "1_C3850-NM-8-10G_1",
                "1_C3850-NM-8-10G_2"
            ],
            "switch": {
                "serial": "Q234-ABCD-5678"
            },
            "template": {
                "id": 1983748489
            }
        }
    ],
    "createdAt": "2022-09-16T09:18:38Z",
    "updatedAt": "2022-09-16T09:18:38Z",
    "port": {
        "type": "access",
        "vlan": 10,
        "voiceVlan": 20,
        "allowedVlans": "1-100",
        "poeEnabled": true,
        "isolationEnabled": false,
        "rstpEnabled": true,
        "stpGuard": "disabled",
        "udld": "Alert only",
        "accessPolicyType": "Sticky MAC allow list",
        "accessPolicyNumber": 3,
        "macAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowListLimit": 5,
        "stormControlEnabled": true,
        "adaptivePolicyGroupId": "1284392014819",
        "peerSgtCapable": false,
        "daiTrusted": false
    },
    "isOrganizationWide": false,
    "networks": {
        "values": [
            {
                "id": "N_11865",
                "name": "Wonderland-Dev"
            }
        ],
        "type": "included"
    },
    "automations": [
        {
            "id": "N_11865",
            "name": "RYOFXAPO"
        }
    ],
    "access": "full"
}

---

Docs

list the automation port profiles in an organization

Operation ID: getOrganizationSwitchPortsProfilesAutomations

PATH /organizations/{organizationId}/switch/ports/profiles/automations

{
  "items": [
    {
      "id": "1284392014819",
      "name": "Automation 1",
      "description": "A full length description of the automation.",
      "types": [
        "Custom",
        "Built-in"
      ],
      "fallbackProfile": {
        "id": "1284392014819",
        "name": "Profile 1"
      },
      "rules": [
        {
          "priority": 1,
          "conditions": [
            {
              "attribute": "LLDP system description",
              "values": [
                "Meraki MR*",
                "*Wireless*"
              ]
            }
          ],
          "profile": {
            "id": "32",
            "name": "Profile 2"
          }
        }
      ],
      "assignedSwitchPorts": [
        {
          "portIds": [
            "1",
            "2",
            "3",
            "1_C3850-NM-8-10G_1",
            "1_C3850-NM-8-10G_2"
          ],
          "switch": {
            "serial": "Q234-ABCD-5678"
          }
        }
      ],
      "counts": {
        "assigned": {
          "devices": 2,
          "ports": 51,
          "networks": 1
        }
      },
      "isOrganizationWide": false,
      "networks": [
        {
          "id": "N_11865",
          "name": "Wonderland-Dev"
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1
      }
    }
  }
}

- Path added

- New endpoint

list the automation port profiles in an organization

GET /organizations/{organizationId}/switch/ports/profiles/automations

{
    "items": [
        {
            "id": "1284392014819",
            "name": "Automation 1",
            "description": "A full length description of the automation.",
            "types": [
                "Custom",
                "Built-in"
            ],
            "fallbackProfile": {
                "id": "1284392014819",
                "name": "Profile 1"
            },
            "rules": [
                {
                    "priority": 1,
                    "conditions": [
                        {
                            "attribute": "LLDP system description",
                            "values": [
                                "Meraki MR*",
                                "*Wireless*"
                            ]
                        }
                    ],
                    "profile": {
                        "id": "32",
                        "name": "Profile 2"
                    }
                }
            ],
            "assignedSwitchPorts": [
                {
                    "portIds": [
                        "1",
                        "2",
                        "3",
                        "1_C3850-NM-8-10G_1",
                        "1_C3850-NM-8-10G_2"
                    ],
                    "switch": {
                        "serial": "Q234-ABCD-5678"
                    }
                }
            ],
            "counts": {
                "assigned": {
                    "devices": 2,
                    "ports": 51,
                    "networks": 1
                }
            },
            "isOrganizationWide": false,
            "networks": [
                {
                    "id": "N_11865",
                    "name": "Wonderland-Dev"
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1
            }
        }
    }
}

---

- New endpoint

Create a port profile automation for an organization

POST /organizations/{organizationId}/switch/ports/profiles/automations

{
    "id": "1284392014819",
    "name": "Automation 1",
    "description": "A full length description of the automation.",
    "types": [
        "Custom",
        "Built-in"
    ],
    "fallbackProfile": {
        "id": "1284392014819",
        "name": "Profile 1"
    },
    "rules": [
        {
            "priority": 1,
            "conditions": [
                {
                    "attribute": "LLDP system description",
                    "values": [
                        "Meraki MR*",
                        "*Wireless*"
                    ]
                }
            ],
            "profile": {
                "id": "32",
                "name": "Profile 2"
            }
        }
    ],
    "assignedSwitchPorts": [
        {
            "portIds": [
                "1",
                "2",
                "3",
                "1_C3850-NM-8-10G_1",
                "1_C3850-NM-8-10G_2"
            ],
            "switch": {
                "serial": "Q234-ABCD-5678"
            }
        }
    ],
    "counts": {
        "assigned": {
            "devices": 2,
            "ports": 51,
            "networks": 1
        }
    },
    "isOrganizationWide": false,
    "networks": [
        {
            "id": "N_11865",
            "name": "Wonderland-Dev"
        }
    ]
}

---

Docs

Update a port profile automation in an organization

Operation ID: updateOrganizationSwitchPortsProfilesAutomation

PATH /organizations/{organizationId}/switch/ports/profiles/automations/{id}

{
  "id": "1284392014819",
  "name": "Automation 1",
  "description": "A full length description of the automation.",
  "types": [
    "Custom",
    "Built-in"
  ],
  "fallbackProfile": {
    "id": "1284392014819",
    "name": "Profile 1"
  },
  "rules": [
    {
      "priority": 1,
      "conditions": [
        {
          "attribute": "LLDP system description",
          "values": [
            "Meraki MR*",
            "*Wireless*"
          ]
        }
      ],
      "profile": {
        "id": "32",
        "name": "Profile 2"
      }
    }
  ],
  "assignedSwitchPorts": [
    {
      "portIds": [
        "1",
        "2",
        "3",
        "1_C3850-NM-8-10G_1",
        "1_C3850-NM-8-10G_2"
      ],
      "switch": {
        "serial": "Q234-ABCD-5678"
      }
    }
  ],
  "counts": {
    "assigned": {
      "devices": 2,
      "ports": 51,
      "networks": 1
    }
  },
  "isOrganizationWide": false,
  "networks": [
    {
      "id": "N_11865",
      "name": "Wonderland-Dev"
    }
  ]
}

- Path added

- New endpoint

Update a port profile automation in an organization

PUT /organizations/{organizationId}/switch/ports/profiles/automations/{id}

{
    "id": "1284392014819",
    "name": "Automation 1",
    "description": "A full length description of the automation.",
    "types": [
        "Custom",
        "Built-in"
    ],
    "fallbackProfile": {
        "id": "1284392014819",
        "name": "Profile 1"
    },
    "rules": [
        {
            "priority": 1,
            "conditions": [
                {
                    "attribute": "LLDP system description",
                    "values": [
                        "Meraki MR*",
                        "*Wireless*"
                    ]
                }
            ],
            "profile": {
                "id": "32",
                "name": "Profile 2"
            }
        }
    ],
    "assignedSwitchPorts": [
        {
            "portIds": [
                "1",
                "2",
                "3",
                "1_C3850-NM-8-10G_1",
                "1_C3850-NM-8-10G_2"
            ],
            "switch": {
                "serial": "Q234-ABCD-5678"
            }
        }
    ],
    "counts": {
        "assigned": {
            "devices": 2,
            "ports": 51,
            "networks": 1
        }
    },
    "isOrganizationWide": false,
    "networks": [
        {
            "id": "N_11865",
            "name": "Wonderland-Dev"
        }
    ]
}

---

- New endpoint

Delete an automation port profile from an organization

DELETE /organizations/{organizationId}/switch/ports/profiles/automations/{id}

---

Docs

Fetch all Network - Smart Port Profile associations for an organization

Operation ID: getOrganizationSwitchPortsProfilesNetworksAssignments

PATH /organizations/{organizationId}/switch/ports/profiles/networks/assignments

{
  "items": [
    {
      "assignmentId": "123456",
      "type": "included",
      "profile": {
        "id": "4354353"
      },
      "network": {
        "id": "N_24329156"
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 42,
        "remaining": 32
      }
    }
  }
}

- Path added

- New endpoint

Fetch all Network - Smart Port Profile associations for an organization

GET /organizations/{organizationId}/switch/ports/profiles/networks/assignments

{
    "items": [
        {
            "assignmentId": "123456",
            "type": "included",
            "profile": {
                "id": "4354353"
            },
            "network": {
                "id": "N_24329156"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 42,
                "remaining": 32
            }
        }
    }
}

---

- New endpoint

Create Network and Smart Ports Profile association for a specific profile

POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments

{
    "assignmentId": "123456",
    "type": "included",
    "profile": {
        "id": "4354353"
    },
    "network": {
        "id": "N_24329156"
    }
}

---

Docs

Batch Create Network and Smart Ports Profile associations for a specific profile

Operation ID: batchOrganizationSwitchPortsProfilesNetworksAssignmentsCreate

PATH /organizations/{organizationId}/switch/ports/profiles/networks/assignments/batchCreate

{
  "items": [
    {
      "assignmentId": "123456",
      "type": "included",
      "profile": {
        "id": "4354353"
      },
      "network": {
        "id": "N_24329156"
      }
    }
  ]
}

- Path added

- New endpoint

Batch Create Network and Smart Ports Profile associations for a specific profile

POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments/batchCreate

{
    "items": [
        {
            "assignmentId": "123456",
            "type": "included",
            "profile": {
                "id": "4354353"
            },
            "network": {
                "id": "N_24329156"
            }
        }
    ]
}

---

Docs

Bulk delete Network and Smart Port Profile associations

Operation ID: bulkOrganizationSwitchPortsProfilesNetworksAssignmentsDelete

PATH /organizations/{organizationId}/switch/ports/profiles/networks/assignments/bulkDelete

- Path added

- New endpoint

Bulk delete Network and Smart Port Profile associations

POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments/bulkDelete

---

Docs

Delete Network and Smart Port profile association for a specific profile

Operation ID: deleteOrganizationSwitchPortsProfilesNetworksAssignment

PATH /organizations/{organizationId}/switch/ports/profiles/networks/assignments/{assignmentId}

- Path added

- New endpoint

Delete Network and Smart Port profile association for a specific profile

DELETE /organizations/{organizationId}/switch/ports/profiles/networks/assignments/{assignmentId}

---

Docs

List the port profiles in an organization

Operation ID: getOrganizationSwitchPortsProfilesOverviewByProfile

PATH /organizations/{organizationId}/switch/ports/profiles/overview/byProfile

[
  {
    "items": [
      {
        "profileId": "1284392014819",
        "name": "Phone",
        "description": "IP Phones for all office workers",
        "createdAt": "2018-02-11T00:00:00.090210Z",
        "updatedAt": "2018-02-11T00:00:00.090210Z",
        "network": {
          "id": "N_24329156"
        },
        "counts": {
          "assigned": {
            "ports": 4,
            "switches": 2,
            "automations": 6
          },
          "networksCount": {
            "included": 40,
            "excluded": 20
          }
        },
        "isOrganizationWide": false,
        "networks": {
          "values": [
            {
              "id": "N_11865",
              "name": "Wonderland-Dev"
            }
          ],
          "type": "included"
        },
        "access": "full"
      }
    ],
    "meta": {
      "counts": {
        "items": {
          "total": 1
        }
      }
    }
  }
]

- Path added

- New endpoint

List the port profiles in an organization

GET /organizations/{organizationId}/switch/ports/profiles/overview/byProfile

[
    {
        "items": [
            {
                "profileId": "1284392014819",
                "name": "Phone",
                "description": "IP Phones for all office workers",
                "createdAt": "2018-02-11T00:00:00.090210Z",
                "updatedAt": "2018-02-11T00:00:00.090210Z",
                "network": {
                    "id": "N_24329156"
                },
                "counts": {
                    "assigned": {
                        "ports": 4,
                        "switches": 2,
                        "automations": 6
                    },
                    "networksCount": {
                        "included": 40,
                        "excluded": 20
                    }
                },
                "isOrganizationWide": false,
                "networks": {
                    "values": [
                        {
                            "id": "N_11865",
                            "name": "Wonderland-Dev"
                        }
                    ],
                    "type": "included"
                },
                "access": "full"
            }
        ],
        "meta": {
            "counts": {
                "items": {
                    "total": 1
                }
            }
        }
    }
]

---

Docs

Get detailed information about a port profile

Operation ID: getOrganizationSwitchPortsProfile

PATH /organizations/{organizationId}/switch/ports/profiles/{id}

{
  "profileId": "1284392014819",
  "networkId": "N_24329156",
  "name": "Phone",
  "description": "IP Phones for all office workers",
  "tags": [
    "tag1",
    "tag2"
  ],
  "associatedPorts": [
    {
      "portId": "8",
      "portNum": 8,
      "portName": "Dev - Cheshire Cat / 8",
      "serial": "Q234-ABCD-5678",
      "profile": {
        "enabled": true,
        "id": "1284392014819"
      }
    }
  ],
  "associatedSwitches": [
    {
      "switchId": 247165647951894,
      "name": "Dev - Cheshire Cat",
      "mac": "e0:cb:bc:a5:98:16",
      "serial": "Q234-ABCD-5678",
      "model": "MS120-48FP"
    }
  ],
  "assignedSwitchports": [
    {
      "portIds": [
        "1",
        "2",
        "3",
        "1_C3850-NM-8-10G_1",
        "1_C3850-NM-8-10G_2"
      ],
      "switch": {
        "serial": "Q234-ABCD-5678"
      },
      "template": {
        "id": 1983748489
      }
    }
  ],
  "createdAt": "2022-09-16T09:18:38Z",
  "updatedAt": "2022-09-16T09:18:38Z",
  "port": {
    "type": "access",
    "vlan": 10,
    "voiceVlan": 20,
    "allowedVlans": "1-100",
    "poeEnabled": true,
    "isolationEnabled": false,
    "rstpEnabled": true,
    "stpGuard": "disabled",
    "udld": "Alert only",
    "accessPolicyType": "Sticky MAC allow list",
    "accessPolicyNumber": 3,
    "macAllowList": [
      "34:56:fe:ce:8e:b0",
      "34:56:fe:ce:8e:b1"
    ],
    "stickyMacAllowList": [
      "34:56:fe:ce:8e:b0",
      "34:56:fe:ce:8e:b1"
    ],
    "stickyMacAllowListLimit": 5,
    "stormControlEnabled": true,
    "adaptivePolicyGroupId": "1284392014819",
    "peerSgtCapable": false,
    "daiTrusted": false
  },
  "isOrganizationWide": false,
  "networks": {
    "values": [
      {
        "id": "N_11865",
        "name": "Wonderland-Dev"
      }
    ],
    "type": "included"
  },
  "automations": [
    {
      "id": "N_11865",
      "name": "RYOFXAPO"
    }
  ],
  "access": "full"
}

- Path added

- New endpoint

Get detailed information about a port profile

GET /organizations/{organizationId}/switch/ports/profiles/{id}

{
    "profileId": "1284392014819",
    "networkId": "N_24329156",
    "name": "Phone",
    "description": "IP Phones for all office workers",
    "tags": [
        "tag1",
        "tag2"
    ],
    "associatedPorts": [
        {
            "portId": "8",
            "portNum": 8,
            "portName": "Dev - Cheshire Cat / 8",
            "serial": "Q234-ABCD-5678",
            "profile": {
                "enabled": true,
                "id": "1284392014819"
            }
        }
    ],
    "associatedSwitches": [
        {
            "switchId": 247165647951894,
            "name": "Dev - Cheshire Cat",
            "mac": "e0:cb:bc:a5:98:16",
            "serial": "Q234-ABCD-5678",
            "model": "MS120-48FP"
        }
    ],
    "assignedSwitchports": [
        {
            "portIds": [
                "1",
                "2",
                "3",
                "1_C3850-NM-8-10G_1",
                "1_C3850-NM-8-10G_2"
            ],
            "switch": {
                "serial": "Q234-ABCD-5678"
            },
            "template": {
                "id": 1983748489
            }
        }
    ],
    "createdAt": "2022-09-16T09:18:38Z",
    "updatedAt": "2022-09-16T09:18:38Z",
    "port": {
        "type": "access",
        "vlan": 10,
        "voiceVlan": 20,
        "allowedVlans": "1-100",
        "poeEnabled": true,
        "isolationEnabled": false,
        "rstpEnabled": true,
        "stpGuard": "disabled",
        "udld": "Alert only",
        "accessPolicyType": "Sticky MAC allow list",
        "accessPolicyNumber": 3,
        "macAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowListLimit": 5,
        "stormControlEnabled": true,
        "adaptivePolicyGroupId": "1284392014819",
        "peerSgtCapable": false,
        "daiTrusted": false
    },
    "isOrganizationWide": false,
    "networks": {
        "values": [
            {
                "id": "N_11865",
                "name": "Wonderland-Dev"
            }
        ],
        "type": "included"
    },
    "automations": [
        {
            "id": "N_11865",
            "name": "RYOFXAPO"
        }
    ],
    "access": "full"
}

---

- New endpoint

Update a port profile in an organization

PUT /organizations/{organizationId}/switch/ports/profiles/{id}

{
    "profileId": "1284392014819",
    "networkId": "N_24329156",
    "name": "Phone",
    "description": "IP Phones for all office workers",
    "tags": [
        "tag1",
        "tag2"
    ],
    "associatedPorts": [
        {
            "portId": "8",
            "portNum": 8,
            "portName": "Dev - Cheshire Cat / 8",
            "serial": "Q234-ABCD-5678",
            "profile": {
                "enabled": true,
                "id": "1284392014819"
            }
        }
    ],
    "associatedSwitches": [
        {
            "switchId": 247165647951894,
            "name": "Dev - Cheshire Cat",
            "mac": "e0:cb:bc:a5:98:16",
            "serial": "Q234-ABCD-5678",
            "model": "MS120-48FP"
        }
    ],
    "assignedSwitchports": [
        {
            "portIds": [
                "1",
                "2",
                "3",
                "1_C3850-NM-8-10G_1",
                "1_C3850-NM-8-10G_2"
            ],
            "switch": {
                "serial": "Q234-ABCD-5678"
            },
            "template": {
                "id": 1983748489
            }
        }
    ],
    "createdAt": "2022-09-16T09:18:38Z",
    "updatedAt": "2022-09-16T09:18:38Z",
    "port": {
        "type": "access",
        "vlan": 10,
        "voiceVlan": 20,
        "allowedVlans": "1-100",
        "poeEnabled": true,
        "isolationEnabled": false,
        "rstpEnabled": true,
        "stpGuard": "disabled",
        "udld": "Alert only",
        "accessPolicyType": "Sticky MAC allow list",
        "accessPolicyNumber": 3,
        "macAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowList": [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1"
        ],
        "stickyMacAllowListLimit": 5,
        "stormControlEnabled": true,
        "adaptivePolicyGroupId": "1284392014819",
        "peerSgtCapable": false,
        "daiTrusted": false
    },
    "isOrganizationWide": false,
    "networks": {
        "values": [
            {
                "id": "N_11865",
                "name": "Wonderland-Dev"
            }
        ],
        "type": "included"
    },
    "automations": [
        {
            "id": "N_11865",
            "name": "RYOFXAPO"
        }
    ],
    "access": "full"
}

---

- New endpoint

Delete a port profile from an organization

DELETE /organizations/{organizationId}/switch/ports/profiles/{id}

---

Docs

Return time-series digital optical monitoring (DOM) readings for ports on each DOM-enabled switch in an organization, in addition to thresholds for each relevant Small Form Factor Pluggable (SFP) module.

Operation ID: getOrganizationSwitchPortsTransceiversReadingsHistoryBySwitch

PATH /organizations/{organizationId}/switch/ports/transceivers/readings/history/bySwitch

{
  "items": [
    {
      "serial": "Q234-ABCD-0001",
      "ports": [
        {
          "portId": "1",
          "indices": {
            "switch": 1,
            "slot": 0,
            "port": 1
          },
          "readings": [
            {
              "startTs": "2018-02-11T00:00:00.090210Z",
              "endTs": "2018-02-11T00:00:00.090210Z",
              "sfpProductId": "PRODUCT1",
              "thresholdSetId": "ABC123",
              "byMetric": {
                "power": {
                  "transmit": {
                    "minimum": 4,
                    "maximum": 5,
                    "median": 4.5
                  },
                  "receive": {
                    "minimum": 4,
                    "maximum": 5,
                    "median": 4.5
                  }
                },
                "temperature": {
                  "fahrenheit": {
                    "minimum": 30,
                    "maximum": 33,
                    "median": 32
                  },
                  "celsius": {
                    "minimum": -1.1,
                    "maximum": 0.6,
                    "median": 0
                  }
                },
                "supplyVoltage": {
                  "level": {
                    "minimum": 3,
                    "maximum": 3.33,
                    "median": 3.11
                  }
                },
                "laserBiasCurrent": {
                  "draw": {
                    "minimum": 5,
                    "maximum": 7,
                    "median": 5.5
                  }
                }
              }
            }
          ]
        }
      ],
      "network": {
        "id": "N_12345678",
        "name": "San Francisco Office"
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 4,
        "remaining": 2
      }
    },
    "units": {
      "power": {
        "name": "decibel milliwatts",
        "symbol": "dBm"
      },
      "supplyVoltage": {
        "name": "volts",
        "symbol": "V"
      },
      "laserBiasCurrent": {
        "name": "milliamps",
        "symbol": "mA"
      }
    },
    "thresholds": [
      {
        "thresholdSetId": "ABC123",
        "power": {
          "transmit": {
            "error": {
              "upper": 1.8,
              "lower": 0.3
            },
            "warning": {
              "upper": 1.5,
              "lower": 0.6
            }
          },
          "receive": {
            "error": {
              "upper": 1.8,
              "lower": 0.3
            },
            "warning": {
              "upper": 1.5,
              "lower": 0.6
            }
          }
        },
        "temperature": {
          "fahrenheit": {
            "error": {
              "upper": 59,
              "lower": 23
            },
            "warning": {
              "upper": 50,
              "lower": 14
            }
          },
          "celsius": {
            "error": {
              "upper": 15,
              "lower": -5
            },
            "warning": {
              "upper": 10,
              "lower": -10
            }
          }
        },
        "supplyVoltage": {
          "level": {
            "error": {
              "upper": 7,
              "lower": 2
            },
            "warning": {
              "upper": 6,
              "lower": 3
            }
          }
        },
        "laserBiasCurrent": {
          "draw": {
            "error": {
              "upper": 6,
              "lower": 1
            },
            "warning": {
              "upper": 5,
              "lower": 2
            }
          }
        }
      }
    ]
  }
}

- Path added

- New endpoint

Return time-series digital optical monitoring (DOM) readings for ports on each DOM-enabled switch in an organization, in addition to thresholds for each relevant Small Form Factor Pluggable (SFP) module.

GET /organizations/{organizationId}/switch/ports/transceivers/readings/history/bySwitch

{
    "items": [
        {
            "serial": "Q234-ABCD-0001",
            "ports": [
                {
                    "portId": "1",
                    "indices": {
                        "switch": 1,
                        "slot": 0,
                        "port": 1
                    },
                    "readings": [
                        {
                            "startTs": "2018-02-11T00:00:00.090210Z",
                            "endTs": "2018-02-11T00:00:00.090210Z",
                            "sfpProductId": "PRODUCT1",
                            "thresholdSetId": "ABC123",
                            "byMetric": {
                                "power": {
                                    "transmit": {
                                        "minimum": 4,
                                        "maximum": 5,
                                        "median": 4.5
                                    },
                                    "receive": {
                                        "minimum": 4,
                                        "maximum": 5,
                                        "median": 4.5
                                    }
                                },
                                "temperature": {
                                    "fahrenheit": {
                                        "minimum": 30,
                                        "maximum": 33,
                                        "median": 32
                                    },
                                    "celsius": {
                                        "minimum": -1.1,
                                        "maximum": 0.6,
                                        "median": 0
                                    }
                                },
                                "supplyVoltage": {
                                    "level": {
                                        "minimum": 3,
                                        "maximum": 3.33,
                                        "median": 3.11
                                    }
                                },
                                "laserBiasCurrent": {
                                    "draw": {
                                        "minimum": 5,
                                        "maximum": 7,
                                        "median": 5.5
                                    }
                                }
                            }
                        }
                    ]
                }
            ],
            "network": {
                "id": "N_12345678",
                "name": "San Francisco Office"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 4,
                "remaining": 2
            }
        },
        "units": {
            "power": {
                "name": "decibel milliwatts",
                "symbol": "dBm"
            },
            "supplyVoltage": {
                "name": "volts",
                "symbol": "V"
            },
            "laserBiasCurrent": {
                "name": "milliamps",
                "symbol": "mA"
            }
        },
        "thresholds": [
            {
                "thresholdSetId": "ABC123",
                "power": {
                    "transmit": {
                        "error": {
                            "upper": 1.8,
                            "lower": 0.3
                        },
                        "warning": {
                            "upper": 1.5,
                            "lower": 0.6
                        }
                    },
                    "receive": {
                        "error": {
                            "upper": 1.8,
                            "lower": 0.3
                        },
                        "warning": {
                            "upper": 1.5,
                            "lower": 0.6
                        }
                    }
                },
                "temperature": {
                    "fahrenheit": {
                        "error": {
                            "upper": 59,
                            "lower": 23
                        },
                        "warning": {
                            "upper": 50,
                            "lower": 14
                        }
                    },
                    "celsius": {
                        "error": {
                            "upper": 15,
                            "lower": -5
                        },
                        "warning": {
                            "upper": 10,
                            "lower": -10
                        }
                    }
                },
                "supplyVoltage": {
                    "level": {
                        "error": {
                            "upper": 7,
                            "lower": 2
                        },
                        "warning": {
                            "upper": 6,
                            "lower": 3
                        }
                    }
                },
                "laserBiasCurrent": {
                    "draw": {
                        "error": {
                            "upper": 6,
                            "lower": 1
                        },
                        "warning": {
                            "upper": 5,
                            "lower": 2
                        }
                    }
                }
            }
        ]
    }
}

---

[ sensor ]

readings

Docs

Return all reported readings from sensors in a given timespan, summarized as a series of intervals, sorted by interval start time in descending order

Operation ID: getOrganizationSensorReadingsHistoryByInterval

PATH /organizations/{organizationId}/sensor/readings/history/byInterval

[
  {
    "startTs": "2022-01-07T23:00:00Z",
    "endTs": "2022-01-07T23:59:59Z",
    "serial": "Q234-ABCD-5678",
    "model": "MT11",
    "network": {
      "id": "N_24329156",
      "name": "Main Office"
    },
    "metric": "temperature",
    "apparentPower": {
      "draw": {
        "minimum": 0,
        "maximum": 15.9,
        "average": 4.9
      }
    },
    "battery": {
      "percentage": {
        "minimum": 95,
        "maximum": 97,
        "average": 96
      }
    },
    "button": {
      "pressType": {
        "counts": {
          "short": 2,
          "long": 4
        }
      }
    },
    "co2": {
      "concentration": {
        "minimum": 221,
        "maximum": 504,
        "average": 440
      }
    },
    "current": {
      "draw": {
        "minimum": 0,
        "maximum": 0.13,
        "average": 0.04
      }
    },
    "door": {
      "counts": {
        "open": 6
      }
    },
    "energy": {
      "usage": 0.116
    },
    "frequency": {
      "draw": {
        "minimum": 59.6,
        "maximum": 60.2,
        "average": 60.1
      }
    },
    "humidity": {
      "relativePercentage": {
        "minimum": 33,
        "maximum": 35,
        "average": 33
      }
    },
    "indoorAirQuality": {
      "score": {
        "minimum": 33,
        "maximum": 35,
        "average": 33
      }
    },
    "noise": {
      "ambient": {
        "level": {
          "minimum": 22,
          "maximum": 45,
          "average": 31
        }
      }
    },
    "pm25": {
      "concentration": {
        "minimum": 0,
        "maximum": 3,
        "average": 1
      }
    },
    "powerFactor": {
      "percentage": {
        "minimum": 84,
        "maximum": 89,
        "average": 86
      }
    },
    "realPower": {
      "draw": {
        "minimum": 0,
        "maximum": 14.2,
        "average": 5
      }
    },
    "temperature": {
      "fahrenheit": {
        "minimum": 68.15,
        "maximum": 74.91,
        "average": 72.08
      },
      "celsius": {
        "minimum": 20.08,
        "maximum": 23.84,
        "average": 22.27
      }
    },
    "tvoc": {
      "concentration": {
        "minimum": 221,
        "maximum": 504,
        "average": 440
      }
    },
    "voltage": {
      "level": {
        "minimum": 120.7,
        "maximum": 124.6,
        "average": 122.6
      }
    },
    "water": {
      "counts": {
        "present": 6
      }
    }
  }
]

- Path added

- New endpoint

Return all reported readings from sensors in a given timespan, summarized as a series of intervals, sorted by interval start time in descending order

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

[
    {
        "startTs": "2022-01-07T23:00:00Z",
        "endTs": "2022-01-07T23:59:59Z",
        "serial": "Q234-ABCD-5678",
        "model": "MT11",
        "network": {
            "id": "N_24329156",
            "name": "Main Office"
        },
        "metric": "temperature",
        "apparentPower": {
            "draw": {
                "minimum": 0,
                "maximum": 15.9,
                "average": 4.9
            }
        },
        "battery": {
            "percentage": {
                "minimum": 95,
                "maximum": 97,
                "average": 96
            }
        },
        "button": {
            "pressType": {
                "counts": {
                    "short": 2,
                    "long": 4
                }
            }
        },
        "co2": {
            "concentration": {
                "minimum": 221,
                "maximum": 504,
                "average": 440
            }
        },
        "current": {
            "draw": {
                "minimum": 0,
                "maximum": 0.13,
                "average": 0.04
            }
        },
        "door": {
            "counts": {
                "open": 6
            }
        },
        "energy": {
            "usage": 0.116
        },
        "frequency": {
            "draw": {
                "minimum": 59.6,
                "maximum": 60.2,
                "average": 60.1
            }
        },
        "humidity": {
            "relativePercentage": {
                "minimum": 33,
                "maximum": 35,
                "average": 33
            }
        },
        "indoorAirQuality": {
            "score": {
                "minimum": 33,
                "maximum": 35,
                "average": 33
            }
        },
        "noise": {
            "ambient": {
                "level": {
                    "minimum": 22,
                    "maximum": 45,
                    "average": 31
                }
            }
        },
        "pm25": {
            "concentration": {
                "minimum": 0,
                "maximum": 3,
                "average": 1
            }
        },
        "powerFactor": {
            "percentage": {
                "minimum": 84,
                "maximum": 89,
                "average": 86
            }
        },
        "realPower": {
            "draw": {
                "minimum": 0,
                "maximum": 14.2,
                "average": 5
            }
        },
        "temperature": {
            "fahrenheit": {
                "minimum": 68.15,
                "maximum": 74.91,
                "average": 72.08
            },
            "celsius": {
                "minimum": 20.08,
                "maximum": 23.84,
                "average": 22.27
            }
        },
        "tvoc": {
            "concentration": {
                "minimum": 221,
                "maximum": 504,
                "average": 440
            }
        },
        "voltage": {
            "level": {
                "minimum": 120.7,
                "maximum": 124.6,
                "average": 122.6
            }
        },
        "water": {
            "counts": {
                "present": 6
            }
        }
    }
]

---

alerts

Docs

Return a list of sensor alert events

Operation ID: getOrganizationSensorAlerts

PATH /organizations/{organizationId}/sensor/alerts

[
  {
    "startTs": "2018-02-11T00:00:00.090210Z",
    "sensor": {
      "name": "My sensor",
      "serial": "Q234-ABCD-5678",
      "model": "MT10",
      "url": "http://example.com"
    },
    "trigger": {
      "ts": "2021-10-18T23:54:48.000000Z",
      "metric": "temperature",
      "apparentPower": {
        "draw": 15.9
      },
      "co2": {
        "concentration": 100
      },
      "current": {
        "draw": 0.13
      },
      "door": {
        "open": true
      },
      "frequency": {
        "level": 60.1
      },
      "humidity": {
        "relativePercentage": 34
      },
      "indoorAirQuality": {
        "score": 89
      },
      "noise": {
        "ambient": {
          "level": 45
        }
      },
      "pm25": {
        "concentration": 100
      },
      "powerFactor": {
        "percentage": 86
      },
      "realPower": {
        "draw": 13.7
      },
      "temperature": {
        "fahrenheit": 77.81,
        "celsius": 25.45
      },
      "tvoc": {
        "concentration": 100
      },
      "upstreamPower": {
        "outageDetected": true
      },
      "voltage": {
        "level": 122.4
      },
      "water": {
        "present": true
      }
    },
    "profile": {
      "id": "1",
      "name": "Too hot",
      "condition": {
        "metric": "temperature",
        "threshold": {
          "temperature": {
            "celsius": 20.5,
            "fahrenheit": 70,
            "quality": "good"
          },
          "humidity": {
            "relativePercentage": 65,
            "quality": "inadequate"
          },
          "water": {
            "present": true
          },
          "door": {
            "open": true
          },
          "tvoc": {
            "concentration": 400,
            "quality": "poor"
          },
          "co2": {
            "concentration": 400,
            "quality": "poor"
          },
          "pm25": {
            "concentration": 90,
            "quality": "fair"
          },
          "noise": {
            "ambient": {
              "level": 120,
              "quality": "poor"
            }
          },
          "indoorAirQuality": {
            "score": 80,
            "quality": "fair"
          },
          "realPower": {
            "draw": 14.1
          },
          "apparentPower": {
            "draw": 17.2
          },
          "powerFactor": {
            "percentage": 81
          },
          "current": {
            "draw": 0.14
          },
          "voltage": {
            "level": 119.5
          },
          "frequency": {
            "level": 58.8
          },
          "upstreamPower": {
            "outageDetected": true
          }
        },
        "direction": "above",
        "duration": 60
      }
    },
    "snapshotCamera": {
      "serial": "QAAA-AAAA-AAAA",
      "name": "Camera",
      "url": "http://example.com"
    }
  }
]

- Path added

- New endpoint

Return a list of sensor alert events

GET /organizations/{organizationId}/sensor/alerts

[
    {
        "startTs": "2018-02-11T00:00:00.090210Z",
        "sensor": {
            "name": "My sensor",
            "serial": "Q234-ABCD-5678",
            "model": "MT10",
            "url": "http://example.com"
        },
        "trigger": {
            "ts": "2021-10-18T23:54:48.000000Z",
            "metric": "temperature",
            "apparentPower": {
                "draw": 15.9
            },
            "co2": {
                "concentration": 100
            },
            "current": {
                "draw": 0.13
            },
            "door": {
                "open": true
            },
            "frequency": {
                "level": 60.1
            },
            "humidity": {
                "relativePercentage": 34
            },
            "indoorAirQuality": {
                "score": 89
            },
            "noise": {
                "ambient": {
                    "level": 45
                }
            },
            "pm25": {
                "concentration": 100
            },
            "powerFactor": {
                "percentage": 86
            },
            "realPower": {
                "draw": 13.7
            },
            "temperature": {
                "fahrenheit": 77.81,
                "celsius": 25.45
            },
            "tvoc": {
                "concentration": 100
            },
            "upstreamPower": {
                "outageDetected": true
            },
            "voltage": {
                "level": 122.4
            },
            "water": {
                "present": true
            }
        },
        "profile": {
            "id": "1",
            "name": "Too hot",
            "condition": {
                "metric": "temperature",
                "threshold": {
                    "temperature": {
                        "celsius": 20.5,
                        "fahrenheit": 70,
                        "quality": "good"
                    },
                    "humidity": {
                        "relativePercentage": 65,
                        "quality": "inadequate"
                    },
                    "water": {
                        "present": true
                    },
                    "door": {
                        "open": true
                    },
                    "tvoc": {
                        "concentration": 400,
                        "quality": "poor"
                    },
                    "co2": {
                        "concentration": 400,
                        "quality": "poor"
                    },
                    "pm25": {
                        "concentration": 90,
                        "quality": "fair"
                    },
                    "noise": {
                        "ambient": {
                            "level": 120,
                            "quality": "poor"
                        }
                    },
                    "indoorAirQuality": {
                        "score": 80,
                        "quality": "fair"
                    },
                    "realPower": {
                        "draw": 14.1
                    },
                    "apparentPower": {
                        "draw": 17.2
                    },
                    "powerFactor": {
                        "percentage": 81
                    },
                    "current": {
                        "draw": 0.14
                    },
                    "voltage": {
                        "level": 119.5
                    },
                    "frequency": {
                        "level": 58.8
                    },
                    "upstreamPower": {
                        "outageDetected": true
                    }
                },
                "direction": "above",
                "duration": 60
            }
        },
        "snapshotCamera": {
            "serial": "QAAA-AAAA-AAAA",
            "name": "Camera",
            "url": "http://example.com"
        }
    }
]

---

schedules

Docs

Returns a list of all sensor schedules.

Operation ID: getNetworkSensorSchedules

PATH /networks/{networkId}/sensor/schedules

[
  {
    "id": "123",
    "name": "Weekday schedule"
  },
  {
    "id": "124",
    "name": "Office hours"
  }
]

- Path added

- New endpoint

Returns a list of all sensor schedules.

GET /networks/{networkId}/sensor/schedules

[
    {
        "id": "123",
        "name": "Weekday schedule"
    },
    {
        "id": "124",
        "name": "Office hours"
    }
]

---

[ appliance ]

sdwan

Docs

Get the SDWAN internet traffic preferences for an MX network

Operation ID: getOrganizationApplianceSdwanInternetPolicies

PATH /organizations/{organizationId}/appliance/sdwan/internetPolicies

{
  "wanTrafficUplinkPreferences": [
    {
      "preferredUplink": "wan1",
      "failOverCriterion": "poorPerformance",
      "performanceClass": {
        "type": "custom",
        "builtinPerformanceClassName": "VoIP",
        "customPerformanceClassId": "123456"
      },
      "trafficFilters": [
        {
          "type": "custom",
          "value": {
            "protocol": "tcp",
            "source": {
              "port": "1-1024",
              "cidr": "192.168.1.0/24",
              "vlan": 10,
              "host": 254
            },
            "destination": {
              "port": "any",
              "cidr": "any",
              "applications": [
                {
                  "id": "meraki:layer7/application/3",
                  "name": "DNS",
                  "type": "major"
                }
              ]
            }
          }
        }
      ]
    }
  ]
}

- Path added

- New endpoint

Get the SDWAN internet traffic preferences for an MX network

GET /organizations/{organizationId}/appliance/sdwan/internetPolicies

{
    "wanTrafficUplinkPreferences": [
        {
            "preferredUplink": "wan1",
            "failOverCriterion": "poorPerformance",
            "performanceClass": {
                "type": "custom",
                "builtinPerformanceClassName": "VoIP",
                "customPerformanceClassId": "123456"
            },
            "trafficFilters": [
                {
                    "type": "custom",
                    "value": {
                        "protocol": "tcp",
                        "source": {
                            "port": "1-1024",
                            "cidr": "192.168.1.0/24",
                            "vlan": 10,
                            "host": 254
                        },
                        "destination": {
                            "port": "any",
                            "cidr": "any",
                            "applications": [
                                {
                                    "id": "meraki:layer7/application/3",
                                    "name": "DNS",
                                    "type": "major"
                                }
                            ]
                        }
                    }
                }
            ]
        }
    ]
}

---

umbrella

Docs

Connect to Cisco Umbrella account to this network

Operation ID: connectNetworkApplianceUmbrellaAccount

PATH /networks/{networkId}/appliance/umbrella/account/connect

{
  "umbrellaOrganizationId": "8769012"
}

- Path added

- New endpoint

Connect to Cisco Umbrella account to this network

POST /networks/{networkId}/appliance/umbrella/account/connect

{
    "umbrellaOrganizationId": "8769012"
}

---

Docs

Disconnect Umbrella account from this network

Operation ID: disconnectNetworkApplianceUmbrellaAccount

PATH /networks/{networkId}/appliance/umbrella/account/disconnect

{
  "success": true,
  "message": "Successfully updated"
}

- Path added

- New endpoint

Disconnect Umbrella account from this network

DELETE /networks/{networkId}/appliance/umbrella/account/disconnect

{
    "success": true,
    "message": "Successfully updated"
}

---

Docs

Disable umbrella protection for an MX network

Operation ID: disableNetworkApplianceUmbrellaProtection

PATH /networks/{networkId}/appliance/umbrella/disableProtection

{
  "success": true,
  "message": "Successfully updated"
}

- Path added

- New endpoint

Disable umbrella protection for an MX network

DELETE /networks/{networkId}/appliance/umbrella/disableProtection

{
    "success": true,
    "message": "Successfully updated"
}

---

Docs

Enable umbrella protection for an MX network

Operation ID: enableNetworkApplianceUmbrellaProtection

PATH /networks/{networkId}/appliance/umbrella/enableProtection

{
  "success": true,
  "message": "Successfully updated"
}

- Path added

- New endpoint

Enable umbrella protection for an MX network

POST /networks/{networkId}/appliance/umbrella/enableProtection

{
    "success": true,
    "message": "Successfully updated"
}

---

Docs

Specify one or more domain names to be excluded from being routed to Cisco Umbrella.

Operation ID: excludeNetworkApplianceUmbrellaDomains

PATH /networks/{networkId}/appliance/umbrella/excludeDomains

{
  "success": true,
  "message": "Successfully updated"
}

- Path added

- New endpoint

Specify one or more domain names to be excluded from being routed to Cisco Umbrella.

PUT /networks/{networkId}/appliance/umbrella/excludeDomains

{
    "success": true,
    "message": "Successfully updated"
}

---

Docs

Update umbrella policies applied to MX network.

Operation ID: policiesNetworkApplianceUmbrella

PATH /networks/{networkId}/appliance/umbrella/policies

{
  "success": true,
  "message": "Successfully updated"
}

- Path added

- New endpoint

Update umbrella policies applied to MX network.

PUT /networks/{networkId}/appliance/umbrella/policies

{
    "success": true,
    "message": "Successfully updated"
}

---

vlans

Docs

List the VLANs for an Organization

Operation ID: getOrganizationApplianceVlans

PATH /organizations/{organizationId}/appliance/vlans

[
  {
    "id": "1234",
    "interfaceId": "1284392014819",
    "name": "My VLAN",
    "subnet": "192.168.1.0/24",
    "applianceIp": "192.168.1.2",
    "groupPolicyId": "101",
    "templateVlanType": "same",
    "cidr": "192.168.1.0/24",
    "mask": 28,
    "dhcpRelayServerIps": [
      "192.168.1.0/24",
      "192.168.128.0/24"
    ],
    "dhcpHandling": "Run a DHCP server",
    "dhcpLeaseTime": "1 day",
    "dhcpBootOptionsEnabled": false,
    "dhcpBootNextServer": "1.2.3.4",
    "dhcpBootFilename": "sample.file",
    "fixedIpAssignments": {
      "00:11:22:33:44:55": {
        "ip": "1.2.3.4",
        "name": "My favorite IP"
      }
    },
    "reservedIpRanges": [
      {
        "start": "192.168.1.0",
        "end": "192.168.1.1",
        "comment": "A reserved IP range"
      }
    ],
    "dnsNameservers": "google_dns",
    "dhcpOptions": [
      {
        "code": "5",
        "type": "text",
        "value": "five"
      }
    ],
    "vpnNatSubnet": "192.168.1.0/24",
    "mandatoryDhcp": {
      "enabled": true
    },
    "ipv6": {
      "enabled": true,
      "prefixAssignments": [
        {
          "autonomous": false,
          "staticPrefix": "2001:db8:3c4d:15::/64",
          "staticApplianceIp6": "2001:db8:3c4d:15::1",
          "origin": {
            "type": "internet",
            "interfaces": [
              "wan0"
            ]
          }
        }
      ]
    }
  }
]

- Path added

- New endpoint

List the VLANs for an Organization

GET /organizations/{organizationId}/appliance/vlans

[
    {
        "id": "1234",
        "interfaceId": "1284392014819",
        "name": "My VLAN",
        "subnet": "192.168.1.0/24",
        "applianceIp": "192.168.1.2",
        "groupPolicyId": "101",
        "templateVlanType": "same",
        "cidr": "192.168.1.0/24",
        "mask": 28,
        "dhcpRelayServerIps": [
            "192.168.1.0/24",
            "192.168.128.0/24"
        ],
        "dhcpHandling": "Run a DHCP server",
        "dhcpLeaseTime": "1 day",
        "dhcpBootOptionsEnabled": false,
        "dhcpBootNextServer": "1.2.3.4",
        "dhcpBootFilename": "sample.file",
        "fixedIpAssignments": {
            "00:11:22:33:44:55": {
                "ip": "1.2.3.4",
                "name": "My favorite IP"
            }
        },
        "reservedIpRanges": [
            {
                "start": "192.168.1.0",
                "end": "192.168.1.1",
                "comment": "A reserved IP range"
            }
        ],
        "dnsNameservers": "google_dns",
        "dhcpOptions": [
            {
                "code": "5",
                "type": "text",
                "value": "five"
            }
        ],
        "vpnNatSubnet": "192.168.1.0/24",
        "mandatoryDhcp": {
            "enabled": true
        },
        "ipv6": {
            "enabled": true,
            "prefixAssignments": [
                {
                    "autonomous": false,
                    "staticPrefix": "2001:db8:3c4d:15::/64",
                    "staticApplianceIp6": "2001:db8:3c4d:15::1",
                    "origin": {
                        "type": "internet",
                        "interfaces": [
                            "wan0"
                        ]
                    }
                }
            ]
        }
    }
]

---

Changed

[ insight ]

applications

Docs

Add an Insight tracked application

Operation ID: createOrganizationInsightApplication

POST /organizations/{organizationId}/insight/applications

- Added endpoint method

Add an Insight tracked application

createOrganizationInsightApplication

{
    "applicationId": "19.12",
    "name": "Meraki HTTPS",
    "thresholds": {
        "type": "smart",
        "byNetwork": [
            {
                "networkId": "N_12345678",
                "goodput": 50000,
                "responseDuration": 1000
            }
        ]
    }
}

---

[ organizations ]

summary

Docs

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

Operation ID: getOrganizationSummaryTopAppliancesByUtilization

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

- Optional param networkId added

Docs

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

Operation ID: getOrganizationSummaryTopClientsByUsage

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

- Optional param networkId added

Docs

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

Operation ID: getOrganizationSummaryTopClientsManufacturersByUsage

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

- Optional param networkId added

Docs

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

Operation ID: getOrganizationSummaryTopDevicesByUsage

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

- Optional param networkId added

Docs

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

Operation ID: getOrganizationSummaryTopDevicesModelsByUsage

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

- Optional param networkId added

Docs

List the client and status overview information for the networks in an organization

Operation ID: getOrganizationSummaryTopNetworksByStatus

GET /organizations/{organizationId}/summary/top/networks/byStatus

- Optional param networkId added

Docs

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

Operation ID: getOrganizationSummaryTopSsidsByUsage

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

- Optional param networkId added

Docs

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

Operation ID: getOrganizationSummaryTopSwitchesByEnergyUsage

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

- Optional param networkId added

devices

Docs

List the availability history information for devices in an organization.

Operation ID: getOrganizationDevicesAvailabilitiesChangeHistory

GET /organizations/{organizationId}/devices/availabilities/changeHistory

- Optional param categories added

- Optional param networkTags added

- Optional param networkTagsFilterType added

- Optional param deviceTags added

- Optional param deviceTagsFilterType added

- Optional property tags Added

- Optional property category Added

- Response property tags value added

- Response property category value added

Docs

List the status of every Meraki device in the organization

Operation ID: getOrganizationDevicesStatuses

GET /organizations/{organizationId}/devices/statuses

- Optional param configurationUpdatedAfter added

clients

Docs

Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.

Operation ID: getOrganizationClientsBandwidthUsageHistory

GET /organizations/{organizationId}/clients/bandwidthUsageHistory

- Optional param networkId added

[ networks ]

settings

Docs

Update the settings for a network

Operation ID: updateNetworkSettings

PUT /networks/{networkId}/settings

- Optional property fips Added

firmwareUpgrades

Docs

Rollback a Firmware Upgrade For A Network

Operation ID: createNetworkFirmwareUpgradesRollback

POST /networks/{networkId}/firmwareUpgrades/rollbacks

- Optional property predownloadFirmware Added

- Optional property predownloadFirmware Added

Docs

Update firmware upgrade information for a network

Operation ID: updateNetworkFirmwareUpgrades

PUT /networks/{networkId}/firmwareUpgrades

- Optional property upgradeStrategy Added

- Optional property predownloadFirmware Added

- Optional property upgradeStrategy Added

- Optional property predownloadFirmware Added

Docs

Get firmware upgrade information for a network

Operation ID: getNetworkFirmwareUpgrades

GET /networks/{networkId}/firmwareUpgrades

- Optional property upgradeStrategy Added

- Optional property predownloadFirmware Added

- Response property upgradeStrategy value added

- Response property predownloadFirmware value added

[ wireless ]

rfProfiles

Docs

Creates new RF profile for this network

Operation ID: createNetworkWirelessRfProfile

POST /networks/{networkId}/wireless/rfProfiles

- Optional property afcEnabled Added

- Optional property afcEnabled Added

Docs

Updates specified RF profile for this network

Operation ID: updateNetworkWirelessRfProfile

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

- Optional property afcEnabled Added

- Optional property afcEnabled Added

Docs

List RF profiles for this network

Operation ID: getNetworkWirelessRfProfiles

GET /networks/{networkId}/wireless/rfProfiles

- Optional property afcEnabled Added

- Response property afcEnabled value added

Docs

Return a RF profile

Operation ID: getNetworkWirelessRfProfile

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

- Optional property afcEnabled Added

- Response property afcEnabled value added

settings

Docs

Update the wireless settings for a network

Operation ID: updateNetworkWirelessSettings

PUT /networks/{networkId}/wireless/settings

- Optional property predownloadFirmware Added

- Optional property predownloadFirmware Added

Docs

Return the wireless settings for a network

Operation ID: getNetworkWirelessSettings

GET /networks/{networkId}/wireless/settings

- Optional property predownloadFirmware Added

- Response property predownloadFirmware value added

bluetooth

Docs

Update the bluetooth settings for a wireless device

Operation ID: updateDeviceWirelessBluetoothSettings

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

- Optional property transmit Added

- Optional property transmit Added

Docs

Update the Bluetooth settings for a network

Operation ID: updateNetworkWirelessBluetoothSettings

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

- Optional property transmit Added

- Optional property transmit Added

Docs

Return the bluetooth settings for a wireless device

Operation ID: getDeviceWirelessBluetoothSettings

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

- Optional property transmit Added

- Response property transmit value added

Docs

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

Operation ID: getNetworkWirelessBluetoothSettings

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

- Optional property transmit Added

- Response property transmit value added

[ switch ]

stacks

Docs

Create a layer 3 interface for a switch stack

Operation ID: createNetworkSwitchStackRoutingInterface

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

Docs

Update a layer 3 interface for a switch stack

Operation ID: updateNetworkSwitchStackRoutingInterface

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

Docs

List layer 3 interfaces for a switch stack

Operation ID: getNetworkSwitchStackRoutingInterfaces

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Response property staticV6Dns1 value added

- Response property staticV6Dns2 value added

- Response property staticV4Dns1 value added

- Response property staticV4Dns2 value added

Docs

Return a layer 3 interface from a switch stack

Operation ID: getNetworkSwitchStackRoutingInterface

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Response property staticV6Dns1 value added

- Response property staticV6Dns2 value added

- Response property staticV4Dns1 value added

- Response property staticV4Dns2 value added

ports

Docs

List the switchports in an organization by switch

Operation ID: getOrganizationSwitchPortsBySwitch

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

- Optional param extendedParams added

routing

Docs

Create a layer 3 interface for a switch

Operation ID: createDeviceSwitchRoutingInterface

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

Docs

Create a multicast rendezvous point

Operation ID: createNetworkSwitchRoutingMulticastRendezvousPoint

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

- Optional property vrf Added

Docs

Update a layer 3 interface for a switch

Operation ID: updateDeviceSwitchRoutingInterface

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property uplinkV4 Added

- Optional property uplinkV6 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

Docs

Update a multicast rendezvous point

Operation ID: updateNetworkSwitchRoutingMulticastRendezvousPoint

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

- Optional property vrf Added

Docs

List layer 3 interfaces for a switch

Operation ID: getDeviceSwitchRoutingInterfaces

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Response property staticV6Dns1 value added

- Response property staticV6Dns2 value added

- Response property staticV4Dns1 value added

- Response property staticV4Dns2 value added

Docs

Return a layer 3 interface for a switch

Operation ID: getDeviceSwitchRoutingInterface

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

- Optional property staticV6Dns1 Added

- Optional property staticV6Dns2 Added

- Optional property staticV4Dns1 Added

- Optional property staticV4Dns2 Added

- Response property staticV6Dns1 value added

- Response property staticV6Dns2 value added

- Response property staticV4Dns1 value added

- Response property staticV4Dns2 value added

Docs

List multicast rendezvous points

Operation ID: getNetworkSwitchRoutingMulticastRendezvousPoints

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

- Optional property vrf Added

- Response property vrf value added

Docs

Return a multicast rendezvous point

Operation ID: getNetworkSwitchRoutingMulticastRendezvousPoint

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

- Optional property vrf Added

- Response property vrf value added

[ sensor ]

commands

Docs

Sends a command to a sensor

Operation ID: createDeviceSensorCommand

POST /devices/{serial}/sensor/commands

- Optional property arguments Added

[ appliance ]

vlans

Docs

Add a VLAN

Operation ID: createNetworkApplianceVlan

POST /networks/{networkId}/appliance/vlans

- Optional property adaptivePolicyGroupId Added

Docs

Update a VLAN

Operation ID: updateNetworkApplianceVlan

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

- Optional property adaptivePolicyGroupId Added

ports

Docs

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

Operation ID: updateNetworkAppliancePort

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

- Optional property peerSgtCapable Added

- Optional property adaptivePolicyGroupId Added

- Optional property peerSgtCapable Added

Docs

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

Operation ID: getNetworkAppliancePorts

GET /networks/{networkId}/appliance/ports

- Optional property peerSgtCapable Added

- Response property peerSgtCapable value added

Docs

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

Operation ID: getNetworkAppliancePort

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

- Optional property peerSgtCapable Added

- Response property peerSgtCapable value added

uplinks

Docs

Update the uplink settings for an MX appliance

Operation ID: updateDeviceApplianceUplinksSettings

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

- Optional property sgt Added

- Optional property sgt Added

- Optional property sgt Added

Docs

Return the uplink settings for an MX appliance

Operation ID: getDeviceApplianceUplinksSettings

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

- Optional property sgt Added

- Optional property sgt Added

- Response property sgt value added

- Response property sgt value added