Skip to content

Coverage.md

Latest commit

 

History

History
508 lines (397 loc) · 17.7 KB

Coverage.md

File metadata and controls

508 lines (397 loc) · 17.7 KB
Raw

API Coverage

API Usage

  • List the API requests made by an organization
    • Not implemented

Action batches

  • Create an action batch
  • Return the list of action batches in the organization
  • Return an action batch
  • Delete an action batch
  • Update an action batch

Admins

  • List the dashboard administrators in this organization
    • getorgadmins
  • Create a new dashboard administrator
    • addadmin
  • Update an administrator
    • updateadmin
  • Revoke all access for a dashboard administrator within this organization
    • deladmin

Alert settings

  • Return the alert configuration for this network
  • Update the alert configuration for this network

Bluetooth clients

  • Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.
  • List the Bluetooth clients seen by APs in this network

Cameras

  • Returns video link for the specified camera. If a timestamp supplied, it links to that time.
  • Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Clients

  • Return the client associated with the given identifier.
    • getclient
  • Provisions a client with a name and policy.
  • Return the client's daily usage history.
  • Return the policy assigned to a client on the network.
    • getclientpolicy
  • Update the policy assigned to a client on the network.
    • updateclientpolicy
  • Return the splash authorization for a client, for each SSID they've associated with through splash.
    • getclientsplash
  • Update a client's splash authorization.
    • updateclientsplash
  • List the clients that have used this network in the timespan
  • List the clients of a device, up to a maximum of a month ago.
    • getclients
  • Return the client's network traffic data over time.
  • Return the events associated with this client.
  • Return the latency history for a client.

Config templates

  • List the configuration templates for this organization
    • gettemplates
  • Remove a configuration template
    • deltemplate

Content filtering categories

  • List all available content filtering categories for an MX network
    • getcontentcategories

Content filtering rules

  • Return the content filtering settings for an MX network
    • getcontentfiltering
  • Update the content filtering settings for an MX network
    • updatecontentfiltering

Devices

  • List LLDP and CDP information for a device
    • getlldpcdp
  • List the devices in an organization
  • List the devices in a network
    • getnetworkdevices
  • Return a single device
    • getdevicedetail
  • Return the performance score for a single device.
    • getmxperf
  • Return the uplink information for a device.
    • getdeviceuplink
  • Update the attributes of a device
    • updatedevice
  • Claim a device into a network
    • adddevtonet
  • Remove a single device
    • removedevfromnet
  • Get the uplink loss percentage and latency in milliseconds for a wired network device.
  • Reboot a device
  • Blink the LEDs on a device

Firewalled services

  • List the appliance services and their accessibility rules
  • Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')
  • Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')

Group policies

  • List the group policies in a network
    • getgrouppolicies
  • Create a group policy
  • Display a group policy
  • Update a group policy
  • Delete a group policy

HTTP servers

  • List the HTTP servers for a network
  • Return an HTTP server for a network
  • Update an HTTP server
  • Add an HTTP server to a network
  • Delete an HTTP server from a network
  • Send a test webhook for a network
  • Return the status of a webhook test for a network

Intrusion settings

  • Returns all supported intrusion settings for an MX network
    • getmxintrusionsettings
  • Set the supported intrusion settings for an MX network
    • updatemxintrusionsettings
  • Returns all supported intrusion settings for an organization
    • getorgintrusionsettings
  • Sets supported intrusion settings for an organization
    • updateorgintrusionsettings

MR L3 firewall

  • Return the L3 firewall rules for an SSID on an MR network
    • getssidl3fwrules
  • Update the L3 firewall rules of an SSID on an MR network
    • updatessidl3fwrules

MV Sense

  • Returns an overview of aggregate analytics data for a timespan
  • Returns all configured analytic zones for this camera
  • Return historical records for analytic zones
  • Returns most recent record for analytics zones
  • Returns live state from camera of analytics zones

MX 1:1 NAT rules

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

MX 1:Many NAT rules

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

MX L3 firewall

  • Return the L3 firewall rules for an MX network
    • getmxl3fwrules
  • Update the L3 firewall rules of an MX network
    • updatemxl3fwrules

MX L7 application categories

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

MX L7 firewall

  • List the MX L7 firewall rules for an MX network
  • Update the MX L7 firewall rules for an MX network

MX VPN firewall

  • Return the firewall rules for an organization's site-to-site VPN
    • getmxvpnfwrules
  • Update the firewall rules of an organization's site-to-site VPN
    • updatemxvpnfwrules

MX cellular firewall

  • Return the cellular firewall rules for an MX network
    • getmxcellularfwrules
  • Update the cellular firewall rules of an MX network
    • updatemxcellularfwrules

MX port forwarding rules

  • Return the port forwarding rules for an MX network
  • Update the port forwarding rules for an MX network

Malware settings

  • Returns all supported malware settings for an MX network
    • getmalwaresettings
  • Set the supported malware settings for an MX network
    • updatemalwaresettings

Management interface settings

  • Return the management interface settings for a device
  • Update the management interface settings for a device

Meraki auth users

  • List the splash or RADIUS users configured under Meraki Authentication for a network
  • Return the Meraki Auth splash or RADIUS user

Named tag scope

  • List the target groups in this network
  • Return a target group
  • Update a target group
  • Add a target group
  • Delete a target group from a network

NetFlow settings

  • Return the NetFlow traffic reporting settings for a network
  • Update the NetFlow traffic reporting settings for a network

Networks

  • Return the Bluetooth settings for a network.
    • getbluetooth
  • Update the Bluetooth settings for a network.
    • updatebluetooth
  • List the networks in an organization
    • getnetworklist
  • Return a network
    • getnetworkdetail
  • Update a network
    • updatenetwork
  • Create a network
    • addnetwork
  • Delete a network
    • delnetwork
  • Bind a network to a template.
    • bindtotemplate
  • Unbind a network from a template.
    • unbindfromtemplate
  • The traffic analysis data for this network.
    • getnetworktrafficstats
  • List the access policies for this network.
    • getaccesspolicies
  • List Air Marshal scan results from a network
    • getairmarshal
  • Combine multiple networks into a single network
  • Split a combined network into individual networks for each type of device
  • Return the site-to-site VPN settings of a network.
    • getvpnsettings
  • Update the site-to-site VPN settings of a network.
    • updatevpnsettings

OpenAPI Spec

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

Organizations

  • List the organizations that the user has privileges on
    • myorgaccess
  • Return an organization
    • getorg
  • Update an organization
    • renameorg
  • Create a new organization
    • addorg
  • Create a new organization by cloning the addressed organization
    • cloneorg
  • Return the license state for an organization
    • getlicensestate
  • Return the inventory for an organization
    • getorginventory
  • List the status of every Meraki device in the organization
    • get_device_statuses
  • Delete an organization
  • Claim a device, license key, or order into an organization.
    • claim
  • Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
  • Return the third party VPN peers for an organization
    • getnonmerakivpnpeers
  • Update the third party VPN peers for an organization
    • updatenonmerakivpn
    • appendnonmerakivpn

PII

  • List the keys required to access Personally Identifiable Information (PII) for a given identifier.
  • Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier.
  • Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier.
  • List the PII requests for this network or organization
  • Return a PII request
  • Submit a new delete or restrict processing PII request
  • Delete a restrict processing PII request

Radio settings

  • Return the radio settings of a device
  • Update the radio settings of a device
  • List the non-basic RF profiles for this network

SAML roles

  • List the SAML roles for this organization
    • getsamlroles
  • Return a SAML role
    • getsamlroledetail
  • Update a SAML role
    • updatesamlrole
  • Create a SAML role
    • addsamlrole
  • Remove a SAML role
    • delsamlrole

SM

  • Create a new profile containing a Cisco Clarity payload
  • Update an existing profile containing a Cisco Clarity payload
  • Add a Cisco Clarity payload to an existing profile
  • Get details for a Cisco Clarity payload
  • Delete a Cisco Clarity payload.
  • Create a new profile containing a Cisco Umbrella payload
  • Update an existing profile containing a Cisco Umbrella payload
  • Add a Cisco Umbrella payload to an existing profile
  • Get details for a Cisco Umbrella payload
  • Delete a Cisco Umbrella payload.
  • Create a new Polaris app
  • Update an existing Polaris app
  • Get details for a Cisco Polaris app if it exists
  • Delete a Cisco Polaris app
  • Return historical records of various Systems Manager client metrics for desktop devices.
  • Return historical records of various Systems Manager network connection details for desktop devices.
  • Return historical records of commands sent to Systems Manager devices.
  • Returns historical connectivity data (whether a device is regularly checking in to Dashboard).
  • List the devices enrolled in an SM network with various specified fields and filters
    • getsmdevices
  • List the owners in an SM network with various specified fields and filters
  • Get the profiles associated with a user
  • Get the profiles associated with a device
  • Get a list of softwares associated with a user
  • Get a list of softwares associated with a device
  • List the network adapters of a device
  • List the saved SSID names on a device
  • List the security centers on a device
  • List the restrictions on a device
  • List the certs on a device
  • Add, delete, or update the tags of a set of devices
    • updatesmtags
  • Modify the fields of a device
    • updatesmfields
  • Lock a set of devices
    • lockdevices
  • Wipe a device
    • wipedevices
  • Force check-in a set of devices
    • checkindevices
  • Move a set of devices to a new network
    • movedevices
  • Unenroll a device
  • Bypass activation lock attempt
  • Bypass activation lock attempt status
  • List all the profiles in the network
  • Return the client's daily cellular data usage history.

SNMP settings

  • Return the SNMP settings for a network
  • Update the SNMP settings for a network
  • Return the SNMP settings for an organization
    • getsnmpsettings
  • Update the SNMP settings for an organization
    • updatesnmpsettings

SSIDs

  • List the SSIDs in a network. Supports networks with access points or wireless-enabled security appliances and teleworker gateways.
  • Return a single SSID
    • getssiddetail
  • Update the attributes of an SSID
    • updatessid
    • updatessidobject

Security events

  • List the security events for a client.
  • List the security events for a network
  • List the security events for an organization

Splash login attempts

  • List the splash login attempts for a network

Splash settings

  • Display the splash page settings for the given SSID
  • Modify the splash page settings for the given SSID

Static routes

  • List the static routes for this network
    • getstaticroutes
  • Return a static route
    • getstaticroutedetail
  • Update a static route
    • updatestaticroute
  • Add a static route
    • addstaticroute
  • Delete a static route from a network
    • delstaticroute

Switch port schedules

  • List switch port schedules

Switch ports

  • List the switch ports for a switch
    • getswitchports
  • Return a switch port
    • getswitchportdetail
  • Update a switch port
    • updateswitchport

Switch profiles

  • List the switch profiles for your switch template configuration

Switch settings

  • Returns the switch network settings
  • Update switch network settings

Switch stacks

  • List the switch stacks in a network
  • Show a switch stack
  • Add a switch to a stack
  • Remove a switch from a stack
  • Create a stack
  • Delete a stack

Syslog servers

  • List the syslog servers for a network
  • Update the syslog servers for a network

Traffic analysis settings

  • Return the traffic analysis settings for a network
  • Update the traffic analysis settings for a network

Traffic shaping

  • Update the traffic shaping settings for an MX network
  • Display the traffic shaping settings for an MX network
  • Update the traffic shaping settings for an SSID on an MR network
  • Display the traffic shaping settings for a SSID on an MR network
  • Returns the available DSCP tagging options for your traffic shaping rules.
  • Returns the application categories for traffic shaping rules.

Uplink settings

  • Returns the uplink settings for your MX network.
  • Updates the uplink settings for your MX network.

VLANs

  • List the VLANs for an MX network
    • getvlans
  • Return a VLAN
    • getvlandetail
  • Update a VLAN
    • updatevlan
  • Add a VLAN
    • addvlan
  • Delete a VLAN from a network
    • delvlan
  • Returns the enabled status of VLANs for the network
  • Enable/Disable VLANs for the given network

Webhook logs

  • Return the log of webhook POSTs sent

Wireless health

  • Aggregated connectivity info for this network
  • Aggregated connectivity info for this network, grouped by node
  • Aggregated connectivity info for a given AP on this network
  • Aggregated connectivity info for this network, grouped by clients
  • Aggregated connectivity info for a given client on this network.
  • Aggregated latency info for this network
  • Aggregated latency info for this network, grouped by node
  • Aggregated latency info for a given AP on this network
  • Aggregated latency info for this network, grouped by clients
  • Aggregated latency info for a given client on this network.
  • List of all failed client connection events on this network in a given time range