Articles in this section

Available Cisco Meraki APIs

When you configure an export, import, other type of flow step using the prebuilt Cisco Meraki connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Cisco Meraki API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Me

Returns the identity of the current user

X

Configure

Return a single device

X

Update the attributes of a device

X

Subnets

Return the DHCP subnet information for an appliance

X

Performance

Return the performance score for a single MX

X

Delegated

Return current delegated IPV6 prefixes on an appliance

X

VLAN assignments

Return prefixes assigned to all IPV6 enabled VLANs on an appliance

X

Settings

Return the radio settings of an appliance

X

Update the radio settings of an appliance

X

Return the appliance settings for a network

X

Update the appliance settings for a network

X

Uplinks

Return the uplink settings for an MX appliance

X

Update the uplink settings for an MX appliance

X

Authentication token

Generate a new VMX authentication token

X

Live tools

Blink the LEDs on a device

X

Reboot a device

X

Camera

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

X

Live

Returns live state from camera of analytics zones

X

Overview

Returns an overview of aggregate analytics data for a timespan

X

Recent

Returns most recent record for analytics zones

X

Zones

Returns all configured analytic zones for this camera

X

History

Return historical records for analytic zones

X

Custom analytics

Return custom analytics settings for a camera

X

Update custom analytics settings for a camera

X

Quality and retention

Return quality and retention settings for the given camera

X

Update quality and retention settings for the given camera

X

Sense

Return sense settings for a given camera

X

Update sense settings for the given camera

X

Object detection models

Return the mv sense object detection model list for the given camera

X

Video

Return video settings for the given camera

X

Update video settings for the given camera

X

Video link

Return video link to the specified camera

X

Wireless profiles

Return wireless profile assigned to the given camera

X

Assign wireless profiles to the given camera

X

Create a new camera wireless profile for this network

X

List the camera wireless profiles for this network

X

Retrieve a single camera wireless profile

X

Update an existing camera wireless profile in this network

X

Delete an existing camera wireless profile for this network

X

SIMs

Return the SIM and APN configurations for a cellular device

X

Update the SIM and APN configurations for a cellular device

X

Cellular gateway

List common DHCP settings of MGs

X

Update common DHCP settings of MGs

X

LAN

Show the LAN settings of a MG

X

Update the LAN settings for a single MG

X

Port forwarding rules

Return the port forwarding rules for a single MG

X

Update the port forwarding rules for a single MG

X

Clients

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

X

Ping

Enqueue a job to ping a target host from the device

X

Return a ping job

X

Ping device

Enqueue a job to check connectivity status to the device

X

Return a ping device job

X

Wake on LAN

Enqueue a job to send a wake-on-LAN packet from the device

X

Return a wake-on-LAN job

X

IIDP CDP

List IIDP and CDP information for a device

X

Loss and latency history

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for MX, MG, and Z devices

X

Management interface

Return the management interface settings for a device

X

Update the management interface settings for a device

X

Commands

Return a historical log of all commands

X

Return information about the command's execution, including the status

X

Send a command to a sensor

X

Relationships

List the sensor roles for a given sensor or camera device

X

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

X

List the sensor roles for devices in a given network

X

Switch

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

X

Return the switch network settings

X

Update switch network settings

X

Ports

Return the counts of all active ports for the requested timespan, grouped by speed

X

List the switch ports for a switch

X

Return a switch port

X

Update a switch port

X

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

X

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

X

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

X

Cycle a set of switch ports

X

Statuses

Return the status for all the ports of a switch

X

List the uplink status of every Meraki mx and z series appliance in the organization

X

Packets

Return the packet counters for all the ports of a switch

X

Interfaces

List layer 3 interfaces for a switch

X

Create a layer 3 interface for a switch

X

Return a layer 3 interface for a switch

X

Update a layer 3 interface for a switch

X

Delete a layer 3 interface from the switch

X

Return a layer 3 interface DHCP configuration for a switch

X

Update a layer 3 interface DHCP configuration for a switch

X

Static routes

List layer 3 static routes for a switch

X

Create a layer 3 static route for a switch

X

Return a layer 3 static route for a switch

X

Update a layer 3 static route for a switch

X

Delete a layer 3 static route for a switch

X

List the static routes for an MX or teleworker network

X

Add a static route for an MX or teleworker network

X

Return a static route for an MX or teleworker network

X

Update a static route for an MX or teleworker network

X

Delete a static route from an MX or teleworker network

X

Warm spare

Return warm spare configuration for a switch

X

Update warm spare configuration for a switch

X

Return MX warm spare settings

X

Update MX warm spare settings

X

Swap MX primary and warm spare appliances

X

Wireless

Return the radio settings of a device

X

Update the radio settings of a device

X

Return the wireless settings for a network

X

Update the wireless settings for a network

X

Alternate management interface

Return the switch alternate management interface for the network

X

Update the switch alternate management interface for the network

X

Return alternate management interface and devices with IP assigned

X

Update alternate management interface and device static IP

X

IPV6

Update alternate management interface IPV6 address

X

Bluetooth

Return the Bluetooth settings for a wireless device

X

Update the Bluetooth settings for a wireless device

X

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

X

Update the Bluetooth settings for a network

X

Connection stats

Aggregate connectivity info for a given AP on this network

X

Aggregate connectivity info for this network, grouped by clients

X

Aggregate connectivity info for a given client on this network

X

Aggregate connectivity info for this network

X

Aggregate connectivity info for this network, grouped by node

X

Health scores

Fetch the health scores for a given AP on this network

X

Fetch the health scores for all clients on this network

X

Fetch the health scores for a given client on this network

X

Fetch the health scores of all APs on this network

X

Latency stats

Aggregate latency info for a given AP on this network

X

Aggregate latency info for this network, grouped by clients

X

Aggregate latency info for a given client on this network

X

Aggregate latency info for this network, grouped by node

X

Aggregate latency info for this network

X

Status

Return the SSID statuses of an access point

X

Networks

List the clients that have used this network in the timespan

X

Return overview statistics for network clients

X

Return the client associated with the given identifier

X

List the devices in a network

X

Claim devices into a network.

X

Remove a single device

X

Return a network

X

Update a network

X

Delete a network

X

Bind a network to a template

X

Provision a client with a name and policy

X

Return the settings for a network

X

Update the settings for a network

X

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

X

Unbind a network from a template

X

Alerts

Return the alert history for this network

X

Return the alert configuration for this network

X

Update the alert configuration for this network

X

Events

List the security events for a client

X

List the security events for a network

X

List the events for the network

X

List the security events for an organization

X

Connectivity monitoring destinations

Return the connectivity testing destinations for an MX network

X

Update the connectivity testing destinations for an MX network

X

Return the connectivity testing destinations for an MG network

X

Update the connectivity testing destinations for an MG network

X

Content filtering

Return the content filtering settings for an MX network

X

Update the content filtering settings for an MX network

X

Categories

List all available content filtering categories for an MX network

X

Firewall

Return the port forwarding rules for an MX network

X

Update the port forwarding rules for an MX network

X

Return the firewall settings for this network

X

Update the firewall settings for this network

X

Cellular firewall rules

Return the cellular firewall rules for an MX network

X

Update the cellular firewall rules of an MX network

X

Firewalled services

List the appliance services and their accessibility rules

X

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

X

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

X

Inbound cellular firewall rules

Return the inbound cellular firewall rules for an MX network

X

Update the inbound cellular firewall rules of an MX network

X

Inbound firewall rules

Return the inbound firewall rules for an MX network

X

Update the inbound firewall rules of an MX network

X

l3 firewall rules

Return the l3 firewall rules for an MX network

X

Update the l3 firewall rules of an MX network

X

l7 firewall rules

List the MX l7 firewall rules for an MX network

X

Update the MX l7 firewall rules for an MX network

X

Application categories

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

X

One to many NAT rules

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

X

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

X

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

X

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

X

Statics

List static delegated prefixes for a network

X

Add a static delegated prefix from a network

X

Return a static delegated prefix from a network

X

Update a static delegated prefix from a network

X

Delete a static delegated prefix from a network

X

RF profiles

List the RF profiles for this network

X

Create new RF profile for this network

X

Updates specified RF profile for this network

X

Delete an RF profile

X

Return an RF profile

X

List RF profiles for this network

X

Creates new RF profile for this network

X

Update specified RF profile for this network

X

Delete an RF profile

X

Return an RF profile

X

Intrusion

Return all supported intrusion settings for an MX network

X

Set the supported intrusion settings for an MX network

X

Return all supported intrusion settings for an organization

X

Set supported intrusion settings for an organization

X

Malware

Returns all supported malware settings for an MX network

X

Set the supported malware settings for an MX network

X

Single LAN

Return single LAN configuration

X

Update single LAN configuration

X

SSIDS

List the mx SSIDs in a network

X

Return a single MX SSID

X

Update the attributes of an MX SSID

X

List the MR SSIDs in a network

X

Return a single MR SSID

X

Update the attributes of an MR SSID

X

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

X

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

X

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

X

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

X

Traffic shaping

Display the traffic shaping settings for an MX network

X

Update the traffic shaping settings for an MX network

X

Return the application categories for traffic shaping rules

X

Custom performance classes

List all custom performance classes for an MX network

X

Add a custom performance class for an MX network

X

Return a custom performance class for an MX network

X

Update a custom performance class for an MX network

X

Delete a custom performance class from an MX network

X

Rules

Update the traffic shaping settings rules for an MX network

X

Display the traffic shaping settings rules for an MX network

X

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

X

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

X

Uplink bandwidth

Return the uplink bandwidth limits for your MX network

X

Update the uplink bandwidth settings for your MX network

X

Show uplink selection settings for an MX network

X

Update uplink selection settings for an MX network

X

VPN exclusions

Update VPN exclusion rules for an MX network

X

Usage history

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

X

Return the client's daily usage history

X

Return AP usage over time for a device or network client

X

VLANs

List the VLANs for an mx network

X

Add a VLAN

X

Return the enabled status of VLANs for the network

X

Enable/disable VLANs for the given network

X

Return a VLAN

X

Update a VLAN

X

Delete a VLAN from a network

X

VPN

Show VPN status for networks in an organization

X

List the VPN settings for the SSID

X

Update the VPN settings for the SSID

X

BGP

Return a hub BGP configuration

X

Update a hub BGP configuration

X

Site-to-site VPN

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

X

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

X

Bluetooth clients

List the Bluetooth clients seen by APS in this network

X

Return a Bluetooth client

X

Quality retention profiles

List the quality retention profiles for this network

X

Create new quality retention profile for this network

X

Retrieve a single quality retention profile

X

Update an existing quality retention profile for this network

X

Delete an existing quality retention profile for this network

X

Schedules

Return a list of all camera recording schedules

X

Return a list of all sensor schedules

X

List the outage schedule for the SSID

X

Update the outage schedule for the SSID

X

Subnet pool

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

X

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

X

Uplink

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

X

Return the uplink settings for your mg network

X

Update the uplink settings for your mg network

X

Application usage

Return the application usage data for clients

X

Bandwidth usage history

Return a time series of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second

X

Usage histories

Return the usage histories for clients

X

Policy

Return the policy assigned to a client on the network

X

Update the policy assigned to a client on the network

X

Splash authorization status

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

X

Update a client's splash authorization

X

Traffic history

Return the client's network traffic data over time

X

Claim

Claim a VMX into a network

X

Event types

List the event type to human-readable description

X

Firmware upgrades

Get firmware upgrade information for a network

X

Update firmware upgrade information for a network

X

Rollbacks

Rollback a firmware upgrade for a network

X

Staged

Get the staged upgrade event from a network

X

Create a staged upgrade event for a network

X

Update the staged upgrade event for a network

X

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

X

Rollback a staged upgrade event for a network

X

Groups

List of staged upgrade groups in a network

X

Create a staged upgrade group for a network

X

Get a staged upgrade group from a network

X

Update a staged upgrade group for a network

X

Delete a staged upgrade group

X

Stages

Order of staged upgrade groups in a network

X

Assign staged upgrade group order in the sequence.

X

Floor plans

List the floor plans that belong to your network

X

Upload a floor plan

X

Find a floor plan by ID

X

Update a floor plan's geolocation and other metadata

X

Destroy a floor plan

X

Group policies

List the group policies in a network

X

Create a group policy

X

Display a group policy

X

Update a group policy

X

Delete a group policy

X

Health

Return all global alerts on this network

X

Applications

List all insight tracked applications

X

Add an insight tracked application

X

Update an insight tracked application

X

Health by time

Get application health by time

X

Location scanning

Return scanning API settings

X

Change scanning API settings

X

HTTP servers

Return list of scanning API receivers

X

Set the list of scanning API receivers

X

Meraki auth users

List the users configured under Meraki authentication for a network

X

Authorize a user configured with Meraki authentication for a network 

X

Return the Meraki auth splash guest, radius, or client VPN user

X

Delete an 802.1x radius user, or deauthorize and optionally delete a splash guest or client VPN user

X

Update a user configured with Meraki authentication 

X

MQTT brokers

List the MQTT brokers for this network

X

Add an MQTT broker

X

Return an MQTT broker

X

Update an MQTT broker

X

Delete an MQTT broker

X

List the sensor settings of all MQTT brokers for this network

X

Return the sensor settings of an MQTT broker

X

Update the sensor settings of an MQTT broker

X

Netflow

Return the NetFlow traffic reporting settings for a network

X

Update the NetFlow traffic reporting settings for a network

X

Channel utilization

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

X

PII keys

List the keys required to access PII for a given identifier

X

Requests

List the PII requests for this network or organization

X

Submit a new delete or restrict processing PII request

X

Return a PII request

X

Delete a restrict processing PII request

X

SM devices for key

Give a piece of PII, return the systems manager device IDs associated with that identifier

X

SM owners for key

Give a piece of PII, return the systems manager owner IDs associated with that identifier

X

By client

Get policies for all clients with policies

X

By metric

Return an overview of currently alerting sensors by metric

X

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

X

Profiles

Lists all sensor alert profiles for a network

X

Create a sensor alert profile for a network

X

Show details of a sensor alert profile for a network

X

Update a sensor alert profile for a network

X

Delete a sensor alert profile from a network

X

SM

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

X

Force check-in a set of devices

X

Lock a set of devices

X

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

X

Move a set of devices to a new network

X

Wipe a device

X

Install applications on a device

X

Refresh the details of a device

X

Unenroll a device

X

Uninstall applications on a device

X

List all profiles in a network

X

Bypass activation lock attempts

Bypass activation lock attempt

X

Bypass activation lock attempt status

X

Fields

Modify the fields of a device

X

Cellular usage history

Return the client's daily cellular data usage history

X

Certs

List the certs on a device

X

Connectivity

Returns historical connectivity data

X

Desktop logs

Return historical records of various systems manager network connection details for desktop devices

X

Device command logs

Return historical records of commands sent to systems manager devices

X

Device profiles

Get the installed profiles associated with a device

X

Network adapters

List the network adapters of a device

X

Performance history

Return historical records of various systems manager client metrics for desktop devices

X

Restrictions

List the restrictions on a device

X

Security centers

List the security centers on a device

X

Softwares

Get a list of softwares associated with a device

X

WLAN lists

List the saved SSID names on a device

X

Target groups

List the target groups in this network

X

Add a target group

X

Return a target group

X

Update a target group

X

Delete a target group from a network

X

Trusted access configs

List trusted access configs

X

User access devices

List user access devices and its trusted access connections

X

Delete a user access device

X

Users

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

X

Get the profiles associated with a user

X

Get a list of software associated with a user

X

SNMP

Return the SNMP settings for a network

X

Update the SNMP settings for a network

X

Splash login attempts

List the splash login attempts for a network

X

Access control lists

Return the access control lists for an MS network

X

Update the access control lists for an MS network

X

Access policies

List the access policies for a switch network

X

Create an access policy for a switch network

X

Return a specific access policy for a switch network

X

Update an access policy for a switch network

X

Delete an access policy for a switch network

X

Seen

Return the network's dhcpv4 servers seen within the selected timeframe

X

DHCP server policy

Return the DHCP server settings

X

Update the DHCP server settings

X

Trusted servers

Return the list of servers trusted by dynamic ARP inspection on this network

X

Add a server to be trusted by dynamic ARP inspection on this network

X

Update a server that is trusted by dynamic ARP inspection on this network

X

Remove a server from being trusted by dynamic ARP inspection on this network

X

By device

Get average channel utilization for all bands in a network, split by ap

X

Return the devices that have a dynamic arp inspection warning and their warnings

X

DSCP to cos mappings

Return the DSCP to cos mappings

X

Update the DSCP to cos mappings

X

Link aggregations

List link aggregation groups

X

Create a link aggregation group

X

Update a link aggregation group

X

Split a link aggregation group into separate ports

X

MTU

Return the MTU configuration

X

Update the MTU configuration

X

Port schedules

List switch port schedules

X

Add a switch port schedule

X

Delete a switch port schedule

X

Update a switch port schedule

X

QOS rules

List quality of service rules

X

Add a quality of service rule

X

Return a quality of service rule

X

Delete a quality of service rule

X

Update a quality of service rule

X

Order

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

X

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

X

Multicast

Return multicast settings for a network

X

Update multicast settings for a network

X

Rendezvous points

List multicast rendezvous points

X

Create a multicast rendezvous point

X

Return a multicast rendezvous point

X

Delete a multicast rendezvous point

X

Update a multicast rendezvous point

X

OSPF

Return layer 3 OSPF routing configuration

X

Update layer 3 OSPF routing configuration

X

Stacks

List the switch stacks in a network

X

Create a stack

X

Show a switch stack

X

Delete a stack

X

Add a switch to a stack

X

Remove a switch from a stack

X

List layer 3 interfaces for a switch stack

X

Create a layer 3 interface for a switch stack

X

Return a layer 3 interface from a switch stack

X

Update a layer 3 interface for a switch stack

X

Delete a layer 3 interface from a switch stack

X

Return a layer 3 interface DHCP configuration for a switch stack

X

Update a layer 3 interface DHCP configuration for a switch stack

X

List layer 3 static routes for a switch stack

X

Create a layer 3 static route for a switch stack

X

Return a layer 3 static route for a switch stack

X

Update a layer 3 static route for a switch stack

X

Delete a layer 3 static route for a switch stack

X

Storm control

Return the storm control configuration for a switch network

X

Update the storm control configuration for a switch network

X

STP

Returns STP settings

X

Updates STP settings

X

Syslog servers

List the Syslog servers for a network

X

Update the Syslog servers for a network

X

Link layer

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

X

Traffic

Return the traffic analysis data for this network

X

Traffic analysis

Return the traffic analysis settings for a network

X

Update the traffic analysis settings for a network

X

DSCP tagging options

Return the available DSCP tagging options for your traffic shaping rules

X

VLAN profiles

List VLAN profiles for a network

X

Create a VLAN profile for a network

X

Get an existing VLAN profile of a network

X

Update an existing VLAN profile of a network

X

Delete a VLAN profile of a network

X

Assignments

Get the assigned VLAN profiles for devices in a network

X

Update the assigned VLAN profile for devices in a network

X

Webhooks

List the HTTP servers for a network

X

Add an HTTP server to a network

X

Return an HTTP server for a network

X

Update an HTTP server

X

Delete an HTTP server from a network

X

Payload templates

List the webhook payload templates for a network

X

Create a webhook payload template for a network

X

Get the webhook payload template for a network

X

Destroy a webhook payload template for a network

X

Update a webhook payload template for a network

X

Webhook tests

Send a test webhook for a network

X

Return the status of a webhook test for a network

X

Air marshal

List air marshal scan results from a network

X

Billing

Return the billing settings of this network

X

Update the billing settings

X

Channel utilization history

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

X

Client count history

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

X

Onboarding history

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

X

Connectivity events

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

X

Latency history

Return the latency history for a client

X

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

X

Data rate history

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

X

Ethernet

List the most recent ethernet link speed, duplex, aggregation and power mode, and status information for wireless devices

X

List the AP port profiles for this network

X

Create an AP port profile

X

Assign AP port profile to list of APs

X

Set the AP port profile to be default for this network

X

Show the AP port profile by ID for this network

X

Update the AP port profile by ID for this network

X

Delete an AP port profile

X

Failed connections

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

X

Mesh statuses

List wireless mesh statuses for repeaters

X

Auto RF

Update the auto RF settings for a wireless network

X

Signal quality history

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

X

Bonjour forwarding

List the bonjour forwarding setting and rules for the SSID

X

Update the bonjour forwarding setting and rules for the SSID

X

Device type group policies

List the device type group policies for the SSID

X

Update the device type group policies for the SSID

X

EAP override

Return the EAP overridden parameters for an SSID

X

Update the EAP overridden parameters for an SSID

X

Hotspot 2.0

Update the hotspot 2.0 settings of an SSID

X

Return the hotspot 2.0 settings for an SSID

X

Identity PSKS

List all identity PSKs in a wireless network

X

Create an identity PSK

X

Return an identity PSK

X

Update an identity PSK

X

Delete an identity PSK

X

Splash

Display the splash page settings for the given SSID

X

Modify the splash page settings for the given SSID

X

Organizations

Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.

X

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

X

List the status of every Meraki device in the organization

X

Return an overview of current device statuses

X

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

X

List the devices in an organization

X

List the organizations that the user has privileges on

X

Create a new organization

X

Return an organization

X

Update an organization

X

Delete an organization

X

List all organization-wide alert configurations

X

Create an organization-wide alert configuration

X

Update an organization-wide alert config

X

Removes an organization-wide alert config

X

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

X

Create a new organization by cloning the addressed organization

X

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

X

Create a network

X

Combine multiple networks into a single network

X

Get policies for all clients with policies

X

Return the SNMP settings for an organization

X

Update the SNMP settings for an organization

X

List the HTTP servers for this organization

X

Add an HTTP server to an organization

X

Return an HTTP server for an organization

X

Update an HTTP server for an organization

X

Delete an HTTP server from an organization

X

List the webhook payload templates for an organization

X

Create a webhook payload template for an organization

X

Get the webhook payload template for an organization

X

Destroy a webhook payload template for an organization

X

Update a webhook payload template for an organization

X

Send a test webhook for an organization

X

Return the status of a webhook test for an organization

X

Action batches

Create an action batch

X

Return the list of action batches in the organization

X

Return an action batch

X

Delete an action batch

X

Update an action batch

X

Adaptive policy

Return adaptive policy aggregate statistics for an organization

X

List adaptive policy groups in an organization

X

Create a new adaptive policy group

X

Return an adaptive policy group

X

Update an adaptive policy group

X

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

X

List adaptive policies in an organization

X

Add an adaptive policy

X

Return an adaptive policy

X

Update an adaptive policy

X

Delete an adaptive policy

X

Return global adaptive policy settings in an organization

X

Update global adaptive policy settings

X

ACLS

List adaptive policy ACLs in an organization

X

Create new adaptive policy ACL

X

Return the adaptive policy ACL information

X

Update an adaptive policy ACL

X

Delete the specified adaptive policy ACL

X

Admins

List the dashboard administrators in this organization

X

Create a new dashboard administrator

X

Update an administrator

X

Revoke all access for a dashboard administrator within this organization

X

API requests

List the API requests made by an organization

X

Return an aggregated overview of API requests data

X

By interval

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

X

Get a time-series of average channel utilization for all bands, segmented by device

X

By network

Get average channel utilization across all bands for all networks in the organization

X

Get a time-series of average channel utilization for all bands

X

Display VPN exclusion rules for mx networks

X

List the auto RF settings of an organization by network

X

Usage

Get the sent and received bytes for each uplink of all MX and Z networks within an organization

X

Stats

Show VPN history stat for networks in an organization

X

Third party VPN peers

Return the third party VPN peers for an organization

X

Update the third party VPN peers for an organization

X

VPN firewall rules

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

X

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

X

Branding policies

List the branding policies of an organization

X

Add a new branding policy to an organization

X

Return a branding policy

X

Update a branding policy

X

Delete a branding policy

X

Priorities

Return the branding policy IDs of an organization in priority order

X

Update the priority ordering of an organization's branding policies

X

Artifacts

List custom analytics artifacts

X

Create custom analytics artifact

X

Get custom analytics artifact

X

Delete custom analytics artifact

X

Onboarding

Fetch onboarding status of cameras

X

Notify that credential handoff to camera has completed

X

Permissions

List the permissions scopes for this organization

X

Retrieve a single permission scope

X

Roles

List all the roles in this organization

X

Creates new role for this organization

X

Retrieve a single role

X

Delete an existing role for this organization

X

Update an existing role in this organization

X

Certificates

Gets all or specific certificates for an organization

X

Delete a certificate for an organization

X

Update a certificate's description for an organization

X

Import

Import certificate for this organization

X

Device certificate authorities

Query for details on the organization's RADSEC device CAS

X

Create an organization's RADSEC device CA

X

Query for details on an organization's RADSEC device CA with the given ID

X

Update an organization's RADSEC device CA state

X

Revocation list

Query for CRL for the organization's RADSEC device CA with the given ID

X

Deltas

Query for all delta CRL for the organization's RADSEC device CA with the given ID

X

Contents

Download the trusted certificate by certificate ID

X

Search

Return the client details in an organization

X

Requirements

List of source/destination traffic rules

X

Config templates

List the configuration templates for this organization

X

Create a new configuration template

X

Update a configuration template

X

Remove a configuration template

X

Return a single configuration template

X

List the switch templates for your switch template configuration

X

Return all the ports of a switch template

X

Return a switch template port

X

Update a switch template port

X

Configuration changes

View the change log for your organization

X

Availabilities

List the availability information for devices in an organization

X

Change history

List the availability history information for devices in an organization

X

Power modules

List the most recent status information for power modules in rackmount mx and ms devices that support them

X

Provisioning

List the provisioning status information for devices in an organization.

X

Addresses

List the current uplink addresses for devices in an organization

X

Uplinks loss and latency

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

X

Features

List the available early access features for organization

X

Opt ins

List the early access feature opt-ins for an organization

X

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

X

Show an early access feature opt-in for an organization

X

Update an early access feature opt-in for an organization

X

Delete an early access feature opt-in

X

Upgrades

Get firmware upgrade information for an organization

X

Get firmware upgrade status for the filtered devices

X

Monitored media servers

List the monitored media servers for this organization

X

Add a media server to be monitored for this organization

X

Return a monitored media server for this organization

X

Update a monitored media server for this organization

X

Delete a monitored media server from this organization

X

Web apps

Lists all default web applications rules with counter set rule IDs

X

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

X

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

X

Delete a custom web application by counter set rule ID

X

Inventory

Return the device inventory for an organization

X

Return a single device from the inventory of an organization

X

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

X

Release a list of claimed devices from an organization

X

Bulk

Swap the devices identified by devices.old with a devices.new, then perform the:afteraction on the devices.old

X

List of device swaps for a given request ID

X

Cloud monitoring

Return list of networks eligible for adding cloud monitored device

X

Export events

Import event logs related to the onboarding app into Elastisearch

X

Imports

Commit the import operation to complete the onboarding of a device into dashboard for monitoring

X

Check the status of a committed import operation

X

Prepare

Initiate or updates an import session

X

Licenses

Return an overview of the license state for an organization

X

List the licenses for an organization

X

Assign SM seats to a network

X

Move licenses to another organization

X

Move SM seats to another organization

X

Renew SM seats of a license

X

Display a license

X

Update a license

X

Co-term

List the licenses in a co-term organization

X

Move a license to a different organization (co-term only)

X

Login security

Return the login security settings for an organization

X

Update the login security settings for an organization

X

Open API spec

Return the open API specification of the organization's API documentation in JSON

X

Policy objects

List policy objects belonging to the organization

X

Create a new policy object

X

List policy object groups belonging to the organization

X

Create a new policy object group

X

Show details of a policy object group

X

Update a policy object group

X

Delete a policy object group

X

Show details of a policy object

X

Update a policy object

X

Delete a policy object

X

SAML

Return the SAML SSO enabled settings for an organization

X

Update the SAML SSO-enabled settings for an organization

X

IDPs

List the SAML IDPs in your organization

X

Create a SAML IDP for your organization

X

Update a SAML IDP in your organization

X

Get a SAML IDP from your organization

X

Remove a SAML IDP in your organization

X

SAML roles

List the SAML roles for this organization

X

Create a SAML role

X

Return a SAML role

X

Update a SAML role

X

Remove a SAML role

X

Private application groups

Provide a list of private application groups for an organization

X

Create a group of private applications to apply to policy

X

Update an application group in an organization

X

Delete private application group from an organization

X

Return the details of a specific private application group

X

Private applications

Provide a list of private applications for an organization

X

Adds a new private application to the organization

X

Update a specific private application

X

Delete a specific private application

X

Return the details of a specific private application

X

Provide a list of public applications for an organization

X

Remote access log

List the latest 5000 events logged by remote access

X

Remote access log exports

Provide a list of remote access logs exports for an organization

X

Create an export for a provided timestamp interval

X

Return the details of a specific remote access logs export

X

Download

Redirect to the download link of the completed export

X

Readings

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

X

Return all reported readings from sensors in a given timespan, summarized as a series of intervals, sorted by interval start time in descending order

X

Latest

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

X

APNS cert

Get the organization's APNS certificate

X

VPP accounts

List the VPP accounts in the organization

X

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

X

Power

Return the total POE power draw for all switch ports in the organization over the requested timespan 

X

By utilization

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

X

By usage

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

X

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

X

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

X

Manufacturers

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

X

Models

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

X

By energy usage

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

X

Sales representatives

Returns the organization's sales representatives

X

By switch

List the switch ports in an organization

X

List the switch ports in an organization by switch

X

Alert types

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

X

Callbacks

Return the status of an API callback

X

Logs

Return the log of webhook posts sent

X

Activities

List the channel planning activities of an organization

X

Packet loss

Get average packet loss for the given timespan for all clients in the organization

X

Get average packet loss for the given timespan for all devices in the organization

X

Get average packet loss for the given timespan for all networks in the organization

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.