From e62b3d11a1894ca1758028262a5787c191fd185c Mon Sep 17 00:00:00 2001 From: Cory Guynn Date: Thu, 3 Oct 2024 11:12:48 +0200 Subject: [PATCH] v1.50.0 --- changelog/v1-beta.md | 2842 ++++++++++++++++++------------------------ changelog/v1.51.0.md | 1207 ++++++++++++++++++ documents/2024.md | 81 +- 3 files changed, 2480 insertions(+), 1650 deletions(-) create mode 100644 changelog/v1.51.0.md diff --git a/changelog/v1-beta.md b/changelog/v1-beta.md index 90c9ac6..b6f0660 100644 --- a/changelog/v1-beta.md +++ b/changelog/v1-beta.md @@ -10,6 +10,12 @@ - [List per-port VLAN settings for all ports of a MX.](#list-per-port-vlan-settings-for-all-ports-of-a-mx) - [Return per-port VLAN settings for a single MX port.](#return-per-port-vlan-settings-for-a-single-mx-port) - [Update the per-port VLAN settings for a single MX port.](#update-the-per-port-vlan-settings-for-a-single-mx-port) + * [\[ sensor \]](#-sensor-) + + [alerts](#alerts) + - [Updates a sensor alert profile for a network.](#updates-a-sensor-alert-profile-for-a-network) + - [Creates a sensor alert profile for a network.](#creates-a-sensor-alert-profile-for-a-network) + + [commands](#commands) + - [Sends a command to a sensor](#sends-a-command-to-a-sensor) * [\[ networks \]](#-networks-) + [settings](#settings) - [Update the settings for a network](#update-the-settings-for-a-network) @@ -55,6 +61,13 @@ * [\[ appliance \]](#-appliance--1) + [sdwan](#sdwan) - [Get the SDWAN internet traffic preferences for an MX network](#get-the-sdwan-internet-traffic-preferences-for-an-mx-network) + * [\[ sensor \]](#-sensor--1) + + [alerts](#alerts-1) + - [Return a list of sensor alert events](#return-a-list-of-sensor-alert-events) + + [readings](#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) + + [schedules](#schedules) + - [Returns a list of all sensor schedules.](#returns-a-list-of-all-sensor-schedules) * [\[ networks \]](#-networks--1) + [locationScanning](#locationscanning) - [Return scanning API settings](#return-scanning-api-settings) @@ -76,6 +89,7 @@ - [Create a port profile 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](#delete-a-port-profile-from-a-network) + - [List the client counts in an organization](#list-the-client-counts-in-an-organization) - [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](#create-a-port-profile-in-an-organization) @@ -87,17 +101,22 @@ - [Update a port profile in an organization](#update-a-port-profile-in-an-organization) - [Delete a port profile from an organization](#delete-a-port-profile-from-an-organization) - [List the switchports in an organization](#list-the-switchports-in-an-organization) + - [List most recently seen LLDP/CDP discovery and topology information per switch port in an organization.](#list-most-recently-seen-lldpcdp-discovery-and-topology-information-per-switch-port-in-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) + - [List the historical usage data of switchports in an organization.](#list-the-historical-usage-data-of-switchports-in-an-organization) * [\[ wireless \]](#-wireless--1) + + [healthScores](#healthscores) + - [Fetch the health scores for a given AP on this network](#fetch-the-health-scores-for-a-given-ap-on-this-network) + [radio](#radio) - - [Return the positioning for a wireless device](#return-the-positioning-for-a-wireless-device) - - [Update the positioning attributes for this device](#update-the-positioning-attributes-for-this-device) + - [Return the position for a wireless device](#return-the-position-for-a-wireless-device) + - [Update the position attributes for this 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) - [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-1) - [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) + - [Recalculates automatically assigned channels for every AP within specified the specified network(s). Note: This could cause a brief loss in connectivity for wireless clients.](#recalculates-automatically-assigned-channels-for-every-ap-within-specified-the-specified-networks-note-this-could-cause-a-brief-loss-in-connectivity-for-wireless-clients) + [zigbee](#zigbee) - [Enqueue a job to start enrolling doorlocks on zigbee configured MRs](#enqueue-a-job-to-start-enrolling-doorlocks-on-zigbee-configured-mrs) - [Return an enrollment job](#return-an-enrollment-job) @@ -108,17 +127,18 @@ - [Return a disenrollment job](#return-a-disenrollment-job) - [Return the list of doorlocks for a network](#return-the-list-of-doorlocks-for-a-network) - [Endpoint to bulk update door locks params](#endpoint-to-bulk-update-door-locks-params) - + [healthScores](#healthscores) - - [Fetch the health scores for a given AP on this network](#fetch-the-health-scores-for-a-given-ap-on-this-network) + + [opportunisticPcap](#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) + [clients](#clients-1) - [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. Clients are identified by their MAC or ID](#fetch-the-health-scores-for-a-given-client-on-this-network-clients-are-identified-by-their-mac-or-id) - - [List access point client count at the moment in an organization](#list-access-point-client-count-at-the-moment-in-an-organization) + [devices](#devices-2) - [Fetch the health scores of all APs on this network](#fetch-the-health-scores-of-all-aps-on-this-network) - - [List of Catalyst access points information](#list-of-catalyst-access-points-information) * [\[ organizations \]](#-organizations--1) + + [snmp](#snmp-1) + - [Retrieve the SNMP trap configuration for the networks in an organization](#retrieve-the-snmp-trap-configuration-for-the-networks-in-an-organization) + [auth](#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](#add-an-organization-wide-radius-server) @@ -157,6 +177,8 @@ - [Delete packet capture from cloud](#delete-packet-capture-from-cloud) - [Get presigned download URL for given packet capture id](#get-presigned-download-url-for-given-packet-capture-id) - [Stop a specific packet capture](#stop-a-specific-packet-capture) + + [spaces](#spaces) + - [Remove the Spaces integration from Meraki](#remove-the-spaces-integration-from-meraki) + [support](#support) - [Returns the organization's sales representatives](#returns-the-organizations-sales-representatives) + [webhooks](#webhooks) @@ -172,22 +194,6 @@ - [Destroy a webhook payload template for an organization. Does not work for included templates ('wpt\_00001', 'wpt\_00002', 'wpt\_00003', 'wpt\_00004', 'wpt\_00005' or 'wpt\_00006')](#destroy-a-webhook-payload-template-for-an-organization-does-not-work-for-included-templates-wpt_00001-wpt_00002-wpt_00003-wpt_00004-wpt_00005-or-wpt_00006) - [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) - + [wirelessController](#wirelesscontroller) - - [List connectivity data of wireless LAN controllers in an organization. If it is HA setup, then only returns active WLC data start from switchover](#list-connectivity-data-of-wireless-lan-controllers-in-an-organization-if-it-is-ha-setup-then-only-returns-active-wlc-data-start-from-switchover) - - [List wireless client counts of wireless LAN controllers over time in an organization](#list-wireless-client-counts-of-wireless-lan-controllers-over-time-in-an-organization) - - [List all access points associated with wireless LAN controllers in an organization](#list-all-access-points-associated-with-wireless-lan-controllers-in-an-organization) - - [List wireless LAN controller layer 2 interfaces in an organization](#list-wireless-lan-controller-layer-2-interfaces-in-an-organization) - - [List wireless LAN controller layer 2 interfaces history status in an organization](#list-wireless-lan-controller-layer-2-interfaces-history-status-in-an-organization) - - [List wireless LAN controller layer 2 interfaces history usage in an organization](#list-wireless-lan-controller-layer-2-interfaces-history-usage-in-an-organization) - - [List wireless LAN controller layer 3 interfaces in an organization](#list-wireless-lan-controller-layer-3-interfaces-in-an-organization) - - [List wireless LAN controller layer 3 interfaces history status in an organization](#list-wireless-lan-controller-layer-3-interfaces-history-status-in-an-organization) - - [List wireless LAN controller layer 3 interfaces history usage in an organization](#list-wireless-lan-controller-layer-3-interfaces-history-usage-in-an-organization) - - [List the failover events of wireless LAN controllers in an organization](#list-the-failover-events-of-wireless-lan-controllers-in-an-organization) - - [List redundancy details of wireless LAN controllers in an organization. The failover count refers to the total failovers system happens from the moment of this device onboarding to Dashboard](#list-redundancy-details-of-wireless-lan-controllers-in-an-organization-the-failover-count-refers-to-the-total-failovers-system-happens-from-the-moment-of-this-device-onboarding-to-dashboard) - - [List cpu utilization data of wireless LAN controllers in an organization](#list-cpu-utilization-data-of-wireless-lan-controllers-in-an-organization) - - [List the overview information of wireless LAN controllers in an organization and it is updated every minute.](#list-the-overview-information-of-wireless-lan-controllers-in-an-organization-and-it-is-updated-every-minute) - + [snmp](#snmp-1) - - [Retrieve the SNMP trap configuration for the networks in an organization](#retrieve-the-snmp-trap-configuration-for-the-networks-in-an-organization) * [\[ insight \]](#-insight--1) + [speedTestResults](#speedtestresults) - [List the speed tests for the given devices under this organization. Only valid for organizations with Meraki Insight.](#list-the-speed-tests-for-the-given-devices-under-this-organization-only-valid-for-organizations-with-meraki-insight) @@ -221,13 +227,6 @@ + [aclHitCount](#aclhitcount) - [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.](#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) - * [\[ sensor \]](#-sensor-) - + [schedules](#schedules) - - [Returns a list of all sensor schedules.](#returns-a-list-of-all-sensor-schedules) - + [alerts](#alerts) - - [Return a list of sensor alert events](#return-a-list-of-sensor-alert-events) - + [readings](#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) * [\[ secureConnect \]](#-secureconnect-) + [privateApplicationGroups](#privateapplicationgroups) - [Provides a list of private application groups for an Organization](#provides-a-list-of-private-application-groups-for-an-organization) @@ -267,19 +266,19 @@ - [Delete a PccBulkEnrollmentToken](#delete-a-pccbulkenrollmenttoken) - [List all BulkEnrollmentTokens for an organization.](#list-all-bulkenrollmenttokens-for-an-organization) -Version **1.50.0** _to_ **1.50.0-beta.0** +Version **1.51.0** _to_ **1.51.0-beta.0** * * * **Summary of Changes** -**120 - New** +**112 - New** -**54 - Updated** +**59 - Updated** -**905 - Total Endpoints** +**914 - Total Endpoints** -**610 - Total Paths** +**619 - Total Paths** * * * @@ -371,6 +370,41 @@ PUT _`/networks/{networkId}/appliance/ports/{portId}`_ * * * +\[ sensor \] +------------ + +### alerts + +#### Updates a sensor alert profile for a network. + +PUT _`/networks/{networkId}/sensor/alerts/profiles/{id}`_ + +> \- Optional property `includeSensorLink` Added + +> \- Optional property `message` Added + +* * * + +#### Creates a sensor alert profile for a network. + +POST _`/networks/{networkId}/sensor/alerts/profiles`_ + +> \- Optional property `includeSensorLink` Added + +> \- Optional property `message` Added + +* * * + +### commands + +#### Sends a command to a sensor + +POST _`/devices/{serial}/sensor/commands`_ + +> \- Optional property `arguments` Added + +* * * + \[ networks \] -------------- @@ -710,76 +744,419 @@ PATH _`/organizations/{organizationId}/appliance/sdwan/internetPolicies`_ * * * -\[ networks \] --------------- +\[ sensor \] +------------ -### locationScanning +### alerts -PATH _`/networks/{networkId}/locationScanning`_ +PATH _`/organizations/{organizationId}/sensor/alerts`_ > \- Path added > > \- New endpoint > -> #### Return scanning API settings -> -> **GET** `/networks/{networkId}/locationScanning` -> -> { -> "analyticsEnabled": true, -> "scanningApiEnabled": true, -> "validator": "xxyzzy" -> } -> -> * * * -> -> -> \- New endpoint -> -> #### Change scanning API settings +> #### Return a list of sensor alert events > -> **PUT** `/networks/{networkId}/locationScanning` +> **GET** `/organizations/{organizationId}/sensor/alerts` > -> { -> "analyticsEnabled": true, -> "scanningApiEnabled": true, -> "validator": "xxyzzy" -> } +> [ +> { +> "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 _`/networks/{networkId}/locationScanning/httpServers`_ +### readings + +PATH _`/organizations/{organizationId}/sensor/readings/history/byInterval`_ > \- Path added > > \- New endpoint > -> #### Return list of scanning API receivers +> #### 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** `/networks/{networkId}/locationScanning/httpServers` +> **GET** `/organizations/{organizationId}/sensor/readings/history/byInterval` > > [ > { -> "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}}]" +> "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 +> } +> } +> } +> ] +> +> * * * + +* * * + +### schedules + +PATH _`/networks/{networkId}/sensor/schedules`_ + +> \- 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" +> } +> ] +> +> * * * + +* * * + +\[ networks \] +-------------- + +### locationScanning + +PATH _`/networks/{networkId}/locationScanning`_ + +> \- 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" +> } +> +> * * * + +* * * + +PATH _`/networks/{networkId}/locationScanning/httpServers`_ + +> \- 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}}]" +> } +> ] > } > ] > @@ -834,7 +1211,7 @@ PATH _`/networks/{networkId}/snmp/traps`_ > "id": "N_12345678", > "name": "networkName" > }, -> "mode": "users", +> "mode": "v3", > "receiver": { > "address": "1.1.1.1", > "port": "1234" @@ -1410,47 +1787,94 @@ PATH _`/networks/{networkId}/switch/ports/profiles/{id}`_ * * * -PATH _`/organizations/{organizationId}/switch/ports/mirrors/bySwitch`_ +PATH _`/organizations/{organizationId}/switch/ports/clients/overview/byDevice`_ > \- Path added > > \- New endpoint > -> #### list the port mirror configurations in an organization by switch +> #### List the client counts in an organization > -> **GET** `/organizations/{organizationId}/switch/ports/mirrors/bySwitch` +> **GET** `/organizations/{organizationId}/switch/ports/clients/overview/byDevice` > > { > "items": [ > { -> "serial": "Q234-ABCD-5678", +> "name": "Example Switch", +> "serial": "Q555-5555-5555", +> "mac": "01:23:45:67:ab:cd", > "network": { -> "id": "N_24329156", -> "name": "Main Office" +> "name": "Example Network", +> "id": "L_12345" > }, -> "mirror": { -> "source": { -> "ports": [ -> { -> "number": 2, -> "module": { -> "type": "C9800-2X40GE", -> "slot": 2 -> } +> "model": "MS120-8", +> "ports": [ +> { +> "portId": "1", +> "counts": { +> "byStatus": { +> "online": 0 > } -> ], -> "filter": { -> "vlans": "100, 200-210", -> "hasTransitVlan": true > } -> }, -> "destination": { -> "port": { -> "number": 7, -> "module": { -> "type": "C9800-2X40GE", -> "slot": 1 -> } +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 1, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/switch/ports/mirrors/bySwitch`_ + +> \- 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" > }, @@ -1959,91 +2383,114 @@ PATH _`/organizations/{organizationId}/switch/ports/statuses/bySwitch`_ > > **GET** `/organizations/{organizationId}/switch/ports/statuses/bySwitch` > -> [ -> { -> "name": "Example Switch", -> "serial": "Q555-5555-5555", -> "mac": "01:23:45:67", -> "network": { -> "name": "Example Network", -> "id": "N_12345" -> }, -> "model": "MS120-8", -> "ports": [ -> { -> "portId": "1", -> "enabled": true, -> "status": "Connected", -> "spanningTree": { -> "statuses": [ -> "Learning" -> ] -> }, -> "isUplink": false, -> "errors": [ -> "PoE overload", -> "Very high proportion of CRC errors" -> ], -> "warnings": [ -> "SecurePort authentication in progress", -> "PoE port was denied power", -> "High proportion of CRC errors" -> ], -> "speed": "10 Gbps", -> "duplex": "full", -> "usageInKb": { -> "total": 40867, -> "sent": 23008, -> "recv": 17859 -> }, -> "cdp": { -> "systemName": "", -> "platform": "MS350-24X", -> "deviceId": "0c8ddbddee:ff", -> "portId": "Port 20", -> "nativeVlan": 1, -> "address": "10.0,0.1", -> "managementAddress": "10.0.0.100", -> "version": "1", -> "vtpManagementDomain": "", -> "capabilities": "Switch" -> }, -> "lldp": { -> "systemName": "MS350-24X - Test", -> "systemDescription": "MS350-24X Cloud Managed PoE Switch", -> "chassisId": "0c:8d:db:dd:ee:ff", -> "portId": "20", -> "managementVlan": 1, -> "portVlan": 1, -> "managementAddress": "10.0.0.100", -> "portDescription": "Port 20", -> "systemCapabilities": "switch" -> }, -> "clientCount": 10, -> "powerUsageInWh": 55.9, -> "trafficInKbps": { -> "total": 2.2, -> "sent": 1.2, -> "recv": 1 -> }, -> "securePort": { +> { +> "items": [ +> { +> "name": "Example Switch", +> "serial": "Q555-5555-5555", +> "mac": "01:23:45:67:ab:cd", +> "network": { +> "name": "Example Network", +> "id": "L_12345" +> }, +> "model": "MS120-8", +> "ports": [ +> { +> "portId": "1", > "enabled": true, -> "active": true, -> "authenticationStatus": "Authentication in progress", -> "configOverrides": { -> "type": "trunk", -> "vlan": 12, -> "voiceVlan": 34, -> "allowedVlans": "all" +> "status": "Connected", +> "isUplink": false, +> "errors": [ +> "PoE overload", +> "Very high proportion of CRC errors" +> ], +> "warnings": [ +> "SecurePort authentication in progress", +> "PoE port was denied power", +> "High proportion of CRC errors" +> ], +> "speed": "10 Gbps", +> "duplex": "full", +> "spanningTree": { +> "statuses": [ +> "Learning" +> ] +> }, +> "poe": { +> "isAllocated": false +> }, +> "securePort": { +> "active": true, +> "authenticationStatus": "Authentication in progress" > } -> }, -> "poe": { -> "isAllocated": false > } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 1, +> "remaining": 0 > } -> ] +> } > } -> ] +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/switch/ports/topology/discovery/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List most recently seen LLDP/CDP discovery and topology information per switch port in an organization. +> +> **GET** `/organizations/{organizationId}/switch/ports/topology/discovery/byDevice` +> +> { +> "items": [ +> { +> "name": "Example Switch", +> "serial": "Q555-5555-5555", +> "mac": "01:23:45:67:ab:cd", +> "network": { +> "name": "Example Network", +> "id": "L_12345" +> }, +> "model": "MS120-8", +> "ports": [ +> { +> "portId": "1", +> "lastUpdatedAt": "ISO8061Z", +> "cdp": [ +> { +> "name": "System name", +> "value": "MS350-24X - Test" +> } +> ], +> "lldp": [ +> { +> "name": "System name", +> "value": "MS350-24X - Test" +> } +> ] +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 1, +> "remaining": 0 +> } +> } +> } +> } > > * * * @@ -2223,20 +2670,101 @@ PATH _`/organizations/{organizationId}/switch/ports/transceivers/readings/histor * * * +PATH _`/organizations/{organizationId}/switch/ports/usage/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List the historical usage data of switchports in an organization. +> +> **GET** `/organizations/{organizationId}/switch/ports/usage/byDevice` +> +> { +> "items": [ +> { +> "name": "Example Switch", +> "serial": "Q555-5555-5555", +> "mac": "01:23:45:67:ab:cd", +> "network": { +> "name": "Example Network", +> "id": "L_12345" +> }, +> "model": "MS120-8", +> "ports": [ +> { +> "portId": "1", +> "powerUsageInWh": 55.9, +> "trafficInKbps": { +> "total": 2.2, +> "sent": 1.2, +> "received": 1 +> }, +> "usageInKb": { +> "total": 40867, +> "sent": 23008, +> "received": 17859 +> } +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 1, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + \[ wireless \] -------------- +### healthScores + +PATH _`/devices/{serial}/wireless/healthScores`_ + +> \- 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 +> } +> } +> +> * * * + +* * * + ### radio -PATH _`/devices/{serial}/wireless/radio/afc/positioning`_ +PATH _`/devices/{serial}/wireless/radio/afc/position`_ > \- Path added > > \- New endpoint > -> #### Return the positioning for a wireless device +> #### Return the position for a wireless device > -> **GET** `/devices/{serial}/wireless/radio/afc/positioning` +> **GET** `/devices/{serial}/wireless/radio/afc/position` > > { > "name": "Some MR", @@ -2260,9 +2788,9 @@ PATH _`/devices/{serial}/wireless/radio/afc/positioning`_ > > \- New endpoint > -> #### Update the positioning attributes for this device +> #### Update the position attributes for this device > -> **PUT** `/devices/{serial}/wireless/radio/afc/positioning` +> **PUT** `/devices/{serial}/wireless/radio/afc/position` > > { > "name": "Some MR", @@ -2368,7 +2896,7 @@ PATH _`/networks/{networkId}/wireless/radio/autoRf`_ * * * -PATH _`/organizations/{organizationId}/wireless/radio/afc/positioning/byDevice`_ +PATH _`/organizations/{organizationId}/wireless/radio/afc/position/byDevice`_ > \- Path added > @@ -2376,7 +2904,7 @@ PATH _`/organizations/{organizationId}/wireless/radio/afc/positioning/byDevice`_ > > #### List the AFC power limits of an organization by device > -> **GET** `/organizations/{organizationId}/wireless/radio/afc/positioning/byDevice` +> **GET** `/organizations/{organizationId}/wireless/radio/afc/position/byDevice` > > [ > { @@ -2531,6 +3059,24 @@ PATH _`/organizations/{organizationId}/wireless/radio/autoRf/channels/planning/a * * * +PATH _`/organizations/{organizationId}/wireless/radio/autoRf/channels/recalculate`_ + +> \- Path added +> +> \- New endpoint +> +> #### Recalculates automatically assigned channels for every AP within specified the specified network(s). Note: This could cause a brief loss in connectivity for wireless clients. +> +> **POST** `/organizations/{organizationId}/wireless/radio/autoRf/channels/recalculate` +> +> { +> "estimatedCompletedAt": "2019-01-01T00:00:00Z" +> } +> +> * * * + +* * * + ### zigbee PATH _`/devices/{serial}/wireless/zigbee/enrollments`_ @@ -2846,27 +3392,30 @@ PATH _`/organizations/{organizationId}/wireless/zigbee/doorLocks/bulkUpdate`_ * * * -### healthScores +### opportunisticPcap -PATH _`/devices/{serial}/wireless/healthScores`_ +PATH _`/networks/{networkId}/wireless/opportunisticPcap`_ > \- Path added > > \- New endpoint > -> #### Fetch the health scores for a given AP on this network +> #### Update the Opportunistic Pcap settings for a wireless network > -> **GET** `/devices/{serial}/wireless/healthScores` +> **PUT** `/networks/{networkId}/wireless/opportunisticPcap` > > { -> "device": { -> "serial": "Q234-ABCD-5678" -> }, -> "performance": { -> "latest": 80 -> }, -> "onboarding": { -> "latest": 20 +> "networkId": "L_12345", +> "name": "My Network", +> "enablement": { +> "networkWide": 0, +> "serials": [ +> "Q234-ABCD-5678" +> ], +> "tags": [ +> "tag1", +> "tag2" +> ] > } > } > @@ -2874,6 +3423,37 @@ PATH _`/devices/{serial}/wireless/healthScores`_ * * * +PATH _`/organizations/{organizationId}/wireless/opportunisticPcap/byNetwork`_ + +> \- 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" +> ] +> } +> } +> ] +> +> * * * + +* * * + ### clients PATH _`/networks/{networkId}/wireless/clients/healthScores`_ @@ -2991,45 +3571,7 @@ PATH _`/networks/{networkId}/wireless/clients/{clientId}/healthScores`_ * * * -PATH _`/organizations/{organizationId}/wireless/clients/overview/byDevice`_ - -> \- Path added -> -> \- New endpoint -> -> #### List access point client count at the moment in an organization -> -> **GET** `/organizations/{organizationId}/wireless/clients/overview/byDevice` -> -> { -> "items": [ -> { -> "network": { -> "id": "N_24329156" -> }, -> "serial": "Q234-ABCD-5678", -> "counts": { -> "byStatus": { -> "online": 1 -> } -> } -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } -> } -> } -> -> * * * - -* * * - -### devices +### devices PATH _`/networks/{networkId}/wireless/devices/healthScores`_ @@ -3059,62 +3601,49 @@ PATH _`/networks/{networkId}/wireless/devices/healthScores`_ * * * -PATH _`/organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice`_ +\[ organizations \] +------------------- + +### snmp + +PATH _`/organizations/{organizationId}/snmp/traps/byNetwork`_ > \- Path added > > \- New endpoint > -> #### List of Catalyst access points information +> #### Retrieve the SNMP trap configuration for the networks in an organization > -> **GET** `/organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice` +> **GET** `/organizations/{organizationId}/snmp/traps/byNetwork` > -> { -> "items": [ -> { -> "network": { -> "id": "N_24329156" -> }, -> "serial": "Q234-ABCD-5678", -> "controller": { -> "serial": "Q234-ABCD-5678" -> }, -> "joinedAt": "2020-01-01T00:00:00Z", -> "model": "C9115AXI-H", -> "tags": [ -> { -> "policy": "4F", -> "site": "default-site-tag", -> "rf": "default-rf-tag" -> } -> ], -> "mode": "local", -> "countryCode": "CA", -> "details": [ +> [ +> { +> "network": { +> "id": "N_12345678", +> "name": "networkName" +> }, +> "mode": "v3", +> "receiver": { +> "address": "1.1.1.1", +> "port": "1234" +> }, +> "v2": { +> "community": "public" +> }, +> "v3": { +> "users": [ > { -> "name": "catalyst serial", -> "value": "FGL2446L7QQ" +> "name": "merakian" > } > ] > } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } > } -> } +> ] > > * * * * * * -\[ organizations \] -------------------- - ### auth PATH _`/organizations/{organizationId}/auth/radius/servers`_ @@ -3882,16 +4411,17 @@ PATH _`/organizations/{organizationId}/devices/packetCapture/captures`_ > "name": "file_name", > "startTime": "2018-02-11T00:00:00.090210Z", > "ports": "1, 2", -> "status": "new", +> "status": "capturing", > "errorMessage": "Some error message", -> "outputType": "text", +> "outputType": "pcap", > "captureSource": "automatic", > "captureReason": "capture reason", > "fileSize": 1066, > "duration": 60, > "filterExpression": "(icmp)", > "autopcapType": "dhcp", -> "packetCount": 10 +> "packetCount": 10, +> "interfaces": "wired" > } > ], > "meta": { @@ -3935,16 +4465,17 @@ PATH _`/organizations/{organizationId}/devices/packetCapture/captures`_ > "name": "file_name", > "startTime": "2018-02-11T00:00:00.090210Z", > "ports": "1, 2", -> "status": "new", +> "status": "capturing", > "errorMessage": "Some error message", -> "outputType": "text", +> "outputType": "pcap", > "captureSource": "automatic", > "captureReason": "capture reason", > "fileSize": 1066, > "duration": 60, > "filterExpression": "(icmp)", > "autopcapType": "dhcp", -> "packetCount": 10 +> "packetCount": 10, +> "interfaces": "wired" > } > > * * * @@ -4010,16 +4541,38 @@ PATH _`/organizations/{organizationId}/devices/packetCapture/captures/{id}/stop` > "name": "file_name", > "startTime": "2018-02-11T00:00:00.090210Z", > "ports": "1, 2", -> "status": "new", +> "status": "capturing", > "errorMessage": "Some error message", -> "outputType": "text", +> "outputType": "pcap", > "captureSource": "automatic", > "captureReason": "capture reason", > "fileSize": 1066, > "duration": 60, > "filterExpression": "(icmp)", > "autopcapType": "dhcp", -> "packetCount": 10 +> "packetCount": 10, +> "interfaces": "wired" +> } +> +> * * * + +* * * + +### spaces + +PATH _`/organizations/{organizationId}/spaces/integration/remove`_ + +> \- Path added +> +> \- New endpoint +> +> #### Remove the Spaces integration from Meraki +> +> **DELETE** `/organizations/{organizationId}/spaces/integration/remove` +> +> { +> "status": true, +> "message": "Succesfully fetched the spaces dashboard access" > } > > * * * @@ -4342,120 +4895,94 @@ PATH _`/organizations/{organizationId}/webhooks/webhookTests/{webhookTestId}`_ * * * -### wirelessController +\[ insight \] +------------- + +### speedTestResults -PATH _`/organizations/{organizationId}/wirelessController/availabilities/changeHistory`_ +PATH _`/organizations/{organizationId}/insight/speedTestResults`_ > \- Path added > > \- New endpoint > -> #### List connectivity data of wireless LAN controllers in an organization. If it is HA setup, then only returns active WLC data start from switchover +> #### List the speed tests for the given devices under this organization. Only valid for organizations with Meraki Insight. > -> **GET** `/organizations/{organizationId}/wirelessController/availabilities/changeHistory` +> **GET** `/organizations/{organizationId}/insight/speedTestResults` > -> { -> "items": [ -> { +> [ +> { +> "speedTestId": "1284392014819", +> "networkId": "N_24329156", +> "request": { > "serial": "Q234-ABCD-5678", -> "changes": [ -> { -> "startTs": "2020-01-01T00:00:00Z", -> "endTs": "null", -> "status": "online" -> } -> ] -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 +> "interface": "wan1" +> }, +> "results": { +> "speeds": { +> "average": 247.279 > } -> } +> }, +> "startedAt": "2021-12-08T20:07:13Z" > } -> } +> ] > > * * * * * * -PATH _`/organizations/{organizationId}/wirelessController/clients/overview/history/byDevice/byInterval`_ +### webApps + +PATH _`/organizations/{organizationId}/insight/webApps`_ > \- Path added > > \- New endpoint > -> #### List wireless client counts of wireless LAN controllers over time in an organization +> #### Lists all default web applications rules with counter set rule ids > -> **GET** `/organizations/{organizationId}/wirelessController/clients/overview/history/byDevice/byInterval` +> **GET** `/organizations/{organizationId}/insight/webApps` > -> { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "network": { -> "id": "N_24329156" -> }, -> "readings": [ -> { -> "startTs": "2020-01-01T00:00:00Z", -> "endTs": "2020-01-01T01:00:00Z", -> "counts": { -> "byStatus": { -> "online": 1 -> } -> } -> } -> ] -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } +> [ +> { +> "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 _`/organizations/{organizationId}/wirelessController/connections`_ - -> \- Path added +> > > \- New endpoint > -> #### List all access points associated with wireless LAN controllers in an organization +> #### Add a custom web application for Insight to be able to track > -> **GET** `/organizations/{organizationId}/wirelessController/connections` +> **POST** `/organizations/{organizationId}/insight/webApps` > > { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "controller": { -> "serial": "Q234-ABCD-5678" -> }, -> "network": { -> "id": "N_24329156", -> "url": "https://network/url", -> "name": "Network1" -> } -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } +> "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" > } > } > @@ -4463,193 +4990,112 @@ PATH _`/organizations/{organizationId}/wirelessController/connections`_ * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l2/byDevice`_ +PATH _`/organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}`_ > \- Path added > > \- New endpoint > -> #### List wireless LAN controller layer 2 interfaces in an organization +> #### Update a custom web application for Insight to be able to track > -> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l2/byDevice` +> **PUT** `/organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}` > > { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "interfaces": [ -> { -> "name": "TenGigabitEthernet0/0/5", -> "description": "Uplink", -> "enabled": true, -> "mac": "b0:c5:3c:0d:c5:0b", -> "status": "disabled", -> "speed": "1 Gbps", -> "isUplink": true, -> "vlan": 10, -> "isRedundancyPort": true, -> "linkNegotiation": "auto", -> "channelGroup": { -> "number": 5 -> }, -> "module": { -> "model": "C9800-2X40GE" -> } -> } -> ] -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } +> "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}` +> +> * * * * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l2/statuses/changeHistory/byDevice`_ +### applications + +PATH _`/organizations/{organizationId}/insight/applications/{applicationId}`_ > \- Path added > > \- New endpoint > -> #### List wireless LAN controller layer 2 interfaces history status in an organization +> #### Update an Insight tracked application > -> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l2/statuses/changeHistory/byDevice` +> **PUT** `/organizations/{organizationId}/insight/applications/{applicationId}` > > { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "interfaces": [ -> { -> "name": "TenGigabitEthernet0/0/5", -> "mac": "b0:c5:3c:0d:c5:0b", -> "changes": [ -> { -> "ts": "2020-01-01T00:00:00Z", -> "status": "disabled", -> "warnings": [ -> "CRC warnings" -> ], -> "errors": [ -> "CRC errors" -> ] -> } -> ] -> } -> ] -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 +> "applicationId": "19.12", +> "name": "Meraki HTTPS", +> "thresholds": { +> "type": "smart", +> "byNetwork": [ +> { +> "networkId": "N_12345678", +> "goodput": 50000, +> "responseDuration": 1000 > } -> } +> ] > } > } > > * * * - -* * * - -PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l2/usage/history/byInterval`_ - -> \- Path added +> > > \- New endpoint > -> #### List wireless LAN controller layer 2 interfaces history usage in an organization -> -> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l2/usage/history/byInterval` +> #### Delete an Insight tracked application > -> { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "readings": [ -> { -> "name": "TenGigabitEthernet0/0/5", -> "mac": "b0:c5:3c:0d:c5:0b", -> "recv": 0, -> "send": 0 -> } -> ] -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } -> } -> } +> **DELETE** `/organizations/{organizationId}/insight/applications/{applicationId}` > > * * * * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/byDevice`_ +\[ devices \] +------------- + +### traceRoute + +PATH _`/devices/{serial}/liveTools/traceRoute`_ > \- Path added > > \- New endpoint > -> #### List wireless LAN controller layer 3 interfaces in an organization +> #### 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. > -> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l3/byDevice` +> **POST** `/devices/{serial}/liveTools/traceRoute` > > { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "interfaces": [ -> { -> "name": "vlan123", -> "description": "Wireless Mgmt", -> "mac": "1c:e8:5d:00:00:0c", -> "status": "disabled", -> "speed": "1 Gbps", -> "addresses": [ -> { -> "protocol": "ipv4", -> "address": "192.168.123.1", -> "subnet": "192.168.123.0/24" -> } -> ], -> "vrf": { -> "name": "Global" -> }, -> "isUplink": true, -> "vlan": 10, -> "linkNegotiation": "auto", -> "channelGroup": { -> "number": 5 -> }, -> "module": { -> "model": "C9800-2X40GE" -> } -> } -> ] -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } +> "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" > } > } > @@ -4657,84 +5103,63 @@ PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/ * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/statuses/changeHistory/byDevice`_ +PATH _`/devices/{serial}/liveTools/traceRoute/{traceRouteId}`_ > \- Path added > > \- New endpoint > -> #### List wireless LAN controller layer 3 interfaces history status in an organization +> #### Return a trace route job > -> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l3/statuses/changeHistory/byDevice` +> **GET** `/devices/{serial}/liveTools/traceRoute/{traceRouteId}` > > { -> "items": [ +> "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": [ > { -> "serial": "Q234-ABCD-5678", -> "interfaces": [ -> { -> "name": "TenGigabitEthernet0/0/5", -> "mac": "b0:c5:3c:0d:c5:0b", -> "changes": [ -> { -> "ts": "2020-01-01T00:00:00Z", -> "status": "disabled", -> "warnings": [ -> "CRC warnings" -> ], -> "errors": [ -> "CRC errors" -> ] -> } -> ] -> } -> ] +> "hop": 0, +> "ip": "100.100.0.1", +> "rttAvg": 0.00005, +> "count": 3 > } > ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } -> } +> "error": "The device is unreachable." > } > > * * * * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/usage/history/byInterval`_ +### speedTest + +PATH _`/devices/{serial}/liveTools/speedTest`_ > \- Path added > > \- New endpoint > -> #### List wireless LAN controller layer 3 interfaces history usage in an organization +> #### Enqueue a job to execute a speed test from a device > -> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l3/usage/history/byInterval` +> **POST** `/devices/{serial}/liveTools/speedTest` > > { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "readings": [ -> { -> "name": "TenGigabitEthernet0/0/5", -> "mac": "b0:c5:3c:0d:c5:0b", -> "recv": 0, -> "send": 0 -> } -> ] -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } +> "speedTestId": "1284392014819", +> "url": "/devices/SERIAL/liveTools/speedTest/1284392014819", +> "request": { +> "serial": "Q234-ABCD-5678", +> "interface": "wan1" +> }, +> "status": "complete", +> "results": { +> "speeds": { +> "average": 123.45 > } > } > } @@ -4743,85 +5168,58 @@ PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/ * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/redundancy/failover/history`_ +PATH _`/devices/{serial}/liveTools/speedTest/{id}`_ > \- Path added > > \- New endpoint > -> #### List the failover events of wireless LAN controllers in an organization +> #### Returns a speed test result in megabits per second. If test is not complete, no results are present. > -> **GET** `/organizations/{organizationId}/wirelessController/devices/redundancy/failover/history` +> **GET** `/devices/{serial}/liveTools/speedTest/{id}` > -> [ -> { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "ts": "2020-01-01T00:00:00Z", -> "reason": "Active Unit Failed", -> "failed": { -> "chassis": { -> "name": "Chassis 2" -> } -> }, -> "active": { -> "chassis": { -> "name": "Chassis 1" -> } -> } -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } +> { +> "speedTestId": "1284392014819", +> "url": "/devices/SERIAL/liveTools/speedTest/1284392014819", +> "request": { +> "serial": "Q234-ABCD-5678", +> "interface": "wan1" +> }, +> "status": "complete", +> "results": { +> "speeds": { +> "average": 123.45 > } > } -> ] +> } > > * * * * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/redundancy/statuses`_ +### routingTable + +PATH _`/devices/{serial}/liveTools/routingTable`_ > \- Path added > > \- New endpoint > -> #### List redundancy details of wireless LAN controllers in an organization. The failover count refers to the total failovers system happens from the moment of this device onboarding to Dashboard +> #### 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. > -> **GET** `/organizations/{organizationId}/wirelessController/devices/redundancy/statuses` +> **POST** `/devices/{serial}/liveTools/routingTable` > > { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "mode": "SSO", -> "enabled": true, -> "failover": { -> "last": { -> "ts": "2020-01-01T00:00:00Z", -> "reason": "Active Unit Failed" -> }, -> "counts": { -> "total": 2 -> } -> }, -> "mobilityMac": "b0:c5:3c:0d:c5:0b" -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } +> "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" > } > } > @@ -4829,116 +5227,60 @@ PATH _`/organizations/{organizationId}/wirelessController/devices/redundancy/sta * * * -PATH _`/organizations/{organizationId}/wirelessController/devices/system/utilization/history/byInterval`_ +PATH _`/devices/{serial}/liveTools/routingTable/{id}`_ > \- Path added > > \- New endpoint > -> #### List cpu utilization data of wireless LAN controllers in an organization +> #### Return an routing table live tool job. > -> **GET** `/organizations/{organizationId}/wirelessController/devices/system/utilization/history/byInterval` +> **GET** `/devices/{serial}/liveTools/routingTable/{id}` > > { -> "items": [ +> "routingTableId": "1284392014819", +> "url": "/devices/Q234-ABCD-5678/liveTools/routingTable/1284392014819", +> "request": { +> "serial": "Q234-ABCD-5678" +> }, +> "status": "complete", +> "entries": [ > { -> "serial": "Q234-ABCD-5678", -> "intervals": [ -> { -> "startTs": "2024-03-04T05:25:03Z", -> "endTs": "2024-03-04T05:30:19Z", -> "overall": { -> "usage": { -> "average": { -> "percentage": 10.59 -> } -> } -> }, -> "byCore": [ -> { -> "name": "0", -> "usage": { -> "average": { -> "percentage": 2.74 -> } -> } -> } -> ] -> } -> ] +> "type": "static", +> "subnet": "10.200.10.1/32", +> "staticGateway": "22.22.22.21" > } > ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } -> } +> "error": "The device is unreachable" > } > > * * * * * * -PATH _`/organizations/{organizationId}/wirelessController/overview/byDevice`_ +### macTable + +PATH _`/devices/{serial}/liveTools/macTable`_ > \- Path added > > \- New endpoint > -> #### List the overview information of wireless LAN controllers in an organization and it is updated every minute. +> #### Enqueue a job to request the MAC table from the device. Switches currently support this feature. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests. > -> **GET** `/organizations/{organizationId}/wirelessController/overview/byDevice` +> **POST** `/devices/{serial}/liveTools/macTable` > > { -> "items": [ -> { -> "serial": "Q234-ABCD-5678", -> "network": { -> "id": "N_24329156" -> }, -> "counts": { -> "clients": { -> "byStatus": { -> "online": 300 -> } -> }, -> "connections": { -> "total": 200, -> "byStatus": { -> "online": 180, -> "offline": 20 -> } -> } -> }, -> "redundancy": { -> "role": "Active", -> "id": "123456", -> "chassisName": "Chassis 1", -> "management": { -> "addresses": [ -> { -> "address": "10.14.140.5" -> } -> ] -> } -> }, -> "firmware": { -> "version": { -> "shortName": "ios-xe" -> } -> } -> } -> ], -> "meta": { -> "counts": { -> "items": { -> "total": 10, -> "remaining": 0 -> } -> } +> "macTableId": "1284392014819", +> "url": "/devices/Q234-ABCD-5678/liveTools/macTable/1284392014819", +> "request": { +> "serial": "Q234-ABCD-5678" +> }, +> "status": "complete", +> "callback": { +> "id": "1284392014819", +> "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031", +> "status": "new" > } > } > @@ -4946,134 +5288,121 @@ PATH _`/organizations/{organizationId}/wirelessController/overview/byDevice`_ * * * -### snmp - -PATH _`/organizations/{organizationId}/snmp/traps/byNetwork`_ +PATH _`/devices/{serial}/liveTools/macTable/{macTableId}`_ > \- Path added > > \- New endpoint > -> #### Retrieve the SNMP trap configuration for the networks in an organization +> #### Return a MAC table live tool job. > -> **GET** `/organizations/{organizationId}/snmp/traps/byNetwork` +> **GET** `/devices/{serial}/liveTools/macTable/{macTableId}` > -> [ -> { -> "network": { -> "id": "N_12345678", -> "name": "networkName" -> }, -> "mode": "users", -> "receiver": { -> "address": "1.1.1.1", -> "port": "1234" -> }, -> "v2": { -> "community": "public" -> }, -> "v3": { -> "users": [ -> { -> "name": "merakian" -> } -> ] +> { +> "macTableId": "1284392014819", +> "url": "/devices/Q234-ABCD-5678/liveTools/macTable/1284392014819", +> "request": { +> "serial": "Q234-ABCD-5678" +> }, +> "status": "complete", +> "entries": [ +> { +> "mac": "00:11:22:33:44:55", +> "port": "Tw1/0/9", +> "vlanId": 100 > } -> } -> ] +> ], +> "error": "The device is unreachable." +> } > > * * * * * * -\[ insight \] -------------- - -### speedTestResults +### leds -PATH _`/organizations/{organizationId}/insight/speedTestResults`_ +PATH _`/devices/{serial}/liveTools/leds/blink`_ > \- Path added > > \- New endpoint > -> #### List the speed tests for the given devices under this organization. Only valid for organizations with Meraki Insight. +> #### Enqueue a job to blink LEDs on a device. This endpoint has a rate limit of one request every 10 seconds. > -> **GET** `/organizations/{organizationId}/insight/speedTestResults` +> **POST** `/devices/{serial}/liveTools/leds/blink` > -> [ -> { -> "speedTestId": "1284392014819", -> "networkId": "N_24329156", -> "request": { -> "serial": "Q234-ABCD-5678", -> "interface": "wan1" -> }, -> "results": { -> "speeds": { -> "average": 247.279 -> } -> }, -> "startedAt": "2021-12-08T20:07:13Z" +> { +> "ledsBlinkId": "123", +> "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/leds/blink/1738", +> "status": "complete", +> "request": { +> "serial": "Q234-ABCD-5678", +> "duration": 30 +> }, +> "error": "error description", +> "callback": { +> "id": "1284392014819", +> "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031", +> "status": "new" > } -> ] +> } > > * * * * * * -### webApps - -PATH _`/organizations/{organizationId}/insight/webApps`_ +PATH _`/devices/{serial}/liveTools/leds/blink/{ledsBlinkId}`_ > \- Path added > > \- New endpoint > -> #### Lists all default web applications rules with counter set rule ids +> #### Return a blink LEDs job > -> **GET** `/organizations/{organizationId}/insight/webApps` +> **GET** `/devices/{serial}/liveTools/leds/blink/{ledsBlinkId}` > -> [ -> { -> "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" -> } -> } -> ] +> { +> "ledsBlinkId": "123", +> "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/leds/blink/1738", +> "status": "complete", +> "request": { +> "serial": "Q234-ABCD-5678", +> "duration": 30 +> }, +> "error": "error description" +> } > > * * * -> + +* * * + +### cyclePort + +PATH _`/devices/{serial}/liveTools/cyclePort`_ + +> \- Path added > > \- New endpoint > -> #### Add a custom web application for Insight to be able to track +> #### 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** `/organizations/{organizationId}/insight/webApps` +> **POST** `/devices/{serial}/liveTools/cyclePort` > > { -> "counterSetRuleId": "12345", -> "name": "Meraki HTTPS", -> "category": "Remote monitoring & management", -> "thresholds": { -> "goodput": "20000", -> "responseDelay": "3000" +> "cyclePortId": "1284392014819", +> "url": "/devices/Q234-ABCD-5678/liveTools/cyclePort/1284392014819", +> "request": { +> "serial": "Q234-ABCD-5678", +> "ports": [ +> "2", +> "8" +> ] > }, -> "expression": "http_host[*.example.com] or http_host", -> "signature": { -> "signatureType": "custom_host", -> "host": "exampled.com" +> "status": "complete", +> "callback": { +> "id": "1284392014819", +> "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031", +> "status": "new" > } > } > @@ -5081,889 +5410,126 @@ PATH _`/organizations/{organizationId}/insight/webApps`_ * * * -PATH _`/organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}`_ +PATH _`/devices/{serial}/liveTools/cyclePort/{id}`_ > \- Path added > > \- New endpoint > -> #### Update a custom web application for Insight to be able to track +> #### Return a cycle port live tool job. > -> **PUT** `/organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}` +> **GET** `/devices/{serial}/liveTools/cyclePort/{id}` > > { -> "counterSetRuleId": "12345", -> "name": "Meraki HTTPS", -> "category": "Remote monitoring & management", -> "thresholds": { -> "goodput": "20000", -> "responseDelay": "3000" +> "cyclePortId": "1284392014819", +> "url": "/devices/Q234-ABCD-5678/liveTools/cyclePort/1284392014819", +> "request": { +> "serial": "Q234-ABCD-5678", +> "ports": [ +> "2", +> "8" +> ] > }, -> "expression": "http_host[*.example.com] or http_host", -> "signature": { -> "signatureType": "custom_host", -> "host": "exampled.com" -> } +> "status": "complete", +> "error": "The device is unreachable." > } > > * * * -> + +* * * + +### aclHitCount + +PATH _`/devices/{serial}/liveTools/aclHitCount`_ + +> \- Path added > > \- New endpoint > -> #### Delete a custom web application by counter set rule id. +> #### 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. > -> **DELETE** `/organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}` +> **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" +> } +> } > > * * * * * * -### applications - -PATH _`/organizations/{organizationId}/insight/applications/{applicationId}`_ +PATH _`/devices/{serial}/liveTools/aclHitCount/{id}`_ > \- Path added > > \- New endpoint > -> #### Update an Insight tracked application +> #### Return an ACL hit count live tool job. > -> **PUT** `/organizations/{organizationId}/insight/applications/{applicationId}` +> **GET** `/devices/{serial}/liveTools/aclHitCount/{id}` > > { -> "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}` -> -> * * * - -* * * - -\[ devices \] -------------- - -### traceRoute - -PATH _`/devices/{serial}/liveTools/traceRoute`_ - -> \- 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" -> } -> } -> -> * * * - -* * * - -PATH _`/devices/{serial}/liveTools/traceRoute/{traceRouteId}`_ - -> \- 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 - -PATH _`/devices/{serial}/liveTools/speedTest`_ - -> \- 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 -> } -> } -> } -> -> * * * - -* * * - -PATH _`/devices/{serial}/liveTools/speedTest/{id}`_ - -> \- 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 - -PATH _`/devices/{serial}/liveTools/routingTable`_ - -> \- 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" -> } -> } -> -> * * * - -* * * - -PATH _`/devices/{serial}/liveTools/routingTable/{id}`_ - -> \- 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", +> "aclHitCountId": "1284392014819", +> "url": "/devices/Q234-ABCD-5678/liveTools/aclHitCount/1284392014819", > "request": { > "serial": "Q234-ABCD-5678" > }, > "status": "complete", -> "entries": [ +> "acls": [ > { -> "type": "static", -> "subnet": "10.200.10.1/32", -> "staticGateway": "22.22.22.21" +> "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" +> "error": "The device is unreachable." > } > > * * * * * * -### macTable - -PATH _`/devices/{serial}/liveTools/macTable`_ - -> \- Path added -> -> \- New endpoint -> -> #### Enqueue a job to request the MAC table from the device. Switches currently support this feature. 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/macTable` -> -> { -> "macTableId": "1284392014819", -> "url": "/devices/Q234-ABCD-5678/liveTools/macTable/1284392014819", -> "request": { -> "serial": "Q234-ABCD-5678" -> }, -> "status": "complete", -> "callback": { -> "id": "1284392014819", -> "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031", -> "status": "new" -> } -> } -> -> * * * - -* * * - -PATH _`/devices/{serial}/liveTools/macTable/{macTableId}`_ - -> \- Path added -> -> \- New endpoint -> -> #### Return a MAC table live tool job. -> -> **GET** `/devices/{serial}/liveTools/macTable/{macTableId}` -> -> { -> "macTableId": "1284392014819", -> "url": "/devices/Q234-ABCD-5678/liveTools/macTable/1284392014819", -> "request": { -> "serial": "Q234-ABCD-5678" -> }, -> "status": "complete", -> "entries": [ -> { -> "mac": "00:11:22:33:44:55", -> "port": "Tw1/0/9", -> "vlanId": 100 -> } -> ], -> "error": "The device is unreachable." -> } -> -> * * * - -* * * - -### leds - -PATH _`/devices/{serial}/liveTools/leds/blink`_ - -> \- Path added -> -> \- New endpoint -> -> #### Enqueue a job to blink LEDs on a device. This endpoint has a rate limit of one request every 10 seconds. -> -> **POST** `/devices/{serial}/liveTools/leds/blink` -> -> { -> "ledsBlinkId": "123", -> "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/leds/blink/1738", -> "status": "complete", -> "request": { -> "serial": "Q234-ABCD-5678", -> "duration": 30 -> }, -> "error": "error description", -> "callback": { -> "id": "1284392014819", -> "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031", -> "status": "new" -> } -> } -> -> * * * - -* * * - -PATH _`/devices/{serial}/liveTools/leds/blink/{ledsBlinkId}`_ - -> \- Path added -> -> \- New endpoint -> -> #### Return a blink LEDs job -> -> **GET** `/devices/{serial}/liveTools/leds/blink/{ledsBlinkId}` -> -> { -> "ledsBlinkId": "123", -> "url": "/devices/QXXX-YYYY-ZZZZ/liveTools/leds/blink/1738", -> "status": "complete", -> "request": { -> "serial": "Q234-ABCD-5678", -> "duration": 30 -> }, -> "error": "error description" -> } -> -> * * * - -* * * - -### cyclePort - -PATH _`/devices/{serial}/liveTools/cyclePort`_ - -> \- 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" -> } -> } -> -> * * * - -* * * - -PATH _`/devices/{serial}/liveTools/cyclePort/{id}`_ - -> \- 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 - -PATH _`/devices/{serial}/liveTools/aclHitCount`_ - -> \- 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" -> } -> } -> -> * * * - -* * * - -PATH _`/devices/{serial}/liveTools/aclHitCount/{id}`_ - -> \- 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." -> } -> -> * * * - -* * * - -\[ sensor \] ------------- - -### schedules - -PATH _`/networks/{networkId}/sensor/schedules`_ - -> \- 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" -> } -> ] -> -> * * * - -* * * - -### alerts - -PATH _`/organizations/{organizationId}/sensor/alerts`_ - -> \- 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" -> } -> } -> ] -> -> * * * - -* * * - -### readings - -PATH _`/organizations/{organizationId}/sensor/readings/history/byInterval`_ - -> \- 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 -> } -> } -> } -> ] -> -> * * * - -* * * - \[ secureConnect \] ------------------- diff --git a/changelog/v1.51.0.md b/changelog/v1.51.0.md new file mode 100644 index 0000000..84d262e --- /dev/null +++ b/changelog/v1.51.0.md @@ -0,0 +1,1207 @@ + - [What's Updated](#whats-updated) + * [\[ licensing \]](#-licensing-) + + [subscription](#subscription) + - [List available subscriptions](#list-available-subscriptions) + * [\[ devices \]](#-devices-) + + [lldpCdp](#lldpcdp) + - [List LLDP and CDP information for a device](#list-lldp-and-cdp-information-for-a-device) + * [\[ networks \]](#-networks-) + + [merakiAuthUsers](#merakiauthusers) + - [List the authorized users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network)](#list-the-authorized-users-configured-under-meraki-authentication-for-a-network-splash-guest-or-radius-users-for-a-wireless-network-or-client-vpn-users-for-a-mx-network) + + [service](#service) + - [Return a network](#return-a-network) + - [Update a network](#update-a-network) + - [Split a combined network into individual networks for each type of device](#split-a-combined-network-into-individual-networks-for-each-type-of-device) + - [Unbind a network from a template.](#unbind-a-network-from-a-template) + * [\[ camera \]](#-camera-) + + [qualityRetentionProfiles](#qualityretentionprofiles) + - [Update an existing quality retention profile for this network.](#update-an-existing-quality-retention-profile-for-this-network) + - [Creates new quality retention profile for this network.](#creates-new-quality-retention-profile-for-this-network) + * [\[ switch \]](#-switch-) + + [stacks](#stacks) + - [List the switch stacks in a network](#list-the-switch-stacks-in-a-network) + - [Show a switch stack](#show-a-switch-stack) + - [Create a switch stack](#create-a-switch-stack) + - [Add a switch to a stack](#add-a-switch-to-a-stack) + - [Remove a switch from a stack](#remove-a-switch-from-a-stack) + + [stormControl](#stormcontrol) + - [Return the storm control configuration for a switch network](#return-the-storm-control-configuration-for-a-switch-network) + - [Update the storm control configuration for a switch network](#update-the-storm-control-configuration-for-a-switch-network) + + [ports](#ports) + - [List the switchports in an organization by switch](#list-the-switchports-in-an-organization-by-switch) + * [\[ appliance \]](#-appliance-) + + [vpn](#vpn) + - [Update the third party VPN peers for an organization](#update-the-third-party-vpn-peers-for-an-organization) + * [\[ cellularGateway \]](#-cellulargateway-) + + [esims](#esims) + - [The eSIM inventory of a given organization.](#the-esim-inventory-of-a-given-organization) + - [Toggle the status of an eSIM](#toggle-the-status-of-an-esim) + * [\[ organizations \]](#-organizations-) + + [devices](#devices) + - [List the availability information for devices in an organization](#list-the-availability-information-for-devices-in-an-organization) + - [List the current uplink addresses for devices in an organization.](#list-the-current-uplink-addresses-for-devices-in-an-organization) + + [inventory](#inventory) + - [Returns list of networks eligible for adding cloud monitored device](#returns-list-of-networks-eligible-for-adding-cloud-monitored-device) + + [networks](#networks) + - [List the networks that the user has privileges on in an organization](#list-the-networks-that-the-user-has-privileges-on-in-an-organization) + - [Create a network](#create-a-network) + - [Combine multiple networks into a single network](#combine-multiple-networks-into-a-single-network) +- [What's New](#whats-new) + * [\[ organizations \]](#-organizations--1) + + [wirelessController](#wirelesscontroller) + - [List connectivity data of wireless LAN controllers in an organization. If it is HA setup, then only returns active WLC data start from switchover](#list-connectivity-data-of-wireless-lan-controllers-in-an-organization-if-it-is-ha-setup-then-only-returns-active-wlc-data-start-from-switchover) + - [List wireless client counts of wireless LAN controllers over time in an organization](#list-wireless-client-counts-of-wireless-lan-controllers-over-time-in-an-organization) + - [List all access points associated with wireless LAN controllers in an organization](#list-all-access-points-associated-with-wireless-lan-controllers-in-an-organization) + - [List wireless LAN controller layer 2 interfaces in an organization](#list-wireless-lan-controller-layer-2-interfaces-in-an-organization) + - [List wireless LAN controller layer 2 interfaces history status in an organization](#list-wireless-lan-controller-layer-2-interfaces-history-status-in-an-organization) + - [List wireless LAN controller layer 2 interfaces history usage in an organization](#list-wireless-lan-controller-layer-2-interfaces-history-usage-in-an-organization) + - [List wireless LAN controller layer 3 interfaces in an organization](#list-wireless-lan-controller-layer-3-interfaces-in-an-organization) + - [List wireless LAN controller layer 3 interfaces history status in an organization](#list-wireless-lan-controller-layer-3-interfaces-history-status-in-an-organization) + - [List wireless LAN controller layer 3 interfaces history usage in an organization](#list-wireless-lan-controller-layer-3-interfaces-history-usage-in-an-organization) + - [Retrieve the packet counters for the interfaces of a Wireless LAN controller](#retrieve-the-packet-counters-for-the-interfaces-of-a-wireless-lan-controller) + - [Retrieve the traffic for the interfaces of a Wireless LAN controller](#retrieve-the-traffic-for-the-interfaces-of-a-wireless-lan-controller) + - [List the failover events of wireless LAN controllers in an organization](#list-the-failover-events-of-wireless-lan-controllers-in-an-organization) + - [List redundancy details of wireless LAN controllers in an organization. The failover count refers to the total failovers system happens from the moment of this device onboarding to Dashboard](#list-redundancy-details-of-wireless-lan-controllers-in-an-organization-the-failover-count-refers-to-the-total-failovers-system-happens-from-the-moment-of-this-device-onboarding-to-dashboard) + - [List cpu utilization data of wireless LAN controllers in an organization](#list-cpu-utilization-data-of-wireless-lan-controllers-in-an-organization) + - [List the overview information of wireless LAN controllers in an organization and it is updated every minute.](#list-the-overview-information-of-wireless-lan-controllers-in-an-organization-and-it-is-updated-every-minute) + * [\[ wireless \]](#-wireless-) + + [devices](#devices-1) + - [List of Catalyst access points information](#list-of-catalyst-access-points-information) + + [clients](#clients) + - [List access point client count at the moment in an organization](#list-access-point-client-count-at-the-moment-in-an-organization) + +Version **1.50.0** _to_ **1.51.0** + +* * * + +**Summary of Changes** + +**17 - New** + +**51 - Updated** + +**760 - Total Endpoints** + +**507 - Total Paths** + +* * * + +* * * + +What's Updated +============== + +\[ licensing \] +--------------- + +### subscription + +#### List available subscriptions + +GET _`/administered/licensing/subscription/subscriptions`_ + +> \- Optional param `name` added + +* * * + +\[ devices \] +------------- + +### lldpCdp + +#### List LLDP and CDP information for a device + +GET _`/devices/{serial}/lldpCdp`_ + +> \- Property `name` Deleted + +> \- Optional property `deviceMac` Added + +> \- Response property `deviceMac` value added + +* * * + +\[ networks \] +-------------- + +### merakiAuthUsers + +#### List the authorized users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network) + +GET _`/networks/{networkId}/merakiAuthUsers`_ + +> \- Summary changed from `List the users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network)` to `List the authorized users configured under Meraki Authentication for a network (splash guest or RADIUS users for a wireless network, or client VPN users for a MX network)` + +* * * + +### service + +#### Return a network + +GET _`/networks/{networkId}`_ + +> \- Property `isVirtual` Deleted + +* * * + +#### Update a network + +PUT _`/networks/{networkId}`_ + +> \- Property `isVirtual` Deleted + +* * * + +#### Split a combined network into individual networks for each type of device + +POST _`/networks/{networkId}/split`_ + +> \- Property `isVirtual` Deleted + +* * * + +#### Unbind a network from a template. + +POST _`/networks/{networkId}/unbind`_ + +> \- Property `isVirtual` Deleted + +* * * + +\[ camera \] +------------ + +### qualityRetentionProfiles + +#### Update an existing quality retention profile for this network. + +PUT _`/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}`_ + +> \- Optional property `MV23` Added + +> \- Optional property `MV23M` Added + +> \- Optional property `MV23X` Added + +> \- Optional property `MV73` Added + +> \- Optional property `MV73M` Added + +> \- Optional property `MV73X` Added + +* * * + +#### Creates new quality retention profile for this network. + +POST _`/networks/{networkId}/camera/qualityRetentionProfiles`_ + +> \- Optional property `MV23` Added + +> \- Optional property `MV23M` Added + +> \- Optional property `MV23X` Added + +> \- Optional property `MV73` Added + +> \- Optional property `MV73M` Added + +> \- Optional property `MV73X` Added + +* * * + +\[ switch \] +------------ + +### stacks + +#### List the switch stacks in a network + +GET _`/networks/{networkId}/switch/stacks`_ + +> \- Optional property `isMonitorOnly` Added + +> \- Optional property `members` Added + +> \- Response property `isMonitorOnly` value added + +> \- Response property `members` value added + +* * * + +#### Show a switch stack + +GET _`/networks/{networkId}/switch/stacks/{switchStackId}`_ + +> \- Optional property `isMonitorOnly` Added + +> \- Optional property `members` Added + +> \- Response property `isMonitorOnly` value added + +> \- Response property `members` value added + +* * * + +#### Create a switch stack + +POST _`/networks/{networkId}/switch/stacks`_ + +> \- Optional property `isMonitorOnly` Added + +> \- Optional property `members` Added + +* * * + +#### Add a switch to a stack + +POST _`/networks/{networkId}/switch/stacks/{switchStackId}/add`_ + +> \- Optional property `isMonitorOnly` Added + +> \- Optional property `members` Added + +* * * + +#### Remove a switch from a stack + +POST _`/networks/{networkId}/switch/stacks/{switchStackId}/remove`_ + +> \- Optional property `isMonitorOnly` Added + +> \- Optional property `members` Added + +* * * + +### stormControl + +#### Return the storm control configuration for a switch network + +GET _`/networks/{networkId}/switch/stormControl`_ + +> \- Optional property `treatTheseTrafficTypesAsOneThreshold` Added + +> \- Response property `treatTheseTrafficTypesAsOneThreshold` value added + +* * * + +#### Update the storm control configuration for a switch network + +PUT _`/networks/{networkId}/switch/stormControl`_ + +> \- Optional property `treatTheseTrafficTypesAsOneThreshold` Added + +> \- Optional property `treatTheseTrafficTypesAsOneThreshold` Added + +* * * + +### ports + +#### List the switchports in an organization by switch + +GET _`/organizations/{organizationId}/switch/ports/bySwitch`_ + +> \- Response property `properties` value added + +* * * + +\[ appliance \] +--------------- + +### vpn + +#### Update the third party VPN peers for an organization + +PUT _`/organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers`_ + +> \- Optional property `publicHostname` Added + +* * * + +\[ cellularGateway \] +--------------------- + +### esims + +#### The eSIM inventory of a given organization. + +GET _`/organizations/{organizationId}/cellularGateway/esims/inventory`_ + +> \- Optional property `status` Added + +> \- Response property `status` value added + +* * * + +#### Toggle the status of an eSIM + +PUT _`/organizations/{organizationId}/cellularGateway/esims/inventory/{id}`_ + +> \- Optional property `status` Added + +* * * + +\[ organizations \] +------------------- + +### devices + +#### List the availability information for devices in an organization + +GET _`/organizations/{organizationId}/devices/availabilities`_ + +> \- Optional param `statuses` added + +* * * + +#### List the current uplink addresses for devices in an organization. + +GET _`/organizations/{organizationId}/devices/uplinks/addresses/byDevice`_ + +> \- Optional property `nameservers` Added + +> \- Response property `nameservers` value added + +* * * + +### inventory + +#### Returns list of networks eligible for adding cloud monitored device + +GET _`/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks`_ + +> \- Property `isVirtual` Deleted + +* * * + +### networks + +#### List the networks that the user has privileges on in an organization + +GET _`/organizations/{organizationId}/networks`_ + +> \- Property `isVirtual` Deleted + +* * * + +#### Create a network + +POST _`/organizations/{organizationId}/networks`_ + +> \- Property `isVirtual` Deleted + +* * * + +#### Combine multiple networks into a single network + +POST _`/organizations/{organizationId}/networks/combine`_ + +> \- Property `isVirtual` Deleted + +* * * + +What's New +========== + +\[ organizations \] +------------------- + +### wirelessController + +PATH _`/organizations/{organizationId}/wirelessController/availabilities/changeHistory`_ + +> \- Path added +> +> \- New endpoint +> +> #### List connectivity data of wireless LAN controllers in an organization. If it is HA setup, then only returns active WLC data start from switchover +> +> **GET** `/organizations/{organizationId}/wirelessController/availabilities/changeHistory` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "changes": [ +> { +> "startTs": "2020-01-01T00:00:00Z", +> "endTs": "null", +> "status": "online" +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/clients/overview/history/byDevice/byInterval`_ + +> \- Path added +> +> \- New endpoint +> +> #### List wireless client counts of wireless LAN controllers over time in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/clients/overview/history/byDevice/byInterval` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "network": { +> "id": "N_24329156" +> }, +> "readings": [ +> { +> "startTs": "2020-01-01T00:00:00Z", +> "endTs": "2020-01-01T01:00:00Z", +> "counts": { +> "byStatus": { +> "online": 1 +> } +> } +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/connections`_ + +> \- Path added +> +> \- New endpoint +> +> #### List all access points associated with wireless LAN controllers in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/connections` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "controller": { +> "serial": "Q234-ABCD-5678" +> }, +> "network": { +> "id": "N_24329156", +> "url": "https://network/url", +> "name": "Network1" +> } +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l2/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List wireless LAN controller layer 2 interfaces in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l2/byDevice` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "interfaces": [ +> { +> "name": "TenGigabitEthernet0/0/5", +> "description": "Uplink", +> "enabled": true, +> "mac": "b0:c5:3c:0d:c5:0b", +> "status": "disabled", +> "speed": "1 Gbps", +> "isUplink": true, +> "vlan": 10, +> "isRedundancyPort": true, +> "linkNegotiation": "auto", +> "channelGroup": { +> "number": 5 +> }, +> "module": { +> "model": "C9800-2X40GE" +> } +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l2/statuses/changeHistory/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List wireless LAN controller layer 2 interfaces history status in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l2/statuses/changeHistory/byDevice` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "interfaces": [ +> { +> "name": "TenGigabitEthernet0/0/5", +> "mac": "b0:c5:3c:0d:c5:0b", +> "changes": [ +> { +> "ts": "2020-01-01T00:00:00Z", +> "status": "disabled", +> "warnings": [ +> "CRC warnings" +> ], +> "errors": [ +> "CRC errors" +> ] +> } +> ] +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l2/usage/history/byInterval`_ + +> \- Path added +> +> \- New endpoint +> +> #### List wireless LAN controller layer 2 interfaces history usage in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l2/usage/history/byInterval` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "readings": [ +> { +> "name": "TenGigabitEthernet0/0/5", +> "mac": "b0:c5:3c:0d:c5:0b", +> "recv": 0, +> "send": 0 +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List wireless LAN controller layer 3 interfaces in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l3/byDevice` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "interfaces": [ +> { +> "name": "vlan123", +> "description": "Wireless Mgmt", +> "mac": "1c:e8:5d:00:00:0c", +> "status": "disabled", +> "speed": "1 Gbps", +> "addresses": [ +> { +> "protocol": "ipv4", +> "address": "192.168.123.1", +> "subnet": "192.168.123.0/24" +> } +> ], +> "vrf": { +> "name": "Global" +> }, +> "isUplink": true, +> "vlan": 10, +> "linkNegotiation": "auto", +> "channelGroup": { +> "number": 5 +> }, +> "module": { +> "model": "C9800-2X40GE" +> } +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/statuses/changeHistory/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List wireless LAN controller layer 3 interfaces history status in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l3/statuses/changeHistory/byDevice` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "interfaces": [ +> { +> "name": "TenGigabitEthernet0/0/5", +> "mac": "b0:c5:3c:0d:c5:0b", +> "changes": [ +> { +> "ts": "2020-01-01T00:00:00Z", +> "status": "disabled", +> "warnings": [ +> "CRC warnings" +> ], +> "errors": [ +> "CRC errors" +> ] +> } +> ] +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/l3/usage/history/byInterval`_ + +> \- Path added +> +> \- New endpoint +> +> #### List wireless LAN controller layer 3 interfaces history usage in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/l3/usage/history/byInterval` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "readings": [ +> { +> "name": "TenGigabitEthernet0/0/5", +> "mac": "b0:c5:3c:0d:c5:0b", +> "recv": 0, +> "send": 0 +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/packets/overview/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### Retrieve the packet counters for the interfaces of a Wireless LAN controller +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/packets/overview/byDevice` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "interfaces": [ +> { +> "name": "TenGigabitEthernet0/0/0", +> "readings": [ +> { +> "name": "Total", +> "total": 2001, +> "recv": 1000, +> "send": 1001, +> "rate": { +> "total": 12, +> "recv": 3, +> "send": 8 +> } +> } +> ] +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/interfaces/usage/history/byInterval`_ + +> \- Path added +> +> \- New endpoint +> +> #### Retrieve the traffic for the interfaces of a Wireless LAN controller +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/interfaces/usage/history/byInterval` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "intervals": [ +> { +> "startTs": "2024-07-25T03:20:55Z", +> "endTs": "2024-07-25T03:25:55Z", +> "overall": { +> "total": 12300, +> "recv": 2300, +> "send": 10000 +> }, +> "byInterface": [ +> { +> "name": "TenGigabitEthernet0/0/1", +> "usage": { +> "total": 12300, +> "recv": 2300, +> "send": 10000 +> } +> } +> ] +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/redundancy/failover/history`_ + +> \- Path added +> +> \- New endpoint +> +> #### List the failover events of wireless LAN controllers in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/redundancy/failover/history` +> +> [ +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "ts": "2020-01-01T00:00:00Z", +> "reason": "Active Unit Failed", +> "failed": { +> "chassis": { +> "name": "Chassis 2" +> } +> }, +> "active": { +> "chassis": { +> "name": "Chassis 1" +> } +> } +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> ] +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/redundancy/statuses`_ + +> \- Path added +> +> \- New endpoint +> +> #### List redundancy details of wireless LAN controllers in an organization. The failover count refers to the total failovers system happens from the moment of this device onboarding to Dashboard +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/redundancy/statuses` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "mode": "SSO", +> "enabled": true, +> "failover": { +> "last": { +> "ts": "2020-01-01T00:00:00Z", +> "reason": "Active Unit Failed" +> }, +> "counts": { +> "total": 2 +> } +> }, +> "mobilityMac": "b0:c5:3c:0d:c5:0b" +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/devices/system/utilization/history/byInterval`_ + +> \- Path added +> +> \- New endpoint +> +> #### List cpu utilization data of wireless LAN controllers in an organization +> +> **GET** `/organizations/{organizationId}/wirelessController/devices/system/utilization/history/byInterval` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "intervals": [ +> { +> "startTs": "2024-03-04T05:25:03Z", +> "endTs": "2024-03-04T05:30:19Z", +> "overall": { +> "usage": { +> "average": { +> "percentage": 10.59 +> } +> } +> }, +> "byCore": [ +> { +> "name": "0", +> "usage": { +> "average": { +> "percentage": 2.74 +> } +> } +> } +> ] +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +PATH _`/organizations/{organizationId}/wirelessController/overview/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List the overview information of wireless LAN controllers in an organization and it is updated every minute. +> +> **GET** `/organizations/{organizationId}/wirelessController/overview/byDevice` +> +> { +> "items": [ +> { +> "serial": "Q234-ABCD-5678", +> "network": { +> "id": "N_24329156" +> }, +> "counts": { +> "clients": { +> "byStatus": { +> "online": 300 +> } +> }, +> "connections": { +> "total": 200, +> "byStatus": { +> "online": 180, +> "offline": 20 +> } +> } +> }, +> "redundancy": { +> "role": "Active", +> "id": "123456", +> "chassisName": "Chassis 1", +> "management": { +> "addresses": [ +> { +> "address": "10.14.140.5" +> } +> ] +> } +> }, +> "firmware": { +> "version": { +> "shortName": "ios-xe" +> } +> } +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +\[ wireless \] +-------------- + +### devices + +PATH _`/organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List of Catalyst access points information +> +> **GET** `/organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice` +> +> { +> "items": [ +> { +> "network": { +> "id": "N_24329156" +> }, +> "serial": "Q234-ABCD-5678", +> "controller": { +> "serial": "Q234-ABCD-5678" +> }, +> "joinedAt": "2020-01-01T00:00:00Z", +> "model": "C9115AXI-H", +> "tags": [ +> { +> "policy": "4F", +> "site": "default-site-tag", +> "rf": "default-rf-tag" +> } +> ], +> "mode": "local", +> "countryCode": "CA", +> "details": [ +> { +> "name": "catalyst serial", +> "value": "FGL2446L7QQ" +> } +> ] +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * + +### clients + +PATH _`/organizations/{organizationId}/wireless/clients/overview/byDevice`_ + +> \- Path added +> +> \- New endpoint +> +> #### List access point client count at the moment in an organization +> +> **GET** `/organizations/{organizationId}/wireless/clients/overview/byDevice` +> +> { +> "items": [ +> { +> "network": { +> "id": "N_24329156" +> }, +> "serial": "Q234-ABCD-5678", +> "counts": { +> "byStatus": { +> "online": 1 +> } +> } +> } +> ], +> "meta": { +> "counts": { +> "items": { +> "total": 10, +> "remaining": 0 +> } +> } +> } +> } +> +> * * * + +* * * \ No newline at end of file diff --git a/documents/2024.md b/documents/2024.md index b7ed15b..ae2e22d 100644 --- a/documents/2024.md +++ b/documents/2024.md @@ -1,5 +1,73 @@ +# 10-2024 + +## Dashboard API Release v1.51 +[**Changelog**](https://developer.cisco.com/meraki/api-v1/v1-51-0/) + +## Summary of Changes +- **New Endpoints**: 17 +- **Updated Endpoints**: 51 +- **Total Endpoints**: 760 +- **Total Paths**: 507 + +This release introduces **wireless LAN controller** management capabilities with a suite of new endpoints designed to provide enhanced control and monitoring of wireless infrastructure. These additions enable granular tracking of connectivity status, interface performance, and failover events. + +Key highlights include: +- **Wireless Controller Management**: New endpoints provide functionality for viewing layer 2 and layer 3 interface details, traffic patterns, redundancy statuses, and historical utilization of wireless LAN controllers. +- **Expanded Licensing Capabilities**: Additional properties for subscription SKUs, product classifications, and smart account identifiers are now available. +- **Enhanced Network Monitoring**: Properties related to network and smart account integration provide deeper insights for network configurations. +- **Camera and Switch Stack Updates**: Newly added properties for camera quality retention profiles and switch stack configurations facilitate better device management and visibility. + + +## What's New + +\[ organizations \] +------------------- + +### wirelessController + +- [List connectivity data of wireless LAN controllers in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-availabilities-change-history/) +- [List wireless client counts of wireless LAN controllers over time in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-clients-overview-history-by-device-by-interval/) +- [List all access points associated with wireless LAN controllers in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-connections/) +- [List wireless LAN controller layer 2 interfaces in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-l-2-by-device/) +- [List wireless LAN controller layer 2 interfaces history status in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-l-2-statuses-change-history-by-device/) +- [List wireless LAN controller layer 2 interfaces history usage in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-l-2-usage-history-by-interval/) +- [List wireless LAN controller layer 3 interfaces in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-l-3-by-device/) +- [List wireless LAN controller layer 3 interfaces history status in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-l-3-statuses-change-history-by-device/) +- [List wireless LAN controller layer 3 interfaces history usage in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-l-3-usage-history-by-interval/) +- [Retrieve the packet counters for the interfaces of a Wireless LAN controller](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-packets-overview-by-device/) +- [Retrieve the traffic for the interfaces of a Wireless LAN controller](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-interfaces-usage-history-by-interval/) +- [List the failover events of wireless LAN controllers in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-redundancy-failover-history/) +- [List redundancy details of wireless LAN controllers in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-controller-devices-redundancy-statuses/) + +## What's Updated + +### Licensing +- **Properties Added**: `skus`, `productClass`, `productType` + - [Retrieve the list of purchasable entitlements](https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-entitlements) + - [Claim a subscription into an organization](https://developer.cisco.com/meraki/api-v1/claim-administered-licensing-subscription-subscriptions) + +### Devices +- **Properties Added**: `deviceMac` + - [List LLDP and CDP information for a device](https://developer.cisco.com/meraki/api-v1/get-device-lldp-cdp) + +### Networks +- **Property Added**: `smartAccount` + - [List the networks that the user has privileges on in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-networks) + - [Create a network](https://developer.cisco.com/meraki/api-v1/create-organization-network) + +### Cameras +- **Property Added**: `MV23`, `MV73` + - [Create a new quality retention profile](https://developer.cisco.com/meraki/api-v1/create-network-camera-quality-retention-profile) + - [Update an existing quality retention profile](https://developer.cisco.com/meraki/api-v1/update-network-camera-quality-retention-profile) + +### Switch Stacks +- **Properties Added**: `isMonitorOnly`, `members` + - [List the switch stacks in a network](https://developer.cisco.com/meraki/api-v1/get-network-switch-stacks) + - [Show a switch stack](https://developer.cisco.com/meraki/api-v1/get-network-switch-stack) + + # 09-2024 ## Dashboard API Release v1.50 @@ -11,7 +79,7 @@ - **Total Endpoints**: 743 - **Total Paths**: 490 -This version introduces new eSIM management endpoints and updates to licensing, device details, network virtualization, camera retention profiles, and switch stacks with additional properties and parameters to enhance functionality. +This version introduces new eSIM management endpoints and updates to licensing, device details, camera retention profiles, and switch stacks with additional properties and parameters to enhance functionality. ## What's New @@ -41,17 +109,6 @@ This version introduces new eSIM management endpoints and updates to licensing, - **Properties Added**: `name`, `model`, `version`, `device` - [List LLDP and CDP information for a device](https://developer.cisco.com/meraki/api-v1/get-device-lldp-cdp/) -### Networks -- **Property Added**: `isVirtual` - - [Return a network](https://developer.cisco.com/meraki/api-v1/get-network) - - [Split a combined network](https://developer.cisco.com/meraki/api-v1/split-network/) - - [Unbind a network from a template](https://developer.cisco.com/meraki/api-v1/unbind-network/) - - [Update a network](https://developer.cisco.com/meraki/api-v1/update-network) - - [List the networks eligible for cloud monitoring](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-networks) - - [List the networks with user privileges](https://developer.cisco.com/meraki/api-v1/get-organization-networks) - - [Create a network](https://developer.cisco.com/meraki/api-v1/create-organization-network/) - - [Combine multiple networks into a single network](https://developer.cisco.com/meraki/api-v1/combine-organization-networks/) - - **Param Added**: `isCatalyst` - [List the events for the network](https://developer.cisco.com/meraki/api-v1/get-network-events)