From ba41bac2d54efdd922514f66fa30bae98ade7d4a Mon Sep 17 00:00:00 2001 From: mdurban Date: Wed, 5 Jun 2024 12:06:01 +0000 Subject: [PATCH] API version v1.47.0 --- openapi/spec2.json | 1789 ++++++++++++++++++++++++++++++++++++--- openapi/spec3.json | 1973 ++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 3488 insertions(+), 274 deletions(-) diff --git a/openapi/spec2.json b/openapi/spec2.json index 04763fb..a978af4 100644 --- a/openapi/spec2.json +++ b/openapi/spec2.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "version": "1.46.0", + "version": "1.47.0", "title": "Meraki Dashboard API", - "description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 01 May, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", + "description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 05 June, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", "contact": { "name": "Meraki Developer Community", "url": "https://meraki.io/community" @@ -1937,7 +1937,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 2.4 GHz. Can be between '5' or '30' or null for using auto power range." + "description": "Set a manual target power for 2.4 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 2.4 GHz." @@ -1992,7 +1992,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range." + "description": "Set a manual target power for 5 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 5 GHz." @@ -4612,11 +4612,11 @@ "properties": { "slot": { "type": "string", - "description": "SIM slot being configured. Must be 'sim1' on single-sim devices." + "description": "SIM slot being configured. Must be 'sim1' on single-sim devices. Use 'sim3' for eSIM." }, "isPrimary": { "type": "boolean", - "description": "If true, this SIM is used for boot. Must be true on single-SIM devices.", + "description": "If true, this SIM is activated on platform bootup. It must be true on single-SIM devices and is a required field for dual-SIM MGs unless it is being configured using 'simOrdering'.", "default": false }, "apns": { @@ -4679,7 +4679,7 @@ "items": { "type": "string" }, - "description": "Specifies which SIMs to use for primary and secondary. Required for devices with 3 or more SIMs." + "description": "Specifies the ordering of all SIMs for an MG: primary, secondary, and not-in-use (when applicable). It's required for devices with 3 or more SIMs and can be used in place of 'isPrimary' for dual-SIM devices. To indicate eSIM, use 'sim3'. Sim failover will occur only between primary and secondary sim slots." }, "simFailover": { "type": "object", @@ -4764,11 +4764,11 @@ "properties": { "slot": { "type": "string", - "description": "SIM slot being configured. Must be 'sim1' on single-sim devices." + "description": "SIM slot being configured. Must be 'sim1' on single-sim devices. Use 'sim3' for eSIM." }, "isPrimary": { "type": "boolean", - "description": "If true, this SIM is used for boot. Must be true on single-SIM devices.", + "description": "If true, this SIM is activated on platform bootup. It must be true on single-SIM devices and is a required field for dual-SIM MGs unless it is being configured using 'simOrdering'.", "default": false }, "apns": { @@ -4883,11 +4883,11 @@ "properties": { "slot": { "type": "string", - "description": "SIM slot being configured. Must be 'sim1' on single-sim devices." + "description": "SIM slot being configured. Must be 'sim1' on single-sim devices. Use 'sim3' for eSIM." }, "isPrimary": { "type": "boolean", - "description": "If true, this SIM is used for boot. Must be true on single-SIM devices.", + "description": "If true, this SIM is activated on platform bootup. It must be true on single-SIM devices and is a required field for dual-SIM MGs unless it is being configured using 'simOrdering'.", "default": false }, "apns": { @@ -4950,7 +4950,7 @@ "items": { "type": "string" }, - "description": "Specifies which SIMs to use for primary and secondary. Required for devices with 3 or more SIMs." + "description": "Specifies the ordering of all SIMs for an MG: primary, secondary, and not-in-use (when applicable). It's required for devices with 3 or more SIMs and can be used in place of 'isPrimary' for dual-SIM devices. To indicate eSIM, use 'sim3'. Sim failover will occur only between primary and secondary sim slots." }, "simFailover": { "type": "object", @@ -5677,7 +5677,7 @@ }, "/devices/{serial}/liveTools/arpTable": { "post": { - "description": "Enqueue a job to perform a ARP table request for the device. This endpoint currently supports switches.", + "description": "Enqueue a job to perform a ARP table request for the device. This endpoint currently supports switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.", "operationId": "createDeviceLiveToolsArpTable", "parameters": [ { @@ -6639,7 +6639,7 @@ }, "/devices/{serial}/liveTools/pingDevice": { "post": { - "description": "Enqueue a job to check connectivity status to the device", + "description": "Enqueue a job to check connectivity status to the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.", "operationId": "createDeviceLiveToolsPingDevice", "parameters": [ { @@ -6988,7 +6988,7 @@ }, "/devices/{serial}/liveTools/throughputTest": { "post": { - "description": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput", + "description": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput. This endpoint has a rate limit of one request every five seconds per device.", "operationId": "createDeviceLiveToolsThroughputTest", "parameters": [ { @@ -7271,7 +7271,7 @@ }, "/devices/{serial}/liveTools/wakeOnLan": { "post": { - "description": "Enqueue a job to send a Wake-on-LAN packet from the device", + "description": "Enqueue a job to send a Wake-on-LAN packet from the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.", "operationId": "createDeviceLiveToolsWakeOnLan", "parameters": [ { @@ -8205,7 +8205,7 @@ }, "/devices/{serial}/reboot": { "post": { - "description": "Reboot a device", + "description": "Reboot a device. This endpoint has a sustained rate limit of one request every 60 seconds.", "operationId": "rebootDevice", "parameters": [ { @@ -9060,8 +9060,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -9921,8 +9921,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -10146,8 +10146,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -10383,8 +10383,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -12729,6 +12729,165 @@ ] } }, + "/devices/{serial}/wireless/electronicShelfLabel": { + "get": { + "description": "Return the ESL settings of a device", + "operationId": "getDeviceWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "serial", + "in": "path", + "description": "Serial", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "apEslId": { + "type": "integer", + "description": "An identifier for the device used by the ESL system" + }, + "serial": { + "type": "string", + "description": "The serial number of the device" + }, + "channel": { + "type": "string", + "description": "Desired ESL channel for the device, or 'Auto' (case insensitive) to use the recommended channel" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this device" + }, + "networkId": { + "type": "string", + "description": "The identifier for the device's network" + }, + "hostname": { + "type": "string", + "description": "Hostname of the ESL management service" + }, + "provider": { + "type": "string", + "description": "The service providing ESL functionality" + } + } + }, + "examples": { + "application/json": { + "apEslId": 16777216, + "serial": "Q234-ABCD-5678", + "channel": "1", + "enabled": true, + "networkId": "N_24329156", + "hostname": "localhost:700", + "provider": "imagotag" + } + } + } + }, + "summary": "Return the ESL settings of a device", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + }, + "put": { + "description": "Update the ESL settings of a device", + "operationId": "updateDeviceWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "serial", + "in": "path", + "description": "Serial", + "type": "string", + "required": true + }, + { + "name": "updateDeviceWirelessElectronicShelfLabel", + "in": "body", + "schema": { + "type": "object", + "properties": { + "channel": { + "type": "string", + "description": "Desired ESL channel for the device, or 'Auto' (case insensitive) to use the recommended channel" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this device" + } + }, + "example": { + "channel": "1", + "enabled": true + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "apEslId": { + "type": "integer", + "description": "An identifier for the device used by the ESL system" + }, + "serial": { + "type": "string", + "description": "The serial number of the device" + }, + "channel": { + "type": "string", + "description": "Desired ESL channel for the device, or 'Auto' (case insensitive) to use the recommended channel" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this device" + }, + "networkId": { + "type": "string", + "description": "The identifier for the device's network" + }, + "hostname": { + "type": "string", + "description": "Hostname of the ESL management service" + }, + "provider": { + "type": "string", + "description": "The service providing ESL functionality" + } + } + }, + "examples": { + "application/json": { + "apEslId": 16777216, + "serial": "Q234-ABCD-5678", + "channel": "1", + "enabled": true, + "networkId": "N_24329156", + "hostname": "localhost:700", + "provider": "imagotag" + } + } + } + }, + "summary": "Update the ESL settings of a device", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + } + }, "/devices/{serial}/wireless/latencyStats": { "get": { "description": "Aggregated latency info for a given AP on this network", @@ -12931,7 +13090,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 2.4 GHz. Can be between '5' or '30' or null for using auto power range." + "description": "Set a manual target power for 2.4 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 2.4 GHz." @@ -12986,7 +13145,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range." + "description": "Set a manual target power for 5 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 5 GHz." @@ -27348,6 +27507,34 @@ ], "description": "Quality and resolution for MV33 camera models." }, + "MV33M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112", + "2880x2880" + ], + "description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV33M camera models." + }, "MV12WE": { "type": "object", "properties": { @@ -27403,6 +27590,34 @@ ], "description": "Quality and resolution for MV13 camera models." }, + "MV13M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512", + "3840x2160" + ], + "description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV13M camera models." + }, "MV22X/MV72X": { "type": "object", "properties": { @@ -27487,6 +27702,33 @@ ], "description": "Quality and resolution for MV63 camera models." }, + "MV63M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512" + ], + "description": "Resolution of the camera. Can be one of '1920x1080' or '2688x1512'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV63M camera models." + }, "MV93": { "type": "object", "properties": { @@ -27514,6 +27756,33 @@ ], "description": "Quality and resolution for MV93 camera models." }, + "MV93M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112" + ], + "description": "Resolution of the camera. Can be one of '1080x1080' or '2112x2112'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV93M camera models." + }, "MV63X": { "type": "object", "properties": { @@ -27866,6 +28135,34 @@ ], "description": "Quality and resolution for MV33 camera models." }, + "MV33M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112", + "2880x2880" + ], + "description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV33M camera models." + }, "MV12WE": { "type": "object", "properties": { @@ -27921,6 +28218,34 @@ ], "description": "Quality and resolution for MV13 camera models." }, + "MV13M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512", + "3840x2160" + ], + "description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV13M camera models." + }, "MV22X/MV72X": { "type": "object", "properties": { @@ -28005,6 +28330,33 @@ ], "description": "Quality and resolution for MV63 camera models." }, + "MV63M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512" + ], + "description": "Resolution of the camera. Can be one of '1920x1080' or '2688x1512'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV63M camera models." + }, "MV93": { "type": "object", "properties": { @@ -28032,6 +28384,33 @@ ], "description": "Quality and resolution for MV93 camera models." }, + "MV93M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112" + ], + "description": "Resolution of the camera. Can be one of '1080x1080' or '2112x2112'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV93M camera models." + }, "MV63X": { "type": "object", "properties": { @@ -30933,6 +31312,10 @@ "Online" ], "description": "The connection status of the client" + }, + "notes": { + "type": "string", + "description": "The notes associated with the client" } } }, @@ -31014,7 +31397,8 @@ "Two-port MAC Relay" ] ], - "status": "Online" + "status": "Online", + "notes": "My client note" } } } @@ -31801,6 +32185,12 @@ "type": "string", "required": true }, + { + "type": "boolean", + "name": "addAtomically", + "in": "query", + "description": "Whether to claim devices atomically. If true, all devices will be claimed or none will be claimed. Default is true." + }, { "name": "claimNetworkDevices", "in": "body", @@ -31820,7 +32210,8 @@ "Q234-ABCD-0001", "Q234-ABCD-0002", "Q234-ABCD-0003" - ] + ], + "addAtomically": true }, "required": [ "serials" @@ -31841,6 +32232,30 @@ "type": "string" }, "description": "The serials of the devices" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serial": { + "type": "string", + "description": "The serial of the device" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The errors for the device" + } + }, + "required": [ + "serial", + "errors" + ] + }, + "description": "Errors for devices that were not added" } } }, @@ -31850,6 +32265,14 @@ "Q234-ABCD-0001", "Q234-ABCD-0002", "Q234-ABCD-0003" + ], + "errors": [ + { + "serial": "Q234-ABCD-5678", + "errors": [ + "Device already claimed" + ] + } ] } } @@ -43863,6 +44286,7 @@ }, "/networks/{networkId}/health/alerts": { "get": { + "deprecated": true, "description": "Return all global alerts on this network", "operationId": "getNetworkHealthAlerts", "parameters": [ @@ -47023,6 +47447,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -47299,6 +47743,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -47521,6 +47969,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -47788,6 +48256,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -48003,6 +48475,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -48277,6 +48769,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -48516,6 +49012,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -48790,6 +49306,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -49018,6 +49538,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -49285,6 +49825,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -49495,6 +50039,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -49769,6 +50333,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -54975,7 +55543,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -55021,6 +55589,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -55048,7 +55630,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -55164,7 +55746,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -55234,10 +55820,6 @@ "items": { "type": "object", "properties": { - "serverId": { - "type": "string", - "description": "unique ID of the RADIUS server" - }, "organizationRadiusServerId": { "type": "string", "description": "Organization wide RADIUS server ID. If this field is provided, the host, port and secret field will be ignored" @@ -55286,6 +55868,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -55311,10 +55907,6 @@ "items": { "type": "object", "properties": { - "serverId": { - "type": "string", - "description": "unique ID of the RADIUS accounting server" - }, "organizationRadiusServerId": { "type": "string", "description": "Organization wide RADIUS server ID. If this field is provided, the host, port and secret field will be ignored" @@ -55400,7 +55992,6 @@ "name": "Access policy #1", "radiusServers": [ { - "serverId": "1", "organizationRadiusServerId": "42", "host": "1.2.3.4", "port": 22, @@ -55414,7 +56005,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -55422,7 +56017,6 @@ "radiusAccountingEnabled": true, "radiusAccountingServers": [ { - "serverId": "2", "organizationRadiusServerId": "42", "host": "1.2.3.4", "port": 22, @@ -55473,7 +56067,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -55519,6 +56113,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -55546,7 +56154,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -55660,7 +56268,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -55741,7 +56353,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -55787,6 +56399,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -55814,7 +56440,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -55928,7 +56554,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -56006,7 +56636,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server" + "description": "Unique ID of the RADIUS server. Leave this empty when new entry is created" }, "organizationRadiusServerId": { "type": "string", @@ -56056,6 +56686,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -56083,7 +56727,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server" + "description": "Unique ID of the RADIUS accounting server. Leave this empty when new entry is created" }, "organizationRadiusServerId": { "type": "string", @@ -56184,7 +56828,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -56233,7 +56881,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -56279,6 +56927,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -56306,7 +56968,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -56420,7 +57082,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -70477,6 +71143,166 @@ ] } }, + "/networks/{networkId}/wireless/electronicShelfLabel": { + "get": { + "description": "Return the ESL settings of a wireless network", + "operationId": "getNetworkWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "networkId", + "in": "path", + "description": "Network ID", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + } + }, + "examples": { + "application/json": { + "hostname": "N_24329156", + "enabled": true + } + } + } + }, + "summary": "Return the ESL settings of a wireless network", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + }, + "put": { + "description": "Update the ESL settings of a wireless network", + "operationId": "updateNetworkWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "networkId", + "in": "path", + "description": "Network ID", + "type": "string", + "required": true + }, + { + "name": "updateNetworkWirelessElectronicShelfLabel", + "in": "body", + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + }, + "example": { + "hostname": "N_24329156", + "enabled": true + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + } + }, + "examples": { + "application/json": { + "hostname": "N_24329156", + "enabled": true + } + } + } + }, + "summary": "Update the ESL settings of a wireless network", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + } + }, + "/networks/{networkId}/wireless/electronicShelfLabel/configuredDevices": { + "get": { + "description": "Get a list of all ESL eligible devices of a network", + "operationId": "getNetworkWirelessElectronicShelfLabelConfiguredDevices", + "parameters": [ + { + "name": "networkId", + "in": "path", + "description": "Network ID", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + } + } + }, + "examples": { + "application/json": [ + { + "hostname": "N_24329156", + "enabled": true + } + ] + } + } + }, + "summary": "Get a list of all ESL eligible devices of a network", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel", + "configuredDevices" + ] + } + }, "/networks/{networkId}/wireless/ethernet/ports/profiles": { "get": { "description": "List the AP port profiles for this network", @@ -79301,6 +80127,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -79639,6 +80466,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -80048,6 +80876,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -80057,7 +80886,7 @@ "Sponsored guest", "Systems Manager Sentry" ], - "description": "The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth', 'Sponsored guest', 'Cisco ISE' or 'Google Apps domain'). This attribute is not supported for template children." + "description": "The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth', 'Microsoft Entra ID', 'Sponsored guest', 'Cisco ISE' or 'Google Apps domain'). This attribute is not supported for template children." }, "splashGuestSponsorDomains": { "type": "array", @@ -80801,6 +81630,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -83479,6 +84309,24 @@ }, "splashTimeout": { "type": "integer", + "enum": [ + 30, + 60, + 120, + 240, + 480, + 720, + 1080, + 1440, + 2880, + 5760, + 7200, + 10080, + 20160, + 43200, + 86400, + 129600 + ], "description": "Splash timeout in minutes." }, "redirectUrl": { @@ -83744,6 +84592,24 @@ }, "splashTimeout": { "type": "integer", + "enum": [ + 30, + 60, + 120, + 240, + 480, + 720, + 1080, + 1440, + 2880, + 5760, + 7200, + 10080, + 20160, + 43200, + 86400, + 129600 + ], "description": "Splash timeout in minutes. This will determine how often users will see the splash page." }, "redirectUrl": { @@ -84043,6 +84909,24 @@ }, "splashTimeout": { "type": "integer", + "enum": [ + 30, + 60, + 120, + 240, + 480, + 720, + 1080, + 1440, + 2880, + 5760, + 7200, + 10080, + 20160, + 43200, + 86400, + 129600 + ], "description": "Splash timeout in minutes." }, "redirectUrl": { @@ -93128,6 +94012,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -93477,7 +94362,7 @@ "summary": "Return all health alerts for an organization", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -93503,15 +94388,15 @@ "alertIds": { "type": "array", "items": { - "type": "integer" + "type": "string" }, - "description": "Parameter to dismiss alerts by ID" + "description": "Array of alert IDs to dismiss" } }, "example": { "alertIds": [ - 123, - 456 + "1234", + "4567" ] }, "required": [ @@ -93529,7 +94414,7 @@ "summary": "Dismiss health alerts", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -93679,6 +94564,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -93877,7 +94763,7 @@ "summary": "Return overview of active health alerts for an organization", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview" ] @@ -94056,6 +94942,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -94300,7 +95187,7 @@ "summary": "Return a Summary of Alerts grouped by network and severity", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview", "byNetwork" @@ -94480,6 +95367,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -94703,7 +95591,7 @@ "summary": "Return a Summary of Alerts grouped by type and severity", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview", "byType" @@ -94862,6 +95750,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -95087,7 +95976,7 @@ "summary": "Returns historical health alert overviews", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview", "historical" @@ -95115,15 +96004,15 @@ "alertIds": { "type": "array", "items": { - "type": "integer" + "type": "string" }, - "description": "Parameter to restore alerts by ID" + "description": "Array of alert IDs to restore" } }, "example": { "alertIds": [ - 123, - 456 + "1234", + "4567" ] }, "required": [ @@ -95141,7 +96030,7 @@ "summary": "Restore health alerts from dismissed", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -95350,7 +96239,7 @@ "summary": "Return a singular Health Alert by its id", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -98770,6 +99659,36 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -98780,15 +99699,15 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -100100,8 +101019,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -100378,8 +101297,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -100609,8 +101528,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -100836,8 +101755,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -102826,6 +103745,16 @@ } }, "description": "Public interface information." + }, + "vlan": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VLAN ID of the uplink interface" + } + }, + "description": "VLAN information of the uplink interface" } } }, @@ -102869,6 +103798,9 @@ "gateway": "fe80:db8:c15:c0:d0c::10ca:1d02", "public": { "address": "2001:db8:c15:c0:d0c:15e:15e:bab1" + }, + "vlan": { + "id": "1" } } ] @@ -108571,6 +109503,25 @@ "in": "query", "description": "An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appliance", + "camera", + "cellularGateway", + "secureConnect", + "sensor", + "switch", + "systemsManager", + "wireless" + ] + }, + "name": "productTypes", + "in": "query", + "description": "An optional parameter to filter networks by product type. Results will have at least one of the included product types." + }, { "type": "integer", "name": "perPage", @@ -113913,15 +114864,15 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -113977,6 +114928,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -113987,16 +114974,16 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", "minimum": 1500, - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -114089,6 +115076,265 @@ ] } }, + "/organizations/{organizationId}/summary/top/applications/byUsage": { + "get": { + "description": "Return the top applications sorted by data usage over given time range. Default unit is megabytes.", + "operationId": "getOrganizationSummaryTopApplicationsByUsage", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "device", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, + { + "type": "string", + "name": "t0", + "in": "query", + "description": "The beginning of the timespan for the data." + }, + { + "type": "string", + "name": "t1", + "in": "query", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." + }, + { + "type": "number", + "format": "float", + "minimum": 1500, + "maximum": 16070400, + "name": "timespan", + "in": "query", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "application": { + "type": "string", + "description": "Name of the Application" + }, + "total": { + "type": "number", + "format": "float", + "description": "Total usage of the Application, in megabytes" + }, + "downstream": { + "type": "number", + "format": "float", + "description": "Downstream usage of the Application, in megabytes" + }, + "upstream": { + "type": "number", + "format": "float", + "description": "Upstream usage of the Application, in megabytes" + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percent usage of the Application" + } + } + } + }, + "examples": { + "application/json": [ + { + "application": "sample name", + "total": 18000.0, + "downstream": 10000.0, + "upstream": 8000.0, + "percentage": 80.223456789 + } + ] + } + } + }, + "summary": "Return the top applications sorted by data usage over given time range", + "tags": [ + "organizations", + "monitor", + "summary", + "top", + "applications", + "byUsage" + ] + } + }, + "/organizations/{organizationId}/summary/top/applications/categories/byUsage": { + "get": { + "description": "Return the top application categories sorted by data usage over given time range. Default unit is megabytes.", + "operationId": "getOrganizationSummaryTopApplicationsCategoriesByUsage", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, + { + "type": "string", + "name": "t0", + "in": "query", + "description": "The beginning of the timespan for the data." + }, + { + "type": "string", + "name": "t1", + "in": "query", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." + }, + { + "type": "number", + "format": "float", + "minimum": 1500, + "maximum": 16070400, + "name": "timespan", + "in": "query", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Name of the Application Category" + }, + "total": { + "type": "number", + "format": "float", + "description": "Total usage of the Application Category, in megabytes" + }, + "downstream": { + "type": "number", + "format": "float", + "description": "Downstream usage of the Application Category, in megabytes" + }, + "upstream": { + "type": "number", + "format": "float", + "description": "Upstream usage of the Application Category, in megabytes" + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percent usage of the Application Category" + } + } + } + }, + "examples": { + "application/json": [ + { + "category": "other", + "total": 18000.0, + "downstream": 10000.0, + "upstream": 8000.0, + "percentage": 80.223456789 + } + ] + } + } + }, + "summary": "Return the top application categories sorted by data usage over given time range", + "tags": [ + "organizations", + "monitor", + "summary", + "top", + "applications", + "categories", + "byUsage" + ] + } + }, "/organizations/{organizationId}/summary/top/clients/byUsage": { "get": { "description": "Return metrics for organization's top 10 clients by data usage (in mb) over given time range.", @@ -114101,6 +115347,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -114111,16 +115393,16 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -114230,6 +115512,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -114240,15 +115558,15 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -114346,6 +115664,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -114356,16 +115710,16 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -114494,6 +115848,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -114504,16 +115894,16 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -114589,6 +115979,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "integer", "name": "perPage", @@ -114825,6 +116251,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -114835,16 +116297,16 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -114947,6 +116409,42 @@ "type": "string", "required": true }, + { + "type": "string", + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag" + }, + { + "type": "string", + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag" + }, + { + "type": "string", + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id" + }, + { + "type": "integer", + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10." + }, + { + "type": "string", + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name" + }, + { + "type": "string", + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink" + }, { "type": "string", "name": "t0", @@ -114957,16 +116455,16 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", "minimum": 1500, - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -115162,49 +116660,56 @@ "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it." }, { - "type": "array", - "items": { - "type": "string" - }, - "name": "networkIds", + "type": "string", + "format": "date-time", + "name": "configurationUpdatedAfter", "in": "query", - "description": "Optional parameter to filter switchports by network." + "description": "Optional parameter to filter items to switches where the configuration has been updated after the given timestamp." + }, + { + "type": "string", + "name": "mac", + "in": "query", + "description": "Optional parameter to filter items to switches with MAC addresses that contain the search term or are an exact match." }, { "type": "array", "items": { "type": "string" }, - "name": "portProfileIds", + "name": "macs", "in": "query", - "description": "Optional parameter to filter switchports belonging to the specified port profiles." + "description": "Optional parameter to filter items to switches that have one of the provided MAC addresses." }, { "type": "string", "name": "name", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match." + "description": "Optional parameter to filter items to switches with names that contain the search term or are an exact match." }, { - "type": "string", - "name": "mac", + "type": "array", + "items": { + "type": "string" + }, + "name": "networkIds", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match." + "description": "Optional parameter to filter items to switches in one of the provided networks." }, { "type": "array", "items": { "type": "string" }, - "name": "macs", + "name": "portProfileIds", "in": "query", - "description": "Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match." + "description": "Optional parameter to filter items to switches that contain switchports belonging to one of the specified port profiles." }, { "type": "string", "name": "serial", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match." + "description": "Optional parameter to filter items to switches with serial number that contains the search term or are an exact match." }, { "type": "array", @@ -115213,13 +116718,7 @@ }, "name": "serials", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match." - }, - { - "type": "string", - "name": "configurationUpdatedAfter", - "in": "query", - "description": "Optional parameter to filter results by switches where the configuration has been updated after the given timestamp." + "description": "Optional parameter to filter items to switches that have one of the provided serials." } ], "responses": { @@ -115433,16 +116932,16 @@ "type": "string", "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "type": "number", "format": "float", "minimum": 43200, - "maximum": 2678400, + "maximum": 16070400, "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 12 hours and be less than or equal to 31 days. The default is 1 day." + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 12 hours and be less than or equal to 186 days. The default is 1 day." } ], "responses": { @@ -118766,7 +120265,7 @@ "summary": "List status information of all BSSIDs in your organization", "tags": [ "wireless", - "configure", + "monitor", "ssids", "statuses", "byDevice" @@ -119018,6 +120517,9 @@ { "name": "configure" }, + { + "name": "configuredDevices" + }, { "name": "connectionStats" }, @@ -119084,6 +120586,9 @@ { "name": "earlyAccess" }, + { + "name": "electronicShelfLabel" + }, { "name": "entitlements" }, @@ -119932,6 +121437,18 @@ "resource": "/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}", "operation": "update" }, + { + "group": "Esl network settings", + "summary": "Update the ESL settings of a wireless network", + "resource": "/networks/{networkId}/wireless/electronicShelfLabel", + "operation": "update" + }, + { + "group": "Esl node settings", + "summary": "Update the ESL settings of a device", + "resource": "/devices/{serial}/wireless/electronicShelfLabel", + "operation": "update" + }, { "group": "Feature opt in", "summary": "Update an early access feature opt-in for an organization", @@ -120240,7 +121757,7 @@ }, { "group": "Ms/live tools/actions/perform throughput", - "summary": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput", + "summary": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput. This endpoint has a rate limit of one request every five seconds per device.", "resource": "/devices/{serial}/liveTools/throughputTest", "operation": "test" }, @@ -120857,10 +122374,10 @@ "operation": "update" }, { - "group": "Wired/actions/bgp settings", + "group": "Wired/actions/bgp", "summary": "Update a Hub BGP Configuration", "resource": "/networks/{networkId}/appliance/vpn/bgp", - "operation": "update" + "operation": "settings/update" }, { "group": "Wired/actions/vpn exclusions", diff --git a/openapi/spec3.json b/openapi/spec3.json index 680e770..b49a16c 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -2,12 +2,12 @@ "openapi": "3.0.1", "info": { "title": "Meraki Dashboard API", - "description": "A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 01 May, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", + "description": "A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 05 June, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", "contact": { "name": "Meraki Developer Community", "url": "https://meraki.io/community" }, - "version": "1.46.0" + "version": "1.47.0" }, "servers": [ { @@ -2096,7 +2096,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 2.4 GHz. Can be between '5' or '30' or null for using auto power range." + "description": "Set a manual target power for 2.4 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 2.4 GHz." @@ -2151,7 +2151,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range." + "description": "Set a manual target power for 5 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 5 GHz." @@ -4913,11 +4913,11 @@ "properties": { "slot": { "type": "string", - "description": "SIM slot being configured. Must be 'sim1' on single-sim devices." + "description": "SIM slot being configured. Must be 'sim1' on single-sim devices. Use 'sim3' for eSIM." }, "isPrimary": { "type": "boolean", - "description": "If true, this SIM is used for boot. Must be true on single-SIM devices.", + "description": "If true, this SIM is activated on platform bootup. It must be true on single-SIM devices and is a required field for dual-SIM MGs unless it is being configured using 'simOrdering'.", "default": false }, "apns": { @@ -4980,7 +4980,7 @@ "items": { "type": "string" }, - "description": "Specifies which SIMs to use for primary and secondary. Required for devices with 3 or more SIMs." + "description": "Specifies the ordering of all SIMs for an MG: primary, secondary, and not-in-use (when applicable). It's required for devices with 3 or more SIMs and can be used in place of 'isPrimary' for dual-SIM devices. To indicate eSIM, use 'sim3'. Sim failover will occur only between primary and secondary sim slots." }, "simFailover": { "type": "object", @@ -5068,11 +5068,11 @@ "properties": { "slot": { "type": "string", - "description": "SIM slot being configured. Must be 'sim1' on single-sim devices." + "description": "SIM slot being configured. Must be 'sim1' on single-sim devices. Use 'sim3' for eSIM." }, "isPrimary": { "type": "boolean", - "description": "If true, this SIM is used for boot. Must be true on single-SIM devices.", + "description": "If true, this SIM is activated on platform bootup. It must be true on single-SIM devices and is a required field for dual-SIM MGs unless it is being configured using 'simOrdering'.", "default": false }, "apns": { @@ -5191,11 +5191,11 @@ "properties": { "slot": { "type": "string", - "description": "SIM slot being configured. Must be 'sim1' on single-sim devices." + "description": "SIM slot being configured. Must be 'sim1' on single-sim devices. Use 'sim3' for eSIM." }, "isPrimary": { "type": "boolean", - "description": "If true, this SIM is used for boot. Must be true on single-SIM devices.", + "description": "If true, this SIM is activated on platform bootup. It must be true on single-SIM devices and is a required field for dual-SIM MGs unless it is being configured using 'simOrdering'.", "default": false }, "apns": { @@ -5258,7 +5258,7 @@ "items": { "type": "string" }, - "description": "Specifies which SIMs to use for primary and secondary. Required for devices with 3 or more SIMs." + "description": "Specifies the ordering of all SIMs for an MG: primary, secondary, and not-in-use (when applicable). It's required for devices with 3 or more SIMs and can be used in place of 'isPrimary' for dual-SIM devices. To indicate eSIM, use 'sim3'. Sim failover will occur only between primary and secondary sim slots." }, "simFailover": { "type": "object", @@ -6134,7 +6134,7 @@ } } }, - "description": "Enqueue a job to perform a ARP table request for the device. This endpoint currently supports switches.", + "description": "Enqueue a job to perform a ARP table request for the device. This endpoint currently supports switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.", "operationId": "createDeviceLiveToolsArpTable", "parameters": [ { @@ -7621,7 +7621,7 @@ } } }, - "description": "Enqueue a job to check connectivity status to the device", + "description": "Enqueue a job to check connectivity status to the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.", "operationId": "createDeviceLiveToolsPingDevice", "parameters": [ { @@ -8093,7 +8093,7 @@ } } }, - "description": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput", + "description": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput. This endpoint has a rate limit of one request every five seconds per device.", "operationId": "createDeviceLiveToolsThroughputTest", "parameters": [ { @@ -8490,7 +8490,7 @@ } } }, - "description": "Enqueue a job to send a Wake-on-LAN packet from the device", + "description": "Enqueue a job to send a Wake-on-LAN packet from the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.", "operationId": "createDeviceLiveToolsWakeOnLan", "parameters": [ { @@ -9467,7 +9467,7 @@ }, "/devices/{serial}/reboot": { "post": { - "description": "Reboot a device", + "description": "Reboot a device. This endpoint has a sustained rate limit of one request every 60 seconds.", "operationId": "rebootDevice", "parameters": [ { @@ -10374,8 +10374,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -11263,8 +11263,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -11494,8 +11494,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -11734,8 +11734,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -14201,6 +14201,176 @@ ] } }, + "/devices/{serial}/wireless/electronicShelfLabel": { + "get": { + "description": "Return the ESL settings of a device", + "operationId": "getDeviceWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "serial", + "in": "path", + "description": "Serial", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apEslId": { + "type": "integer", + "description": "An identifier for the device used by the ESL system" + }, + "serial": { + "type": "string", + "description": "The serial number of the device" + }, + "channel": { + "type": "string", + "description": "Desired ESL channel for the device, or 'Auto' (case insensitive) to use the recommended channel" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this device" + }, + "networkId": { + "type": "string", + "description": "The identifier for the device's network" + }, + "hostname": { + "type": "string", + "description": "Hostname of the ESL management service" + }, + "provider": { + "type": "string", + "description": "The service providing ESL functionality" + } + } + }, + "example": { + "apEslId": 16777216, + "serial": "Q234-ABCD-5678", + "channel": "1", + "enabled": true, + "networkId": "N_24329156", + "hostname": "localhost:700", + "provider": "imagotag" + } + } + } + } + }, + "summary": "Return the ESL settings of a device", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + }, + "put": { + "description": "Update the ESL settings of a device", + "operationId": "updateDeviceWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "serial", + "in": "path", + "description": "Serial", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "channel": { + "type": "string", + "description": "Desired ESL channel for the device, or 'Auto' (case insensitive) to use the recommended channel" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this device" + } + }, + "example": { + "channel": "1", + "enabled": true + } + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apEslId": { + "type": "integer", + "description": "An identifier for the device used by the ESL system" + }, + "serial": { + "type": "string", + "description": "The serial number of the device" + }, + "channel": { + "type": "string", + "description": "Desired ESL channel for the device, or 'Auto' (case insensitive) to use the recommended channel" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this device" + }, + "networkId": { + "type": "string", + "description": "The identifier for the device's network" + }, + "hostname": { + "type": "string", + "description": "Hostname of the ESL management service" + }, + "provider": { + "type": "string", + "description": "The service providing ESL functionality" + } + } + }, + "example": { + "apEslId": 16777216, + "serial": "Q234-ABCD-5678", + "channel": "1", + "enabled": true, + "networkId": "N_24329156", + "hostname": "localhost:700", + "provider": "imagotag" + } + } + } + } + }, + "summary": "Update the ESL settings of a device", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + } + }, "/devices/{serial}/wireless/latencyStats": { "get": { "description": "Aggregated latency info for a given AP on this network", @@ -14430,7 +14600,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 2.4 GHz. Can be between '5' or '30' or null for using auto power range." + "description": "Set a manual target power for 2.4 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 2.4 GHz." @@ -14485,7 +14655,7 @@ }, "targetPower": { "type": "integer", - "description": "Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range." + "description": "Set a manual target power for 5 GHz (dBm). Enter null for using auto power range." } }, "description": "Manual radio settings for 5 GHz." @@ -29459,6 +29629,34 @@ ], "description": "Quality and resolution for MV33 camera models." }, + "MV33M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112", + "2880x2880" + ], + "description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV33M camera models." + }, "MV12WE": { "type": "object", "properties": { @@ -29514,6 +29712,34 @@ ], "description": "Quality and resolution for MV13 camera models." }, + "MV13M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512", + "3840x2160" + ], + "description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV13M camera models." + }, "MV22X/MV72X": { "type": "object", "properties": { @@ -29598,6 +29824,33 @@ ], "description": "Quality and resolution for MV63 camera models." }, + "MV63M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512" + ], + "description": "Resolution of the camera. Can be one of '1920x1080' or '2688x1512'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV63M camera models." + }, "MV93": { "type": "object", "properties": { @@ -29625,6 +29878,33 @@ ], "description": "Quality and resolution for MV93 camera models." }, + "MV93M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112" + ], + "description": "Resolution of the camera. Can be one of '1080x1080' or '2112x2112'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV93M camera models." + }, "MV63X": { "type": "object", "properties": { @@ -29991,6 +30271,34 @@ ], "description": "Quality and resolution for MV33 camera models." }, + "MV33M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112", + "2880x2880" + ], + "description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV33M camera models." + }, "MV12WE": { "type": "object", "properties": { @@ -30046,6 +30354,34 @@ ], "description": "Quality and resolution for MV13 camera models." }, + "MV13M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512", + "3840x2160" + ], + "description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV13M camera models." + }, "MV22X/MV72X": { "type": "object", "properties": { @@ -30130,6 +30466,33 @@ ], "description": "Quality and resolution for MV63 camera models." }, + "MV63M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1920x1080", + "2688x1512" + ], + "description": "Resolution of the camera. Can be one of '1920x1080' or '2688x1512'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV63M camera models." + }, "MV93": { "type": "object", "properties": { @@ -30157,6 +30520,33 @@ ], "description": "Quality and resolution for MV93 camera models." }, + "MV93M": { + "type": "object", + "properties": { + "quality": { + "type": "string", + "enum": [ + "Enhanced", + "High", + "Standard" + ], + "description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'." + }, + "resolution": { + "type": "string", + "enum": [ + "1080x1080", + "2112x2112" + ], + "description": "Resolution of the camera. Can be one of '1080x1080' or '2112x2112'." + } + }, + "required": [ + "quality", + "resolution" + ], + "description": "Quality and resolution for MV93M camera models." + }, "MV63X": { "type": "object", "properties": { @@ -33267,6 +33657,10 @@ "Online" ], "description": "The connection status of the client" + }, + "notes": { + "type": "string", + "description": "The notes associated with the client" } } }, @@ -33347,7 +33741,8 @@ "Two-port MAC Relay" ] ], - "status": "Online" + "status": "Online", + "notes": "My client note" } } } @@ -34188,6 +34583,14 @@ "type": "string" }, "required": true + }, + { + "name": "addAtomically", + "in": "query", + "description": "Whether to claim devices atomically. If true, all devices will be claimed or none will be claimed. Default is true.", + "schema": { + "type": "boolean" + } } ], "requestBody": { @@ -34209,7 +34612,8 @@ "Q234-ABCD-0001", "Q234-ABCD-0002", "Q234-ABCD-0003" - ] + ], + "addAtomically": true }, "required": [ "serials" @@ -34233,6 +34637,30 @@ "type": "string" }, "description": "The serials of the devices" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "serial": { + "type": "string", + "description": "The serial of the device" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The errors for the device" + } + }, + "required": [ + "serial", + "errors" + ] + }, + "description": "Errors for devices that were not added" } } }, @@ -34241,6 +34669,14 @@ "Q234-ABCD-0001", "Q234-ABCD-0002", "Q234-ABCD-0003" + ], + "errors": [ + { + "serial": "Q234-ABCD-5678", + "errors": [ + "Device already claimed" + ] + } ] } } @@ -46447,6 +46883,7 @@ }, "/networks/{networkId}/health/alerts": { "get": { + "deprecated": true, "description": "Return all global alerts on this network", "operationId": "getNetworkHealthAlerts", "parameters": [ @@ -49821,6 +50258,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -50096,6 +50553,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -50322,6 +50783,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -50589,6 +51070,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -50807,6 +51292,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -51080,6 +51585,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -51326,6 +51835,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -51599,6 +52128,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -51833,6 +52366,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -52100,6 +52653,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -52314,6 +52871,26 @@ }, "description": "TVOC concentration threshold. One of 'concentration' or 'quality' must be provided." }, + "co2": { + "type": "object", + "properties": { + "concentration": { + "type": "integer", + "description": "Alerting threshold as CO2 parts per million." + }, + "quality": { + "type": "string", + "enum": [ + "fair", + "good", + "inadequate", + "poor" + ], + "description": "Alerting threshold as a qualitative CO2 level." + } + }, + "description": "CO2 concentration threshold. One of 'concentration' or 'quality' must be provided." + }, "pm25": { "type": "object", "properties": { @@ -52587,6 +53164,10 @@ "concentration": 400, "quality": "poor" }, + "co2": { + "concentration": 400, + "quality": "poor" + }, "pm25": { "concentration": 90, "quality": "fair" @@ -58185,7 +58766,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -58231,6 +58812,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -58258,7 +58853,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -58373,7 +58968,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -58447,10 +59046,6 @@ "items": { "type": "object", "properties": { - "serverId": { - "type": "string", - "description": "unique ID of the RADIUS server" - }, "organizationRadiusServerId": { "type": "string", "description": "Organization wide RADIUS server ID. If this field is provided, the host, port and secret field will be ignored" @@ -58499,6 +59094,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -58524,10 +59133,6 @@ "items": { "type": "object", "properties": { - "serverId": { - "type": "string", - "description": "unique ID of the RADIUS accounting server" - }, "organizationRadiusServerId": { "type": "string", "description": "Organization wide RADIUS server ID. If this field is provided, the host, port and secret field will be ignored" @@ -58613,7 +59218,6 @@ "name": "Access policy #1", "radiusServers": [ { - "serverId": "1", "organizationRadiusServerId": "42", "host": "1.2.3.4", "port": 22, @@ -58627,7 +59231,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -58635,7 +59243,6 @@ "radiusAccountingEnabled": true, "radiusAccountingServers": [ { - "serverId": "2", "organizationRadiusServerId": "42", "host": "1.2.3.4", "port": 22, @@ -58689,7 +59296,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -58735,6 +59342,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -58762,7 +59383,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -58875,7 +59496,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -58963,7 +59588,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -59009,6 +59634,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -59036,7 +59675,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -59149,7 +59788,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -59233,7 +59876,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server" + "description": "Unique ID of the RADIUS server. Leave this empty when new entry is created" }, "organizationRadiusServerId": { "type": "string", @@ -59283,6 +59926,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -59310,7 +59967,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server" + "description": "Unique ID of the RADIUS accounting server. Leave this empty when new entry is created" }, "organizationRadiusServerId": { "type": "string", @@ -59411,7 +60068,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -59464,7 +60125,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS server" }, "organizationRadiusServerId": { "type": "string", @@ -59510,6 +60171,20 @@ "reAuthenticationInterval": { "type": "integer", "description": "Re-authentication period in seconds. Will be null if hostMode is Multi-Auth" + }, + "cache": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable to cache authorization and authentication responses on the RADIUS server" + }, + "timeout": { + "type": "integer", + "description": "If RADIUS caching is enabled, this value dictates how long the cache will remain in the RADIUS server, in hours, to allow network access without authentication" + } + }, + "description": "Object for RADIUS Cache Settings" } }, "description": "Object for RADIUS Settings" @@ -59537,7 +60212,7 @@ "properties": { "serverId": { "type": "string", - "description": "unique ID of the RADIUS accounting server. Leave this empty when new entry is created" + "description": "Unique ID of the RADIUS accounting server" }, "organizationRadiusServerId": { "type": "string", @@ -59650,7 +60325,11 @@ "suspendPortBounce": true }, "failedAuthVlanId": 100, - "reAuthenticationInterval": 120 + "reAuthenticationInterval": 120, + "cache": { + "enabled": false, + "timeout": 24 + } }, "guestPortBouncing": false, "radiusTestingEnabled": false, @@ -74604,6 +75283,181 @@ ] } }, + "/networks/{networkId}/wireless/electronicShelfLabel": { + "get": { + "description": "Return the ESL settings of a wireless network", + "operationId": "getNetworkWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "networkId", + "in": "path", + "description": "Network ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + } + }, + "example": { + "hostname": "N_24329156", + "enabled": true + } + } + } + } + }, + "summary": "Return the ESL settings of a wireless network", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + }, + "put": { + "description": "Update the ESL settings of a wireless network", + "operationId": "updateNetworkWirelessElectronicShelfLabel", + "parameters": [ + { + "name": "networkId", + "in": "path", + "description": "Network ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + }, + "example": { + "hostname": "N_24329156", + "enabled": true + } + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + } + }, + "example": { + "hostname": "N_24329156", + "enabled": true + } + } + } + } + }, + "summary": "Update the ESL settings of a wireless network", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel" + ] + } + }, + "/networks/{networkId}/wireless/electronicShelfLabel/configuredDevices": { + "get": { + "description": "Get a list of all ESL eligible devices of a network", + "operationId": "getNetworkWirelessElectronicShelfLabelConfiguredDevices", + "parameters": [ + { + "name": "networkId", + "in": "path", + "description": "Network ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "description": "Desired ESL hostname of the network" + }, + "enabled": { + "type": "boolean", + "description": "Turn ESL features on and off for this network" + } + } + } + }, + "example": [ + { + "hostname": "N_24329156", + "enabled": true + } + ] + } + } + } + }, + "summary": "Get a list of all ESL eligible devices of a network", + "tags": [ + "wireless", + "configure", + "electronicShelfLabel", + "configuredDevices" + ] + } + }, "/networks/{networkId}/wireless/ethernet/ports/profiles": { "get": { "description": "List the AP port profiles for this network", @@ -83619,6 +84473,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -83963,6 +84818,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -84377,6 +85233,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -84386,7 +85243,7 @@ "Sponsored guest", "Systems Manager Sentry" ], - "description": "The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth', 'Sponsored guest', 'Cisco ISE' or 'Google Apps domain'). This attribute is not supported for template children." + "description": "The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth', 'Microsoft Entra ID', 'Sponsored guest', 'Cisco ISE' or 'Google Apps domain'). This attribute is not supported for template children." }, "splashGuestSponsorDomains": { "type": "array", @@ -85134,6 +85991,7 @@ "Facebook Wi-Fi", "Google Apps domain", "Google OAuth", + "Microsoft Entra ID", "None", "Password-protected with Active Directory", "Password-protected with LDAP", @@ -87962,6 +88820,24 @@ }, "splashTimeout": { "type": "integer", + "enum": [ + 30, + 60, + 120, + 240, + 480, + 720, + 1080, + 1440, + 2880, + 5760, + 7200, + 10080, + 20160, + 43200, + 86400, + 129600 + ], "description": "Splash timeout in minutes." }, "redirectUrl": { @@ -88232,6 +89108,24 @@ }, "splashTimeout": { "type": "integer", + "enum": [ + 30, + 60, + 120, + 240, + 480, + 720, + 1080, + 1440, + 2880, + 5760, + 7200, + 10080, + 20160, + 43200, + 86400, + 129600 + ], "description": "Splash timeout in minutes. This will determine how often users will see the splash page." }, "redirectUrl": { @@ -88535,6 +89429,24 @@ }, "splashTimeout": { "type": "integer", + "enum": [ + 30, + 60, + 120, + 240, + 480, + 720, + 1080, + 1440, + 2880, + 5760, + 7200, + 10080, + 20160, + 43200, + 86400, + 129600 + ], "description": "Splash timeout in minutes." }, "redirectUrl": { @@ -98238,6 +99150,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -98611,7 +99524,7 @@ "summary": "Return all health alerts for an organization", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -98640,15 +99553,15 @@ "alertIds": { "type": "array", "items": { - "type": "integer" + "type": "string" }, - "description": "Parameter to dismiss alerts by ID" + "description": "Array of alert IDs to dismiss" } }, "example": { "alertIds": [ - 123, - 456 + "1234", + "4567" ] }, "required": [ @@ -98667,7 +99580,7 @@ "summary": "Dismiss health alerts", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -98827,6 +99740,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -99043,7 +99957,7 @@ "summary": "Return overview of active health alerts for an organization", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview" ] @@ -99240,6 +100154,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -99504,7 +100419,7 @@ "summary": "Return a Summary of Alerts grouped by network and severity", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview", "byNetwork" @@ -99702,6 +100617,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -99947,7 +100863,7 @@ "summary": "Return a Summary of Alerts grouped by type and severity", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview", "byType" @@ -100118,6 +101034,7 @@ "ssh_port_rotary_conflict", "stack_misconfigured", "stack_not_configured", + "start_monitoring_provisioning", "sticky_client", "stp_bpdu_conflict", "stp_bpduguard_active", @@ -100351,7 +101268,7 @@ "summary": "Returns historical health alert overviews", "tags": [ "organizations", - "configure", + "monitor", "alerts", "overview", "historical" @@ -100382,15 +101299,15 @@ "alertIds": { "type": "array", "items": { - "type": "integer" + "type": "string" }, - "description": "Parameter to restore alerts by ID" + "description": "Array of alert IDs to restore" } }, "example": { "alertIds": [ - 123, - 456 + "1234", + "4567" ] }, "required": [ @@ -100409,7 +101326,7 @@ "summary": "Restore health alerts from dismissed", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -100624,7 +101541,7 @@ "summary": "Return a singular Health Alert by its id", "tags": [ "organizations", - "configure", + "monitor", "alerts" ] } @@ -104242,6 +105159,46 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -104253,7 +105210,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -104261,11 +105218,11 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -105652,8 +106609,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -105940,8 +106897,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -106181,8 +107138,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -106411,8 +107368,8 @@ "accessPolicyType": "Sticky MAC allow list", "accessPolicyNumber": 2, "macAllowList": [ - "34:56:fe:ce:8e:b0", - "34:56:fe:ce:8e:b1" + "34:56:fe:ce:8e:a0", + "34:56:fe:ce:8e:a1" ], "stickyMacAllowList": [ "34:56:fe:ce:8e:b0", @@ -108622,6 +109579,16 @@ } }, "description": "Public interface information." + }, + "vlan": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VLAN ID of the uplink interface" + } + }, + "description": "VLAN information of the uplink interface" } } }, @@ -108658,6 +109625,9 @@ "gateway": "fe80:db8:c15:c0:d0c::10ca:1d02", "public": { "address": "2001:db8:c15:c0:d0c:15e:15e:bab1" + }, + "vlan": { + "id": "1" } } ] @@ -114695,6 +115665,27 @@ ] } }, + { + "name": "productTypes", + "in": "query", + "description": "An optional parameter to filter networks by product type. Results will have at least one of the included product types.", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appliance", + "camera", + "cellularGateway", + "secureConnect", + "sensor", + "switch", + "systemsManager", + "wireless" + ] + } + } + }, { "name": "perPage", "in": "query", @@ -120369,7 +121360,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -120377,11 +121368,11 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -120442,6 +121433,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -120453,7 +121492,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -120461,12 +121500,12 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", "minimum": 1500, - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -120562,6 +121601,309 @@ ] } }, + "/organizations/{organizationId}/summary/top/applications/byUsage": { + "get": { + "description": "Return the top applications sorted by data usage over given time range. Default unit is megabytes.", + "operationId": "getOrganizationSummaryTopApplicationsByUsage", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "device", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, + { + "name": "t0", + "in": "query", + "description": "The beginning of the timespan for the data.", + "schema": { + "type": "string" + } + }, + { + "name": "t1", + "in": "query", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", + "schema": { + "type": "string" + } + }, + { + "name": "timespan", + "in": "query", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day.", + "schema": { + "type": "number", + "format": "float", + "minimum": 1500, + "maximum": 16070400 + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "application": { + "type": "string", + "description": "Name of the Application" + }, + "total": { + "type": "number", + "format": "float", + "description": "Total usage of the Application, in megabytes" + }, + "downstream": { + "type": "number", + "format": "float", + "description": "Downstream usage of the Application, in megabytes" + }, + "upstream": { + "type": "number", + "format": "float", + "description": "Upstream usage of the Application, in megabytes" + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percent usage of the Application" + } + } + } + }, + "example": [ + { + "application": "sample name", + "total": 18000.0, + "downstream": 10000.0, + "upstream": 8000.0, + "percentage": 80.223456789 + } + ] + } + } + } + }, + "summary": "Return the top applications sorted by data usage over given time range", + "tags": [ + "organizations", + "monitor", + "summary", + "top", + "applications", + "byUsage" + ] + } + }, + "/organizations/{organizationId}/summary/top/applications/categories/byUsage": { + "get": { + "description": "Return the top application categories sorted by data usage over given time range. Default unit is megabytes.", + "operationId": "getOrganizationSummaryTopApplicationsCategoriesByUsage", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, + { + "name": "t0", + "in": "query", + "description": "The beginning of the timespan for the data.", + "schema": { + "type": "string" + } + }, + { + "name": "t1", + "in": "query", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", + "schema": { + "type": "string" + } + }, + { + "name": "timespan", + "in": "query", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day.", + "schema": { + "type": "number", + "format": "float", + "minimum": 1500, + "maximum": 16070400 + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Name of the Application Category" + }, + "total": { + "type": "number", + "format": "float", + "description": "Total usage of the Application Category, in megabytes" + }, + "downstream": { + "type": "number", + "format": "float", + "description": "Downstream usage of the Application Category, in megabytes" + }, + "upstream": { + "type": "number", + "format": "float", + "description": "Upstream usage of the Application Category, in megabytes" + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percent usage of the Application Category" + } + } + } + }, + "example": [ + { + "category": "other", + "total": 18000.0, + "downstream": 10000.0, + "upstream": 8000.0, + "percentage": 80.223456789 + } + ] + } + } + } + }, + "summary": "Return the top application categories sorted by data usage over given time range", + "tags": [ + "organizations", + "monitor", + "summary", + "top", + "applications", + "categories", + "byUsage" + ] + } + }, "/organizations/{organizationId}/summary/top/clients/byUsage": { "get": { "description": "Return metrics for organization's top 10 clients by data usage (in mb) over given time range.", @@ -120576,6 +121918,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -120587,7 +121977,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -120595,12 +121985,12 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -120715,6 +122105,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -120726,7 +122164,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -120734,11 +122172,11 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -120841,6 +122279,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -120852,7 +122338,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -120860,12 +122346,12 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -120999,6 +122485,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -121010,7 +122544,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -121018,12 +122552,12 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -121104,6 +122638,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "perPage", "in": "query", @@ -121352,6 +122934,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -121363,7 +122993,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -121371,12 +123001,12 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", "minimum": 28800, - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -121484,6 +123114,54 @@ }, "required": true }, + { + "name": "networkTag", + "in": "query", + "description": "Match result to an exact network tag", + "schema": { + "type": "string" + } + }, + { + "name": "deviceTag", + "in": "query", + "description": "Match result to an exact device tag", + "schema": { + "type": "string" + } + }, + { + "name": "networkId", + "in": "query", + "description": "Match result to an exact network id", + "schema": { + "type": "string" + } + }, + { + "name": "quantity", + "in": "query", + "description": "Set number of desired results to return. Default is 10.", + "schema": { + "type": "integer" + } + }, + { + "name": "ssidName", + "in": "query", + "description": "Filter results by ssid name", + "schema": { + "type": "string" + } + }, + { + "name": "usageUplink", + "in": "query", + "description": "Filter results by usage uplink", + "schema": { + "type": "string" + } + }, { "name": "t0", "in": "query", @@ -121495,7 +123173,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -121503,12 +123181,12 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", "minimum": 1500, - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -121721,20 +123399,26 @@ } }, { - "name": "networkIds", + "name": "configurationUpdatedAfter", "in": "query", - "description": "Optional parameter to filter switchports by network.", + "description": "Optional parameter to filter items to switches where the configuration has been updated after the given timestamp.", "schema": { - "type": "array", - "items": { - "type": "string" - } + "type": "string", + "format": "date-time" } }, { - "name": "portProfileIds", + "name": "mac", + "in": "query", + "description": "Optional parameter to filter items to switches with MAC addresses that contain the search term or are an exact match.", + "schema": { + "type": "string" + } + }, + { + "name": "macs", "in": "query", - "description": "Optional parameter to filter switchports belonging to the specified port profiles.", + "description": "Optional parameter to filter items to switches that have one of the provided MAC addresses.", "schema": { "type": "array", "items": { @@ -121745,23 +123429,26 @@ { "name": "name", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.", + "description": "Optional parameter to filter items to switches with names that contain the search term or are an exact match.", "schema": { "type": "string" } }, { - "name": "mac", + "name": "networkIds", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.", + "description": "Optional parameter to filter items to switches in one of the provided networks.", "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string" + } } }, { - "name": "macs", + "name": "portProfileIds", "in": "query", - "description": "Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.", + "description": "Optional parameter to filter items to switches that contain switchports belonging to one of the specified port profiles.", "schema": { "type": "array", "items": { @@ -121772,7 +123459,7 @@ { "name": "serial", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.", + "description": "Optional parameter to filter items to switches with serial number that contains the search term or are an exact match.", "schema": { "type": "string" } @@ -121780,21 +123467,13 @@ { "name": "serials", "in": "query", - "description": "Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.", + "description": "Optional parameter to filter items to switches that have one of the provided serials.", "schema": { "type": "array", "items": { "type": "string" } } - }, - { - "name": "configurationUpdatedAfter", - "in": "query", - "description": "Optional parameter to filter results by switches where the configuration has been updated after the given timestamp.", - "schema": { - "type": "string" - } } ], "responses": { @@ -122015,7 +123694,7 @@ { "name": "t1", "in": "query", - "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0.", + "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0.", "schema": { "type": "string" } @@ -122023,12 +123702,12 @@ { "name": "timespan", "in": "query", - "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 12 hours and be less than or equal to 31 days. The default is 1 day.", + "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 12 hours and be less than or equal to 186 days. The default is 1 day.", "schema": { "type": "number", "format": "float", "minimum": 43200, - "maximum": 2678400 + "maximum": 16070400 } } ], @@ -125671,7 +127350,7 @@ "summary": "List status information of all BSSIDs in your organization", "tags": [ "wireless", - "configure", + "monitor", "ssids", "statuses", "byDevice" @@ -125923,6 +127602,9 @@ { "name": "configure" }, + { + "name": "configuredDevices" + }, { "name": "connectionStats" }, @@ -125989,6 +127671,9 @@ { "name": "earlyAccess" }, + { + "name": "electronicShelfLabel" + }, { "name": "entitlements" }, @@ -126837,6 +128522,18 @@ "resource": "/networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}", "operation": "update" }, + { + "group": "Esl network settings", + "summary": "Update the ESL settings of a wireless network", + "resource": "/networks/{networkId}/wireless/electronicShelfLabel", + "operation": "update" + }, + { + "group": "Esl node settings", + "summary": "Update the ESL settings of a device", + "resource": "/devices/{serial}/wireless/electronicShelfLabel", + "operation": "update" + }, { "group": "Feature opt in", "summary": "Update an early access feature opt-in for an organization", @@ -127145,7 +128842,7 @@ }, { "group": "Ms/live tools/actions/perform throughput", - "summary": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput", + "summary": "Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput. This endpoint has a rate limit of one request every five seconds per device.", "resource": "/devices/{serial}/liveTools/throughputTest", "operation": "test" }, @@ -127762,10 +129459,10 @@ "operation": "update" }, { - "group": "Wired/actions/bgp settings", + "group": "Wired/actions/bgp", "summary": "Update a Hub BGP Configuration", "resource": "/networks/{networkId}/appliance/vpn/bgp", - "operation": "update" + "operation": "settings/update" }, { "group": "Wired/actions/vpn exclusions",