{
"openapi": "3.0.1",
"info": {
"title": "Cisco Meraki Dashboard API \u2014 wireless",
"description": "The wireless operations of the Cisco Meraki Dashboard API, split by product area from Cisco's published OpenAPI definition.",
"version": "1.72.0",
"contact": {
"name": "Meraki Developer Community",
"url": "https://meraki.io/community"
},
"x-provenance": {
"method": "harvested",
"authored_by": "Cisco Meraki",
"harvested_by": "API Evangelist",
"harvested_on": "2026-07-31",
"first_party": true,
"note": "Split by first tag from Cisco's published spec3.json; operations unmodified.",
"provider_published": true
},
"x-evidence": [
{
"type": "source",
"url": "https://github.com/meraki/openapi/blob/master/openapi/spec3.json"
},
{
"type": "raw",
"url": "https://raw.githubusercontent.com/meraki/openapi/master/openapi/spec3.json"
},
{
"type": "alternate",
"url": "https://api.meraki.com/api/v1/openapiSpec"
}
]
},
"servers": [
{
"url": "https://api.meraki.com/{basePath}",
"variables": {
"basePath": {
"default": "api/v1"
}
}
}
],
"security": [
{
"meraki_api_key": []
},
{
"bearerAuth": []
}
],
"tags": [
{
"name": "airMarshal",
"description": ""
},
{
"name": "allowlist",
"description": ""
},
{
"name": "alternateManagementInterface",
"description": ""
},
{
"name": "assignments",
"description": ""
},
{
"name": "authorities",
"description": ""
},
{
"name": "autoRf",
"description": ""
},
{
"name": "billing",
"description": ""
},
{
"name": "bluetooth",
"description": ""
},
{
"name": "bonjourForwarding",
"description": ""
},
{
"name": "byClient",
"description": ""
},
{
"name": "byDevice",
"description": ""
},
{
"name": "byInterval",
"description": ""
},
{
"name": "byNetwork",
"description": ""
},
{
"name": "certificates",
"description": ""
},
{
"name": "channelUtilization",
"description": ""
},
{
"name": "channelUtilizationHistory",
"description": ""
},
{
"name": "channels",
"description": ""
},
{
"name": "clientCountHistory",
"description": ""
},
{
"name": "clients",
"description": ""
},
{
"name": "configure",
"description": ""
},
{
"name": "configuredDevices",
"description": ""
},
{
"name": "connectionStats",
"description": ""
},
{
"name": "connectivityEvents",
"description": ""
},
{
"name": "cpu",
"description": ""
},
{
"name": "crls",
"description": ""
},
{
"name": "dataRateHistory",
"description": ""
},
{
"name": "deltas",
"description": ""
},
{
"name": "deployments",
"description": ""
},
{
"name": "deviceTypeGroupPolicies",
"description": ""
},
{
"name": "devices",
"description": ""
},
{
"name": "disenrollments",
"description": ""
},
{
"name": "doorLocks",
"description": ""
},
{
"name": "eapOverride",
"description": ""
},
{
"name": "electronicShelfLabel",
"description": ""
},
{
"name": "enrollments",
"description": ""
},
{
"name": "entries",
"description": ""
},
{
"name": "ethernet",
"description": ""
},
{
"name": "failedConnections",
"description": ""
},
{
"name": "firewall",
"description": ""
},
{
"name": "history",
"description": ""
},
{
"name": "hotspot20",
"description": ""
},
{
"name": "identityPsks",
"description": ""
},
{
"name": "ipv6",
"description": ""
},
{
"name": "isolation",
"description": ""
},
{
"name": "l3FirewallRules",
"description": ""
},
{
"name": "l7FirewallRules",
"description": ""
},
{
"name": "latencyHistory",
"description": ""
},
{
"name": "latencyStats",
"description": ""
},
{
"name": "load",
"description": ""
},
{
"name": "location",
"description": ""
},
{
"name": "meshStatuses",
"description": ""
},
{
"name": "mode",
"description": ""
},
{
"name": "monitor",
"description": ""
},
{
"name": "mqtt",
"description": ""
},
{
"name": "openRoaming",
"description": ""
},
{
"name": "overview",
"description": ""
},
{
"name": "packetLoss",
"description": ""
},
{
"name": "ports",
"description": ""
},
{
"name": "power",
"description": ""
},
{
"name": "profiles",
"description": ""
},
{
"name": "provisioning",
"description": ""
},
{
"name": "radio",
"description": ""
},
{
"name": "radsec",
"description": ""
},
{
"name": "receivers",
"description": ""
},
{
"name": "rfProfiles",
"description": ""
},
{
"name": "rrm",
"description": ""
},
{
"name": "rules",
"description": ""
},
{
"name": "scanning",
"description": ""
},
{
"name": "schedules",
"description": ""
},
{
"name": "settings",
"description": ""
},
{
"name": "signalQualityHistory",
"description": ""
},
{
"name": "splash",
"description": ""
},
{
"name": "ssids",
"description": ""
},
{
"name": "status",
"description": ""
},
{
"name": "statuses",
"description": ""
},
{
"name": "system",
"description": ""
},
{
"name": "trafficShaping",
"description": ""
},
{
"name": "usageHistory",
"description": ""
},
{
"name": "vpn",
"description": ""
},
{
"name": "wireless",
"description": ""
},
{
"name": "wirelessControllers",
"description": ""
},
{
"name": "zigbee",
"description": ""
}
],
"components": {
"securitySchemes": {
"meraki_api_key": {
"type": "apiKey",
"name": "X-Cisco-Meraki-API-Key",
"in": "header"
},
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "API Key"
}
}
},
"paths": {
"/devices/{serial}/wireless/alternateManagementInterface/ipv6": {
"put": {
"description": "Update alternate management interface IPv6 address",
"operationId": "updateDeviceWirelessAlternateManagementInterfaceIpv6",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"enum": [
"ipv4",
"ipv6"
],
"description": "The IP protocol used for the address"
},
"assignmentMode": {
"type": "string",
"enum": [
"dynamic",
"static"
],
"description": "The type of address assignment. Either static or dynamic."
},
"address": {
"type": "string",
"description": "The IP address configured for the alternate management interface"
},
"gateway": {
"type": "string",
"description": "The gateway address configured for the alternate managment interface"
},
"prefix": {
"type": "string",
"description": "The IPv6 prefix length of the IPv6 interface. Required if IPv6 object is included."
},
"nameservers": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority."
}
},
"description": "The DNS servers settings for this address."
}
}
},
"description": "configured alternate management interface addresses"
}
},
"example": {
"addresses": [
{
"protocol": "ipv6",
"assignmentMode": "static",
"address": "2001:db8:3c4d:15::1",
"gateway": "fe80:db8:c15:c0:d0c::10ca:1d02",
"prefix": "2001:db8:3c4d:15::/64",
"nameservers": {
"addresses": [
"2001:db8:3c4d:15::1",
"2001:db8:3c4d:15::1"
]
}
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"enum": [
"ipv4",
"ipv6"
],
"description": "The IP protocol used for the address"
},
"assignmentMode": {
"type": "string",
"enum": [
"dynamic",
"static"
],
"description": "The type of address assignment. Either static or dynamic."
},
"address": {
"type": "string",
"description": "The IP address configured for the alternate management interface"
},
"gateway": {
"type": "string",
"description": "The gateway address configured for the alternate managment interface"
},
"prefix": {
"type": "string",
"description": "The IPv6 prefix of the interface. Required if IPv6 object is included."
},
"nameservers": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority."
}
},
"description": "The DNS servers settings for this address."
}
}
},
"description": "configured alternate management interface addresses"
}
}
},
"example": {
"addresses": [
{
"protocol": "ipv6",
"assignmentMode": "static",
"address": "2001:db8:3c4d:15::1",
"gateway": "fe80:db8:c15:c0:d0c::10ca:1d02",
"prefix": "2001:db8:3c4d:15::/64",
"nameservers": {
"addresses": [
"2001:db8:3c4d:15::1",
"2001:db8:3c4d:15::1"
]
}
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update alternate management interface IPv6 address",
"tags": [
"wireless",
"configure",
"alternateManagementInterface",
"ipv6"
]
}
},
"/devices/{serial}/wireless/bluetooth/settings": {
"get": {
"description": "Return the bluetooth settings for a wireless device",
"operationId": "getDeviceWirelessBluetoothSettings",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's\n automatically generated value."
},
"major": {
"type": "integer",
"description": "Desired major value of the beacon. If the value is set to null it will reset to\n Dashboard's automatically generated value."
},
"minor": {
"type": "integer",
"description": "Desired minor value of the beacon. If the value is set to null it will reset to\n Dashboard's automatically generated value."
}
}
},
"example": {
"uuid": "00000000-0000-0000-0000-000000000000",
"major": 13,
"minor": 125
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the bluetooth settings for a wireless device",
"tags": [
"wireless",
"configure",
"bluetooth",
"settings"
]
},
"put": {
"description": "Update the bluetooth settings for a wireless device",
"operationId": "updateDeviceWirelessBluetoothSettings",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"nullable": true,
"description": "Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's\n automatically generated value."
},
"major": {
"type": "integer",
"nullable": true,
"description": "Desired major value of the beacon. If the value is set to null it will reset to\n Dashboard's automatically generated value."
},
"minor": {
"type": "integer",
"nullable": true,
"description": "Desired minor value of the beacon. If the value is set to null it will reset to\n Dashboard's automatically generated value."
}
},
"example": {
"uuid": "00000000-0000-0000-0000-000000000000",
"major": 13,
"minor": 125
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's\n automatically generated value."
},
"major": {
"type": "integer",
"description": "Desired major value of the beacon. If the value is set to null it will reset to\n Dashboard's automatically generated value."
},
"minor": {
"type": "integer",
"description": "Desired minor value of the beacon. If the value is set to null it will reset to\n Dashboard's automatically generated value."
}
}
},
"example": {
"uuid": "00000000-0000-0000-0000-000000000000",
"major": 13,
"minor": 125
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the bluetooth settings for a wireless device",
"tags": [
"wireless",
"configure",
"bluetooth",
"settings"
]
}
},
"/devices/{serial}/wireless/connectionStats": {
"get": {
"description": "Aggregated connectivity info for a given AP on this network",
"operationId": "getDeviceWirelessConnectionStats",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The serial number for the device"
},
"connectionStats": {
"type": "object",
"properties": {
"assoc": {
"type": "integer",
"description": "The number of failed association attempts"
},
"auth": {
"type": "integer",
"description": "The number of failed authentication attempts"
},
"dhcp": {
"type": "integer",
"description": "The number of failed DHCP attempts"
},
"dns": {
"type": "integer",
"description": "The number of failed DNS attempts"
},
"success": {
"type": "integer",
"description": "The number of successful connection attempts"
}
},
"description": "The connection stats of the device"
}
}
},
"example": {
"serial": "Q234-ABCD-5678",
"connectionStats": {
"assoc": 0,
"auth": 1,
"dhcp": 0,
"dns": 0,
"success": 43
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated connectivity info for a given AP on this network",
"tags": [
"wireless",
"monitor",
"connectionStats"
]
}
},
"/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",
"operationId": "getDeviceWirelessLatencyStats",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
},
{
"name": "vlan",
"in": "query",
"description": "Filter results by VLAN",
"schema": {
"type": "integer"
}
},
{
"name": "fields",
"in": "query",
"description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The serial number for the device"
},
"latencyStats": {
"type": "object",
"properties": {
"backgroundTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Background traffic latency stats"
},
"bestEffortTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Best effort traffic latency stats"
},
"videoTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Video traffic latency stats"
},
"voiceTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Voice traffic latency stats"
}
},
"description": "Latency stats for the device"
}
}
},
"example": {
"serial": "Q2JC-2MJM-FHRD",
"latencyStats": {
"backgroundTraffic": {
"avg": 606.52
},
"bestEffortTraffic": {
"avg": 606.52
},
"videoTraffic": {
"avg": 606.52
},
"voiceTraffic": {
"avg": 606.52
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated latency info for a given AP on this network",
"tags": [
"wireless",
"monitor",
"latencyStats"
]
}
},
"/devices/{serial}/wireless/radio/settings": {
"get": {
"description": "Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.",
"operationId": "getDeviceWirelessRadioSettings",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The device serial"
},
"rfProfileId": {
"type": "string",
"description": "RF Profile ID"
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"channel": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"description": "Manual channel for 2.4 GHz"
},
"targetPower": {
"type": "integer",
"description": "Manual target power for 2.4 GHz"
}
},
"description": "Manual radio settings for 2.4 GHz"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"channel": {
"type": "integer",
"enum": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165,
169,
173,
177
],
"description": "Manual channel for 5 GHz"
},
"channelWidth": {
"type": "integer",
"enum": [
0,
20,
40,
80,
160
],
"description": "Manual channel width for 5 GHz"
},
"targetPower": {
"type": "integer",
"description": "Manual target power for 5 GHz"
}
},
"description": "Manual radio settings for 5 GHz"
}
}
},
"example": {
"serial": "Q234-ABCD-5678",
"rfProfileId": "1234",
"twoFourGhzSettings": {
"channel": 11,
"targetPower": 21
},
"fiveGhzSettings": {
"channel": 149,
"channelWidth": 20,
"targetPower": 15
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.",
"tags": [
"wireless",
"configure",
"radio",
"settings"
]
},
"put": {
"description": "Update 2.4 GHz and 5 GHz radio settings (channel, channel width, power) that override RF profiles. For 6 GHz support or radio enable/disable, use updateDeviceWirelessRadioOverrides instead.",
"operationId": "updateDeviceWirelessRadioSettings",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rfProfileId": {
"type": "string",
"nullable": true,
"description": "The ID of an RF profile to assign to the device. If the value of this parameter is null, the appropriate basic RF profile (indoor or outdoor) will be assigned to the device. Assigning an RF profile will clear ALL manually configured overrides on the device (channel width, channel, power)."
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"channel": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"description": "Sets a manual channel for 2.4 GHz. Can be '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13' or '14' or null for using auto channel.",
"nullable": true
},
"targetPower": {
"type": "integer",
"description": "Set a manual target power for 2.4 GHz (dBm). Enter null for using auto power range.",
"nullable": true
}
},
"description": "Manual radio settings for 2.4 GHz."
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"channel": {
"type": "integer",
"enum": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165,
169,
173,
177
],
"description": "Sets a manual channel for 5 GHz. Can be '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161', '165', '169', '173' or '177' or null for using auto channel.",
"nullable": true
},
"channelWidth": {
"type": "integer",
"enum": [
0,
20,
40,
80,
160
],
"description": "Sets a manual channel width for 5 GHz. Can be '0', '20', '40', '80' or '160' or null for using auto channel width.",
"nullable": true
},
"targetPower": {
"type": "integer",
"description": "Set a manual target power for 5 GHz (dBm). Enter null for using auto power range.",
"nullable": true
}
},
"description": "Manual radio settings for 5 GHz."
}
},
"example": {
"rfProfileId": "1234",
"twoFourGhzSettings": {
"channel": 11,
"targetPower": 21
},
"fiveGhzSettings": {
"channel": 149,
"channelWidth": 20,
"targetPower": 15
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The device serial"
},
"rfProfileId": {
"type": "string",
"description": "RF Profile ID"
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"channel": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"description": "Manual channel for 2.4 GHz"
},
"targetPower": {
"type": "integer",
"description": "Manual target power for 2.4 GHz"
}
},
"description": "Manual radio settings for 2.4 GHz"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"channel": {
"type": "integer",
"enum": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165,
169,
173,
177
],
"description": "Manual channel for 5 GHz"
},
"channelWidth": {
"type": "integer",
"enum": [
0,
20,
40,
80,
160
],
"description": "Manual channel width for 5 GHz"
},
"targetPower": {
"type": "integer",
"description": "Manual target power for 5 GHz"
}
},
"description": "Manual radio settings for 5 GHz"
}
}
},
"example": {
"serial": "Q234-ABCD-5678",
"rfProfileId": "1234",
"twoFourGhzSettings": {
"channel": 11,
"targetPower": 21
},
"fiveGhzSettings": {
"channel": 149,
"channelWidth": 20,
"targetPower": 15
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update 2.4 GHz and 5 GHz radio settings (channel, channel width, power) that override RF profiles",
"tags": [
"wireless",
"configure",
"radio",
"settings"
]
}
},
"/devices/{serial}/wireless/status": {
"get": {
"description": "Return the SSID statuses of an access point",
"operationId": "getDeviceWirelessStatus",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"basicServiceSets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ssidName": {
"type": "string",
"description": "Name of wireless network"
},
"ssidNumber": {
"type": "integer",
"description": "Unique identifier of wireless network"
},
"enabled": {
"type": "boolean",
"description": "Status of wireless network"
},
"band": {
"type": "string",
"description": "Frequency range used by wireless network"
},
"bssid": {
"type": "string",
"description": "Unique identifier of wireless access point"
},
"channel": {
"type": "integer",
"description": "Frequency channel used by wireless network"
},
"channelWidth": {
"type": "string",
"description": "Width of frequency channel used by wireless network"
},
"power": {
"type": "string",
"description": "Strength of wireless signal"
},
"visible": {
"type": "boolean",
"description": "Whether the SSID is advertised or hidden"
},
"broadcasting": {
"type": "boolean",
"description": "Whether the SSID is broadcasting based on an availability schedule"
}
}
},
"description": "SSID status list"
}
}
},
"example": {
"basicServiceSets": [
{
"ssidName": "My SSID",
"ssidNumber": 0,
"enabled": true,
"band": "2.4 GHz",
"bssid": "8A:15:04:00:00:00",
"channel": 11,
"channelWidth": "20 MHz",
"power": "18 dBm",
"visible": true,
"broadcasting": true
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return the SSID statuses of an access point",
"tags": [
"wireless",
"monitor",
"status"
]
}
},
"/devices/{serial}/wireless/zigbee/enrollments": {
"post": {
"description": "Enqueue a job to start enrolling door locks on zigbee configured wireless devices",
"operationId": "createDeviceWirelessZigbeeEnrollment",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"description": "Id to check the status of your enrollment"
},
"url": {
"type": "string",
"description": "Url to check the status of your enrollment"
},
"request": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Device serial number"
}
},
"description": "Enrollment parameters"
},
"status": {
"type": "string",
"description": "Status of the enrollment"
}
}
},
"example": {
"enrollmentId": "1234",
"url": "/devices/SERIAL/wireless/zigbee/enrollments/1234",
"request": {
"serial": "Q234-ABCD-5678"
},
"status": "complete"
}
}
}
}
},
"summary": "Enqueue a job to start enrolling door locks on zigbee configured wireless devices",
"tags": [
"wireless",
"configure",
"zigbee",
"enrollments"
]
}
},
"/devices/{serial}/wireless/zigbee/enrollments/{enrollmentId}": {
"get": {
"description": "Return an enrollment",
"operationId": "getDeviceWirelessZigbeeEnrollment",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "enrollmentId",
"in": "path",
"description": "Enrollment ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"description": "Id to check the status of your enrollment"
},
"url": {
"type": "string",
"description": "Url to check the status of your enrollment"
},
"request": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Device serial number"
}
},
"description": "Enrollment parameters"
},
"status": {
"type": "string",
"description": "Status of the enrollment"
},
"enrollmentStartedAt": {
"type": "string",
"description": "Enrollment started at"
},
"doorLocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"doorLockId": {
"type": "string",
"description": "The Door Lock ID"
},
"name": {
"type": "string",
"description": "The Door lock name"
},
"shortId": {
"type": "string",
"description": "The Door lock short ID"
},
"lqi": {
"type": "string",
"description": "The Door lock L quality index"
},
"rssi": {
"type": "string",
"description": "The Door lock received signal strength indicator"
},
"status": {
"type": "string",
"enum": [
"offline",
"online"
],
"description": "The Door lock status, either online or offline."
},
"eui64": {
"type": "string",
"description": "The Door lock unique identifier per network"
},
"enrolledAt": {
"type": "string",
"format": "date-time",
"description": "Date time the door lock was enrolled"
},
"lastSeenAt": {
"type": "string",
"format": "date-time",
"description": "Date time the door lock last send any messages"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network name"
}
},
"description": "Network this door lock is connected to"
},
"gateway": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "MR Device Name"
},
"serial": {
"type": "string",
"description": "Gateway serial"
}
},
"description": "Gateway this door lock is connected to"
}
}
},
"description": "Door locks"
}
}
},
"example": {
"enrollmentId": "1234",
"url": "/devices/SERIAL/wireless/zigbee/enrollments/1234",
"request": {
"serial": "Q234-ABCD-5678"
},
"status": "complete",
"enrollmentStartedAt": "complete",
"doorLocks": [
{
"doorLockId": "1",
"name": "Door Lock 123",
"shortId": "ABE123",
"lqi": "1",
"rssi": "1",
"status": "online",
"eui64": "DL403",
"enrolledAt": "2023-08-14T19:57:06Z",
"lastSeenAt": "2023-08-14T19:59:01Z",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"gateway": {
"name": "My AP",
"serial": "Q234-ABCD-5678"
}
}
]
}
}
}
}
},
"summary": "Return an enrollment",
"tags": [
"wireless",
"configure",
"zigbee",
"enrollments"
]
}
},
"/networks/{networkId}/wireless/airMarshal": {
"get": {
"description": "List Air Marshal scan results from a network",
"operationId": "getNetworkWirelessAirMarshal",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "timespan",
"in": "query",
"description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ssid": {
"type": "string",
"description": "SSID name"
},
"bssids": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bssid": {
"type": "string",
"description": "BSSID of the observed SSID"
},
"contained": {
"type": "boolean",
"description": "Whether this BSSID is contained"
},
"detectedBy": {
"type": "array",
"items": {
"type": "object",
"properties": {
"device": {
"type": "string",
"description": "Serial of the detecting AP"
},
"rssi": {
"type": "integer",
"description": "RSSI reported by the AP"
}
}
},
"description": "Access points that detected the BSSID"
}
}
},
"description": "BSSIDs broadcasting the SSID"
},
"channels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Channels where the SSID was observed"
},
"firstSeen": {
"type": "integer",
"description": "First time the SSID was observed (epoch seconds)"
},
"lastSeen": {
"type": "integer",
"description": "Most recent time the SSID was observed (epoch seconds)"
},
"wiredMacs": {
"type": "array",
"items": {
"type": "string"
},
"description": "MAC addresses observed on the SSID"
},
"wiredVlans": {
"type": "array",
"items": {
"type": "integer"
},
"description": "VLAN IDs observed on the SSID"
},
"wiredLastSeen": {
"type": "integer",
"description": "Last time observed on the SSID (epoch seconds)"
},
"manufacturers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Vendor names resolved from the OUI of each broadcasting BSSID (not the OUI hex prefix itself). Strings come from the IEEE OUI registry and are not casing-normalized -- callers should compare case-insensitively. Example values: \"Linksys\", \"Cisco Systems\", \"OMRON TATEISI Electronics\". Deduplicated and capped at 10 entries; empty when no OUI can be resolved."
},
"encryption": {
"type": "string",
"enum": [
"WEP",
"WPA",
"open"
],
"description": "High-level encryption mode observed for the SSID; null when it cannot be inferred",
"nullable": true
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"rogue",
"spoof"
]
},
"description": "Threat classifications applied to this SSID. \"rogue\": seen on LAN and not allow-listed by an is_known containment rule. \"spoof\": SSID name matches an enabled SSID on this network. Empty when no classification applies."
}
}
}
},
"example": [
{
"ssid": "linksys",
"bssids": [
{
"bssid": "00:11:22:33:44:55",
"contained": false,
"detectedBy": [
{
"device": "Q234-ABCD-5678",
"rssi": 17
}
]
}
],
"channels": [
36,
40
],
"firstSeen": 1518365681,
"lastSeen": 1526087474,
"wiredMacs": [
"00:11:22:33:44:55"
],
"wiredVlans": [
0,
108
],
"wiredLastSeen": 1526087474,
"manufacturers": [
"Linksys",
"Cisco Systems"
],
"encryption": "WPA",
"types": [
"rogue"
]
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List Air Marshal scan results from a network",
"tags": [
"wireless",
"monitor",
"airMarshal"
]
}
},
"/networks/{networkId}/wireless/airMarshal/rules": {
"post": {
"description": "Creates a new rule",
"operationId": "createNetworkWirelessAirMarshalRule",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert",
"allow",
"block"
],
"description": "Indicates if this rule will allow, block, or alert."
},
"match": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bssid",
"contains",
"exact",
"wildcard"
],
"description": "The type of match."
},
"string": {
"type": "string",
"description": "The string used to match."
}
},
"description": "Object describing the rule specification."
}
},
"example": {
"type": "allow",
"match": {
"type": "bssid",
"string": "00:11:22:33:44:55"
}
},
"required": [
"type",
"match"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network name"
}
},
"description": "Network details"
},
"ruleId": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"type": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Updated at timestamp"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Created at timestamp"
},
"match": {
"type": "object",
"properties": {
"string": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"type": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
}
},
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
}
}
},
"example": {
"network": {
"id": "N_12345",
"name": "Network 1"
},
"ruleId": "5239",
"type": "allow",
"updatedAt": "2023-05-23 12:02:46.298",
"createdAt": "2023-05-23 12:02:46.298",
"match": {
"string": "ipsum",
"type": "contains"
}
}
}
}
}
},
"summary": "Creates a new rule",
"tags": [
"wireless",
"configure",
"airMarshal",
"rules"
]
}
},
"/networks/{networkId}/wireless/airMarshal/rules/{ruleId}": {
"put": {
"description": "Update a rule",
"operationId": "updateNetworkWirelessAirMarshalRule",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "ruleId",
"in": "path",
"description": "Rule ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert",
"allow",
"block"
],
"description": "Indicates if this rule will allow, block, or alert."
},
"match": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bssid",
"contains",
"exact",
"wildcard"
],
"description": "The type of match."
},
"string": {
"type": "string",
"description": "The string used to match."
}
},
"description": "Object describing the rule specification."
}
},
"example": {
"type": "allow",
"match": {
"type": "bssid",
"string": "00:11:22:33:44:55"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network name"
}
},
"description": "Network details"
},
"ruleId": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"type": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Updated at timestamp"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Created at timestamp"
},
"match": {
"type": "object",
"properties": {
"string": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"type": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
}
},
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
}
}
},
"example": {
"network": {
"id": "N_12345",
"name": "Network 1"
},
"ruleId": "5239",
"type": "allow",
"updatedAt": "2023-05-23 12:02:46.298",
"createdAt": "2023-05-23 12:02:46.298",
"match": {
"string": "ipsum",
"type": "contains"
}
}
}
}
}
},
"summary": "Update a rule",
"tags": [
"wireless",
"configure",
"airMarshal",
"rules"
]
},
"delete": {
"description": "Delete an Air Marshal rule.",
"operationId": "deleteNetworkWirelessAirMarshalRule",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "ruleId",
"in": "path",
"description": "Rule ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"summary": "Delete an Air Marshal rule.",
"tags": [
"wireless",
"configure",
"airMarshal",
"rules"
]
}
},
"/networks/{networkId}/wireless/airMarshal/settings": {
"put": {
"description": "Updates Air Marshal settings.",
"operationId": "updateNetworkWirelessAirMarshalSettings",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"defaultPolicy": {
"type": "string",
"enum": [
"allow",
"block"
],
"description": "Allows clients to access rogue networks. Blocked by default."
}
},
"example": {
"defaultPolicy": "allow"
},
"required": [
"defaultPolicy"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network ID"
},
"defaultPolicy": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs. (blocked by default)"
}
}
},
"example": {
"networkId": "N_12345",
"defaultPolicy": "allow"
}
}
}
}
},
"summary": "Updates Air Marshal settings.",
"tags": [
"wireless",
"configure",
"airMarshal",
"settings"
]
}
},
"/networks/{networkId}/wireless/alternateManagementInterface": {
"get": {
"description": "Return alternate management interface and devices with IP assigned",
"operationId": "getNetworkWirelessAlternateManagementInterface",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"enabled": true,
"vlanId": 100,
"protocols": [
"radius",
"snmp",
"syslog",
"ldap"
],
"accessPoints": [
{
"serial": "Q234-ABCD-5678",
"alternateManagementIp": "1.2.3.4",
"subnetMask": "255.255.255.0",
"gateway": "1.2.3.5",
"dns1": "8.8.8.8",
"dns2": "8.8.4.4"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return alternate management interface and devices with IP assigned",
"tags": [
"wireless",
"configure",
"alternateManagementInterface"
]
},
"put": {
"description": "Update alternate management interface and device static IP",
"operationId": "updateNetworkWirelessAlternateManagementInterface",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean value to enable or disable alternate management interface"
},
"vlanId": {
"type": "integer",
"description": "Alternate management interface VLAN, must be between 1 and 4094"
},
"protocols": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ldap",
"radius",
"snmp",
"syslog"
]
},
"description": "Can be one or more of the following values: 'radius', 'snmp', 'syslog' or 'ldap'"
},
"accessPoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of access point to be configured with alternate management IP"
},
"alternateManagementIp": {
"type": "string",
"description": "Wireless alternate management interface device IP. Provide an empty string to remove alternate management IP assignment"
},
"subnetMask": {
"type": "string",
"description": "Subnet mask must be in IP format"
},
"gateway": {
"type": "string",
"description": "Gateway must be in IP format"
},
"dns1": {
"type": "string",
"description": "Primary DNS must be in IP format"
},
"dns2": {
"type": "string",
"description": "Optional secondary DNS must be in IP format"
}
},
"required": [
"serial",
"alternateManagementIp"
]
},
"description": "Array of access point serial number and IP assignment. Note: accessPoints IP assignment is not applicable for template networks, in other words, do not put 'accessPoints' in the body when updating template networks. Also, an empty 'accessPoints' array will remove all previous static IP assignments"
}
},
"example": {
"enabled": true,
"vlanId": 100,
"protocols": [
"radius",
"snmp",
"syslog",
"ldap"
],
"accessPoints": [
{
"serial": "Q234-ABCD-5678",
"alternateManagementIp": "1.2.3.4",
"subnetMask": "255.255.255.0",
"gateway": "1.2.3.5",
"dns1": "8.8.8.8",
"dns2": "8.8.4.4"
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"enabled": true,
"vlanId": 100,
"protocols": [
"radius",
"snmp",
"syslog",
"ldap"
],
"accessPoints": [
{
"serial": "Q234-ABCD-5678",
"alternateManagementIp": "1.2.3.4",
"subnetMask": "255.255.255.0",
"gateway": "1.2.3.5",
"dns1": "8.8.8.8",
"dns2": "8.8.4.4"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update alternate management interface and device static IP",
"tags": [
"wireless",
"configure",
"alternateManagementInterface"
]
}
},
"/networks/{networkId}/wireless/billing": {
"get": {
"description": "Return the billing settings of this network",
"operationId": "getNetworkWirelessBilling",
"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": {
"currency": {
"type": "string",
"description": "The currency code of this node group's billing plans"
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the pricing plan to update."
},
"price": {
"type": "number",
"format": "float",
"description": "The price of the billing plan."
},
"bandwidthLimits": {
"type": "object",
"properties": {
"limitUp": {
"type": "integer",
"description": "The maximum upload limit (integer, in Kbps)."
},
"limitDown": {
"type": "integer",
"description": "The maximum download limit (integer, in Kbps)."
}
},
"description": "The uplink bandwidth settings for the pricing plan."
},
"timeLimit": {
"type": "string",
"description": "The time limit of the pricing plan in minutes."
}
}
},
"description": "Array of billing plans in the node group. (Can configure a maximum of 5)"
}
}
},
"example": {
"currency": "USD",
"plans": [
{
"id": "1",
"price": 5.0,
"bandwidthLimits": {
"limitUp": 1000,
"limitDown": 1000
},
"timeLimit": "1 hour"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the billing settings of this network",
"tags": [
"wireless",
"configure",
"billing"
]
},
"put": {
"description": "Update the billing settings",
"operationId": "updateNetworkWirelessBilling",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "The currency code of this node group's billing plans"
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the pricing plan to update."
},
"price": {
"type": "number",
"format": "float",
"description": "The price of the billing plan."
},
"bandwidthLimits": {
"type": "object",
"properties": {
"limitUp": {
"type": "integer",
"description": "The maximum upload limit (integer, in Kbps). null indicates no limit",
"nullable": true
},
"limitDown": {
"type": "integer",
"description": "The maximum download limit (integer, in Kbps). null indicates no limit",
"nullable": true
}
},
"description": "The uplink bandwidth settings for the pricing plan."
},
"timeLimit": {
"type": "string",
"enum": [
"1 day",
"1 hour",
"1 week",
"30 days"
],
"description": "The time limit of the pricing plan in minutes. Can be '1 hour', '1 day', '1 week', or '30 days'."
}
},
"required": [
"price",
"bandwidthLimits",
"timeLimit"
]
},
"description": "Array of billing plans in the node group. (Can configure a maximum of 5)"
}
},
"example": {
"currency": "USD",
"plans": [
{
"id": "1",
"price": 5.0,
"bandwidthLimits": {
"limitUp": 1000000,
"limitDown": 1000000
},
"timeLimit": "1 hour"
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "The currency code of this node group's billing plans"
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the pricing plan to update."
},
"price": {
"type": "number",
"format": "float",
"description": "The price of the billing plan."
},
"bandwidthLimits": {
"type": "object",
"properties": {
"limitUp": {
"type": "integer",
"description": "The maximum upload limit (integer, in Kbps)."
},
"limitDown": {
"type": "integer",
"description": "The maximum download limit (integer, in Kbps)."
}
},
"description": "The uplink bandwidth settings for the pricing plan."
},
"timeLimit": {
"type": "string",
"description": "The time limit of the pricing plan in minutes."
}
}
},
"description": "Array of billing plans in the node group. (Can configure a maximum of 5)"
}
}
},
"example": {
"currency": "USD",
"plans": [
{
"id": "1",
"price": 5.0,
"bandwidthLimits": {
"limitUp": 1000,
"limitDown": 1000
},
"timeLimit": "1 hour"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the billing settings",
"tags": [
"wireless",
"configure",
"billing"
]
}
},
"/networks/{networkId}/wireless/bluetooth/settings": {
"get": {
"description": "Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.",
"operationId": "getNetworkWirelessBluetoothSettings",
"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": {
"scanningEnabled": {
"type": "boolean",
"description": "Whether APs will scan for Bluetooth enabled clients."
},
"advertisingEnabled": {
"type": "boolean",
"description": "Whether APs will advertise beacons."
},
"uuid": {
"type": "string",
"description": "The UUID to be used in the beacon identifier."
},
"majorMinorAssignmentMode": {
"type": "string",
"description": "The way major and minor number should be assigned to nodes in the network. ('Unique', 'Non-unique')"
},
"major": {
"type": "integer",
"description": "The major number to be used in the beacon identifier. Only valid in 'Non-unique' mode."
},
"minor": {
"type": "integer",
"description": "The minor number to be used in the beacon identifier. Only valid in 'Non-unique' mode."
},
"eslEnabled": {
"type": "boolean",
"description": "Whether ESL is enabled on this network."
}
}
},
"example": {
"scanningEnabled": true,
"advertisingEnabled": true,
"uuid": "00000000-0000-0000-0000-000000000000",
"majorMinorAssignmentMode": "Non-unique",
"major": 1,
"minor": 1,
"eslEnabled": true
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.",
"tags": [
"wireless",
"configure",
"bluetooth",
"settings"
]
},
"put": {
"description": "Update the Bluetooth settings for a network. See the docs page for Bluetooth settings.",
"operationId": "updateNetworkWirelessBluetoothSettings",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scanningEnabled": {
"type": "boolean",
"description": "Whether APs will scan for Bluetooth enabled clients."
},
"advertisingEnabled": {
"type": "boolean",
"description": "Whether APs will advertise beacons."
},
"uuid": {
"type": "string",
"description": "The UUID to be used in the beacon identifier."
},
"majorMinorAssignmentMode": {
"type": "string",
"enum": [
"Non-unique",
"Unique"
],
"description": "The way major and minor number should be assigned to nodes in the network. ('Unique', 'Non-unique')"
},
"major": {
"type": "integer",
"description": "The major number to be used in the beacon identifier. Only valid in 'Non-unique' mode."
},
"minor": {
"type": "integer",
"description": "The minor number to be used in the beacon identifier. Only valid in 'Non-unique' mode."
}
},
"example": {
"scanningEnabled": true,
"advertisingEnabled": true,
"uuid": "00000000-0000-0000-0000-000000000000",
"majorMinorAssignmentMode": "Non-unique",
"major": 1,
"minor": 1
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scanningEnabled": {
"type": "boolean",
"description": "Whether APs will scan for Bluetooth enabled clients."
},
"advertisingEnabled": {
"type": "boolean",
"description": "Whether APs will advertise beacons."
},
"uuid": {
"type": "string",
"description": "The UUID to be used in the beacon identifier."
},
"majorMinorAssignmentMode": {
"type": "string",
"description": "The way major and minor number should be assigned to nodes in the network. ('Unique', 'Non-unique')"
},
"major": {
"type": "integer",
"description": "The major number to be used in the beacon identifier. Only valid in 'Non-unique' mode."
},
"minor": {
"type": "integer",
"description": "The minor number to be used in the beacon identifier. Only valid in 'Non-unique' mode."
},
"eslEnabled": {
"type": "boolean",
"description": "Whether ESL is enabled on this network."
}
}
},
"example": {
"scanningEnabled": true,
"advertisingEnabled": true,
"uuid": "00000000-0000-0000-0000-000000000000",
"majorMinorAssignmentMode": "Non-unique",
"major": 1,
"minor": 1,
"eslEnabled": true
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the Bluetooth settings for a network",
"tags": [
"wireless",
"configure",
"bluetooth",
"settings"
]
}
},
"/networks/{networkId}/wireless/channelUtilizationHistory": {
"get": {
"description": "Return AP channel utilization over time for a device or network client",
"operationId": "getNetworkWirelessChannelUtilizationHistory",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400.",
"schema": {
"type": "integer"
}
},
{
"name": "autoResolution",
"in": "query",
"description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.",
"schema": {
"type": "boolean"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history.",
"schema": {
"type": "string"
}
},
{
"name": "deviceSerial",
"in": "query",
"description": "Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified.",
"schema": {
"type": "string"
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified.",
"schema": {
"type": "string"
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6').",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the query range"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the query range"
},
"utilizationTotal": {
"type": "number",
"format": "float",
"description": "Total channel utilization"
},
"utilization80211": {
"type": "number",
"format": "float",
"description": "Average wifi utilization"
},
"utilizationNon80211": {
"type": "number",
"format": "float",
"description": "Average signal interference"
}
}
}
},
"example": [
{
"startTs": "2020-01-01T00:00:00Z",
"endTs": "2020-01-01T01:00:00Z",
"utilizationTotal": 9.89,
"utilization80211": 7.22,
"utilizationNon80211": 2.67
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return AP channel utilization over time for a device or network client",
"tags": [
"wireless",
"monitor",
"channelUtilizationHistory"
]
}
},
"/networks/{networkId}/wireless/clientCountHistory": {
"get": {
"description": "Return wireless client counts over time for a network, device, or network client",
"operationId": "getNetworkWirelessClientCountHistory",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.",
"schema": {
"type": "integer"
}
},
{
"name": "autoResolution",
"in": "query",
"description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.",
"schema": {
"type": "boolean"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history.",
"schema": {
"type": "string"
}
},
{
"name": "deviceSerial",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "string"
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP tag.",
"schema": {
"type": "string"
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6').",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the query range"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the query range"
},
"clientCount": {
"type": "integer",
"description": "Number of connected clients"
}
}
}
},
"example": [
{
"startTs": "2020-01-01T00:00:00Z",
"endTs": "2020-01-01T01:00:00Z",
"clientCount": 14
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return wireless client counts over time for a network, device, or network client",
"tags": [
"wireless",
"monitor",
"clientCountHistory"
]
}
},
"/networks/{networkId}/wireless/clients/connectionStats": {
"get": {
"description": "Aggregated connectivity info for this network, grouped by clients",
"operationId": "getNetworkWirelessClientsConnectionStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "The MAC address of the client"
},
"connectionStats": {
"type": "object",
"properties": {
"assoc": {
"type": "integer",
"description": "The number of failed association attempts"
},
"auth": {
"type": "integer",
"description": "The number of failed authentication attempts"
},
"dhcp": {
"type": "integer",
"description": "The number of failed DHCP attempts"
},
"dns": {
"type": "integer",
"description": "The number of failed DNS attempts"
},
"success": {
"type": "integer",
"description": "The number of successful connection attempts"
}
},
"description": "The connection stats of the client"
}
}
}
},
"example": [
{
"mac": "00:61:71:c8:51:27",
"connectionStats": {
"assoc": 0,
"auth": 4,
"dhcp": 0,
"dns": 0,
"success": 10
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated connectivity info for this network, grouped by clients",
"tags": [
"wireless",
"monitor",
"clients",
"connectionStats"
]
}
},
"/networks/{networkId}/wireless/clients/latencyStats": {
"get": {
"description": "Aggregated latency info for this network, grouped by clients",
"operationId": "getNetworkWirelessClientsLatencyStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
},
{
"name": "vlan",
"in": "query",
"description": "Filter results by VLAN",
"schema": {
"type": "integer"
}
},
{
"name": "fields",
"in": "query",
"description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "The MAC address of the client"
},
"latencyStats": {
"type": "object",
"properties": {
"backgroundTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Background traffic latency stats"
},
"bestEffortTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Best effort traffic latency stats"
},
"videoTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Video traffic latency stats"
},
"voiceTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Voice traffic latency stats"
}
},
"description": "Latency stats for the client"
}
}
}
},
"example": [
{
"mac": "00:61:71:c8:51:27",
"latencyStats": {
"backgroundTraffic": {
"avg": 606.52
},
"bestEffortTraffic": {
"avg": 606.52
},
"videoTraffic": {
"avg": 606.52
},
"voiceTraffic": {
"avg": 606.52
}
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated latency info for this network, grouped by clients",
"tags": [
"wireless",
"monitor",
"clients",
"latencyStats"
]
}
},
"/networks/{networkId}/wireless/clients/{clientId}/connectionStats": {
"get": {
"description": "Aggregated connectivity info for a given client on this network. Clients are identified by their MAC.",
"operationId": "getNetworkWirelessClientConnectionStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "clientId",
"in": "path",
"description": "Client ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "MAC address of the client"
},
"connectionStats": {
"type": "object",
"properties": {
"assoc": {
"type": "integer",
"description": "Association count"
},
"auth": {
"type": "integer",
"description": "Authorization count"
},
"dhcp": {
"type": "integer",
"description": "DHCP count"
},
"success": {
"type": "integer",
"description": "successful count"
}
},
"description": "Connection stats"
}
}
},
"example": {
"mac": "00:11:22:33:44:55",
"connectionStats": {
"assoc": 3,
"auth": 4,
"dhcp": 4,
"success": 5
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated connectivity info for a given client on this network",
"tags": [
"wireless",
"monitor",
"clients",
"connectionStats"
]
}
},
"/networks/{networkId}/wireless/clients/{clientId}/connectivityEvents": {
"get": {
"description": "List the wireless connectivity events for a client within a network in the timespan.",
"operationId": "getNetworkWirelessClientConnectivityEvents",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "clientId",
"in": "path",
"description": "Client ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "sortOrder",
"in": "query",
"description": "Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'.",
"schema": {
"type": "string",
"enum": [
"ascending",
"descending"
]
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 1 day.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "types",
"in": "query",
"description": "A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"assoc",
"auth",
"connection",
"deauth",
"dhcp",
"disassoc",
"dns",
"roam",
"sticky"
]
}
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band. Valid bands are '2.4', '5' or '6'.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssidNumber",
"in": "query",
"description": "Filter results by SSID. If not specified, events for all SSIDs will be returned.",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "includedSeverities",
"in": "query",
"description": "A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"bad",
"good",
"info",
"warn"
]
}
}
},
{
"name": "deviceSerial",
"in": "query",
"description": "Filter results by an AP's serial number.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"occurredAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp at which the event occurred"
},
"band": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
],
"description": "Wireless band the event occurred on"
},
"ssidNumber": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"description": "Number of the SSID the event occurred in"
},
"type": {
"type": "string",
"enum": [
"assoc",
"auth",
"connection",
"deauth",
"dhcp",
"disassoc",
"dns",
"roam",
"sticky"
],
"description": "Event type"
},
"subtype": {
"type": "string",
"description": "Event subtype"
},
"severity": {
"type": "string",
"description": "Event severity"
},
"durationMs": {
"type": "integer",
"description": "Duration of the event in milliseconds"
},
"channel": {
"type": "integer",
"description": "Wireless channel the event occurred over"
},
"rssi": {
"type": "integer",
"description": "RSSI recorded at the time of the event"
},
"eventData": {
"type": "object",
"additionalProperties": true,
"description": "Additional information relevant to the given event. Properties vary based on event type."
},
"deviceSerial": {
"type": "string",
"description": "Serial number of the device the event occurred for"
},
"captureId": {
"type": "string",
"description": "Id of the packet capture triggered for the event, if any"
}
}
}
},
"example": [
{
"occurredAt": "2018-02-11T00:00:00.090210Z",
"band": "5",
"ssidNumber": 1,
"type": "auth",
"subtype": "success",
"severity": "bad",
"durationMs": 100,
"channel": 44,
"rssi": 80,
"deviceSerial": "Q234-ABCD-5678",
"captureId": "123456"
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "List the wireless connectivity events for a client within a network in the timespan.",
"tags": [
"wireless",
"monitor",
"clients",
"connectivityEvents"
]
}
},
"/networks/{networkId}/wireless/clients/{clientId}/latencyHistory": {
"get": {
"description": "Return the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds.",
"operationId": "getNetworkWirelessClientLatencyHistory",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "clientId",
"in": "path",
"description": "Client ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 791 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 791 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 less than or equal to 791 days. The default is 1 day.",
"schema": {
"type": "number",
"format": "float",
"maximum": 68342400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"t0": {
"type": "integer",
"description": "The latency history bucket start time in seconds"
},
"t1": {
"type": "integer",
"description": "The latency history bucket end time in seconds"
},
"latencyBinsByCategory": {
"type": "object",
"properties": {
"backgroundTraffic": {
"type": "object",
"properties": {
"0.5": {
"type": "integer",
"description": "The latency bucket for background traffic in 0.5 seconds"
},
"1.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 1.0 seconds"
},
"2.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 2.0 seconds"
},
"4.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 4.0 seconds"
},
"8.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 8.0 seconds"
},
"16.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 16.0 seconds"
},
"32.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 32.0 seconds"
},
"64.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 64.0 seconds"
},
"128.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 128.0 seconds"
},
"256.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 256.0 seconds"
},
"512.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 512.0 seconds"
},
"1024.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 1024.0 seconds"
},
"2048.0": {
"type": "integer",
"description": "The latency bucket for background traffic in 2048.0 seconds"
}
},
"description": "The time bucket's background traffic latency history"
},
"bestEffortTraffic": {
"type": "object",
"properties": {
"0.5": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 0.5 seconds"
},
"1.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 1.0 seconds"
},
"2.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 2.0 seconds"
},
"4.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 4.0 seconds"
},
"8.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 8.0 seconds"
},
"16.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 16.0 seconds"
},
"32.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 32.0 seconds"
},
"64.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 64.0 seconds"
},
"128.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 128.0 seconds"
},
"256.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 256.0 seconds"
},
"512.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 512.0 seconds"
},
"1024.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 1024.0 seconds"
},
"2048.0": {
"type": "integer",
"description": "The latency bucket for best effort traffic in 2048.0 seconds"
}
},
"description": "The time bucket's best effort traffic latency history"
},
"videoTraffic": {
"type": "object",
"properties": {
"0.5": {
"type": "integer",
"description": "The latency bucket for video traffic in 0.5 seconds"
},
"1.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 1.0 seconds"
},
"2.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 2.0 seconds"
},
"4.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 4.0 seconds"
},
"8.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 8.0 seconds"
},
"16.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 16.0 seconds"
},
"32.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 32.0 seconds"
},
"64.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 64.0 seconds"
},
"128.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 128.0 seconds"
},
"256.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 256.0 seconds"
},
"512.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 512.0 seconds"
},
"1024.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 1024.0 seconds"
},
"2048.0": {
"type": "integer",
"description": "The latency bucket for video traffic in 2048.0 seconds"
}
},
"description": "The time bucket's video traffic latency history"
},
"voiceTraffic": {
"type": "object",
"properties": {
"0.5": {
"type": "integer",
"description": "The latency bucket for voice traffic in 0.5 seconds"
},
"1.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 1.0 seconds"
},
"2.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 2.0 seconds"
},
"4.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 4.0 seconds"
},
"8.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 8.0 seconds"
},
"16.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 16.0 seconds"
},
"32.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 32.0 seconds"
},
"64.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 64.0 seconds"
},
"128.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 128.0 seconds"
},
"256.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 256.0 seconds"
},
"512.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 512.0 seconds"
},
"1024.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 1024.0 seconds"
},
"2048.0": {
"type": "integer",
"description": "The latency bucket for voice traffic in 2048.0 seconds"
}
},
"description": "The time bucket's voice traffic latency history"
}
},
"description": "The latency buckets by category"
}
}
}
},
"example": [
{
"t0": 1550534400,
"t1": 1550620800,
"latencyBinsByCategory": {
"backgroundTraffic": {
"0.5": 41750,
"1.0": 21552,
"2.0": 59940,
"4.0": 146622,
"8.0": 57354,
"16.0": 0,
"32.0": 9954,
"64.0": 0,
"128.0": 0,
"256.0": 1896,
"512.0": 0,
"1024.0": 0,
"2048.0": 0
},
"bestEffortTraffic": {
"0.5": 1840899,
"1.0": 1644506,
"2.0": 629958,
"4.0": 449564,
"8.0": 2009658,
"16.0": 1329568,
"32.0": 282168,
"64.0": 97573,
"128.0": 191977,
"256.0": 30560,
"512.0": 26032,
"1024.0": 4943,
"2048.0": 12072
},
"videoTraffic": {
"0.5": 0,
"1.0": 0,
"2.0": 0,
"4.0": 0,
"8.0": 0,
"16.0": 0,
"32.0": 0,
"64.0": 0,
"128.0": 0,
"256.0": 0,
"512.0": 0,
"1024.0": 0,
"2048.0": 0
},
"voiceTraffic": {
"0.5": 716,
"1.0": 948,
"2.0": 474,
"4.0": 78,
"8.0": 0,
"16.0": 0,
"32.0": 0,
"64.0": 0,
"128.0": 0,
"256.0": 0,
"512.0": 0,
"1024.0": 0,
"2048.0": 0
}
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return the latency history for a client",
"tags": [
"wireless",
"monitor",
"clients",
"latencyHistory"
]
}
},
"/networks/{networkId}/wireless/clients/{clientId}/latencyStats": {
"get": {
"description": "Aggregated latency info for a given client on this network. Clients are identified by their MAC.",
"operationId": "getNetworkWirelessClientLatencyStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "clientId",
"in": "path",
"description": "Client ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
},
{
"name": "vlan",
"in": "query",
"description": "Filter results by VLAN",
"schema": {
"type": "integer"
}
},
{
"name": "fields",
"in": "query",
"description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "The MAC address of the client"
},
"latencyStats": {
"type": "object",
"properties": {
"backgroundTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Background traffic latency stats"
},
"bestEffortTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Best effort traffic latency stats"
},
"videoTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Video traffic latency stats"
},
"voiceTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Voice traffic latency stats"
}
},
"description": "Latency stats for the client"
}
}
},
"example": {
"mac": "00:61:71:c8:51:27",
"latencyStats": {
"backgroundTraffic": {
"avg": 606.52
},
"bestEffortTraffic": {
"avg": 606.52
},
"videoTraffic": {
"avg": 606.52
},
"voiceTraffic": {
"avg": 606.52
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated latency info for a given client on this network",
"tags": [
"wireless",
"monitor",
"clients",
"latencyStats"
]
}
},
"/networks/{networkId}/wireless/connectionStats": {
"get": {
"description": "Aggregated connectivity info for this network",
"operationId": "getNetworkWirelessConnectionStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"assoc": {
"type": "integer",
"description": "The number of failed association attempts"
},
"auth": {
"type": "integer",
"description": "The number of failed authentication attempts"
},
"dhcp": {
"type": "integer",
"description": "The number of failed DHCP attempts"
},
"dns": {
"type": "integer",
"description": "The number of failed DNS attempts"
},
"success": {
"type": "integer",
"description": "The number of successful connection attempts"
}
}
},
"example": {
"assoc": 1,
"auth": 5,
"dhcp": 0,
"dns": 0,
"success": 51
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated connectivity info for this network",
"tags": [
"wireless",
"monitor",
"connectionStats"
]
}
},
"/networks/{networkId}/wireless/dataRateHistory": {
"get": {
"description": "Return PHY data rates over time for a network, device, or network client",
"operationId": "getNetworkWirelessDataRateHistory",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.",
"schema": {
"type": "integer"
}
},
{
"name": "autoResolution",
"in": "query",
"description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.",
"schema": {
"type": "boolean"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter results by network client.",
"schema": {
"type": "string"
}
},
{
"name": "deviceSerial",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "string"
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP tag.",
"schema": {
"type": "string"
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6').",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the query range"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the query range"
},
"averageKbps": {
"type": "integer",
"description": "Average data rate in kilobytes-per-second"
},
"downloadKbps": {
"type": "integer",
"description": "Download rate in kilobytes-per-second"
},
"uploadKbps": {
"type": "integer",
"description": "Upload rate in kilobytes-per-second"
}
}
}
},
"example": [
{
"startTs": "2020-01-01T00:00:00Z",
"endTs": "2020-01-01T01:00:00Z",
"averageKbps": 151806,
"downloadKbps": 144839,
"uploadKbps": 158837
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return PHY data rates over time for a network, device, or network client",
"tags": [
"wireless",
"monitor",
"dataRateHistory"
]
}
},
"/networks/{networkId}/wireless/devices/connectionStats": {
"get": {
"description": "Aggregated connectivity info for this network, grouped by node",
"operationId": "getNetworkWirelessDevicesConnectionStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The serial number for the device"
},
"connectionStats": {
"type": "object",
"properties": {
"assoc": {
"type": "integer",
"description": "The number of failed association attempts"
},
"auth": {
"type": "integer",
"description": "The number of failed authentication attempts"
},
"dhcp": {
"type": "integer",
"description": "The number of failed DHCP attempts"
},
"dns": {
"type": "integer",
"description": "The number of failed DNS attempts"
},
"success": {
"type": "integer",
"description": "The number of successful connection attempts"
}
},
"description": "The connection stats of the device"
}
}
}
},
"example": [
{
"serial": "Q234-ABCD-5678",
"connectionStats": {
"assoc": 0,
"auth": 1,
"dhcp": 0,
"dns": 0,
"success": 43
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated connectivity info for this network, grouped by node",
"tags": [
"wireless",
"monitor",
"devices",
"connectionStats"
]
}
},
"/networks/{networkId}/wireless/devices/latencyStats": {
"get": {
"description": "Aggregated latency info for this network, grouped by node",
"operationId": "getNetworkWirelessDevicesLatencyStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
},
{
"name": "vlan",
"in": "query",
"description": "Filter results by VLAN",
"schema": {
"type": "integer"
}
},
{
"name": "fields",
"in": "query",
"description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The serial number for the device"
},
"latencyStats": {
"type": "object",
"properties": {
"backgroundTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Background traffic latency stats"
},
"bestEffortTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Best effort traffic latency stats"
},
"videoTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Video traffic latency stats"
},
"voiceTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Voice traffic latency stats"
}
},
"description": "Latency stats for the device"
}
}
}
},
"example": [
{
"serial": "Q2JC-2MJM-FHRD",
"latencyStats": {
"backgroundTraffic": {
"avg": 606.52
},
"bestEffortTraffic": {
"avg": 606.52
},
"videoTraffic": {
"avg": 606.52
},
"voiceTraffic": {
"avg": 606.52
}
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated latency info for this network, grouped by node",
"tags": [
"wireless",
"monitor",
"devices",
"latencyStats"
]
}
},
"/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"
},
"mode": {
"type": "string",
"description": "Electronic shelf label mode of the network. Valid options are 'Bluetooth', 'high frequency'"
},
"sepioo": {
"type": "object",
"properties": {
"hostname": {
"type": "string",
"description": "Desired sepioo hostname of the network"
}
},
"description": "sepioo IIoT settings"
}
}
},
"example": {
"hostname": "example.com",
"enabled": true,
"mode": "high frequency",
"sepioo": {
"hostname": "example.com"
}
}
}
}
}
},
"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"
},
"mode": {
"type": "string",
"enum": [
"Bluetooth",
"high frequency"
],
"description": "Electronic shelf label mode of the network. Valid options are 'Bluetooth', 'high frequency'"
}
},
"example": {
"hostname": "example.com",
"enabled": true,
"mode": "high frequency"
}
}
}
},
"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"
},
"mode": {
"type": "string",
"description": "Electronic shelf label mode of the network. Valid options are 'Bluetooth', 'high frequency'"
},
"sepioo": {
"type": "object",
"properties": {
"hostname": {
"type": "string",
"description": "Desired sepioo hostname of the network"
}
},
"description": "sepioo IIoT settings"
}
}
},
"example": {
"hostname": "example.com",
"enabled": true,
"mode": "high frequency",
"sepioo": {
"hostname": "example.com"
}
}
}
}
}
},
"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"
},
"mode": {
"type": "string",
"description": "Electronic shelf label mode of the network. Valid options are 'Bluetooth', 'high frequency'"
},
"sepioo": {
"type": "object",
"properties": {
"hostname": {
"type": "string",
"description": "Desired sepioo hostname of the network"
}
},
"description": "sepioo IIoT settings"
}
}
}
},
"example": [
{
"hostname": "example.com",
"enabled": true,
"mode": "high frequency",
"sepioo": {
"hostname": "example.com"
}
}
]
}
}
}
},
"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",
"operationId": "getNetworkWirelessEthernetPortsProfiles",
"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": {
"profileId": {
"type": "string",
"description": "AP port profile ID"
},
"name": {
"type": "string",
"description": "AP port profile name"
},
"isDefault": {
"type": "boolean",
"description": "Is default profile"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"number": {
"type": "integer",
"description": "Number"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
},
"pskGroupId": {
"type": "string",
"description": "PSK Group number"
}
}
},
"description": "Ports config"
},
"usbPorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
}
}
},
"description": "Usb ports config"
}
}
}
},
"example": [
{
"profileId": "1001",
"name": "Ap Port Profile Name",
"isDefault": false,
"ports": [
{
"name": "port 1",
"number": 1,
"enabled": true,
"ssid": 1,
"pskGroupId": "100"
}
],
"usbPorts": [
{
"name": "usb port",
"enabled": true,
"ssid": 5
}
]
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List the AP port profiles for this network",
"tags": [
"wireless",
"configure",
"ethernet",
"ports",
"profiles"
]
},
"post": {
"description": "Create an AP port profile",
"operationId": "createNetworkWirelessEthernetPortsProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "AP port profile name"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "AP port name"
},
"enabled": {
"type": "boolean",
"description": "AP port enabled"
},
"ssid": {
"type": "integer",
"description": "AP port ssid number",
"nullable": true
},
"pskGroupId": {
"type": "string",
"description": "AP port PSK Group ID"
}
},
"required": [
"name"
]
},
"description": "AP ports configuration"
},
"usbPorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "AP usb port name"
},
"enabled": {
"type": "boolean",
"description": "AP usb port enabled"
},
"ssid": {
"type": "integer",
"description": "AP usb port ssid number",
"nullable": true
}
},
"required": [
"name"
]
},
"description": "AP usb ports configuration"
}
},
"example": {
"name": "name",
"ports": [
{
"name": "port",
"enabled": true,
"ssid": 1,
"pskGroupId": "2"
}
],
"usbPorts": [
{
"name": "usb port",
"enabled": true,
"ssid": 2
}
]
},
"required": [
"name",
"ports"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"description": "AP port profile ID"
},
"name": {
"type": "string",
"description": "AP port profile name"
},
"isDefault": {
"type": "boolean",
"description": "Is default profile"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"number": {
"type": "integer",
"description": "Number"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
},
"pskGroupId": {
"type": "string",
"description": "PSK Group number"
}
}
},
"description": "Ports config"
},
"usbPorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
}
}
},
"description": "Usb ports config"
}
}
},
"example": {
"profileId": "1001",
"name": "Ap Port Profile Name",
"isDefault": false,
"ports": [
{
"name": "port 1",
"number": 1,
"enabled": true,
"ssid": 1,
"pskGroupId": "100"
}
],
"usbPorts": [
{
"name": "usb port",
"enabled": true,
"ssid": 5
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Create an AP port profile",
"tags": [
"wireless",
"configure",
"ethernet",
"ports",
"profiles"
]
}
},
"/networks/{networkId}/wireless/ethernet/ports/profiles/assign": {
"post": {
"description": "Assign AP port profile to list of APs",
"operationId": "assignNetworkWirelessEthernetPortsProfiles",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serials": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of AP serials"
},
"profileId": {
"type": "string",
"nullable": true,
"description": "AP profile ID"
}
},
"example": {
"serials": [
"Q234-ABCD-0001",
"Q234-ABCD-0002",
"Q234-ABCD-0003"
],
"profileId": "1001"
},
"required": [
"serials",
"profileId"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serials": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of updated AP serials"
},
"profileId": {
"type": "string",
"description": "AP profile ID"
}
}
},
"example": {
"serials": [
"Q234-ABCD-0001",
"Q234-ABCD-0002",
"Q234-ABCD-0003"
],
"profileId": "1001"
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Assign AP port profile to list of APs",
"tags": [
"wireless",
"configure",
"ethernet",
"ports",
"profiles"
]
}
},
"/networks/{networkId}/wireless/ethernet/ports/profiles/setDefault": {
"post": {
"description": "Set the AP port profile to be default for this network",
"operationId": "setNetworkWirelessEthernetPortsProfilesDefault",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"nullable": true,
"description": "AP profile ID"
}
},
"example": {
"profileId": "1001"
},
"required": [
"profileId"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"description": "AP profile ID"
}
}
},
"example": {
"profileId": "1001"
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Set the AP port profile to be default for this network",
"tags": [
"wireless",
"configure",
"ethernet",
"ports",
"profiles"
]
}
},
"/networks/{networkId}/wireless/ethernet/ports/profiles/{profileId}": {
"get": {
"description": "Show the AP port profile by ID for this network",
"operationId": "getNetworkWirelessEthernetPortsProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "profileId",
"in": "path",
"description": "Profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"description": "AP port profile ID"
},
"name": {
"type": "string",
"description": "AP port profile name"
},
"isDefault": {
"type": "boolean",
"description": "Is default profile"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"number": {
"type": "integer",
"description": "Number"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
},
"pskGroupId": {
"type": "string",
"description": "PSK Group number"
}
}
},
"description": "Ports config"
},
"usbPorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
}
}
},
"description": "Usb ports config"
}
}
},
"example": {
"profileId": "1001",
"name": "Ap Port Profile Name",
"isDefault": false,
"ports": [
{
"name": "port 1",
"number": 1,
"enabled": true,
"ssid": 1,
"pskGroupId": "100"
}
],
"usbPorts": [
{
"name": "usb port",
"enabled": true,
"ssid": 5
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Show the AP port profile by ID for this network",
"tags": [
"wireless",
"configure",
"ethernet",
"ports",
"profiles"
]
},
"put": {
"description": "Update the AP port profile by ID for this network",
"operationId": "updateNetworkWirelessEthernetPortsProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "profileId",
"in": "path",
"description": "Profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "AP port profile name"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "AP port name"
},
"enabled": {
"type": "boolean",
"description": "AP port enabled"
},
"ssid": {
"type": "integer",
"description": "AP port ssid number",
"nullable": true
},
"pskGroupId": {
"type": "string",
"description": "AP port PSK Group number"
}
},
"required": [
"name"
]
},
"description": "AP ports configuration"
},
"usbPorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "AP usb port name"
},
"enabled": {
"type": "boolean",
"description": "AP usb port enabled"
},
"ssid": {
"type": "integer",
"description": "AP usb port ssid number",
"nullable": true
}
},
"required": [
"name"
]
},
"description": "AP usb ports configuration"
}
},
"example": {}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"description": "AP port profile ID"
},
"name": {
"type": "string",
"description": "AP port profile name"
},
"isDefault": {
"type": "boolean",
"description": "Is default profile"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"number": {
"type": "integer",
"description": "Number"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
},
"pskGroupId": {
"type": "string",
"description": "PSK Group number"
}
}
},
"description": "Ports config"
},
"usbPorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"enabled": {
"type": "boolean",
"description": "Enabled"
},
"ssid": {
"type": "integer",
"description": "Ssid number"
}
}
},
"description": "Usb ports config"
}
}
},
"example": {
"profileId": "1001",
"name": "Ap Port Profile Name",
"isDefault": false,
"ports": [
{
"name": "port 1",
"number": 1,
"enabled": true,
"ssid": 1,
"pskGroupId": "100"
}
],
"usbPorts": [
{
"name": "usb port",
"enabled": true,
"ssid": 5
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the AP port profile by ID for this network",
"tags": [
"wireless",
"configure",
"ethernet",
"ports",
"profiles"
]
},
"delete": {
"description": "Delete an AP port profile",
"operationId": "deleteNetworkWirelessEthernetPortsProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "profileId",
"in": "path",
"description": "Profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Delete an AP port profile",
"tags": [
"wireless",
"configure",
"ethernet",
"ports",
"profiles"
]
}
},
"/networks/{networkId}/wireless/failedConnections": {
"get": {
"description": "List of all failed client connection events on this network in a given time range",
"operationId": "getNetworkWirelessFailedConnections",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
},
{
"name": "serial",
"in": "query",
"description": "Filter by AP",
"schema": {
"type": "string"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter by client MAC",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ssidNumber": {
"type": "integer",
"description": "SSID Number"
},
"vlan": {
"type": "integer",
"description": "LAN"
},
"clientMac": {
"type": "string",
"description": "Client Mac"
},
"serial": {
"type": "string",
"description": "Serial Number"
},
"radio": {
"type": "integer",
"description": "Radio number"
},
"failureStep": {
"type": "string",
"description": "The failed onboarding step. One of: assoc, auth, dhcp, dns."
},
"type": {
"type": "string",
"description": "The failure type in the onboarding step"
},
"ts": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the client mac failed"
}
}
}
},
"example": [
{
"ssidNumber": 1,
"vlan": 100,
"clientMac": "22:33:44:55:66:77",
"serial": "Q234-ABCD-5678",
"radio": 0,
"failureStep": "dns",
"type": "802.1X auth fail",
"ts": "2018-02-11T00:00:00.090210Z"
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "List of all failed client connection events on this network in a given time range",
"tags": [
"wireless",
"monitor",
"failedConnections"
]
}
},
"/networks/{networkId}/wireless/latencyHistory": {
"get": {
"description": "Return average wireless latency over time for a network, device, or network client",
"operationId": "getNetworkWirelessLatencyHistory",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.",
"schema": {
"type": "integer"
}
},
{
"name": "autoResolution",
"in": "query",
"description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.",
"schema": {
"type": "boolean"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter results by network client.",
"schema": {
"type": "string"
}
},
{
"name": "deviceSerial",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "string"
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP tag.",
"schema": {
"type": "string"
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6').",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "integer"
}
},
{
"name": "accessCategory",
"in": "query",
"description": "Filter by access category.",
"schema": {
"type": "string",
"enum": [
"backgroundTraffic",
"bestEffortTraffic",
"videoTraffic",
"voiceTraffic"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the query range"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the query range"
},
"avgLatencyMs": {
"type": "integer",
"description": "Average latency in milliseconds"
}
}
}
},
"example": [
{
"startTs": "2020-01-01T00:00:00Z",
"endTs": "2020-01-01T01:00:00Z",
"avgLatencyMs": 29
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return average wireless latency over time for a network, device, or network client",
"tags": [
"wireless",
"monitor",
"latencyHistory"
]
}
},
"/networks/{networkId}/wireless/latencyStats": {
"get": {
"description": "Aggregated latency info for this network",
"operationId": "getNetworkWirelessLatencyStats",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 180 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 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 less than or equal to 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID",
"schema": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP Tag",
"schema": {
"type": "string"
}
},
{
"name": "vlan",
"in": "query",
"description": "Filter results by VLAN",
"schema": {
"type": "integer"
}
},
{
"name": "fields",
"in": "query",
"description": "Partial selection: If present, this call will return only the selected fields of [\"rawDistribution\", \"avg\"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backgroundTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Background traffic latency stats"
},
"bestEffortTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Best effort traffic latency stats"
},
"videoTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Video traffic latency stats"
},
"voiceTraffic": {
"type": "object",
"properties": {
"rawDistribution": {
"type": "object",
"additionalProperties": true,
"description": "Raw distribution of latency buckets in milliseconds to sample counts"
},
"avg": {
"type": "number",
"format": "float",
"description": "Average latency in milliseconds"
}
},
"description": "Voice traffic latency stats"
}
}
},
"example": {
"backgroundTraffic": {
"avg": 606.52
},
"bestEffortTraffic": {
"avg": 606.52
},
"videoTraffic": {
"avg": 606.52
},
"voiceTraffic": {
"avg": 606.52
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Aggregated latency info for this network",
"tags": [
"wireless",
"monitor",
"latencyStats"
]
}
},
"/networks/{networkId}/wireless/location/scanning": {
"put": {
"description": "Change scanning API settings",
"operationId": "updateNetworkWirelessLocationScanning",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Collect location and scanning analytics"
},
"api": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable push API for scanning events, analytics must be enabled"
}
},
"description": "Enable push API for scanning events, analytics must be enabled"
}
},
"example": {
"enabled": true,
"api": {
"enabled": false
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable collection of location and scanning analytics"
},
"api": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable push API for scanning events. Analytics must be enabled to enable scanning API."
},
"validator": {
"type": "object",
"properties": {
"string": {
"type": "string",
"description": "Validator for push API"
}
},
"description": "Validator for push API"
}
},
"description": "Whether to enable collection of location and scanning analytics."
}
}
},
"example": {
"enabled": true,
"api": {
"enabled": true,
"validator": {
"string": "sample_validator"
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:write"
]
}
],
"summary": "Change scanning API settings",
"tags": [
"wireless",
"configure",
"location",
"scanning"
]
}
},
"/networks/{networkId}/wireless/meshStatuses": {
"get": {
"description": "List wireless mesh statuses for repeaters",
"operationId": "getNetworkWirelessMeshStatuses",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 500. Default is 50.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The serial number for the device."
},
"meshRoute": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of device serials that make up the mesh."
},
"latestMeshPerformance": {
"type": "object",
"properties": {
"mbps": {
"type": "integer",
"description": "Average Mbps."
},
"metric": {
"type": "integer",
"description": "Represents the quality of the entire route from the repeater access point to its gateway access point."
},
"usagePercentage": {
"type": "string",
"description": "Mesh utilization as a percentage."
}
},
"description": "Current metrics on how the mesh is performing."
}
}
}
},
"example": [
{
"serial": "Q234-ABCD-5678",
"meshRoute": [
"Q234-ABCD-5678",
"QWEY-SKTD-ST01",
"QWEY-SKTD-ST02"
],
"latestMeshPerformance": {
"mbps": 43,
"metric": 12345,
"usagePercentage": "100%"
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "List wireless mesh statuses for repeaters",
"tags": [
"wireless",
"monitor",
"meshStatuses"
]
}
},
"/networks/{networkId}/wireless/radio/rrm": {
"put": {
"description": "Update the AutoRF settings for a wireless network",
"operationId": "updateNetworkWirelessRadioRrm",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"busyHour": {
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"automatic",
"manual"
],
"description": "The Busy Hour mode applied to the network when minimizeChanges is enabled. Must be one of 'automatic' or 'manual'. Automatic busy hour is only available on firmware versions >= MR 27.0"
},
"manual": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "The hour that Manual Busy Hour starts each day, in the network time zone"
},
"end": {
"type": "string",
"description": "The hour that Manual Busy Hour ends each day, in the network time zone"
}
},
"description": "Manual Busy Hour settings"
}
},
"description": "Busy hour mode settings"
},
"minimizeChanges": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling Busy Hour in a network"
}
},
"description": "Minimize Changes settings"
}
},
"description": "Busy Hour settings"
},
"channel": {
"type": "object",
"properties": {
"avoidance": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling channel avoidance in a network"
}
},
"description": "Avoidance settings"
}
},
"description": "Channel settings"
},
"fra": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled."
}
},
"description": "FRA settings"
},
"ai": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling AI in a network"
}
},
"description": "AI settings"
}
},
"example": {
"busyHour": {
"schedule": {
"mode": "automatic",
"manual": {
"start": "10:00",
"end": "15:00"
}
},
"minimizeChanges": {
"enabled": true
}
},
"channel": {
"avoidance": {
"enabled": true
}
},
"fra": {
"enabled": false
},
"ai": {
"enabled": true
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "Id of the network"
},
"name": {
"type": "string",
"description": "Name of the network"
},
"timeZone": {
"type": "string",
"description": "Time zone of the network"
},
"busyHour": {
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"automatic",
"manual"
],
"description": "The Busy Hour mode applied to the network when minimizeChanges is enabled. Must be one of 'automatic' or 'manual'. Automatic busy hour is only available on firmware versions >= MR 27.0"
},
"automatic": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "The hour that Automatic Busy Hour starts each day, in the network time zone"
},
"end": {
"type": "string",
"description": "The hour that Automatic Busy Hour ends each day, in the network time zone"
}
},
"description": "Automatic Busy Hour settings"
},
"manual": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "The hour that Manual Busy Hour starts each day, in the network time zone"
},
"end": {
"type": "string",
"description": "The hour that Manual Busy Hour ends each day, in the network time zone"
}
},
"description": "Manual Busy Hour settings"
}
},
"description": "Busy hour mode settings"
},
"minimizeChanges": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling Busy Hour in a network"
}
},
"description": "Minimize Changes settings"
}
},
"description": "Busy Hour settings"
},
"channel": {
"type": "object",
"properties": {
"avoidance": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling channel avoidance in a network"
}
},
"description": "Channel avoidance settings"
}
},
"description": "Channel settings"
},
"fra": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled."
}
},
"description": "FRA settings"
},
"ai": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling AI in a network"
},
"lastEnabledAt": {
"type": "string",
"description": "Time at which AI was last enabled in the network"
}
},
"description": "AI settings"
}
}
},
"example": {
"networkId": "L_12345",
"name": "My Network",
"timeZone": "America/Los_Angeles",
"busyHour": {
"schedule": {
"mode": "automatic",
"automatic": {
"start": "08:00",
"end": "17:00"
},
"manual": {
"start": "10:00",
"end": "15:00"
}
},
"minimizeChanges": {
"enabled": true
}
},
"channel": {
"avoidance": {
"enabled": true
}
},
"fra": {
"enabled": false
},
"ai": {
"enabled": true,
"lastEnabledAt": "2026-06-01T08:07:01Z"
}
}
}
}
}
},
"summary": "Update the AutoRF settings for a wireless network",
"tags": [
"wireless",
"configure",
"radio",
"rrm"
]
}
},
"/networks/{networkId}/wireless/rfProfiles": {
"get": {
"description": "List RF profiles for this network",
"operationId": "getNetworkWirelessRfProfiles",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "includeTemplateProfiles",
"in": "query",
"description": "If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The name of the new profile. Must be unique."
},
"networkId": {
"type": "string",
"description": "The network ID of the RF Profile"
},
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique. This param is required on creation."
},
"clientBalancingEnabled": {
"type": "boolean",
"description": "Steers client to best available access point. Can be either true or false. Defaults to true."
},
"minBitrateType": {
"type": "string",
"description": "Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band."
},
"bandSelectionType": {
"type": "string",
"description": "Band selection can be set to either 'ssid' or 'ap'. This param is required on creation."
},
"apBandSettings": {
"type": "object",
"properties": {
"bandOperationMode": {
"type": "string",
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'. Defaults to dual."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band. Can be either true or false. Defaults to true."
}
},
"description": "Settings that will be enabled if selectionType is set to 'ap'."
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 5."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of 2.4Ghz band. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'. Defaults to 11."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 2.4Ghz band. Can be one of '1', '6' or '11'. Defaults to [1, 6, 11]."
},
"axEnabled": {
"type": "boolean",
"description": "Determines whether ax radio on 2.4Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering. Defaults to true."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 2.4Ghz band"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 5Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 5Ghz band. Can be one of '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161' or '165'. Defaults to [36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 5Ghz band. Can be one of 'auto', '20', '40' or '80'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 5Ghz band"
},
"sixGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 6Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 6Ghz band. Can be one of '1', '5', '9', '13', '17', '21', '25', '29', '33', '37', '41', '45', '49', '53', '57', '61', '65', '69', '73', '77', '81', '85', '89', '93', '97', '101', '105', '109', '113', '117', '121', '125', '129', '133', '137', '141', '145', '149', '153', '157', '161', '165', '169', '173', '177', '181', '185', '189', '193', '197', '201', '205', '209', '213', '217', '221', '225', '229' or '233'. Defaults to [1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61, 65, 69, 73, 77, 81, 85, 89, 93, 97, 101, 105, 109, 113, 117, 121, 125, 129, 133, 137, 141, 145, 149, 153, 157, 161, 165, 169, 173, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 6Ghz band. Can be one of 'auto', '20', '40', '80', '160' or '320'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs"
},
"transmission": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for radio transmission. When false, radios will not transmit at all."
}
},
"description": "Settings related to radio transmission."
},
"perSsidSettings": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 0"
},
"1": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 1"
},
"2": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 2"
},
"3": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 3"
},
"4": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 4"
},
"5": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 5"
},
"6": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 6"
},
"7": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 7"
},
"8": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 8"
},
"9": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 9"
},
"10": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 10"
},
"11": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 11"
},
"12": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 12"
},
"13": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 13"
},
"14": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 14"
}
},
"description": "Per-SSID radio settings by number."
},
"isIndoorDefault": {
"type": "boolean",
"description": "Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
},
"isOutdoorDefault": {
"type": "boolean",
"description": "Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
}
}
},
"example": {
"id": "1234",
"networkId": "N_24329156",
"name": "Main Office",
"clientBalancingEnabled": true,
"minBitrateType": "band",
"bandSelectionType": "ap",
"apBandSettings": {
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"twoFourGhzSettings": {
"maxPower": 30,
"minPower": 5,
"minBitrate": 11.0,
"validAutoChannels": [
1,
6,
11
],
"axEnabled": true,
"rxsop": -95
},
"fiveGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165
],
"channelWidth": "auto",
"rxsop": -95
},
"sixGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221,
225,
229,
233
],
"channelWidth": "auto",
"rxsop": -95
},
"transmission": {
"enabled": true
},
"perSsidSettings": {
"0": {
"name": "SSID 0",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"1": {
"name": "SSID 1",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"2": {
"name": "SSID 2",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"3": {
"name": "SSID 3",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"4": {
"name": "SSID 4",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"5": {
"name": "SSID 5",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"6": {
"name": "SSID 6",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"7": {
"name": "SSID 7",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"8": {
"name": "SSID 8",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"9": {
"name": "SSID 9",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"10": {
"name": "SSID 10",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"11": {
"name": "SSID 11",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"12": {
"name": "SSID 12",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"13": {
"name": "SSID 13",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"14": {
"name": "SSID 14",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
}
},
"isIndoorDefault": false,
"isOutdoorDefault": false
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List RF profiles for this network",
"tags": [
"wireless",
"configure",
"rfProfiles"
]
},
"post": {
"description": "Creates new RF profile for this network",
"operationId": "createNetworkWirelessRfProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique. This param is required on creation."
},
"clientBalancingEnabled": {
"type": "boolean",
"description": "Steers client to best available access point. Can be either true or false. Defaults to true."
},
"minBitrateType": {
"type": "string",
"enum": [
"band",
"ssid"
],
"description": "Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band."
},
"bandSelectionType": {
"type": "string",
"enum": [
"ap",
"ssid"
],
"description": "Band selection can be set to either 'ssid' or 'ap'. This param is required on creation."
},
"apBandSettings": {
"type": "object",
"properties": {
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'. Defaults to dual."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band. Can be either true or false. Defaults to true."
}
},
"description": "Settings that will be enabled if selectionType is set to 'ap'."
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 5."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of 2.4Ghz band. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'. Defaults to 11."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 2.4Ghz band. Can be one of '1', '6' or '11'. Defaults to [1, 6, 11]."
},
"axEnabled": {
"type": "boolean",
"description": "Determines whether ax radio on 2.4Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering. Defaults to true."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 2.4Ghz band"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 5Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 5Ghz band. Can be one of '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161' or '165'. Defaults to [36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 5Ghz band. Can be one of 'auto', '20', '40' or '80'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 5Ghz band"
},
"sixGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 6Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 6Ghz band. Can be one of '1', '5', '9', '13', '17', '21', '25', '29', '33', '37', '41', '45', '49', '53', '57', '61', '65', '69', '73', '77', '81', '85', '89', '93', '97', '101', '105', '109', '113', '117', '121', '125', '129', '133', '137', '141', '145', '149', '153', '157', '161', '165', '169', '173', '177', '181', '185', '189', '193', '197', '201', '205', '209', '213', '217', '221', '225', '229' or '233'. Defaults to [1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61, 65, 69, 73, 77, 81, 85, 89, 93, 97, 101, 105, 109, 113, 117, 121, 125, 129, 133, 137, 141, 145, 149, 153, 157, 161, 165, 169, 173, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 6Ghz band. Can be one of 'auto', '20', '40', '80', '160' or '320'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs"
},
"transmission": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for radio transmission. When false, radios will not transmit at all."
}
},
"description": "Settings related to radio transmission."
},
"perSsidSettings": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 0"
},
"1": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 1"
},
"2": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 2"
},
"3": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 3"
},
"4": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 4"
},
"5": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 5"
},
"6": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 6"
},
"7": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 7"
},
"8": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 8"
},
"9": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 9"
},
"10": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 10"
},
"11": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 11"
},
"12": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 12"
},
"13": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 13"
},
"14": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 14"
}
},
"description": "Per-SSID radio settings by number."
},
"flexRadios": {
"type": "object",
"properties": {
"byModel": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "Model of the AP"
},
"bands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "Band to use for each flex radio. For example, ['6'] will set the AP's first flex radio to 6 GHz"
}
}
},
"description": "Flex radios by model."
}
},
"description": "Flex radio settings."
}
},
"example": {
"name": "Main Office",
"clientBalancingEnabled": true,
"minBitrateType": "band",
"bandSelectionType": "ap",
"apBandSettings": {
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"twoFourGhzSettings": {
"maxPower": 30,
"minPower": 5,
"minBitrate": 11.0,
"validAutoChannels": [
1,
6,
11
],
"axEnabled": true,
"rxsop": -95
},
"fiveGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165
],
"channelWidth": "auto",
"rxsop": -95
},
"sixGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221,
225,
229,
233
],
"channelWidth": "auto",
"rxsop": -95
},
"transmission": {
"enabled": true
},
"perSsidSettings": {
"0": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"1": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"2": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"3": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"4": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"5": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"6": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"7": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"8": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"9": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"10": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"11": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"12": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"13": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"14": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
}
},
"flexRadios": {
"byModel": [
{
"model": "MR34",
"bands": [
"5"
]
}
]
}
},
"required": [
"name",
"bandSelectionType"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The name of the new profile. Must be unique."
},
"networkId": {
"type": "string",
"description": "The network ID of the RF Profile"
},
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique. This param is required on creation."
},
"clientBalancingEnabled": {
"type": "boolean",
"description": "Steers client to best available access point. Can be either true or false. Defaults to true."
},
"minBitrateType": {
"type": "string",
"description": "Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band."
},
"bandSelectionType": {
"type": "string",
"description": "Band selection can be set to either 'ssid' or 'ap'. This param is required on creation."
},
"apBandSettings": {
"type": "object",
"properties": {
"bandOperationMode": {
"type": "string",
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'. Defaults to dual."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band. Can be either true or false. Defaults to true."
}
},
"description": "Settings that will be enabled if selectionType is set to 'ap'."
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 5."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of 2.4Ghz band. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'. Defaults to 11."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 2.4Ghz band. Can be one of '1', '6' or '11'. Defaults to [1, 6, 11]."
},
"axEnabled": {
"type": "boolean",
"description": "Determines whether ax radio on 2.4Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering. Defaults to true."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 2.4Ghz band"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 5Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 5Ghz band. Can be one of '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161' or '165'. Defaults to [36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 5Ghz band. Can be one of 'auto', '20', '40' or '80'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 5Ghz band"
},
"sixGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 6Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 6Ghz band. Can be one of '1', '5', '9', '13', '17', '21', '25', '29', '33', '37', '41', '45', '49', '53', '57', '61', '65', '69', '73', '77', '81', '85', '89', '93', '97', '101', '105', '109', '113', '117', '121', '125', '129', '133', '137', '141', '145', '149', '153', '157', '161', '165', '169', '173', '177', '181', '185', '189', '193', '197', '201', '205', '209', '213', '217', '221', '225', '229' or '233'. Defaults to [1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61, 65, 69, 73, 77, 81, 85, 89, 93, 97, 101, 105, 109, 113, 117, 121, 125, 129, 133, 137, 141, 145, 149, 153, 157, 161, 165, 169, 173, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 6Ghz band. Can be one of 'auto', '20', '40', '80', '160' or '320'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs"
},
"transmission": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for radio transmission. When false, radios will not transmit at all."
}
},
"description": "Settings related to radio transmission."
},
"perSsidSettings": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 0"
},
"1": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 1"
},
"2": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 2"
},
"3": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 3"
},
"4": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 4"
},
"5": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 5"
},
"6": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 6"
},
"7": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 7"
},
"8": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 8"
},
"9": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 9"
},
"10": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 10"
},
"11": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 11"
},
"12": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 12"
},
"13": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 13"
},
"14": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 14"
}
},
"description": "Per-SSID radio settings by number."
},
"isIndoorDefault": {
"type": "boolean",
"description": "Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
},
"isOutdoorDefault": {
"type": "boolean",
"description": "Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
}
}
},
"example": {
"id": "1234",
"networkId": "N_24329156",
"name": "Main Office",
"clientBalancingEnabled": true,
"minBitrateType": "band",
"bandSelectionType": "ap",
"apBandSettings": {
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"twoFourGhzSettings": {
"maxPower": 30,
"minPower": 5,
"minBitrate": 11.0,
"validAutoChannels": [
1,
6,
11
],
"axEnabled": true,
"rxsop": -95
},
"fiveGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165
],
"channelWidth": "auto",
"rxsop": -95
},
"sixGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221,
225,
229,
233
],
"channelWidth": "auto",
"rxsop": -95
},
"transmission": {
"enabled": true
},
"perSsidSettings": {
"0": {
"name": "SSID 0",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"1": {
"name": "SSID 1",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"2": {
"name": "SSID 2",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"3": {
"name": "SSID 3",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"4": {
"name": "SSID 4",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"5": {
"name": "SSID 5",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"6": {
"name": "SSID 6",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"7": {
"name": "SSID 7",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"8": {
"name": "SSID 8",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"9": {
"name": "SSID 9",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"10": {
"name": "SSID 10",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"11": {
"name": "SSID 11",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"12": {
"name": "SSID 12",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"13": {
"name": "SSID 13",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"14": {
"name": "SSID 14",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
}
},
"isIndoorDefault": false,
"isOutdoorDefault": false
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Creates new RF profile for this network",
"tags": [
"wireless",
"configure",
"rfProfiles"
]
}
},
"/networks/{networkId}/wireless/rfProfiles/{rfProfileId}": {
"put": {
"description": "Updates specified RF profile for this network. Note: built-in RF profiles can only be assigned as a default, and its attributes are immutable",
"operationId": "updateNetworkWirelessRfProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "rfProfileId",
"in": "path",
"description": "Rf profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique."
},
"isIndoorDefault": {
"type": "boolean",
"description": "Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
},
"isOutdoorDefault": {
"type": "boolean",
"description": "Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
},
"clientBalancingEnabled": {
"type": "boolean",
"description": "Steers client to best available access point. Can be either true or false."
},
"minBitrateType": {
"type": "string",
"enum": [
"band",
"ssid"
],
"description": "Minimum bitrate can be set to either 'band' or 'ssid'."
},
"bandSelectionType": {
"type": "string",
"enum": [
"ap",
"ssid"
],
"description": "Band selection can be set to either 'ssid' or 'ap'."
},
"apBandSettings": {
"type": "object",
"properties": {
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band. Can be either true or false."
}
},
"description": "Settings that will be enabled if selectionType is set to 'ap'."
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 2.4Ghz band. Can be integer between 2 and 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 2.4Ghz band. Can be integer between 2 and 30."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of 2.4Ghz band. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 2.4Ghz band. Can be one of '1', '6' or '11'."
},
"axEnabled": {
"type": "boolean",
"description": "Determines whether ax radio on 2.4Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 2.4Ghz band"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 5Ghz band. Can be integer between 2 and 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 5Ghz band. Can be integer between 2 and 30."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 5Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 5Ghz band. Can be one of '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161' or '165'."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 5Ghz band. Can be one of 'auto', '20', '40' or '80'."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 5Ghz band"
},
"sixGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 6Ghz band. Can be integer between 2 and 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 6Ghz band. Can be integer between 2 and 30."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 6Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 6Ghz band. Can be one of '1', '5', '9', '13', '17', '21', '25', '29', '33', '37', '41', '45', '49', '53', '57', '61', '65', '69', '73', '77', '81', '85', '89', '93', '97', '101', '105', '109', '113', '117', '121', '125', '129', '133', '137', '141', '145', '149', '153', '157', '161', '165', '169', '173', '177', '181', '185', '189', '193', '197', '201', '205', '209', '213', '217', '221', '225', '229' or '233'."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 6Ghz band. Can be one of 'auto', '20', '40', '80', '160' or '320'."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs"
},
"transmission": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for radio transmission. When false, radios will not transmit at all."
}
},
"description": "Settings related to radio transmission."
},
"perSsidSettings": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 0"
},
"1": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 1"
},
"2": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 2"
},
"3": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 3"
},
"4": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 4"
},
"5": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 5"
},
"6": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 6"
},
"7": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 7"
},
"8": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 8"
},
"9": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 9"
},
"10": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 10"
},
"11": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 11"
},
"12": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 12"
},
"13": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 13"
},
"14": {
"type": "object",
"properties": {
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 14"
}
},
"description": "Per-SSID radio settings by number."
},
"flexRadios": {
"type": "object",
"properties": {
"byModel": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "Model of the AP"
},
"bands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"2.4",
"5",
"6",
"disabled"
]
},
"description": "Band to use for each flex radio. For example, ['6'] will set the AP's first flex radio to 6 GHz"
}
}
},
"description": "Flex radios by model."
}
},
"description": "Flex radio settings."
}
},
"example": {
"name": "1234",
"isIndoorDefault": true,
"isOutdoorDefault": true,
"clientBalancingEnabled": true,
"minBitrateType": "band",
"bandSelectionType": "ap",
"apBandSettings": {
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"twoFourGhzSettings": {
"maxPower": 30,
"minPower": 5,
"minBitrate": 11.0,
"validAutoChannels": [
1,
6,
11
],
"axEnabled": true,
"rxsop": -95
},
"fiveGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165
],
"channelWidth": "auto",
"rxsop": -95
},
"sixGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221,
225,
229,
233
],
"channelWidth": "auto",
"rxsop": -95
},
"transmission": {
"enabled": true
},
"perSsidSettings": {
"0": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"1": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"2": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"3": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"4": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"5": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"6": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"7": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"8": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"9": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"10": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"11": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"12": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"13": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"14": {
"minBitrate": 11.0,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
}
},
"flexRadios": {
"byModel": [
{
"model": "MR34",
"bands": [
"5"
]
}
]
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The name of the new profile. Must be unique."
},
"networkId": {
"type": "string",
"description": "The network ID of the RF Profile"
},
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique. This param is required on creation."
},
"clientBalancingEnabled": {
"type": "boolean",
"description": "Steers client to best available access point. Can be either true or false. Defaults to true."
},
"minBitrateType": {
"type": "string",
"description": "Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band."
},
"bandSelectionType": {
"type": "string",
"description": "Band selection can be set to either 'ssid' or 'ap'. This param is required on creation."
},
"apBandSettings": {
"type": "object",
"properties": {
"bandOperationMode": {
"type": "string",
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'. Defaults to dual."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band. Can be either true or false. Defaults to true."
}
},
"description": "Settings that will be enabled if selectionType is set to 'ap'."
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 5."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of 2.4Ghz band. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'. Defaults to 11."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 2.4Ghz band. Can be one of '1', '6' or '11'. Defaults to [1, 6, 11]."
},
"axEnabled": {
"type": "boolean",
"description": "Determines whether ax radio on 2.4Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering. Defaults to true."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 2.4Ghz band"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 5Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 5Ghz band. Can be one of '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161' or '165'. Defaults to [36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 5Ghz band. Can be one of 'auto', '20', '40' or '80'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 5Ghz band"
},
"sixGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 6Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 6Ghz band. Can be one of '1', '5', '9', '13', '17', '21', '25', '29', '33', '37', '41', '45', '49', '53', '57', '61', '65', '69', '73', '77', '81', '85', '89', '93', '97', '101', '105', '109', '113', '117', '121', '125', '129', '133', '137', '141', '145', '149', '153', '157', '161', '165', '169', '173', '177', '181', '185', '189', '193', '197', '201', '205', '209', '213', '217', '221', '225', '229' or '233'. Defaults to [1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61, 65, 69, 73, 77, 81, 85, 89, 93, 97, 101, 105, 109, 113, 117, 121, 125, 129, 133, 137, 141, 145, 149, 153, 157, 161, 165, 169, 173, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 6Ghz band. Can be one of 'auto', '20', '40', '80', '160' or '320'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs"
},
"transmission": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for radio transmission. When false, radios will not transmit at all."
}
},
"description": "Settings related to radio transmission."
},
"perSsidSettings": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 0"
},
"1": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 1"
},
"2": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 2"
},
"3": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 3"
},
"4": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 4"
},
"5": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 5"
},
"6": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 6"
},
"7": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 7"
},
"8": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 8"
},
"9": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 9"
},
"10": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 10"
},
"11": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 11"
},
"12": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 12"
},
"13": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 13"
},
"14": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 14"
}
},
"description": "Per-SSID radio settings by number."
},
"isIndoorDefault": {
"type": "boolean",
"description": "Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
},
"isOutdoorDefault": {
"type": "boolean",
"description": "Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
}
}
},
"example": {
"id": "1234",
"networkId": "N_24329156",
"name": "Main Office",
"clientBalancingEnabled": true,
"minBitrateType": "band",
"bandSelectionType": "ap",
"apBandSettings": {
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"twoFourGhzSettings": {
"maxPower": 30,
"minPower": 5,
"minBitrate": 11.0,
"validAutoChannels": [
1,
6,
11
],
"axEnabled": true,
"rxsop": -95
},
"fiveGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165
],
"channelWidth": "auto",
"rxsop": -95
},
"sixGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221,
225,
229,
233
],
"channelWidth": "auto",
"rxsop": -95
},
"transmission": {
"enabled": true
},
"perSsidSettings": {
"0": {
"name": "SSID 0",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"1": {
"name": "SSID 1",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"2": {
"name": "SSID 2",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"3": {
"name": "SSID 3",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"4": {
"name": "SSID 4",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"5": {
"name": "SSID 5",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"6": {
"name": "SSID 6",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"7": {
"name": "SSID 7",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"8": {
"name": "SSID 8",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"9": {
"name": "SSID 9",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"10": {
"name": "SSID 10",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"11": {
"name": "SSID 11",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"12": {
"name": "SSID 12",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"13": {
"name": "SSID 13",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"14": {
"name": "SSID 14",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
}
},
"isIndoorDefault": false,
"isOutdoorDefault": false
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Updates specified RF profile for this network",
"tags": [
"wireless",
"configure",
"rfProfiles"
]
},
"delete": {
"description": "Delete a RF Profile",
"operationId": "deleteNetworkWirelessRfProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "rfProfileId",
"in": "path",
"description": "Rf profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Delete a RF Profile",
"tags": [
"wireless",
"configure",
"rfProfiles"
]
},
"get": {
"description": "Return a RF profile",
"operationId": "getNetworkWirelessRfProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "rfProfileId",
"in": "path",
"description": "Rf profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The name of the new profile. Must be unique."
},
"networkId": {
"type": "string",
"description": "The network ID of the RF Profile"
},
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique. This param is required on creation."
},
"clientBalancingEnabled": {
"type": "boolean",
"description": "Steers client to best available access point. Can be either true or false. Defaults to true."
},
"minBitrateType": {
"type": "string",
"description": "Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band."
},
"bandSelectionType": {
"type": "string",
"description": "Band selection can be set to either 'ssid' or 'ap'. This param is required on creation."
},
"apBandSettings": {
"type": "object",
"properties": {
"bandOperationMode": {
"type": "string",
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'. Defaults to dual."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band. Can be either true or false. Defaults to true."
}
},
"description": "Settings that will be enabled if selectionType is set to 'ap'."
},
"twoFourGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 2.4Ghz band. Can be integer between 2 and 30. Defaults to 5."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "Sets min bitrate (Mbps) of 2.4Ghz band. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'. Defaults to 11."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 2.4Ghz band. Can be one of '1', '6' or '11'. Defaults to [1, 6, 11]."
},
"axEnabled": {
"type": "boolean",
"description": "Determines whether ax radio on 2.4Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering. Defaults to true."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 2.4Ghz band"
},
"fiveGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 5Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 5Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 5Ghz band. Can be one of '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161' or '165'. Defaults to [36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 5Ghz band. Can be one of 'auto', '20', '40' or '80'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 5Ghz band"
},
"sixGhzSettings": {
"type": "object",
"properties": {
"maxPower": {
"type": "integer",
"description": "Sets max power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 30."
},
"minPower": {
"type": "integer",
"description": "Sets min power (dBm) of 6Ghz band. Can be integer between 2 and 30. Defaults to 8."
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of 6Ghz band. Can be one of '6', '9', '12', '18', '24', '36', '48' or '54'. Defaults to 12."
},
"validAutoChannels": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Sets valid auto channels for 6Ghz band. Can be one of '1', '5', '9', '13', '17', '21', '25', '29', '33', '37', '41', '45', '49', '53', '57', '61', '65', '69', '73', '77', '81', '85', '89', '93', '97', '101', '105', '109', '113', '117', '121', '125', '129', '133', '137', '141', '145', '149', '153', '157', '161', '165', '169', '173', '177', '181', '185', '189', '193', '197', '201', '205', '209', '213', '217', '221', '225', '229' or '233'. Defaults to [1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61, 65, 69, 73, 77, 81, 85, 89, 93, 97, 101, 105, 109, 113, 117, 121, 125, 129, 133, 137, 141, 145, 149, 153, 157, 161, 165, 169, 173, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233]."
},
"channelWidth": {
"type": "string",
"description": "Sets channel width (MHz) for 6Ghz band. Can be one of 'auto', '20', '40', '80', '160' or '320'. Defaults to auto."
},
"rxsop": {
"type": "integer",
"description": "The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). A value of null will reset this to the default.",
"nullable": true
}
},
"description": "Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs"
},
"transmission": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for radio transmission. When false, radios will not transmit at all."
}
},
"description": "Settings related to radio transmission."
},
"perSsidSettings": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 0"
},
"1": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 1"
},
"2": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 2"
},
"3": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 3"
},
"4": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 4"
},
"5": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 5"
},
"6": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 6"
},
"7": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 7"
},
"8": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 8"
},
"9": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 9"
},
"10": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 10"
},
"11": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 11"
},
"12": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 12"
},
"13": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 13"
},
"14": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of SSID"
},
"minBitrate": {
"type": "integer",
"description": "Sets min bitrate (Mbps) of this SSID. Can be one of '1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54'."
},
"bandOperationMode": {
"type": "string",
"enum": [
"2.4ghz",
"5ghz",
"6ghz",
"dual",
"multi"
],
"description": "Choice between 'dual', '2.4ghz', '5ghz', '6ghz' or 'multi'."
},
"bands": {
"type": "object",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of enabled bands. Can include [\"2.4\", \"5\", \"6\", \"disabled\"]"
}
},
"description": "Settings related to all bands"
},
"bandSteeringEnabled": {
"type": "boolean",
"description": "Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false."
}
},
"description": "Settings for SSID 14"
}
},
"description": "Per-SSID radio settings by number."
},
"isIndoorDefault": {
"type": "boolean",
"description": "Set this profile as the default indoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
},
"isOutdoorDefault": {
"type": "boolean",
"description": "Set this profile as the default outdoor rf profile. If the profile ID is one of 'indoor' or 'outdoor', then a new profile will be created from the respective ID and set as the default"
}
}
},
"example": {
"id": "1234",
"networkId": "N_24329156",
"name": "Main Office",
"clientBalancingEnabled": true,
"minBitrateType": "band",
"bandSelectionType": "ap",
"apBandSettings": {
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"twoFourGhzSettings": {
"maxPower": 30,
"minPower": 5,
"minBitrate": 11.0,
"validAutoChannels": [
1,
6,
11
],
"axEnabled": true,
"rxsop": -95
},
"fiveGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165
],
"channelWidth": "auto",
"rxsop": -95
},
"sixGhzSettings": {
"maxPower": 30,
"minPower": 8,
"minBitrate": 12,
"validAutoChannels": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221,
225,
229,
233
],
"channelWidth": "auto",
"rxsop": -95
},
"transmission": {
"enabled": true
},
"perSsidSettings": {
"0": {
"name": "SSID 0",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"1": {
"name": "SSID 1",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"2": {
"name": "SSID 2",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"3": {
"name": "SSID 3",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"4": {
"name": "SSID 4",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"5": {
"name": "SSID 5",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"6": {
"name": "SSID 6",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"7": {
"name": "SSID 7",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"8": {
"name": "SSID 8",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"9": {
"name": "SSID 9",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"10": {
"name": "SSID 10",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"11": {
"name": "SSID 11",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"12": {
"name": "SSID 12",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"13": {
"name": "SSID 13",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
},
"14": {
"name": "SSID 14",
"minBitrate": 11,
"bandOperationMode": "dual",
"bands": {
"enabled": [
"2.4",
"5"
]
},
"bandSteeringEnabled": true
}
},
"isIndoorDefault": false,
"isOutdoorDefault": false
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return a RF profile",
"tags": [
"wireless",
"configure",
"rfProfiles"
]
}
},
"/networks/{networkId}/wireless/settings": {
"get": {
"description": "Return the wireless settings for a network",
"operationId": "getNetworkWirelessSettings",
"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": {
"meshingEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling meshing in a network"
},
"ipv6BridgeEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling IPv6 bridging in a network (Note: if enabled, SSIDs must also be configured to use bridge mode)"
},
"locationAnalyticsEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling location analytics for your network"
},
"upgradeStrategy": {
"type": "string",
"enum": [
"minimizeClientDowntime",
"minimizeUpgradeTime"
],
"description": "The default strategy that network devices will use to perform an upgrade. Requires firmware version MR 26.8 or higher."
},
"upgrade": {
"type": "object",
"properties": {
"predownload": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "The default setting for upgrade firmware predownload. Only applies to devices running MR 32 or higher."
}
},
"description": "Predownload settings for firmware upgrades"
}
},
"description": "Upgrade settings for the network"
},
"ledLightsOn": {
"type": "boolean",
"description": "Toggle for enabling or disabling LED lights on all APs in the network (making them run dark)"
},
"multicastToUnicastConversion": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling multicast-to-unicast conversion across the network"
}
},
"description": "Multicast-to-unicast conversion settings across the network"
},
"namedVlans": {
"type": "object",
"properties": {
"poolDhcpMonitoring": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not devices using named VLAN pools should remove dirty VLANs from the pool, thereby preventing clients from being assigned to VLANs where they would be unable to obtain an IP address via DHCP"
},
"duration": {
"type": "integer",
"description": "The duration in minutes that devices will refrain from using dirty VLANs before adding them back to the pool."
}
},
"description": "Named VLAN Pool DHCP Monitoring settings."
}
},
"description": "Named VLAN settings for wireless networks."
},
"regulatoryDomain": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the regulatory domain for this network."
},
"countryCode": {
"type": "string",
"description": "The country code of the regulatory domain."
},
"permits6e": {
"type": "boolean",
"description": "Whether or not the regulatory domain for this network permits Wifi 6E."
}
},
"description": "Regulatory domain information for this network."
}
}
},
"example": {
"meshingEnabled": true,
"ipv6BridgeEnabled": false,
"locationAnalyticsEnabled": false,
"upgradeStrategy": "minimizeUpgradeTime",
"upgrade": {
"predownload": {
"enabled": false
}
},
"ledLightsOn": false,
"multicastToUnicastConversion": {
"enabled": true
},
"namedVlans": {
"poolDhcpMonitoring": {
"enabled": true,
"duration": 5
}
},
"regulatoryDomain": {
"name": "FCC",
"countryCode": "US",
"permits6e": true
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the wireless settings for a network",
"tags": [
"wireless",
"configure",
"settings"
]
},
"put": {
"description": "Update the wireless settings for a network",
"operationId": "updateNetworkWirelessSettings",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"meshingEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling meshing in a network"
},
"ipv6BridgeEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling IPv6 bridging in a network (Note: if enabled, SSIDs must also be configured to use bridge mode)"
},
"locationAnalyticsEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling location analytics for your network"
},
"upgradeStrategy": {
"type": "string",
"enum": [
"minimizeClientDowntime",
"minimizeUpgradeTime"
],
"description": "The default strategy that network devices will use to perform an upgrade. Requires firmware version MR 26.8 or higher."
},
"upgrade": {
"type": "object",
"properties": {
"predownload": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "The default setting for upgrade firmware predownload. Only applies to devices running MR 32 or higher."
}
},
"description": "Predownload settings for firmware upgrades"
}
},
"description": "Upgrade settings for the network"
},
"ledLightsOn": {
"type": "boolean",
"description": "Toggle for enabling or disabling LED lights on all APs in the network (making them run dark)"
},
"multicastToUnicastConversion": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling multicast-to-unicast conversion across the network"
}
},
"description": "Multicast-to-unicast conversion settings across the network"
},
"namedVlans": {
"type": "object",
"properties": {
"poolDhcpMonitoring": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not devices using named VLAN pools should remove dirty VLANs from the pool, thereby preventing clients from being assigned to VLANs where they would be unable to obtain an IP address via DHCP."
},
"duration": {
"type": "integer",
"description": "The duration in minutes that devices will refrain from using dirty VLANs before adding them back to the pool."
}
},
"description": "Named VLAN Pool DHCP Monitoring settings."
}
},
"description": "Named VLAN settings for wireless networks."
}
},
"example": {
"meshingEnabled": true,
"ipv6BridgeEnabled": false,
"locationAnalyticsEnabled": false,
"upgradeStrategy": "minimizeUpgradeTime",
"upgrade": {
"predownload": {
"enabled": false
}
},
"ledLightsOn": false,
"multicastToUnicastConversion": {
"enabled": true
},
"namedVlans": {
"poolDhcpMonitoring": {
"enabled": true,
"duration": 5
}
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"meshingEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling meshing in a network"
},
"ipv6BridgeEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling IPv6 bridging in a network (Note: if enabled, SSIDs must also be configured to use bridge mode)"
},
"locationAnalyticsEnabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling location analytics for your network"
},
"upgradeStrategy": {
"type": "string",
"enum": [
"minimizeClientDowntime",
"minimizeUpgradeTime"
],
"description": "The default strategy that network devices will use to perform an upgrade. Requires firmware version MR 26.8 or higher."
},
"upgrade": {
"type": "object",
"properties": {
"predownload": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "The default setting for upgrade firmware predownload. Only applies to devices running MR 32 or higher."
}
},
"description": "Predownload settings for firmware upgrades"
}
},
"description": "Upgrade settings for the network"
},
"ledLightsOn": {
"type": "boolean",
"description": "Toggle for enabling or disabling LED lights on all APs in the network (making them run dark)"
},
"multicastToUnicastConversion": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling multicast-to-unicast conversion across the network"
}
},
"description": "Multicast-to-unicast conversion settings across the network"
},
"namedVlans": {
"type": "object",
"properties": {
"poolDhcpMonitoring": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not devices using named VLAN pools should remove dirty VLANs from the pool, thereby preventing clients from being assigned to VLANs where they would be unable to obtain an IP address via DHCP"
},
"duration": {
"type": "integer",
"description": "The duration in minutes that devices will refrain from using dirty VLANs before adding them back to the pool."
}
},
"description": "Named VLAN Pool DHCP Monitoring settings."
}
},
"description": "Named VLAN settings for wireless networks."
},
"regulatoryDomain": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the regulatory domain for this network."
},
"countryCode": {
"type": "string",
"description": "The country code of the regulatory domain."
},
"permits6e": {
"type": "boolean",
"description": "Whether or not the regulatory domain for this network permits Wifi 6E."
}
},
"description": "Regulatory domain information for this network."
}
}
},
"example": {
"meshingEnabled": true,
"ipv6BridgeEnabled": false,
"locationAnalyticsEnabled": false,
"upgradeStrategy": "minimizeUpgradeTime",
"upgrade": {
"predownload": {
"enabled": false
}
},
"ledLightsOn": false,
"multicastToUnicastConversion": {
"enabled": true
},
"namedVlans": {
"poolDhcpMonitoring": {
"enabled": true,
"duration": 5
}
},
"regulatoryDomain": {
"name": "FCC",
"countryCode": "US",
"permits6e": true
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the wireless settings for a network",
"tags": [
"wireless",
"configure",
"settings"
]
}
},
"/networks/{networkId}/wireless/signalQualityHistory": {
"get": {
"description": "Return signal quality (SNR/RSSI) over time for a device or network client",
"operationId": "getNetworkWirelessSignalQualityHistory",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.",
"schema": {
"type": "integer"
}
},
{
"name": "autoResolution",
"in": "query",
"description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.",
"schema": {
"type": "boolean"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter results by network client.",
"schema": {
"type": "string"
}
},
{
"name": "deviceSerial",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "string"
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.",
"schema": {
"type": "string"
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6').",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the query range"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the query range"
},
"snr": {
"type": "integer",
"description": "Signal to noise ratio"
},
"rssi": {
"type": "integer",
"description": "Received signal strength indicator"
}
}
}
},
"example": [
{
"startTs": "2020-01-01T00:00:00Z",
"endTs": "2020-01-01T01:00:00Z",
"snr": 27,
"rssi": -77
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return signal quality (SNR/RSSI) over time for a device or network client",
"tags": [
"wireless",
"monitor",
"signalQualityHistory"
]
}
},
"/networks/{networkId}/wireless/ssids": {
"get": {
"description": "List the MR SSIDs in a network",
"operationId": "getNetworkWirelessSsids",
"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": {
"number": {
"type": "integer",
"description": "Unique identifier of the SSID"
},
"name": {
"type": "string",
"description": "The name of the SSID"
},
"enabled": {
"type": "boolean",
"description": "Whether or not the SSID is enabled"
},
"splashPage": {
"type": "string",
"enum": [
"Billing",
"Cisco ISE",
"Click-through splash page",
"Facebook Wi-Fi",
"Google Apps domain",
"Google OAuth",
"Microsoft Entra ID",
"None",
"Password-protected with Active Directory",
"Password-protected with LDAP",
"Password-protected with Meraki RADIUS",
"Password-protected with custom RADIUS",
"SMS authentication",
"Sponsored guest",
"Systems Manager Sentry"
],
"description": "The type of splash page for the SSID"
},
"ssidAdminAccessible": {
"type": "boolean",
"description": "SSID Administrator access status"
},
"localAuth": {
"type": "boolean",
"description": "Extended local auth flag for Enterprise NAC. Only present when authMode is '8021x-nac'."
},
"authMode": {
"type": "string",
"enum": [
"8021x-entra",
"8021x-google",
"8021x-localradius",
"8021x-meraki",
"8021x-nac",
"8021x-radius",
"ipsk-with-nac",
"ipsk-with-radius",
"ipsk-with-radius-easy-psk",
"ipsk-without-radius",
"open",
"open-enhanced",
"open-enhanced-with-radius",
"open-with-nac",
"open-with-radius",
"psk"
],
"description": "The association control method for the SSID"
},
"psk": {
"type": "string",
"description": "The passkey for the SSID. This param is only valid if the authMode is 'psk'. Read-only admins receive a masked value. Only present when authMode is 'psk'."
},
"encryptionMode": {
"type": "string",
"enum": [
"wep",
"wpa"
],
"description": "The psk encryption mode for the SSID. Only present when authMode requires encryption."
},
"wpaEncryptionMode": {
"type": "string",
"enum": [
"WPA1 and WPA2",
"WPA1 only",
"WPA2 only",
"WPA3 192-bit Security",
"WPA3 Transition Mode",
"WPA3 only"
],
"description": "The types of WPA encryption. Only present when authMode requires encryption."
},
"radiusServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the RADIUS server"
},
"host": {
"type": "string",
"description": "IP address (or FQDN) of your RADIUS server"
},
"port": {
"type": "integer",
"description": "UDP port the RADIUS server listens on for Access-requests"
},
"radsecEnabled": {
"type": "boolean",
"description": "Use RADSEC (TLS over TCP) to connect to this RADIUS server. Requires radiusProxyEnabled."
},
"openRoamingCertificateId": {
"type": "integer",
"description": "The ID of the Openroaming Certificate attached to radius server"
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server"
}
}
},
"description": "List of RADIUS 802.1X servers to be used for authentication. Only present when the SSID is configured to use RADIUS."
},
"radiusAccountingServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "IP address (or FQDN) to which the APs will send RADIUS accounting messages"
},
"port": {
"type": "integer",
"description": "Port on the RADIUS server that is listening for accounting messages"
},
"openRoamingCertificateId": {
"type": "integer",
"description": "The ID of the Openroaming Certificate attached to radius server"
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server"
}
}
},
"description": "List of RADIUS accounting 802.1X servers to be used for authentication. Only present when RADIUS accounting is enabled."
},
"radiusAccountingEnabled": {
"type": "boolean",
"description": "Whether or not RADIUS accounting is enabled. Only present when the SSID is configured to use RADIUS."
},
"radiusEnabled": {
"type": "boolean",
"description": "Whether RADIUS authentication is enabled. Only present when the SSID is configured to use RADIUS."
},
"radiusAttributeForGroupPolicies": {
"type": "string",
"enum": [
"Airespace-ACL-Name",
"Aruba-User-Role",
"Filter-Id",
"Reply-Message"
],
"description": "RADIUS attribute used to look up group policies. Only present when the SSID is configured to use RADIUS and the network supports group policies."
},
"radiusFailoverPolicy": {
"type": "string",
"enum": [
"Allow access",
"Deny access"
],
"description": "Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable. Only present when the SSID uses a RADIUS-based splash page."
},
"radiusLoadBalancingPolicy": {
"type": "string",
"enum": [
"Round robin",
"Strict priority order"
],
"description": "Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts. Only present when the SSID uses a RADIUS-based splash page."
},
"ipAssignmentMode": {
"type": "string",
"enum": [
"Bridge mode",
"Campus Gateway",
"Ethernet over GRE",
"Layer 3 roaming",
"Layer 3 roaming with a concentrator",
"NAT mode",
"VPN"
],
"description": "The client IP assignment mode"
},
"adminSplashUrl": {
"type": "string",
"description": "URL for the admin splash page. Only present when a splash page is configured."
},
"splashTimeout": {
"type": "string",
"description": "Splash page timeout. Only present when a splash page is configured."
},
"walledGardenEnabled": {
"type": "boolean",
"description": "Allow users to access a configurable list of IP ranges prior to sign-on. Only present when a splash page is configured."
},
"walledGardenRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domain names and IP address ranges available in Walled Garden mode. Only present when walledGardenEnabled is true and ranges are configured."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "The minimum bitrate in Mbps of this SSID in the default indoor RF profile"
},
"bandSelection": {
"type": "string",
"enum": [
"5 GHz band only",
"Dual band operation",
"Dual band operation with Band Steering"
],
"description": "The client-serving radio frequencies of this SSID in the default indoor RF profile"
},
"perClientBandwidthLimitUp": {
"type": "integer",
"description": "The upload bandwidth limit in Kbps. (0 represents no limit.)"
},
"perClientBandwidthLimitDown": {
"type": "integer",
"description": "The download bandwidth limit in Kbps. (0 represents no limit.)"
},
"visible": {
"type": "boolean",
"description": "Whether the SSID is advertised or hidden by the AP"
},
"availableOnAllAps": {
"type": "boolean",
"description": "Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags"
},
"availabilityTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list"
},
"perSsidBandwidthLimitUp": {
"type": "integer",
"description": "The total upload bandwidth limit in Kbps (0 represents no limit)"
},
"perSsidBandwidthLimitDown": {
"type": "integer",
"description": "The total download bandwidth limit in Kbps (0 represents no limit)"
},
"adaptivePolicyGroupId": {
"type": "string",
"description": "Adaptive policy group ID this SSID is assigned to."
},
"mandatoryDhcpEnabled": {
"type": "boolean",
"description": "Whether clients connecting to this SSID must use the IP address assigned by the DHCP server"
},
"dot11w": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11w is enabled or not."
},
"required": {
"type": "boolean",
"description": "Whether 802.11w is required or not."
}
},
"description": "The current setting for Protected Management Frames (802.11w). Only present when the authMode requires encryption."
},
"dot11r": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11r is enabled or not."
},
"adaptive": {
"type": "boolean",
"description": "Whether 802.11r is adaptive or not."
}
},
"description": "The current setting for 802.11r. Only present when the authMode requires encryption and firmware supports 802.11r."
},
"enterpriseAdminAccess": {
"type": "string",
"enum": [
"access disabled",
"access enabled"
],
"description": "Whether or not an SSID is accessible by 'enterprise' administrators. Only present when the organization supports enterprise admins."
},
"radiusTestingEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki_8021x_test' to ensure that the RADIUS servers are reachable. Only present when the SSID is configured to use RADIUS."
},
"radiusCalledStationId": {
"type": "string",
"description": "The template of the called station identifier to be used for RADIUS (ex. $NODE_MAC$:$VAP_NUM$). Only present when configured and the SSID uses RADIUS-based auth."
},
"radiusAuthenticationNasId": {
"type": "string",
"description": "The template of the NAS identifier to be used for RADIUS authentication (ex. $NODE_MAC$:$VAP_NUM$). Only present when configured and the SSID uses RADIUS-based auth."
},
"radiusServerTimeout": {
"type": "integer",
"description": "The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds). Only present when the SSID uses RADIUS-based auth."
},
"radiusServerAttemptsLimit": {
"type": "integer",
"description": "The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5). Only present when the SSID uses RADIUS-based auth."
},
"radiusFallbackEnabled": {
"type": "boolean",
"description": "Whether or not higher priority RADIUS servers should be retried after 60 seconds. Only present when the SSID uses RADIUS-based auth."
},
"radiusProxyEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers. Only present when the SSID uses RADIUS-based auth."
},
"radiusCoaEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server. Only present when the SSID uses RADIUS-based auth."
},
"radiusOverride": {
"type": "boolean",
"description": "If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'. Only present when the SSID uses RADIUS-based auth and the network supports group policies."
},
"useVlanTagging": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLANs. Only present when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'."
},
"defaultVlanId": {
"type": "integer",
"description": "The default VLAN ID used for 'all other APs'. Only present when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming' and VLAN tagging is enabled."
},
"adultContentFilteringEnabled": {
"type": "boolean",
"description": "Boolean indicating whether or not adult content will be blocked. Only present when ipAssignmentMode is 'NAT mode'."
},
"dnsRewrite": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not DNS server rewrite is enabled. If disabled, upstream DNS will be used."
},
"dnsCustomNameservers": {
"type": "array",
"items": {
"type": "string"
},
"description": "User specified DNS servers (up to two servers)"
}
},
"description": "DNS servers rewrite settings. Only present when ipAssignmentMode is 'NAT mode'."
},
"gre": {
"type": "object",
"properties": {
"concentrator": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "The EoGRE concentrator's IP or FQDN."
}
},
"description": "The EoGRE concentrator's settings"
},
"key": {
"type": "integer",
"description": "Optional numerical identifier that will add the GRE key field to the GRE header. Used to identify an individual traffic flow within a tunnel."
},
"clientIsolation": {
"type": "boolean",
"description": "Whether or not client isolation is enabled."
}
},
"description": "Ethernet over GRE settings. Only present when ipAssignmentMode is 'Ethernet over GRE'."
},
"lanIsolationEnabled": {
"type": "boolean",
"description": "Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'."
},
"oauth": {
"type": "object",
"properties": {
"allowedDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of domains allowed access to the network."
}
},
"description": "The OAuth settings of this SSID. Only valid if splashPage is 'Google OAuth'. Only present when the SSID uses OAuth."
},
"localAuthFallback": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, MR devices will cache authentication credentials for EAP-TLS or for MAC based authentication."
},
"cacheTimeout": {
"type": "integer",
"description": "The duration (in seconds) for which auths are cached."
},
"serverCaCertificate": {
"type": "object",
"properties": {
"contents": {
"type": "string",
"description": "The contents of the Server CA Certificate. Must be in PEM or DER format.",
"nullable": true
}
},
"description": "The Server CA Certificate used to sign the client certificate."
}
},
"description": "The current configuration for Local Authentication Fallback. Only present when the network supports local auth fallback and the SSID uses WPA-EAP or open-with-RADIUS."
},
"namedVlans": {
"type": "object",
"properties": {
"tagging": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLAN names."
},
"defaultVlanName": {
"type": "string",
"description": "The default VLAN name used to tag traffic in the absence of a matching AP tag."
},
"byApTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of AP tags."
},
"vlanName": {
"type": "string",
"description": "VLAN name that will be used to tag traffic."
}
}
},
"description": "The list of AP tags and VLAN names used for named VLAN tagging."
}
},
"description": "VLAN tagging settings."
},
"radius": {
"type": "object",
"properties": {
"guestVlan": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not RADIUS guest named VLAN is enabled."
},
"name": {
"type": "string",
"description": "RADIUS guest VLAN name."
}
},
"description": "Guest VLAN settings."
}
},
"description": "RADIUS settings."
}
},
"description": "Named VLAN settings. Only present when the network supports named VLANs."
},
"speedBurst": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not to allow users to temporarily exceed the bandwidth limit for short periods while still keeping them under the bandwidth limit over time."
}
},
"description": "The SpeedBurst setting for this SSID"
},
"wifiPersonalNetworkEnabled": {
"type": "boolean",
"description": "Boolean indicating whether or not Wi-Fi Personal Network is enabled for this SSID. Only present when the network supports Wi-Fi Personal Network."
},
"security": {
"type": "object",
"properties": {
"encryption": {
"type": "object",
"properties": {
"ciphers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CCMP 128",
"GCMP 256"
]
},
"description": "Encryption ciphers used by the SSID."
},
"akms": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SAE",
"SAE-EXT"
]
},
"description": "Authentication key management systems used by the SSID."
}
},
"description": "Encryption settings for WPA3 modes"
}
},
"description": "Security settings for the SSID. Only present when WPA3 is configured."
}
},
"required": [
"number",
"name",
"enabled",
"splashPage",
"ssidAdminAccessible",
"authMode",
"ipAssignmentMode",
"minBitrate",
"bandSelection",
"perClientBandwidthLimitUp",
"perClientBandwidthLimitDown",
"visible",
"availableOnAllAps",
"availabilityTags",
"perSsidBandwidthLimitUp",
"perSsidBandwidthLimitDown",
"mandatoryDhcpEnabled",
"speedBurst"
]
}
},
"example": [
{
"number": 0,
"name": "My SSID",
"enabled": true,
"splashPage": "Click-through splash page",
"ssidAdminAccessible": false,
"localAuth": false,
"authMode": "8021x-radius",
"psk": "deadbeef",
"encryptionMode": "wpa",
"wpaEncryptionMode": "WPA2 only",
"radiusServers": [
{
"id": "797137134045134582",
"host": "0.0.0.0",
"port": 3000,
"radsecEnabled": false,
"openRoamingCertificateId": 2,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusAccountingServers": [
{
"host": "0.0.0.0",
"port": 3000,
"openRoamingCertificateId": 2,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusAccountingEnabled": false,
"radiusEnabled": true,
"radiusAttributeForGroupPolicies": "Filter-Id",
"radiusFailoverPolicy": "Deny access",
"radiusLoadBalancingPolicy": "Round robin",
"ipAssignmentMode": "NAT mode",
"adminSplashUrl": "http://example.com",
"splashTimeout": "30 minutes",
"walledGardenEnabled": true,
"walledGardenRanges": [
"example.com",
"1.1.1.1/32"
],
"minBitrate": 11.0,
"bandSelection": "5 GHz band only",
"perClientBandwidthLimitUp": 0,
"perClientBandwidthLimitDown": 0,
"visible": true,
"availableOnAllAps": false,
"availabilityTags": [
"tag1",
"tag2"
],
"perSsidBandwidthLimitUp": 0,
"perSsidBandwidthLimitDown": 0,
"adaptivePolicyGroupId": "1234",
"mandatoryDhcpEnabled": false,
"dot11w": {
"enabled": true,
"required": false
},
"dot11r": {
"enabled": true,
"adaptive": true
},
"enterpriseAdminAccess": "access enabled",
"radiusTestingEnabled": true,
"radiusCalledStationId": "00-11-22-33-44-55:AP1",
"radiusAuthenticationNasId": "00-11-22-33-44-55:AP1",
"radiusServerTimeout": 5,
"radiusServerAttemptsLimit": 5,
"radiusFallbackEnabled": true,
"radiusProxyEnabled": false,
"radiusCoaEnabled": true,
"radiusOverride": false,
"useVlanTagging": false,
"defaultVlanId": 1,
"adultContentFilteringEnabled": false,
"dnsRewrite": {
"enabled": true,
"dnsCustomNameservers": [
"8.8.8.8",
"8.8.4.4"
]
},
"gre": {
"concentrator": {
"host": "192.168.1.1"
},
"key": 5,
"clientIsolation": false
},
"lanIsolationEnabled": true,
"oauth": {
"allowedDomains": [
"example.com"
]
},
"localAuthFallback": {
"enabled": true,
"cacheTimeout": 6500,
"serverCaCertificate": {
"contents": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
},
"namedVlans": {
"tagging": {
"enabled": true,
"defaultVlanName": "My VLAN",
"byApTags": [
{
"tags": [
"tag1",
"tag2"
],
"vlanName": "My VLAN"
}
]
},
"radius": {
"guestVlan": {
"enabled": true,
"name": "Guest VLAN"
}
}
},
"speedBurst": {
"enabled": true
},
"wifiPersonalNetworkEnabled": false,
"security": {
"encryption": {
"ciphers": [
"CCMP 128"
],
"akms": [
"SAE"
]
}
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List the MR SSIDs in a network",
"tags": [
"wireless",
"configure",
"ssids"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}": {
"get": {
"description": "Return a single MR SSID",
"operationId": "getNetworkWirelessSsid",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"description": "Unique identifier of the SSID"
},
"name": {
"type": "string",
"description": "The name of the SSID"
},
"enabled": {
"type": "boolean",
"description": "Whether or not the SSID is enabled"
},
"splashPage": {
"type": "string",
"enum": [
"Billing",
"Cisco ISE",
"Click-through splash page",
"Facebook Wi-Fi",
"Google Apps domain",
"Google OAuth",
"Microsoft Entra ID",
"None",
"Password-protected with Active Directory",
"Password-protected with LDAP",
"Password-protected with Meraki RADIUS",
"Password-protected with custom RADIUS",
"SMS authentication",
"Sponsored guest",
"Systems Manager Sentry"
],
"description": "The type of splash page for the SSID"
},
"ssidAdminAccessible": {
"type": "boolean",
"description": "SSID Administrator access status"
},
"localAuth": {
"type": "boolean",
"description": "Extended local auth flag for Enterprise NAC. Only present when authMode is '8021x-nac'."
},
"authMode": {
"type": "string",
"enum": [
"8021x-entra",
"8021x-google",
"8021x-localradius",
"8021x-meraki",
"8021x-nac",
"8021x-radius",
"ipsk-with-nac",
"ipsk-with-radius",
"ipsk-with-radius-easy-psk",
"ipsk-without-radius",
"open",
"open-enhanced",
"open-enhanced-with-radius",
"open-with-nac",
"open-with-radius",
"psk"
],
"description": "The association control method for the SSID"
},
"psk": {
"type": "string",
"description": "The passkey for the SSID. This param is only valid if the authMode is 'psk'. Read-only admins receive a masked value. Only present when authMode is 'psk'."
},
"encryptionMode": {
"type": "string",
"enum": [
"wep",
"wpa"
],
"description": "The psk encryption mode for the SSID. Only present when authMode requires encryption."
},
"wpaEncryptionMode": {
"type": "string",
"enum": [
"WPA1 and WPA2",
"WPA1 only",
"WPA2 only",
"WPA3 192-bit Security",
"WPA3 Transition Mode",
"WPA3 only"
],
"description": "The types of WPA encryption. Only present when authMode requires encryption."
},
"radiusServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the RADIUS server"
},
"host": {
"type": "string",
"description": "IP address (or FQDN) of your RADIUS server"
},
"port": {
"type": "integer",
"description": "UDP port the RADIUS server listens on for Access-requests"
},
"radsecEnabled": {
"type": "boolean",
"description": "Use RADSEC (TLS over TCP) to connect to this RADIUS server. Requires radiusProxyEnabled."
},
"openRoamingCertificateId": {
"type": "integer",
"description": "The ID of the Openroaming Certificate attached to radius server"
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server"
}
}
},
"description": "List of RADIUS 802.1X servers to be used for authentication. Only present when the SSID is configured to use RADIUS."
},
"radiusAccountingServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "IP address (or FQDN) to which the APs will send RADIUS accounting messages"
},
"port": {
"type": "integer",
"description": "Port on the RADIUS server that is listening for accounting messages"
},
"openRoamingCertificateId": {
"type": "integer",
"description": "The ID of the Openroaming Certificate attached to radius server"
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server"
}
}
},
"description": "List of RADIUS accounting 802.1X servers to be used for authentication. Only present when RADIUS accounting is enabled."
},
"radiusAccountingEnabled": {
"type": "boolean",
"description": "Whether or not RADIUS accounting is enabled. Only present when the SSID is configured to use RADIUS."
},
"radiusEnabled": {
"type": "boolean",
"description": "Whether RADIUS authentication is enabled. Only present when the SSID is configured to use RADIUS."
},
"radiusAttributeForGroupPolicies": {
"type": "string",
"enum": [
"Airespace-ACL-Name",
"Aruba-User-Role",
"Filter-Id",
"Reply-Message"
],
"description": "RADIUS attribute used to look up group policies. Only present when the SSID is configured to use RADIUS and the network supports group policies."
},
"radiusFailoverPolicy": {
"type": "string",
"enum": [
"Allow access",
"Deny access"
],
"description": "Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable. Only present when the SSID uses a RADIUS-based splash page."
},
"radiusLoadBalancingPolicy": {
"type": "string",
"enum": [
"Round robin",
"Strict priority order"
],
"description": "Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts. Only present when the SSID uses a RADIUS-based splash page."
},
"ipAssignmentMode": {
"type": "string",
"enum": [
"Bridge mode",
"Campus Gateway",
"Ethernet over GRE",
"Layer 3 roaming",
"Layer 3 roaming with a concentrator",
"NAT mode",
"VPN"
],
"description": "The client IP assignment mode"
},
"adminSplashUrl": {
"type": "string",
"description": "URL for the admin splash page. Only present when a splash page is configured."
},
"splashTimeout": {
"type": "string",
"description": "Splash page timeout. Only present when a splash page is configured."
},
"walledGardenEnabled": {
"type": "boolean",
"description": "Allow users to access a configurable list of IP ranges prior to sign-on. Only present when a splash page is configured."
},
"walledGardenRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domain names and IP address ranges available in Walled Garden mode. Only present when walledGardenEnabled is true and ranges are configured."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "The minimum bitrate in Mbps of this SSID in the default indoor RF profile"
},
"bandSelection": {
"type": "string",
"enum": [
"5 GHz band only",
"Dual band operation",
"Dual band operation with Band Steering"
],
"description": "The client-serving radio frequencies of this SSID in the default indoor RF profile"
},
"perClientBandwidthLimitUp": {
"type": "integer",
"description": "The upload bandwidth limit in Kbps. (0 represents no limit.)"
},
"perClientBandwidthLimitDown": {
"type": "integer",
"description": "The download bandwidth limit in Kbps. (0 represents no limit.)"
},
"visible": {
"type": "boolean",
"description": "Whether the SSID is advertised or hidden by the AP"
},
"availableOnAllAps": {
"type": "boolean",
"description": "Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags"
},
"availabilityTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list"
},
"perSsidBandwidthLimitUp": {
"type": "integer",
"description": "The total upload bandwidth limit in Kbps (0 represents no limit)"
},
"perSsidBandwidthLimitDown": {
"type": "integer",
"description": "The total download bandwidth limit in Kbps (0 represents no limit)"
},
"adaptivePolicyGroupId": {
"type": "string",
"description": "Adaptive policy group ID this SSID is assigned to."
},
"mandatoryDhcpEnabled": {
"type": "boolean",
"description": "Whether clients connecting to this SSID must use the IP address assigned by the DHCP server"
},
"dot11w": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11w is enabled or not."
},
"required": {
"type": "boolean",
"description": "Whether 802.11w is required or not."
}
},
"description": "The current setting for Protected Management Frames (802.11w). Only present when the authMode requires encryption."
},
"dot11r": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11r is enabled or not."
},
"adaptive": {
"type": "boolean",
"description": "Whether 802.11r is adaptive or not."
}
},
"description": "The current setting for 802.11r. Only present when the authMode requires encryption and firmware supports 802.11r."
},
"enterpriseAdminAccess": {
"type": "string",
"enum": [
"access disabled",
"access enabled"
],
"description": "Whether or not an SSID is accessible by 'enterprise' administrators. Only present when the organization supports enterprise admins."
},
"radiusTestingEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki_8021x_test' to ensure that the RADIUS servers are reachable. Only present when the SSID is configured to use RADIUS."
},
"radiusCalledStationId": {
"type": "string",
"description": "The template of the called station identifier to be used for RADIUS (ex. $NODE_MAC$:$VAP_NUM$). Only present when configured and the SSID uses RADIUS-based auth."
},
"radiusAuthenticationNasId": {
"type": "string",
"description": "The template of the NAS identifier to be used for RADIUS authentication (ex. $NODE_MAC$:$VAP_NUM$). Only present when configured and the SSID uses RADIUS-based auth."
},
"radiusServerTimeout": {
"type": "integer",
"description": "The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds). Only present when the SSID uses RADIUS-based auth."
},
"radiusServerAttemptsLimit": {
"type": "integer",
"description": "The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5). Only present when the SSID uses RADIUS-based auth."
},
"radiusFallbackEnabled": {
"type": "boolean",
"description": "Whether or not higher priority RADIUS servers should be retried after 60 seconds. Only present when the SSID uses RADIUS-based auth."
},
"radiusProxyEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers. Only present when the SSID uses RADIUS-based auth."
},
"radiusCoaEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server. Only present when the SSID uses RADIUS-based auth."
},
"radiusOverride": {
"type": "boolean",
"description": "If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'. Only present when the SSID uses RADIUS-based auth and the network supports group policies."
},
"useVlanTagging": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLANs. Only present when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'."
},
"defaultVlanId": {
"type": "integer",
"description": "The default VLAN ID used for 'all other APs'. Only present when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming' and VLAN tagging is enabled."
},
"adultContentFilteringEnabled": {
"type": "boolean",
"description": "Boolean indicating whether or not adult content will be blocked. Only present when ipAssignmentMode is 'NAT mode'."
},
"dnsRewrite": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not DNS server rewrite is enabled. If disabled, upstream DNS will be used."
},
"dnsCustomNameservers": {
"type": "array",
"items": {
"type": "string"
},
"description": "User specified DNS servers (up to two servers)"
}
},
"description": "DNS servers rewrite settings. Only present when ipAssignmentMode is 'NAT mode'."
},
"gre": {
"type": "object",
"properties": {
"concentrator": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "The EoGRE concentrator's IP or FQDN."
}
},
"description": "The EoGRE concentrator's settings"
},
"key": {
"type": "integer",
"description": "Optional numerical identifier that will add the GRE key field to the GRE header. Used to identify an individual traffic flow within a tunnel."
},
"clientIsolation": {
"type": "boolean",
"description": "Whether or not client isolation is enabled."
}
},
"description": "Ethernet over GRE settings. Only present when ipAssignmentMode is 'Ethernet over GRE'."
},
"lanIsolationEnabled": {
"type": "boolean",
"description": "Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'."
},
"oauth": {
"type": "object",
"properties": {
"allowedDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of domains allowed access to the network."
}
},
"description": "The OAuth settings of this SSID. Only valid if splashPage is 'Google OAuth'. Only present when the SSID uses OAuth."
},
"localAuthFallback": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, MR devices will cache authentication credentials for EAP-TLS or for MAC based authentication."
},
"cacheTimeout": {
"type": "integer",
"description": "The duration (in seconds) for which auths are cached."
},
"serverCaCertificate": {
"type": "object",
"properties": {
"contents": {
"type": "string",
"description": "The contents of the Server CA Certificate. Must be in PEM or DER format.",
"nullable": true
}
},
"description": "The Server CA Certificate used to sign the client certificate."
}
},
"description": "The current configuration for Local Authentication Fallback. Only present when the network supports local auth fallback and the SSID uses WPA-EAP or open-with-RADIUS."
},
"namedVlans": {
"type": "object",
"properties": {
"tagging": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLAN names."
},
"defaultVlanName": {
"type": "string",
"description": "The default VLAN name used to tag traffic in the absence of a matching AP tag."
},
"byApTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of AP tags."
},
"vlanName": {
"type": "string",
"description": "VLAN name that will be used to tag traffic."
}
}
},
"description": "The list of AP tags and VLAN names used for named VLAN tagging."
}
},
"description": "VLAN tagging settings."
},
"radius": {
"type": "object",
"properties": {
"guestVlan": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not RADIUS guest named VLAN is enabled."
},
"name": {
"type": "string",
"description": "RADIUS guest VLAN name."
}
},
"description": "Guest VLAN settings."
}
},
"description": "RADIUS settings."
}
},
"description": "Named VLAN settings. Only present when the network supports named VLANs."
},
"speedBurst": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not to allow users to temporarily exceed the bandwidth limit for short periods while still keeping them under the bandwidth limit over time."
}
},
"description": "The SpeedBurst setting for this SSID"
},
"wifiPersonalNetworkEnabled": {
"type": "boolean",
"description": "Boolean indicating whether or not Wi-Fi Personal Network is enabled for this SSID. Only present when the network supports Wi-Fi Personal Network."
},
"security": {
"type": "object",
"properties": {
"encryption": {
"type": "object",
"properties": {
"ciphers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CCMP 128",
"GCMP 256"
]
},
"description": "Encryption ciphers used by the SSID."
},
"akms": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SAE",
"SAE-EXT"
]
},
"description": "Authentication key management systems used by the SSID."
}
},
"description": "Encryption settings for WPA3 modes"
}
},
"description": "Security settings for the SSID. Only present when WPA3 is configured."
}
},
"required": [
"number",
"name",
"enabled",
"splashPage",
"ssidAdminAccessible",
"authMode",
"ipAssignmentMode",
"minBitrate",
"bandSelection",
"perClientBandwidthLimitUp",
"perClientBandwidthLimitDown",
"visible",
"availableOnAllAps",
"availabilityTags",
"perSsidBandwidthLimitUp",
"perSsidBandwidthLimitDown",
"mandatoryDhcpEnabled",
"speedBurst"
]
},
"example": {
"number": 0,
"name": "My SSID",
"enabled": true,
"splashPage": "Click-through splash page",
"ssidAdminAccessible": false,
"localAuth": false,
"authMode": "8021x-radius",
"psk": "deadbeef",
"encryptionMode": "wpa",
"wpaEncryptionMode": "WPA2 only",
"radiusServers": [
{
"id": "797137134045134582",
"host": "0.0.0.0",
"port": 3000,
"radsecEnabled": false,
"openRoamingCertificateId": 2,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusAccountingServers": [
{
"host": "0.0.0.0",
"port": 3000,
"openRoamingCertificateId": 2,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusAccountingEnabled": false,
"radiusEnabled": true,
"radiusAttributeForGroupPolicies": "Filter-Id",
"radiusFailoverPolicy": "Deny access",
"radiusLoadBalancingPolicy": "Round robin",
"ipAssignmentMode": "NAT mode",
"adminSplashUrl": "http://example.com",
"splashTimeout": "30 minutes",
"walledGardenEnabled": true,
"walledGardenRanges": [
"example.com",
"1.1.1.1/32"
],
"minBitrate": 11.0,
"bandSelection": "5 GHz band only",
"perClientBandwidthLimitUp": 0,
"perClientBandwidthLimitDown": 0,
"visible": true,
"availableOnAllAps": false,
"availabilityTags": [
"tag1",
"tag2"
],
"perSsidBandwidthLimitUp": 0,
"perSsidBandwidthLimitDown": 0,
"adaptivePolicyGroupId": "1234",
"mandatoryDhcpEnabled": false,
"dot11w": {
"enabled": true,
"required": false
},
"dot11r": {
"enabled": true,
"adaptive": true
},
"enterpriseAdminAccess": "access enabled",
"radiusTestingEnabled": true,
"radiusCalledStationId": "00-11-22-33-44-55:AP1",
"radiusAuthenticationNasId": "00-11-22-33-44-55:AP1",
"radiusServerTimeout": 5,
"radiusServerAttemptsLimit": 5,
"radiusFallbackEnabled": true,
"radiusProxyEnabled": false,
"radiusCoaEnabled": true,
"radiusOverride": false,
"useVlanTagging": false,
"defaultVlanId": 1,
"adultContentFilteringEnabled": false,
"dnsRewrite": {
"enabled": true,
"dnsCustomNameservers": [
"8.8.8.8",
"8.8.4.4"
]
},
"gre": {
"concentrator": {
"host": "192.168.1.1"
},
"key": 5,
"clientIsolation": false
},
"lanIsolationEnabled": true,
"oauth": {
"allowedDomains": [
"example.com"
]
},
"localAuthFallback": {
"enabled": true,
"cacheTimeout": 6500,
"serverCaCertificate": {
"contents": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
},
"namedVlans": {
"tagging": {
"enabled": true,
"defaultVlanName": "My VLAN",
"byApTags": [
{
"tags": [
"tag1",
"tag2"
],
"vlanName": "My VLAN"
}
]
},
"radius": {
"guestVlan": {
"enabled": true,
"name": "Guest VLAN"
}
}
},
"speedBurst": {
"enabled": true
},
"wifiPersonalNetworkEnabled": false,
"security": {
"encryption": {
"ciphers": [
"CCMP 128"
],
"akms": [
"SAE"
]
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return a single MR SSID",
"tags": [
"wireless",
"configure",
"ssids"
]
},
"put": {
"description": "Update the attributes of an MR SSID",
"operationId": "updateNetworkWirelessSsid",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SSID"
},
"enabled": {
"type": "boolean",
"description": "Whether or not the SSID is enabled"
},
"authMode": {
"type": "string",
"enum": [
"8021x-entra",
"8021x-google",
"8021x-localradius",
"8021x-meraki",
"8021x-nac",
"8021x-radius",
"ipsk-with-nac",
"ipsk-with-radius",
"ipsk-with-radius-easy-psk",
"ipsk-without-radius",
"open",
"open-enhanced",
"open-enhanced-with-radius",
"open-with-nac",
"open-with-radius",
"psk"
],
"description": "The association control method for the SSID ('open', 'open-enhanced', 'psk', 'open-with-radius', 'open-enhanced-with-radius', 'open-with-nac', '8021x-meraki', '8021x-nac', '8021x-radius', '8021x-google', '8021x-entra', '8021x-localradius', 'ipsk-with-radius', 'ipsk-without-radius', 'ipsk-with-nac' or 'ipsk-with-radius-easy-psk')"
},
"enterpriseAdminAccess": {
"type": "string",
"enum": [
"access disabled",
"access enabled"
],
"description": "Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled')"
},
"ssidAdminAccessible": {
"type": "boolean",
"description": "SSID Administrator access status"
},
"encryptionMode": {
"type": "string",
"enum": [
"open",
"wep",
"wpa",
"wpa-eap"
],
"description": "The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'"
},
"psk": {
"type": "string",
"description": "The passkey for the SSID. This param is only valid if the authMode is 'psk'"
},
"wpaEncryptionMode": {
"type": "string",
"enum": [
"WPA1 and WPA2",
"WPA1 only",
"WPA2 only",
"WPA3 192-bit Security",
"WPA3 Transition Mode",
"WPA3 only"
],
"description": "The types of WPA encryption. ('WPA1 only', 'WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode', 'WPA3 only' or 'WPA3 192-bit Security')"
},
"dot11w": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11w is enabled or not."
},
"required": {
"type": "boolean",
"description": "(Optional) Whether 802.11w is required or not."
}
},
"description": "The current setting for Protected Management Frames (802.11w)."
},
"dot11r": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11r is enabled or not."
},
"adaptive": {
"type": "boolean",
"description": "(Optional) Whether 802.11r is adaptive or not."
}
},
"description": "The current setting for 802.11r"
},
"splashPage": {
"type": "string",
"enum": [
"Billing",
"Cisco ISE",
"Click-through splash page",
"Facebook Wi-Fi",
"Google Apps domain",
"Google OAuth",
"Microsoft Entra ID",
"None",
"Password-protected with Active Directory",
"Password-protected with LDAP",
"Password-protected with Meraki RADIUS",
"Password-protected with custom RADIUS",
"SMS authentication",
"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', 'Microsoft Entra ID', 'Sponsored guest', 'Cisco ISE' or 'Google Apps domain').This attribute is not supported for template children."
},
"splashGuestSponsorDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of valid sponsor email domains for sponsored guest splash type."
},
"oauth": {
"type": "object",
"properties": {
"allowedDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "(Optional) The list of domains allowed access to the network."
}
},
"description": "The OAuth settings of this SSID. Only valid if splashPage is 'Google OAuth'."
},
"localRadius": {
"type": "object",
"properties": {
"cacheTimeout": {
"type": "integer",
"description": "The duration (in seconds) for which LDAP and OCSP lookups are cached."
},
"passwordAuthentication": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not to use EAP-TTLS/PAP or PEAP-GTC password-based authentication via LDAP lookup."
}
},
"description": "The current setting for password-based authentication."
},
"certificateAuthentication": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not to use EAP-TLS certificate-based authentication to validate wireless clients."
},
"useLdap": {
"type": "boolean",
"description": "Whether or not to verify the certificate with LDAP."
},
"useOcsp": {
"type": "boolean",
"description": "Whether or not to verify the certificate with OCSP."
},
"ocspResponderUrl": {
"type": "string",
"description": "(Optional) The URL of the OCSP responder to verify client certificate status.",
"nullable": true
},
"clientRootCaCertificate": {
"type": "object",
"properties": {
"contents": {
"type": "string",
"description": "The contents of the Client CA Certificate. Must be in PEM or DER format.",
"nullable": true
}
},
"description": "The Client CA Certificate used to sign the client certificate."
}
},
"description": "The current setting for certificate verification."
}
},
"description": "The current setting for Local Authentication, a built-in RADIUS server on the access point. Only valid if authMode is '8021x-localradius'."
},
"ldap": {
"type": "object",
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "IP address (or FQDN) of your LDAP server."
},
"port": {
"type": "integer",
"description": "UDP port the LDAP server listens on."
}
},
"required": [
"host",
"port"
]
},
"description": "The LDAP servers to be used for authentication."
},
"credentials": {
"type": "object",
"properties": {
"distinguishedName": {
"type": "string",
"description": "The distinguished name of the LDAP user account (example: cn=user,dc=meraki,dc=com).",
"nullable": true
},
"password": {
"type": "string",
"description": "The password of the LDAP user account.",
"nullable": true
}
},
"description": "(Optional) The credentials of the user account to be used by the AP to bind to your LDAP server. The LDAP account should have permissions on all your LDAP servers."
},
"baseDistinguishedName": {
"type": "string",
"description": "The base distinguished name of users on the LDAP server.",
"nullable": true
},
"serverCaCertificate": {
"type": "object",
"properties": {
"contents": {
"type": "string",
"description": "The contents of the CA certificate. Must be in PEM or DER format.",
"nullable": true
}
},
"description": "The CA certificate used to sign the LDAP server's key."
}
},
"description": "The current setting for LDAP. Only valid if splashPage is 'Password-protected with LDAP'."
},
"activeDirectory": {
"type": "object",
"properties": {
"servers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "IP address (or FQDN) of your Active Directory server."
},
"port": {
"type": "integer",
"description": "(Optional) UDP port the Active Directory server listens on. By default, uses port 3268."
}
},
"required": [
"host"
]
},
"description": "The Active Directory servers to be used for authentication."
},
"credentials": {
"type": "object",
"properties": {
"logonName": {
"type": "string",
"description": "The logon name of the Active Directory account.",
"nullable": true
},
"password": {
"type": "string",
"description": "The password to the Active Directory user account.",
"nullable": true
}
},
"description": "(Optional) The credentials of the user account to be used by the AP to bind to your Active Directory server. The Active Directory account should have permissions on all your Active Directory servers. Only valid if the splashPage is 'Password-protected with Active Directory'."
}
},
"description": "The current setting for Active Directory. Only valid if splashPage is 'Password-protected with Active Directory'"
},
"radiusServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "IP address (or FQDN) of your RADIUS server"
},
"port": {
"type": "integer",
"description": "UDP port the RADIUS server listens on for Access-requests"
},
"secret": {
"type": "string",
"description": "RADIUS client shared secret"
},
"radsecEnabled": {
"type": "boolean",
"description": "Use RadSec (TLS over TCP) to connect to this RADIUS server. Requires radiusProxyEnabled."
},
"openRoamingCertificateId": {
"type": "integer",
"description": "The ID of the Openroaming Certificate attached to radius server.",
"nullable": true
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server",
"nullable": true
}
},
"required": [
"host"
]
},
"description": "The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'"
},
"radiusProxyEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers."
},
"radiusTestingEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki_8021x_test' to ensure that the RADIUS servers are reachable."
},
"radiusCalledStationId": {
"type": "string",
"description": "The template of the called station identifier to be used for RADIUS (ex. $NODE_MAC$:$VAP_NUM$)."
},
"radiusAuthenticationNasId": {
"type": "string",
"description": "The template of the NAS identifier to be used for RADIUS authentication (ex. $NODE_MAC$:$VAP_NUM$)."
},
"radiusServerTimeout": {
"type": "integer",
"description": "The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds)."
},
"radiusServerAttemptsLimit": {
"type": "integer",
"description": "The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5)."
},
"radiusFallbackEnabled": {
"type": "boolean",
"description": "Whether or not higher priority RADIUS servers should be retried after 60 seconds."
},
"radiusRadsec": {
"type": "object",
"properties": {
"tlsTunnel": {
"type": "object",
"properties": {
"timeout": {
"type": "integer",
"description": "The interval (in seconds) to determines how long a TLS session can remain idle for a RadSec server before it is automatically terminated"
}
},
"description": "RadSec TLS tunnel settings"
}
},
"x-release-stage": "general_availability",
"description": "The current settings for RADIUS RadSec"
},
"radiusCoaEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server."
},
"radiusFailoverPolicy": {
"type": "string",
"enum": [
"Allow access",
"Deny access"
],
"description": "This policy determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable ('Deny access' or 'Allow access')"
},
"radiusLoadBalancingPolicy": {
"type": "string",
"enum": [
"Round robin",
"Strict priority order"
],
"description": "This policy determines which RADIUS server will be contacted first in an authentication attempt and the ordering of any necessary retry attempts ('Strict priority order' or 'Round robin')"
},
"radiusAccountingEnabled": {
"type": "boolean",
"description": "Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'"
},
"radiusAccountingServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "IP address (or FQDN) to which the APs will send RADIUS accounting messages"
},
"port": {
"type": "integer",
"description": "Port on the RADIUS server that is listening for accounting messages"
},
"secret": {
"type": "string",
"description": "Shared key used to authenticate messages between the APs and RADIUS server"
},
"radsecEnabled": {
"type": "boolean",
"description": "Use RadSec (TLS over TCP) to connect to this RADIUS accounting server. Requires radiusProxyEnabled."
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server",
"nullable": true
}
},
"required": [
"host"
]
},
"description": "The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius' and radiusAccountingEnabled is 'true'"
},
"radiusAccountingInterimInterval": {
"type": "integer",
"description": "The interval (in seconds) in which accounting information is updated and sent to the RADIUS accounting server."
},
"radiusAttributeForGroupPolicies": {
"type": "string",
"enum": [
"Airespace-ACL-Name",
"Aruba-User-Role",
"Filter-Id",
"Reply-Message"
],
"description": "Specify the RADIUS attribute used to look up group policies ('Filter-Id', 'Reply-Message', 'Airespace-ACL-Name' or 'Aruba-User-Role'). Access points must receive this attribute in the RADIUS Access-Accept message"
},
"ipAssignmentMode": {
"type": "string",
"description": "The client IP assignment mode ('NAT mode', 'Bridge mode', 'Layer 3 roaming', 'Ethernet over GRE', 'Layer 3 roaming with a concentrator', 'VPN' or 'Campus Gateway')"
},
"useVlanTagging": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLANs. This param is only valid if the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'"
},
"concentratorNetworkId": {
"type": "string",
"description": "The concentrator to use when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'."
},
"secondaryConcentratorNetworkId": {
"type": "string",
"description": "The secondary concentrator to use when the ipAssignmentMode is 'VPN'. If configured, the APs will switch to using this concentrator if the primary concentrator is unreachable. This param is optional. ('disabled' represents no secondary concentrator.)"
},
"disassociateClientsOnVpnFailover": {
"type": "boolean",
"description": "Disassociate clients when 'VPN' concentrator failover occurs in order to trigger clients to re-associate and generate new DHCP requests. This param is only valid if ipAssignmentMode is 'VPN'."
},
"vlanId": {
"type": "integer",
"description": "The VLAN ID used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'"
},
"defaultVlanId": {
"type": "integer",
"description": "The default VLAN ID used for 'all other APs'. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'"
},
"apTagsAndVlanIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of AP tags"
},
"vlanId": {
"type": "integer",
"description": "Numerical identifier that is assigned to the VLAN"
}
}
},
"description": "The list of tags and VLAN IDs used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'"
},
"walledGardenEnabled": {
"type": "boolean",
"description": "Allow access to a configurable list of IP ranges, which users may access prior to sign-on."
},
"walledGardenRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specify your walled garden by entering an array of addresses, ranges using CIDR notation, domain names, and domain wildcards (e.g. '192.168.1.1/24', '192.168.37.10/32', 'www.yahoo.com', '*.google.com']). Meraki's splash page is automatically included in your walled garden."
},
"gre": {
"type": "object",
"properties": {
"concentrator": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "The EoGRE concentrator's IP or FQDN. This param is required when ipAssignmentMode is 'Ethernet over GRE'."
}
},
"required": [
"host"
],
"description": "The EoGRE concentrator's settings"
},
"key": {
"type": "integer",
"description": "Optional numerical identifier that will add the GRE key field to the GRE header. Used to identify an individual traffic flow within a tunnel.",
"nullable": true
}
},
"description": "Ethernet over GRE settings"
},
"radiusOverride": {
"type": "boolean",
"description": "If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'."
},
"radiusGuestVlanEnabled": {
"type": "boolean",
"description": "Whether or not RADIUS Guest VLAN is enabled. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode"
},
"radiusGuestVlanId": {
"type": "integer",
"description": "VLAN ID of the RADIUS Guest VLAN. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode"
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "The minimum bitrate in Mbps of this SSID in the default indoor RF profile. ('1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54')"
},
"bandSelection": {
"type": "string",
"description": "The client-serving radio frequencies of this SSID in the default indoor RF profile. ('Dual band operation', '5 GHz band only' or 'Dual band operation with Band Steering')"
},
"perClientBandwidthLimitUp": {
"type": "integer",
"description": "The upload bandwidth limit in Kbps. (0 represents no limit.)"
},
"perClientBandwidthLimitDown": {
"type": "integer",
"description": "The download bandwidth limit in Kbps. (0 represents no limit.)"
},
"perSsidBandwidthLimitUp": {
"type": "integer",
"description": "The total upload bandwidth limit in Kbps. (0 represents no limit.)"
},
"perSsidBandwidthLimitDown": {
"type": "integer",
"description": "The total download bandwidth limit in Kbps. (0 represents no limit.)"
},
"lanIsolationEnabled": {
"type": "boolean",
"description": "Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'."
},
"visible": {
"type": "boolean",
"description": "Boolean indicating whether APs should advertise or hide this SSID. APs will only broadcast this SSID if set to true"
},
"availableOnAllAps": {
"type": "boolean",
"description": "Boolean indicating whether all APs should broadcast the SSID or if it should be restricted to APs matching any availability tags. Can only be false if the SSID has availability tags."
},
"availabilityTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Accepts a list of tags for this SSID. If availableOnAllAps is false, then the SSID will only be broadcast by APs with tags matching any of the tags in this list."
},
"adaptivePolicyGroupId": {
"type": "string",
"description": "Adaptive policy group ID this SSID is assigned to."
},
"mandatoryDhcpEnabled": {
"type": "boolean",
"description": "If true, Mandatory DHCP will enforce that clients connecting to this SSID must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate."
},
"adultContentFilteringEnabled": {
"type": "boolean",
"description": "Boolean indicating whether or not adult content will be blocked"
},
"dnsRewrite": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not DNS server rewrite is enabled. If disabled, upstream DNS will be used"
},
"dnsCustomNameservers": {
"type": "array",
"items": {
"type": "string"
},
"description": "User specified DNS servers (up to two servers)"
}
},
"description": "DNS servers rewrite settings"
},
"speedBurst": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not to allow users to temporarily exceed the bandwidth limit for short periods while still keeping them under the bandwidth limit over time."
}
},
"description": "The SpeedBurst setting for this SSID'"
},
"namedVlans": {
"type": "object",
"properties": {
"tagging": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLAN names."
},
"defaultVlanName": {
"type": "string",
"description": "The default VLAN name used to tag traffic in the absence of a matching AP tag."
},
"byApTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of AP tags."
},
"vlanName": {
"type": "string",
"description": "VLAN name that will be used to tag traffic."
}
}
},
"description": "The list of AP tags and VLAN names used for named VLAN tagging. If an AP has a tag matching one in the list, then traffic on this SSID will be directed to use the VLAN name associated to the tag."
}
},
"description": "VLAN tagging settings. This param is only valid when ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'."
},
"radius": {
"type": "object",
"properties": {
"guestVlan": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not RADIUS guest named VLAN is enabled."
},
"name": {
"type": "string",
"description": "RADIUS guest VLAN name."
}
},
"description": "Guest VLAN settings. Used to direct traffic to a guest VLAN when none of the RADIUS servers are reachable or a client receives access-reject from the RADIUS server."
}
},
"description": "RADIUS settings. This param is only valid when authMode is 'open-with-radius' and ipAssignmentMode is not 'NAT mode'."
}
},
"description": "Named VLAN settings."
},
"security": {
"type": "object",
"properties": {
"encryption": {
"type": "object",
"properties": {
"ciphers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CCMP 128",
"GCMP 256"
]
},
"description": "Encryption ciphers used by the SSID. CCMP 128 is required and cannot be removed."
},
"akms": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SAE",
"SAE-EXT"
]
},
"description": "Authentication key management systems used by the SSID"
}
},
"description": "Encryption settings for WPA3 modes"
}
},
"x-release-stage": "general_availability",
"description": "Security settings for the SSID"
},
"localAuthFallback": {
"type": "object",
"properties": {
"cacheTimeout": {
"type": "integer",
"description": "The duration (in seconds) for which auths are cached. The timeout is measured from the user's most recent non-cached authentication to the network. Between 3600 (1 hour) and 86400 (1 day)"
},
"enabled": {
"type": "boolean",
"description": "If true, MR devices will cache authentication credentials for EAP-TLS or for MAC based authentication."
},
"serverCaCertificate": {
"type": "object",
"properties": {
"contents": {
"type": "string",
"description": "The contents of the Server CA Certificate. Must be in PEM or DER format.",
"nullable": true
}
},
"description": "The Server CA Certificate used to sign the client certificate."
}
},
"x-release-stage": "general_availability",
"description": "The current configuration for Local Authentication Fallback. Enables the Access Point (AP) to store client authentication data for a specified duration that can be adjusted as needed."
},
"radiusAccountingStartDelay": {
"type": "integer",
"description": "The delay (in seconds) before sending the first RADIUS accounting start message. Must be between 0 and 60 seconds."
}
},
"example": {
"name": "My SSID",
"enabled": true,
"authMode": "8021x-radius",
"enterpriseAdminAccess": "access enabled",
"ssidAdminAccessible": false,
"encryptionMode": "wpa",
"psk": "deadbeef",
"wpaEncryptionMode": "WPA2 only",
"dot11w": {
"enabled": true,
"required": false
},
"dot11r": {
"enabled": true,
"adaptive": true
},
"splashPage": "Click-through splash page",
"splashGuestSponsorDomains": [
"example.com"
],
"oauth": {
"allowedDomains": [
"example.com"
]
},
"localRadius": {
"cacheTimeout": 60,
"passwordAuthentication": {
"enabled": false
},
"certificateAuthentication": {
"enabled": true,
"useLdap": false,
"useOcsp": true,
"ocspResponderUrl": "http://ocsp-server.example.com",
"clientRootCaCertificate": {
"contents": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
}
},
"ldap": {
"servers": [
{
"host": "127.0.0.1",
"port": 389
}
],
"credentials": {
"distinguishedName": "cn=user,dc=example,dc=com",
"password": "password"
},
"baseDistinguishedName": "dc=example,dc=com",
"serverCaCertificate": {
"contents": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
},
"activeDirectory": {
"servers": [
{
"host": "127.0.0.1",
"port": 3268
}
],
"credentials": {
"logonName": "user",
"password": "password"
}
},
"radiusServers": [
{
"host": "0.0.0.0",
"port": 3000,
"secret": "secret-string",
"radsecEnabled": true,
"openRoamingCertificateId": 2,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusProxyEnabled": false,
"radiusTestingEnabled": true,
"radiusCalledStationId": "00-11-22-33-44-55:AP1",
"radiusAuthenticationNasId": "00-11-22-33-44-55:AP1",
"radiusServerTimeout": 5,
"radiusServerAttemptsLimit": 5,
"radiusFallbackEnabled": true,
"radiusRadsec": {
"tlsTunnel": {
"timeout": 600
}
},
"radiusCoaEnabled": true,
"radiusFailoverPolicy": "Deny access",
"radiusLoadBalancingPolicy": "Round robin",
"radiusAccountingEnabled": true,
"radiusAccountingServers": [
{
"host": "0.0.0.0",
"port": 3000,
"secret": "secret-string",
"radsecEnabled": true,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusAccountingInterimInterval": 5,
"radiusAttributeForGroupPolicies": "Filter-Id",
"ipAssignmentMode": "NAT mode",
"useVlanTagging": false,
"concentratorNetworkId": "N_24329156",
"secondaryConcentratorNetworkId": "disabled",
"disassociateClientsOnVpnFailover": false,
"vlanId": 10,
"defaultVlanId": 1,
"apTagsAndVlanIds": [
{
"tags": [
"tag1",
"tag2"
],
"vlanId": 100
}
],
"walledGardenEnabled": true,
"walledGardenRanges": [
"example.com",
"1.1.1.1/32"
],
"gre": {
"concentrator": {
"host": "192.168.1.1"
},
"key": 5
},
"radiusOverride": false,
"radiusGuestVlanEnabled": true,
"radiusGuestVlanId": 1,
"minBitrate": 5.5,
"bandSelection": "5 GHz band only",
"perClientBandwidthLimitUp": 0,
"perClientBandwidthLimitDown": 0,
"perSsidBandwidthLimitUp": 0,
"perSsidBandwidthLimitDown": 0,
"lanIsolationEnabled": true,
"visible": true,
"availableOnAllAps": false,
"availabilityTags": [
"tag1",
"tag2"
],
"adaptivePolicyGroupId": "1234",
"mandatoryDhcpEnabled": false,
"adultContentFilteringEnabled": false,
"dnsRewrite": {
"enabled": true,
"dnsCustomNameservers": [
"8.8.8.8",
"8.8.4.4"
]
},
"speedBurst": {
"enabled": true
},
"namedVlans": {
"tagging": {
"enabled": true,
"defaultVlanName": "My VLAN",
"byApTags": [
{
"tags": [
"tag1",
"tag2"
],
"vlanName": "My VLAN"
}
]
},
"radius": {
"guestVlan": {
"enabled": true,
"name": "Guest VLAN"
}
}
},
"security": {
"encryption": {
"ciphers": [
"CCMP 128"
],
"akms": [
"SAE"
]
}
},
"localAuthFallback": {
"cacheTimeout": 6500,
"enabled": true,
"serverCaCertificate": {
"contents": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
},
"radiusAccountingStartDelay": 0
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"description": "Unique identifier of the SSID"
},
"name": {
"type": "string",
"description": "The name of the SSID"
},
"enabled": {
"type": "boolean",
"description": "Whether or not the SSID is enabled"
},
"splashPage": {
"type": "string",
"enum": [
"Billing",
"Cisco ISE",
"Click-through splash page",
"Facebook Wi-Fi",
"Google Apps domain",
"Google OAuth",
"Microsoft Entra ID",
"None",
"Password-protected with Active Directory",
"Password-protected with LDAP",
"Password-protected with Meraki RADIUS",
"Password-protected with custom RADIUS",
"SMS authentication",
"Sponsored guest",
"Systems Manager Sentry"
],
"description": "The type of splash page for the SSID"
},
"ssidAdminAccessible": {
"type": "boolean",
"description": "SSID Administrator access status"
},
"localAuth": {
"type": "boolean",
"description": "Extended local auth flag for Enterprise NAC. Only present when authMode is '8021x-nac'."
},
"authMode": {
"type": "string",
"enum": [
"8021x-entra",
"8021x-google",
"8021x-localradius",
"8021x-meraki",
"8021x-nac",
"8021x-radius",
"ipsk-with-nac",
"ipsk-with-radius",
"ipsk-with-radius-easy-psk",
"ipsk-without-radius",
"open",
"open-enhanced",
"open-enhanced-with-radius",
"open-with-nac",
"open-with-radius",
"psk"
],
"description": "The association control method for the SSID"
},
"psk": {
"type": "string",
"description": "The passkey for the SSID. This param is only valid if the authMode is 'psk'. Read-only admins receive a masked value. Only present when authMode is 'psk'."
},
"encryptionMode": {
"type": "string",
"enum": [
"wep",
"wpa"
],
"description": "The psk encryption mode for the SSID. Only present when authMode requires encryption."
},
"wpaEncryptionMode": {
"type": "string",
"enum": [
"WPA1 and WPA2",
"WPA1 only",
"WPA2 only",
"WPA3 192-bit Security",
"WPA3 Transition Mode",
"WPA3 only"
],
"description": "The types of WPA encryption. Only present when authMode requires encryption."
},
"radiusServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the RADIUS server"
},
"host": {
"type": "string",
"description": "IP address (or FQDN) of your RADIUS server"
},
"port": {
"type": "integer",
"description": "UDP port the RADIUS server listens on for Access-requests"
},
"radsecEnabled": {
"type": "boolean",
"description": "Use RADSEC (TLS over TCP) to connect to this RADIUS server. Requires radiusProxyEnabled."
},
"openRoamingCertificateId": {
"type": "integer",
"description": "The ID of the Openroaming Certificate attached to radius server"
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server"
}
}
},
"description": "List of RADIUS 802.1X servers to be used for authentication. Only present when the SSID is configured to use RADIUS."
},
"radiusAccountingServers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "IP address (or FQDN) to which the APs will send RADIUS accounting messages"
},
"port": {
"type": "integer",
"description": "Port on the RADIUS server that is listening for accounting messages"
},
"openRoamingCertificateId": {
"type": "integer",
"description": "The ID of the Openroaming Certificate attached to radius server"
},
"caCertificate": {
"type": "string",
"description": "Certificate used for authorization for the RadSec Server"
}
}
},
"description": "List of RADIUS accounting 802.1X servers to be used for authentication. Only present when RADIUS accounting is enabled."
},
"radiusAccountingEnabled": {
"type": "boolean",
"description": "Whether or not RADIUS accounting is enabled. Only present when the SSID is configured to use RADIUS."
},
"radiusEnabled": {
"type": "boolean",
"description": "Whether RADIUS authentication is enabled. Only present when the SSID is configured to use RADIUS."
},
"radiusAttributeForGroupPolicies": {
"type": "string",
"enum": [
"Airespace-ACL-Name",
"Aruba-User-Role",
"Filter-Id",
"Reply-Message"
],
"description": "RADIUS attribute used to look up group policies. Only present when the SSID is configured to use RADIUS and the network supports group policies."
},
"radiusFailoverPolicy": {
"type": "string",
"enum": [
"Allow access",
"Deny access"
],
"description": "Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable. Only present when the SSID uses a RADIUS-based splash page."
},
"radiusLoadBalancingPolicy": {
"type": "string",
"enum": [
"Round robin",
"Strict priority order"
],
"description": "Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts. Only present when the SSID uses a RADIUS-based splash page."
},
"ipAssignmentMode": {
"type": "string",
"enum": [
"Bridge mode",
"Campus Gateway",
"Ethernet over GRE",
"Layer 3 roaming",
"Layer 3 roaming with a concentrator",
"NAT mode",
"VPN"
],
"description": "The client IP assignment mode"
},
"adminSplashUrl": {
"type": "string",
"description": "URL for the admin splash page. Only present when a splash page is configured."
},
"splashTimeout": {
"type": "string",
"description": "Splash page timeout. Only present when a splash page is configured."
},
"walledGardenEnabled": {
"type": "boolean",
"description": "Allow users to access a configurable list of IP ranges prior to sign-on. Only present when a splash page is configured."
},
"walledGardenRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domain names and IP address ranges available in Walled Garden mode. Only present when walledGardenEnabled is true and ranges are configured."
},
"minBitrate": {
"type": "number",
"format": "float",
"description": "The minimum bitrate in Mbps of this SSID in the default indoor RF profile"
},
"bandSelection": {
"type": "string",
"enum": [
"5 GHz band only",
"Dual band operation",
"Dual band operation with Band Steering"
],
"description": "The client-serving radio frequencies of this SSID in the default indoor RF profile"
},
"perClientBandwidthLimitUp": {
"type": "integer",
"description": "The upload bandwidth limit in Kbps. (0 represents no limit.)"
},
"perClientBandwidthLimitDown": {
"type": "integer",
"description": "The download bandwidth limit in Kbps. (0 represents no limit.)"
},
"visible": {
"type": "boolean",
"description": "Whether the SSID is advertised or hidden by the AP"
},
"availableOnAllAps": {
"type": "boolean",
"description": "Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags"
},
"availabilityTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list"
},
"perSsidBandwidthLimitUp": {
"type": "integer",
"description": "The total upload bandwidth limit in Kbps (0 represents no limit)"
},
"perSsidBandwidthLimitDown": {
"type": "integer",
"description": "The total download bandwidth limit in Kbps (0 represents no limit)"
},
"adaptivePolicyGroupId": {
"type": "string",
"description": "Adaptive policy group ID this SSID is assigned to."
},
"mandatoryDhcpEnabled": {
"type": "boolean",
"description": "Whether clients connecting to this SSID must use the IP address assigned by the DHCP server"
},
"dot11w": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11w is enabled or not."
},
"required": {
"type": "boolean",
"description": "Whether 802.11w is required or not."
}
},
"description": "The current setting for Protected Management Frames (802.11w). Only present when the authMode requires encryption."
},
"dot11r": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether 802.11r is enabled or not."
},
"adaptive": {
"type": "boolean",
"description": "Whether 802.11r is adaptive or not."
}
},
"description": "The current setting for 802.11r. Only present when the authMode requires encryption and firmware supports 802.11r."
},
"enterpriseAdminAccess": {
"type": "string",
"enum": [
"access disabled",
"access enabled"
],
"description": "Whether or not an SSID is accessible by 'enterprise' administrators. Only present when the organization supports enterprise admins."
},
"radiusTestingEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki_8021x_test' to ensure that the RADIUS servers are reachable. Only present when the SSID is configured to use RADIUS."
},
"radiusCalledStationId": {
"type": "string",
"description": "The template of the called station identifier to be used for RADIUS (ex. $NODE_MAC$:$VAP_NUM$). Only present when configured and the SSID uses RADIUS-based auth."
},
"radiusAuthenticationNasId": {
"type": "string",
"description": "The template of the NAS identifier to be used for RADIUS authentication (ex. $NODE_MAC$:$VAP_NUM$). Only present when configured and the SSID uses RADIUS-based auth."
},
"radiusServerTimeout": {
"type": "integer",
"description": "The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds). Only present when the SSID uses RADIUS-based auth."
},
"radiusServerAttemptsLimit": {
"type": "integer",
"description": "The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5). Only present when the SSID uses RADIUS-based auth."
},
"radiusFallbackEnabled": {
"type": "boolean",
"description": "Whether or not higher priority RADIUS servers should be retried after 60 seconds. Only present when the SSID uses RADIUS-based auth."
},
"radiusProxyEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers. Only present when the SSID uses RADIUS-based auth."
},
"radiusCoaEnabled": {
"type": "boolean",
"description": "If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server. Only present when the SSID uses RADIUS-based auth."
},
"radiusOverride": {
"type": "boolean",
"description": "If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'. Only present when the SSID uses RADIUS-based auth and the network supports group policies."
},
"useVlanTagging": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLANs. Only present when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'."
},
"defaultVlanId": {
"type": "integer",
"description": "The default VLAN ID used for 'all other APs'. Only present when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming' and VLAN tagging is enabled."
},
"adultContentFilteringEnabled": {
"type": "boolean",
"description": "Boolean indicating whether or not adult content will be blocked. Only present when ipAssignmentMode is 'NAT mode'."
},
"dnsRewrite": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not DNS server rewrite is enabled. If disabled, upstream DNS will be used."
},
"dnsCustomNameservers": {
"type": "array",
"items": {
"type": "string"
},
"description": "User specified DNS servers (up to two servers)"
}
},
"description": "DNS servers rewrite settings. Only present when ipAssignmentMode is 'NAT mode'."
},
"gre": {
"type": "object",
"properties": {
"concentrator": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "The EoGRE concentrator's IP or FQDN."
}
},
"description": "The EoGRE concentrator's settings"
},
"key": {
"type": "integer",
"description": "Optional numerical identifier that will add the GRE key field to the GRE header. Used to identify an individual traffic flow within a tunnel."
},
"clientIsolation": {
"type": "boolean",
"description": "Whether or not client isolation is enabled."
}
},
"description": "Ethernet over GRE settings. Only present when ipAssignmentMode is 'Ethernet over GRE'."
},
"lanIsolationEnabled": {
"type": "boolean",
"description": "Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'."
},
"oauth": {
"type": "object",
"properties": {
"allowedDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of domains allowed access to the network."
}
},
"description": "The OAuth settings of this SSID. Only valid if splashPage is 'Google OAuth'. Only present when the SSID uses OAuth."
},
"localAuthFallback": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, MR devices will cache authentication credentials for EAP-TLS or for MAC based authentication."
},
"cacheTimeout": {
"type": "integer",
"description": "The duration (in seconds) for which auths are cached."
},
"serverCaCertificate": {
"type": "object",
"properties": {
"contents": {
"type": "string",
"description": "The contents of the Server CA Certificate. Must be in PEM or DER format.",
"nullable": true
}
},
"description": "The Server CA Certificate used to sign the client certificate."
}
},
"description": "The current configuration for Local Authentication Fallback. Only present when the network supports local auth fallback and the SSID uses WPA-EAP or open-with-RADIUS."
},
"namedVlans": {
"type": "object",
"properties": {
"tagging": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not traffic should be directed to use specific VLAN names."
},
"defaultVlanName": {
"type": "string",
"description": "The default VLAN name used to tag traffic in the absence of a matching AP tag."
},
"byApTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of AP tags."
},
"vlanName": {
"type": "string",
"description": "VLAN name that will be used to tag traffic."
}
}
},
"description": "The list of AP tags and VLAN names used for named VLAN tagging."
}
},
"description": "VLAN tagging settings."
},
"radius": {
"type": "object",
"properties": {
"guestVlan": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not RADIUS guest named VLAN is enabled."
},
"name": {
"type": "string",
"description": "RADIUS guest VLAN name."
}
},
"description": "Guest VLAN settings."
}
},
"description": "RADIUS settings."
}
},
"description": "Named VLAN settings. Only present when the network supports named VLANs."
},
"speedBurst": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether or not to allow users to temporarily exceed the bandwidth limit for short periods while still keeping them under the bandwidth limit over time."
}
},
"description": "The SpeedBurst setting for this SSID"
},
"wifiPersonalNetworkEnabled": {
"type": "boolean",
"description": "Boolean indicating whether or not Wi-Fi Personal Network is enabled for this SSID. Only present when the network supports Wi-Fi Personal Network."
},
"security": {
"type": "object",
"properties": {
"encryption": {
"type": "object",
"properties": {
"ciphers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CCMP 128",
"GCMP 256"
]
},
"description": "Encryption ciphers used by the SSID."
},
"akms": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SAE",
"SAE-EXT"
]
},
"description": "Authentication key management systems used by the SSID."
}
},
"description": "Encryption settings for WPA3 modes"
}
},
"description": "Security settings for the SSID. Only present when WPA3 is configured."
}
},
"required": [
"number",
"name",
"enabled",
"splashPage",
"ssidAdminAccessible",
"authMode",
"ipAssignmentMode",
"minBitrate",
"bandSelection",
"perClientBandwidthLimitUp",
"perClientBandwidthLimitDown",
"visible",
"availableOnAllAps",
"availabilityTags",
"perSsidBandwidthLimitUp",
"perSsidBandwidthLimitDown",
"mandatoryDhcpEnabled",
"speedBurst"
]
},
"example": {
"number": 0,
"name": "My SSID",
"enabled": true,
"splashPage": "Click-through splash page",
"ssidAdminAccessible": false,
"localAuth": false,
"authMode": "8021x-radius",
"psk": "deadbeef",
"encryptionMode": "wpa",
"wpaEncryptionMode": "WPA2 only",
"radiusServers": [
{
"id": "797137134045134582",
"host": "0.0.0.0",
"port": 3000,
"radsecEnabled": false,
"openRoamingCertificateId": 2,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusAccountingServers": [
{
"host": "0.0.0.0",
"port": 3000,
"openRoamingCertificateId": 2,
"caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
],
"radiusAccountingEnabled": false,
"radiusEnabled": true,
"radiusAttributeForGroupPolicies": "Filter-Id",
"radiusFailoverPolicy": "Deny access",
"radiusLoadBalancingPolicy": "Round robin",
"ipAssignmentMode": "NAT mode",
"adminSplashUrl": "http://example.com",
"splashTimeout": "30 minutes",
"walledGardenEnabled": true,
"walledGardenRanges": [
"example.com",
"1.1.1.1/32"
],
"minBitrate": 11.0,
"bandSelection": "5 GHz band only",
"perClientBandwidthLimitUp": 0,
"perClientBandwidthLimitDown": 0,
"visible": true,
"availableOnAllAps": false,
"availabilityTags": [
"tag1",
"tag2"
],
"perSsidBandwidthLimitUp": 0,
"perSsidBandwidthLimitDown": 0,
"adaptivePolicyGroupId": "1234",
"mandatoryDhcpEnabled": false,
"dot11w": {
"enabled": true,
"required": false
},
"dot11r": {
"enabled": true,
"adaptive": true
},
"enterpriseAdminAccess": "access enabled",
"radiusTestingEnabled": true,
"radiusCalledStationId": "00-11-22-33-44-55:AP1",
"radiusAuthenticationNasId": "00-11-22-33-44-55:AP1",
"radiusServerTimeout": 5,
"radiusServerAttemptsLimit": 5,
"radiusFallbackEnabled": true,
"radiusProxyEnabled": false,
"radiusCoaEnabled": true,
"radiusOverride": false,
"useVlanTagging": false,
"defaultVlanId": 1,
"adultContentFilteringEnabled": false,
"dnsRewrite": {
"enabled": true,
"dnsCustomNameservers": [
"8.8.8.8",
"8.8.4.4"
]
},
"gre": {
"concentrator": {
"host": "192.168.1.1"
},
"key": 5,
"clientIsolation": false
},
"lanIsolationEnabled": true,
"oauth": {
"allowedDomains": [
"example.com"
]
},
"localAuthFallback": {
"enabled": true,
"cacheTimeout": 6500,
"serverCaCertificate": {
"contents": "-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----"
}
},
"namedVlans": {
"tagging": {
"enabled": true,
"defaultVlanName": "My VLAN",
"byApTags": [
{
"tags": [
"tag1",
"tag2"
],
"vlanName": "My VLAN"
}
]
},
"radius": {
"guestVlan": {
"enabled": true,
"name": "Guest VLAN"
}
}
},
"speedBurst": {
"enabled": true
},
"wifiPersonalNetworkEnabled": false,
"security": {
"encryption": {
"ciphers": [
"CCMP 128"
],
"akms": [
"SAE"
]
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the attributes of an MR SSID",
"tags": [
"wireless",
"configure",
"ssids"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/bonjourForwarding": {
"get": {
"description": "List the Bonjour forwarding setting and rules for the SSID",
"operationId": "getNetworkWirelessSsidBonjourForwarding",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, Bonjour forwarding is enabled on the SSID."
},
"exception": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, Bonjour forwarding exception is enabled on this SSID. Exception is required to enable L2 isolation and Bonjour forwarding to work together."
}
},
"description": "Bonjour forwarding exception"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Desctiption of the bonjour forwarding rule"
},
"vlanId": {
"type": "string",
"description": "The ID of the service VLAN. Required"
},
"services": {
"type": "array",
"items": {
"type": "string",
"enum": [
"AFP",
"AirPlay",
"All Services",
"Apple screen share",
"BitTorrent",
"Chromecast",
"FTP",
"Printers",
"SSH",
"Samba",
"Scanners",
"Spotify",
"iChat",
"iTunes"
]
},
"description": "A list of Bonjour services. At least one service must be specified. Available services are 'All Services', 'AFP', 'AirPlay', 'Apple screen share', 'BitTorrent', 'Chromecast', 'FTP', 'iChat', 'iTunes', 'Printers', 'Samba', 'Scanners', 'Spotify' and 'SSH'"
}
}
},
"description": "Bonjour forwarding rules"
}
}
},
"example": {
"enabled": true,
"exception": {
"enabled": true
},
"rules": [
{
"description": "A simple bonjour rule",
"vlanId": "1",
"services": [
"All Services"
]
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List the Bonjour forwarding setting and rules for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"bonjourForwarding"
]
},
"put": {
"description": "Update the bonjour forwarding setting and rules for the SSID",
"operationId": "updateNetworkWirelessSsidBonjourForwarding",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, Bonjour forwarding is enabled on this SSID."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A description for your Bonjour forwarding rule. Optional."
},
"vlanId": {
"type": "string",
"description": "The ID of the service VLAN. Required."
},
"services": {
"type": "array",
"items": {
"type": "string",
"enum": [
"AFP",
"AirPlay",
"All Services",
"Apple screen share",
"BitTorrent",
"Chromecast",
"FTP",
"Printers",
"SSH",
"Samba",
"Scanners",
"Spotify",
"iChat",
"iTunes"
]
},
"description": "A list of Bonjour services. At least one service must be specified. Available services are 'All Services', 'AFP', 'AirPlay', 'Apple screen share', 'BitTorrent', 'Chromecast', 'FTP', 'iChat', 'iTunes', 'Printers', 'Samba', 'Scanners', 'Spotify' and 'SSH'"
}
},
"required": [
"vlanId",
"services"
]
},
"description": "List of bonjour forwarding rules."
},
"exception": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, Bonjour forwarding exception is enabled on this SSID. Exception is required to enable L2 isolation and Bonjour forwarding to work together."
}
},
"description": "Bonjour forwarding exception"
}
},
"example": {
"enabled": true,
"rules": [
{
"description": "A simple bonjour rule",
"vlanId": "1",
"services": [
"All Services"
]
}
],
"exception": {
"enabled": true
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, Bonjour forwarding is enabled on the SSID."
},
"exception": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, Bonjour forwarding exception is enabled on this SSID. Exception is required to enable L2 isolation and Bonjour forwarding to work together."
}
},
"description": "Bonjour forwarding exception"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Desctiption of the bonjour forwarding rule"
},
"vlanId": {
"type": "string",
"description": "The ID of the service VLAN. Required"
},
"services": {
"type": "array",
"items": {
"type": "string",
"enum": [
"AFP",
"AirPlay",
"All Services",
"Apple screen share",
"BitTorrent",
"Chromecast",
"FTP",
"Printers",
"SSH",
"Samba",
"Scanners",
"Spotify",
"iChat",
"iTunes"
]
},
"description": "A list of Bonjour services. At least one service must be specified. Available services are 'All Services', 'AFP', 'AirPlay', 'Apple screen share', 'BitTorrent', 'Chromecast', 'FTP', 'iChat', 'iTunes', 'Printers', 'Samba', 'Scanners', 'Spotify' and 'SSH'"
}
}
},
"description": "Bonjour forwarding rules"
}
}
},
"example": {
"enabled": true,
"exception": {
"enabled": true
},
"rules": [
{
"description": "A simple bonjour rule",
"vlanId": "1",
"services": [
"All Services"
]
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the bonjour forwarding setting and rules for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"bonjourForwarding"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/deviceTypeGroupPolicies": {
"get": {
"description": "List the device type group policies for the SSID",
"operationId": "getNetworkWirelessSsidDeviceTypeGroupPolicies",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"enabled": true,
"deviceTypePolicies": [
{
"deviceType": "Android",
"devicePolicy": "Allowed"
},
{
"deviceType": "iPhone",
"devicePolicy": "Group policy",
"groupPolicyId": 101
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List the device type group policies for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"deviceTypeGroupPolicies"
]
},
"put": {
"description": "Update the device type group policies for the SSID",
"operationId": "updateNetworkWirelessSsidDeviceTypeGroupPolicies",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, the SSID device type group policies are enabled."
},
"deviceTypePolicies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceType": {
"type": "string",
"enum": [
"Android",
"B&N Nook",
"BlackBerry",
"Chrome OS",
"Mac OS X",
"Other OS",
"Windows",
"Windows Phone",
"iPad",
"iPhone",
"iPod"
],
"description": "The device type. Can be one of 'Android', 'BlackBerry', 'Chrome OS', 'iPad', 'iPhone', 'iPod', 'Mac OS X', 'Windows', 'Windows Phone', 'B&N Nook' or 'Other OS'"
},
"devicePolicy": {
"type": "string",
"enum": [
"Allowed",
"Blocked",
"Group policy"
],
"description": "The device policy. Can be one of 'Allowed', 'Blocked' or 'Group policy'"
},
"groupPolicyId": {
"type": "integer",
"description": "ID of the group policy object."
}
},
"required": [
"deviceType",
"devicePolicy"
]
},
"description": "List of device type policies."
}
},
"example": {
"enabled": true,
"deviceTypePolicies": [
{
"deviceType": "Android",
"devicePolicy": "Allowed"
},
{
"deviceType": "iPhone",
"devicePolicy": "Group policy",
"groupPolicyId": 101
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"enabled": true,
"deviceTypePolicies": [
{
"deviceType": "Android",
"devicePolicy": "Allowed"
},
{
"deviceType": "iPhone",
"devicePolicy": "Group policy",
"groupPolicyId": 101
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the device type group policies for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"deviceTypeGroupPolicies"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/eapOverride": {
"get": {
"description": "Return the EAP overridden parameters for an SSID",
"operationId": "getNetworkWirelessSsidEapOverride",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timeout": {
"type": "integer",
"description": "General EAP timeout in seconds."
},
"maxRetries": {
"type": "integer",
"description": "Maximum number of general EAP retries."
},
"identity": {
"type": "object",
"properties": {
"retries": {
"type": "integer",
"description": "Maximum number of EAP retries."
},
"timeout": {
"type": "integer",
"description": "EAP timeout in seconds."
}
},
"description": "EAP settings for identity requests."
},
"eapolKey": {
"type": "object",
"properties": {
"retries": {
"type": "integer",
"description": "Maximum number of EAPOL key retries."
},
"timeoutInMs": {
"type": "integer",
"description": "EAPOL Key timeout in milliseconds."
}
},
"description": "EAPOL Key settings."
}
}
},
"example": {
"timeout": 50,
"maxRetries": 5,
"identity": {
"retries": 5,
"timeout": 50
},
"eapolKey": {
"retries": 50,
"timeoutInMs": 5000
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the EAP overridden parameters for an SSID",
"tags": [
"wireless",
"configure",
"ssids",
"eapOverride"
]
},
"put": {
"description": "Update the EAP overridden parameters for an SSID.",
"operationId": "updateNetworkWirelessSsidEapOverride",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timeout": {
"type": "integer",
"description": "General EAP timeout in seconds."
},
"identity": {
"type": "object",
"properties": {
"retries": {
"type": "integer",
"description": "Maximum number of EAP retries."
},
"timeout": {
"type": "integer",
"description": "EAP timeout in seconds."
}
},
"description": "EAP settings for identity requests."
},
"maxRetries": {
"type": "integer",
"description": "Maximum number of general EAP retries."
},
"eapolKey": {
"type": "object",
"properties": {
"retries": {
"type": "integer",
"description": "Maximum number of EAPOL key retries."
},
"timeoutInMs": {
"type": "integer",
"description": "EAPOL Key timeout in milliseconds."
}
},
"description": "EAPOL Key settings."
}
},
"example": {
"timeout": 5,
"identity": {
"retries": 5,
"timeout": 5
},
"maxRetries": 5,
"eapolKey": {
"retries": 5,
"timeoutInMs": 5000
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timeout": {
"type": "integer",
"description": "General EAP timeout in seconds."
},
"maxRetries": {
"type": "integer",
"description": "Maximum number of general EAP retries."
},
"identity": {
"type": "object",
"properties": {
"retries": {
"type": "integer",
"description": "Maximum number of EAP retries."
},
"timeout": {
"type": "integer",
"description": "EAP timeout in seconds."
}
},
"description": "EAP settings for identity requests."
},
"eapolKey": {
"type": "object",
"properties": {
"retries": {
"type": "integer",
"description": "Maximum number of EAPOL key retries."
},
"timeoutInMs": {
"type": "integer",
"description": "EAPOL Key timeout in milliseconds."
}
},
"description": "EAPOL Key settings."
}
}
},
"example": {
"timeout": 50,
"maxRetries": 5,
"identity": {
"retries": 5,
"timeout": 50
},
"eapolKey": {
"retries": 50,
"timeoutInMs": 5000
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the EAP overridden parameters for an SSID.",
"tags": [
"wireless",
"configure",
"ssids",
"eapOverride"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/firewall/l3FirewallRules": {
"get": {
"description": "Return the L3 firewall rules for an SSID on an MR network",
"operationId": "getNetworkWirelessSsidFirewallL3FirewallRules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Description of the rule (optional)"
},
"policy": {
"type": "string",
"enum": [
"allow",
"deny"
],
"description": "'allow' or 'deny' traffic specified by this rule"
},
"ipVer": {
"type": "string",
"enum": [
"both",
"ipv4",
"ipv6"
],
"description": "IP version to which this rule applies (must be one of 'both', 'ipv4' or 'ipv6'). Defaults to 'both' if not specified."
},
"protocol": {
"type": "string",
"enum": [
"any",
"icmp",
"icmp6",
"tcp",
"udp"
],
"description": "The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any')"
},
"destPort": {
"type": "string",
"description": "Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any'"
},
"destCidr": {
"type": "string",
"description": "Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any'"
}
},
"required": [
"policy",
"protocol",
"destCidr"
]
},
"description": "An ordered array of the firewall rules for this SSID (not including the local LAN access rule or the default rule)."
},
"allowLanAccess": {
"type": "boolean",
"description": "Allows wireless client access to local LAN (boolean value - true allows access and false denies access)"
}
}
},
"example": {
"rules": [
{
"comment": "Allow TCP traffic to subnet with HTTP servers.",
"policy": "allow",
"ipVer": "both",
"protocol": "tcp",
"destPort": "443",
"destCidr": "192.168.1.0/24"
}
],
"allowLanAccess": false
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the L3 firewall rules for an SSID on an MR network",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"l3FirewallRules"
]
},
"put": {
"description": "Update the L3 firewall rules of an SSID on an MR network",
"operationId": "updateNetworkWirelessSsidFirewallL3FirewallRules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Description of the rule (optional)"
},
"policy": {
"type": "string",
"enum": [
"allow",
"deny"
],
"description": "'allow' or 'deny' traffic specified by this rule"
},
"ipVer": {
"type": "string",
"enum": [
"both",
"ipv4",
"ipv6"
],
"description": "IP version to which this rule applies (must be one of 'both', 'ipv4' or 'ipv6'). Defaults to 'both' if not specified.",
"default": "both"
},
"protocol": {
"type": "string",
"enum": [
"any",
"icmp",
"icmp6",
"tcp",
"udp"
],
"description": "The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any')"
},
"destPort": {
"type": "string",
"description": "Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any'"
},
"destCidr": {
"type": "string",
"description": "Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any'"
}
},
"required": [
"policy",
"protocol",
"destCidr"
]
},
"description": "An ordered array of the firewall rules for this SSID."
},
"allowLanAccess": {
"type": "boolean",
"description": "Allow wireless client access to local LAN (boolean value - true allows access and false denies access) (optional)"
}
},
"example": {
"rules": [
{
"comment": "Allow TCP traffic to subnet with HTTP servers.",
"policy": "allow",
"ipVer": "both",
"protocol": "tcp",
"destPort": "443",
"destCidr": "192.168.1.0/24"
}
],
"allowLanAccess": true
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Description of the rule (optional)"
},
"policy": {
"type": "string",
"enum": [
"allow",
"deny"
],
"description": "'allow' or 'deny' traffic specified by this rule"
},
"ipVer": {
"type": "string",
"enum": [
"both",
"ipv4",
"ipv6"
],
"description": "IP version to which this rule applies (must be one of 'both', 'ipv4' or 'ipv6'). Defaults to 'both' if not specified."
},
"protocol": {
"type": "string",
"enum": [
"any",
"icmp",
"icmp6",
"tcp",
"udp"
],
"description": "The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any')"
},
"destPort": {
"type": "string",
"description": "Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any'"
},
"destCidr": {
"type": "string",
"description": "Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any'"
}
},
"required": [
"policy",
"protocol",
"destCidr"
]
},
"description": "An ordered array of the firewall rules for this SSID (not including the local LAN access rule or the default rule)."
},
"allowLanAccess": {
"type": "boolean",
"description": "Allows wireless client access to local LAN (boolean value - true allows access and false denies access)"
}
}
},
"example": {
"rules": [
{
"comment": "Allow TCP traffic to subnet with HTTP servers.",
"policy": "allow",
"ipVer": "both",
"protocol": "tcp",
"destPort": "443",
"destCidr": "192.168.1.0/24"
}
],
"allowLanAccess": false
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the L3 firewall rules of an SSID on an MR network",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"l3FirewallRules"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/firewall/l7FirewallRules": {
"get": {
"description": "Return the L7 firewall rules for an SSID on an MR network",
"operationId": "getNetworkWirelessSsidFirewallL7FirewallRules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"policy": {
"type": "string",
"enum": [
"deny"
],
"description": "'Deny' traffic specified by this rule"
},
"type": {
"type": "string",
"enum": [
"application",
"applicationCategory",
"host",
"ipRange",
"port"
],
"description": "Type of the L7 firewall rule. One of: 'application', 'applicationCategory', 'host', 'port', 'ipRange'"
},
"value": {
"type": "string",
"description": "The value of what needs to get blocked. Format of the value varies depending on type of the firewall rule selected."
}
}
},
"description": "An ordered array of the firewall rules for this SSID (not including the local LAN access rule or the default rule)."
}
}
},
"example": {
"rules": [
{
"policy": "deny",
"type": "host",
"value": "google.com"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the L7 firewall rules for an SSID on an MR network",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"l7FirewallRules"
]
},
"put": {
"description": "Update the L7 firewall rules of an SSID on an MR network",
"operationId": "updateNetworkWirelessSsidFirewallL7FirewallRules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"policy": {
"type": "string",
"enum": [
"deny"
],
"description": "'Deny' traffic specified by this rule"
},
"type": {
"type": "string",
"enum": [
"application",
"applicationCategory",
"host",
"ipRange",
"port"
],
"description": "Type of the L7 firewall rule. One of: 'application', 'applicationCategory', 'host', 'port', 'ipRange'"
},
"value": {
"type": "string",
"description": "The value of what needs to get blocked. Format of the value varies depending on type of the firewall rule selected."
}
}
},
"description": "An array of L7 firewall rules for this SSID. Rules will get applied in the same order user has specified in request. Empty array will clear the L7 firewall rule configuration."
}
},
"example": {
"rules": [
{
"policy": "deny",
"type": "host",
"value": "google.com"
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"policy": {
"type": "string",
"enum": [
"deny"
],
"description": "'Deny' traffic specified by this rule"
},
"type": {
"type": "string",
"enum": [
"application",
"applicationCategory",
"host",
"ipRange",
"port"
],
"description": "Type of the L7 firewall rule. One of: 'application', 'applicationCategory', 'host', 'port', 'ipRange'"
},
"value": {
"type": "string",
"description": "The value of what needs to get blocked. Format of the value varies depending on type of the firewall rule selected."
}
}
},
"description": "An ordered array of the firewall rules for this SSID (not including the local LAN access rule or the default rule)."
}
}
},
"example": {
"rules": [
{
"policy": "deny",
"type": "host",
"value": "google.com"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the L7 firewall rules of an SSID on an MR network",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"l7FirewallRules"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/hotspot20": {
"get": {
"description": "Return the Hotspot 2.0 settings for an SSID",
"operationId": "getNetworkWirelessSsidHotspot20",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not Hotspot 2.0 for this SSID is enabled"
},
"operator": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Operator name"
}
},
"description": "Operator settings for this SSID"
},
"venue": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Venue name"
},
"type": {
"type": "string",
"description": "Venue type"
}
},
"description": "Venue settings for this SSID"
},
"networkAccessType": {
"type": "string",
"description": "The network type of this SSID"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of domain names"
},
"roamConsortOis": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of roaming consortium OIs (hexadecimal number 3-5 octets in length)"
},
"mccMncs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mcc": {
"type": "string",
"description": "MCC value"
},
"mnc": {
"type": "string",
"description": "MNC value"
}
}
},
"description": "An array of MCC/MNC pairs"
},
"naiRealms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"format": {
"type": "string",
"description": "The format for the realm ('1' or '0')"
},
"name": {
"type": "string",
"description": "The name of the realm"
},
"methods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of method"
},
"authenticationTypes": {
"type": "object",
"properties": {
"nonEapInnerAuthentication": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of non-EAP inner authentication types"
},
"eapInnerAuthentication": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of EAP inner authentication types"
},
"credentials": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of credentials"
},
"tunneledEapMethodCredentials": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tunneled EAP method credentials"
}
},
"description": "The authentication types for the method. These should be formatted as an object with the EAP method category in camelcase as the key and the list of types as the value"
}
}
},
"description": "An array of EAP methods for the realm."
}
}
},
"description": "An array of NAI realms"
}
}
},
"example": {
"enabled": true,
"operator": {
"name": "Meraki Product Management"
},
"venue": {
"name": "SF Branch",
"type": "Unspecified Assembly"
},
"networkAccessType": "Private network",
"domains": [
"meraki.local",
"domain2.com"
],
"roamConsortOis": [
"ABC123",
"456EFG"
],
"mccMncs": [
{
"mcc": "123",
"mnc": "456"
}
],
"naiRealms": [
{
"format": "1",
"name": "Realm 1",
"methods": [
{
"id": "1",
"authenticationTypes": {
"nonEapInnerAuthentication": [
"MSCHAP"
],
"eapInnerAuthentication": [
"EAP-TTLS with MSCHAPv2"
],
"credentials": [],
"tunneledEapMethodCredentials": []
}
}
]
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return the Hotspot 2.0 settings for an SSID",
"tags": [
"wireless",
"configure",
"ssids",
"hotspot20"
]
},
"put": {
"description": "Update the Hotspot 2.0 settings of an SSID",
"operationId": "updateNetworkWirelessSsidHotspot20",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not Hotspot 2.0 for this SSID is enabled"
},
"operator": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Operator name"
}
},
"description": "Operator settings for this SSID"
},
"venue": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Venue name"
},
"type": {
"type": "string",
"enum": [
"Airplane",
"Alcohol and Drug Rehabilitation Center",
"Amphitheater",
"Amusement Park",
"Arena",
"Attorney Office",
"Automobile or Truck",
"Automotive Service Station",
"Bank",
"Bar",
"Boarding House",
"Bus",
"Bus Stop",
"City Park",
"Coffee Shop",
"Convention Center",
"Doctor or Dentist office",
"Dormitory",
"Emergency Coordination Center",
"Factory",
"Ferry",
"Fire Station",
"Gas Station",
"Grocery Market",
"Group Home",
"Hospital",
"Hotel or Motel",
"Kiosk",
"Library",
"Long-Term Care Facility",
"Motor Bike",
"Muni-mesh Network",
"Museum",
"Passenger Terminal",
"Place of Worship",
"Police Station",
"Post Office",
"Prison or Jail",
"Private Residence",
"Professional Office",
"Research and Development Facility",
"Rest Area",
"Restaurant",
"Retail Store",
"School, Primary",
"School, Secondary",
"Ship or Boat",
"Shopping Mall",
"Stadium",
"Theater",
"Traffic Control",
"Train",
"University or College",
"Unspecified",
"Unspecified Assembly",
"Unspecified Business",
"Unspecified Educational",
"Unspecified Factory and Industrial",
"Unspecified Institutional",
"Unspecified Mercantile",
"Unspecified Outdoor",
"Unspecified Residential",
"Unspecified Storage",
"Unspecified Utility and Miscellaneous",
"Unspecified Vehicular",
"Zoo or Aquarium"
],
"description": "Venue type ('Unspecified', 'Unspecified Assembly', 'Arena', 'Stadium', 'Passenger Terminal', 'Amphitheater', 'Amusement Park', 'Place of Worship', 'Convention Center', 'Library', 'Museum', 'Restaurant', 'Theater', 'Bar', 'Coffee Shop', 'Zoo or Aquarium', 'Emergency Coordination Center', 'Unspecified Business', 'Doctor or Dentist office', 'Bank', 'Fire Station', 'Police Station', 'Post Office', 'Professional Office', 'Research and Development Facility', 'Attorney Office', 'Unspecified Educational', 'School, Primary', 'School, Secondary', 'University or College', 'Unspecified Factory and Industrial', 'Factory', 'Unspecified Institutional', 'Hospital', 'Long-Term Care Facility', 'Alcohol and Drug Rehabilitation Center', 'Group Home', 'Prison or Jail', 'Unspecified Mercantile', 'Retail Store', 'Grocery Market', 'Automotive Service Station', 'Shopping Mall', 'Gas Station', 'Unspecified Residential', 'Private Residence', 'Hotel or Motel', 'Dormitory', 'Boarding House', 'Unspecified Storage', 'Unspecified Utility and Miscellaneous', 'Unspecified Vehicular', 'Automobile or Truck', 'Airplane', 'Bus', 'Ferry', 'Ship or Boat', 'Train', 'Motor Bike', 'Unspecified Outdoor', 'Muni-mesh Network', 'City Park', 'Rest Area', 'Traffic Control', 'Bus Stop', 'Kiosk')"
}
},
"description": "Venue settings for this SSID"
},
"networkAccessType": {
"type": "string",
"enum": [
"Chargeable public network",
"Emergency services only network",
"Free public network",
"Personal device network",
"Private network",
"Private network with guest access",
"Test or experimental",
"Wildcard"
],
"description": "The network type of this SSID ('Private network', 'Private network with guest access', 'Chargeable public network', 'Free public network', 'Personal device network', 'Emergency services only network', 'Test or experimental', 'Wildcard')"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of domain names"
},
"roamConsortOis": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of roaming consortium OIs (hexadecimal number 3-5 octets in length)"
},
"mccMncs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mcc": {
"type": "string",
"description": "MCC value"
},
"mnc": {
"type": "string",
"description": "MNC value"
}
}
},
"description": "An array of MCC/MNC pairs"
},
"naiRealms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"0",
"1"
],
"description": "The format for the realm ('1' or '0')"
},
"realm": {
"type": "string",
"description": "The name of the realm"
},
"methods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of method"
},
"authenticationTypes": {
"type": "object",
"properties": {
"nonEapInnerAuthentication": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of non-EAP inner authentication types"
},
"eapInnerAuthentication": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of EAP inner authentication types"
},
"credentials": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of credentials"
},
"tunneledEapMethodCredentials": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tunneled EAP method credentials"
}
},
"description": "The authentication types for the method. These should be formatted as an object with the EAP method category in camelcase as the key and the list of types as the value (nonEapInnerAuthentication: Reserved, PAP, CHAP, MSCHAP, MSCHAPV2; eapInnerAuthentication: EAP-TLS, EAP-SIM, EAP-AKA, EAP-TTLS with MSCHAPv2; credentials: SIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, none, Reserved, Vendor Specific; tunneledEapMethodCredentials: SIM, USIM, NFC Secure Element, Hardware Token, Softoken, Certificate, username/password, Reserved, Anonymous, Vendor Specific)"
}
}
},
"description": "An array of EAP methods for the realm."
}
}
},
"description": "An array of NAI realms"
}
},
"example": {
"enabled": true,
"operator": {
"name": "Meraki Product Management"
},
"venue": {
"name": "SF Branch",
"type": "Unspecified Assembly"
},
"networkAccessType": "Private network",
"domains": [
"meraki.local",
"domain2.com"
],
"roamConsortOis": [
"ABC123",
"456EFG"
],
"mccMncs": [
{
"mcc": "123",
"mnc": "456"
}
],
"naiRealms": [
{
"format": "1",
"realm": "Realm 1",
"methods": [
{
"id": "1",
"authenticationTypes": {
"nonEapInnerAuthentication": [
"MSCHAP"
],
"eapInnerAuthentication": [
"EAP-TTLS with MSCHAPv2"
],
"credentials": [],
"tunneledEapMethodCredentials": []
}
}
]
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not Hotspot 2.0 for this SSID is enabled"
},
"operator": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Operator name"
}
},
"description": "Operator settings for this SSID"
},
"venue": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Venue name"
},
"type": {
"type": "string",
"description": "Venue type"
}
},
"description": "Venue settings for this SSID"
},
"networkAccessType": {
"type": "string",
"description": "The network type of this SSID"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of domain names"
},
"roamConsortOis": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of roaming consortium OIs (hexadecimal number 3-5 octets in length)"
},
"mccMncs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mcc": {
"type": "string",
"description": "MCC value"
},
"mnc": {
"type": "string",
"description": "MNC value"
}
}
},
"description": "An array of MCC/MNC pairs"
},
"naiRealms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"format": {
"type": "string",
"description": "The format for the realm ('1' or '0')"
},
"name": {
"type": "string",
"description": "The name of the realm"
},
"methods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of method"
},
"authenticationTypes": {
"type": "object",
"properties": {
"nonEapInnerAuthentication": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of non-EAP inner authentication types"
},
"eapInnerAuthentication": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of EAP inner authentication types"
},
"credentials": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of credentials"
},
"tunneledEapMethodCredentials": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tunneled EAP method credentials"
}
},
"description": "The authentication types for the method. These should be formatted as an object with the EAP method category in camelcase as the key and the list of types as the value"
}
}
},
"description": "An array of EAP methods for the realm."
}
}
},
"description": "An array of NAI realms"
}
}
},
"example": {
"enabled": true,
"operator": {
"name": "Meraki Product Management"
},
"venue": {
"name": "SF Branch",
"type": "Unspecified Assembly"
},
"networkAccessType": "Private network",
"domains": [
"meraki.local",
"domain2.com"
],
"roamConsortOis": [
"ABC123",
"456EFG"
],
"mccMncs": [
{
"mcc": "123",
"mnc": "456"
}
],
"naiRealms": [
{
"format": "1",
"name": "Realm 1",
"methods": [
{
"id": "1",
"authenticationTypes": {
"nonEapInnerAuthentication": [
"MSCHAP"
],
"eapInnerAuthentication": [
"EAP-TTLS with MSCHAPv2"
],
"credentials": [],
"tunneledEapMethodCredentials": []
}
}
]
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the Hotspot 2.0 settings of an SSID",
"tags": [
"wireless",
"configure",
"ssids",
"hotspot20"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/identityPsks": {
"get": {
"description": "List all Identity PSKs in a wireless network",
"operationId": "getNetworkWirelessSsidIdentityPsks",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Identity PSK"
},
"id": {
"type": "string",
"description": "The unique identifier of the Identity PSK"
},
"groupPolicyId": {
"type": "string",
"description": "The group policy to be applied to clients"
},
"passphrase": {
"type": "string",
"description": "The passphrase for client authentication"
},
"wifiPersonalNetworkId": {
"type": "string",
"description": "The WiFi Personal Network unique identifier"
},
"email": {
"type": "string",
"description": "The email associated with the System's Manager User"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp for when the Identity PSK expires, or 'null' to never expire",
"nullable": true
}
}
}
},
"example": [
{
"name": "Sample Identity PSK",
"id": "1284392014819",
"groupPolicyId": "101",
"passphrase": "secret",
"wifiPersonalNetworkId": "1284392014819",
"email": "miles@meraki.com",
"expiresAt": "2018-02-11T00:00:00.090210Z"
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List all Identity PSKs in a wireless network",
"tags": [
"wireless",
"configure",
"ssids",
"identityPsks"
]
},
"post": {
"description": "Create an Identity PSK",
"operationId": "createNetworkWirelessSsidIdentityPsk",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Identity PSK"
},
"passphrase": {
"type": "string",
"description": "The passphrase for client authentication. If left blank, one will be auto-generated."
},
"groupPolicyId": {
"type": "string",
"description": "The group policy to be applied to clients"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp for when the Identity PSK expires. Will not expire if left blank."
}
},
"example": {
"name": "Sample Identity PSK",
"passphrase": "secret",
"groupPolicyId": "101",
"expiresAt": "2018-02-11T00:00:00.090210Z"
},
"required": [
"name",
"groupPolicyId"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Identity PSK"
},
"id": {
"type": "string",
"description": "The unique identifier of the Identity PSK"
},
"groupPolicyId": {
"type": "string",
"description": "The group policy to be applied to clients"
},
"passphrase": {
"type": "string",
"description": "The passphrase for client authentication"
},
"wifiPersonalNetworkId": {
"type": "string",
"description": "The WiFi Personal Network unique identifier"
},
"email": {
"type": "string",
"description": "The email associated with the System's Manager User"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp for when the Identity PSK expires, or 'null' to never expire",
"nullable": true
}
}
},
"example": {
"name": "Sample Identity PSK",
"id": "1284392014819",
"groupPolicyId": "101",
"passphrase": "secret",
"wifiPersonalNetworkId": "1284392014819",
"email": "miles@meraki.com",
"expiresAt": "2018-02-11T00:00:00.090210Z"
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Create an Identity PSK",
"tags": [
"wireless",
"configure",
"ssids",
"identityPsks"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId}": {
"get": {
"description": "Return an Identity PSK",
"operationId": "getNetworkWirelessSsidIdentityPsk",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "identityPskId",
"in": "path",
"description": "Identity psk ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Identity PSK"
},
"id": {
"type": "string",
"description": "The unique identifier of the Identity PSK"
},
"groupPolicyId": {
"type": "string",
"description": "The group policy to be applied to clients"
},
"passphrase": {
"type": "string",
"description": "The passphrase for client authentication"
},
"wifiPersonalNetworkId": {
"type": "string",
"description": "The WiFi Personal Network unique identifier"
},
"email": {
"type": "string",
"description": "The email associated with the System's Manager User"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp for when the Identity PSK expires, or 'null' to never expire",
"nullable": true
}
}
},
"example": {
"name": "Sample Identity PSK",
"id": "1284392014819",
"groupPolicyId": "101",
"passphrase": "secret",
"wifiPersonalNetworkId": "1284392014819",
"email": "miles@meraki.com",
"expiresAt": "2018-02-11T00:00:00.090210Z"
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Return an Identity PSK",
"tags": [
"wireless",
"configure",
"ssids",
"identityPsks"
]
},
"put": {
"description": "Update an Identity PSK",
"operationId": "updateNetworkWirelessSsidIdentityPsk",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "identityPskId",
"in": "path",
"description": "Identity psk ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Identity PSK"
},
"passphrase": {
"type": "string",
"description": "The passphrase for client authentication"
},
"groupPolicyId": {
"type": "string",
"description": "The group policy to be applied to clients"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Timestamp for when the Identity PSK expires, or 'null' to never expire"
}
},
"example": {
"name": "Sample Identity PSK",
"passphrase": "secret",
"groupPolicyId": "101",
"expiresAt": "2018-02-11T00:00:00.090210Z"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Identity PSK"
},
"id": {
"type": "string",
"description": "The unique identifier of the Identity PSK"
},
"groupPolicyId": {
"type": "string",
"description": "The group policy to be applied to clients"
},
"passphrase": {
"type": "string",
"description": "The passphrase for client authentication"
},
"wifiPersonalNetworkId": {
"type": "string",
"description": "The WiFi Personal Network unique identifier"
},
"email": {
"type": "string",
"description": "The email associated with the System's Manager User"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp for when the Identity PSK expires, or 'null' to never expire",
"nullable": true
}
}
},
"example": {
"name": "Sample Identity PSK",
"id": "1284392014819",
"groupPolicyId": "101",
"passphrase": "secret",
"wifiPersonalNetworkId": "1284392014819",
"email": "miles@meraki.com",
"expiresAt": "2018-02-11T00:00:00.090210Z"
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update an Identity PSK",
"tags": [
"wireless",
"configure",
"ssids",
"identityPsks"
]
},
"delete": {
"description": "Delete an Identity PSK",
"operationId": "deleteNetworkWirelessSsidIdentityPsk",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "identityPskId",
"in": "path",
"description": "Identity psk ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Delete an Identity PSK",
"tags": [
"wireless",
"configure",
"ssids",
"identityPsks"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/openRoaming": {
"put": {
"description": "Update the OpenRoaming setting for the SSID",
"operationId": "updateNetworkWirelessSsidOpenRoaming",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, OpenRoaming is enabled on this SSID."
},
"tenantId": {
"type": "string",
"description": "The OpenRoaming DNA Spaces tenant ID."
}
},
"example": {
"enabled": true,
"tenantId": "12345"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, OpenRoaming is enabled on the SSID."
},
"tenantId": {
"type": "string",
"description": "The OpenRoaming DNA Spaces tenant ID."
}
}
},
"example": {
"enabled": true,
"tenantId": "123-456"
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the OpenRoaming setting for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"openRoaming"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/schedules": {
"get": {
"description": "List the outage schedule for the SSID",
"operationId": "getNetworkWirelessSsidSchedules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, the SSID outage schedule is enabled."
},
"ranges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDay": {
"type": "string",
"description": "Day of when the outage starts. Can be either full day name, or three letter abbreviation."
},
"startTime": {
"type": "string",
"description": "24 hour time when the outage starts."
},
"endDay": {
"type": "string",
"description": "Day of when the outage ends. Can be either full day name, or three letter abbreviation"
},
"endTime": {
"type": "string",
"description": "24 hour time when the outage ends."
}
},
"required": [
"startDay",
"startTime",
"endDay",
"endTime"
]
},
"description": "List of outage ranges. Has a start date and time, and end date and time. If this parameter is passed in along with rangesInSeconds parameter, this will take precedence."
},
"rangesInSeconds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"description": "Seconds since Sunday at midnight when the outage range starts."
},
"end": {
"type": "integer",
"description": "Seconds since Sunday at midnight when that outage range ends."
}
},
"required": [
"start",
"end"
]
},
"description": "List of outage ranges in seconds since Sunday at Midnight. Has a start and end. If this parameter is passed in along with the ranges parameter, ranges will take precedence."
}
}
},
"example": {
"enabled": true,
"ranges": [
{
"startDay": "Tuesday",
"startTime": "01:00",
"endDay": "Tuesday",
"endTime": "05:00"
}
],
"rangesInSeconds": [
{
"start": 604800,
"end": 0
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List the outage schedule for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"schedules"
]
},
"put": {
"description": "Update the outage schedule for the SSID",
"operationId": "updateNetworkWirelessSsidSchedules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, the SSID outage schedule is enabled."
},
"ranges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDay": {
"type": "string",
"description": "Day of when the outage starts. Can be either full day name, or three letter abbreviation."
},
"startTime": {
"type": "string",
"description": "24 hour time when the outage starts."
},
"endDay": {
"type": "string",
"description": "Day of when the outage ends. Can be either full day name, or three letter abbreviation"
},
"endTime": {
"type": "string",
"description": "24 hour time when the outage ends."
}
},
"required": [
"startDay",
"startTime",
"endDay",
"endTime"
]
},
"description": "List of outage ranges. Has a start date and time, and end date and time. If this parameter is passed in along with rangesInSeconds parameter, this will take precedence."
},
"rangesInSeconds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"description": "Seconds since Sunday at midnight when the outage range starts."
},
"end": {
"type": "integer",
"description": "Seconds since Sunday at midnight when that outage range ends."
}
},
"required": [
"start",
"end"
]
},
"description": "List of outage ranges in seconds since Sunday at Midnight. Has a start and end. If this parameter is passed in along with the ranges parameter, ranges will take precedence."
}
},
"example": {
"enabled": true,
"ranges": [
{
"startDay": "Tuesday",
"startTime": "01:00",
"endDay": "Tuesday",
"endTime": "05:00"
}
],
"rangesInSeconds": [
{
"start": 604800,
"end": 0
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, the SSID outage schedule is enabled."
},
"ranges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDay": {
"type": "string",
"description": "Day of when the outage starts. Can be either full day name, or three letter abbreviation."
},
"startTime": {
"type": "string",
"description": "24 hour time when the outage starts."
},
"endDay": {
"type": "string",
"description": "Day of when the outage ends. Can be either full day name, or three letter abbreviation"
},
"endTime": {
"type": "string",
"description": "24 hour time when the outage ends."
}
},
"required": [
"startDay",
"startTime",
"endDay",
"endTime"
]
},
"description": "List of outage ranges. Has a start date and time, and end date and time. If this parameter is passed in along with rangesInSeconds parameter, this will take precedence."
},
"rangesInSeconds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"description": "Seconds since Sunday at midnight when the outage range starts."
},
"end": {
"type": "integer",
"description": "Seconds since Sunday at midnight when that outage range ends."
}
},
"required": [
"start",
"end"
]
},
"description": "List of outage ranges in seconds since Sunday at Midnight. Has a start and end. If this parameter is passed in along with the ranges parameter, ranges will take precedence."
}
}
},
"example": {
"enabled": true,
"ranges": [
{
"startDay": "Tuesday",
"startTime": "01:00",
"endDay": "Tuesday",
"endTime": "05:00"
}
],
"rangesInSeconds": [
{
"start": 604800,
"end": 0
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the outage schedule for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"schedules"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/splash/settings": {
"get": {
"description": "Display the splash page settings for the given SSID",
"operationId": "getNetworkWirelessSsidSplashSettings",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ssidNumber": {
"type": "integer",
"description": "SSID number"
},
"splashPage": {
"type": "string",
"description": "The type of splash page for this SSID"
},
"useSplashUrl": {
"type": "boolean",
"description": "Boolean indicating whether the users will be redirected to the custom splash url"
},
"splashUrl": {
"type": "string",
"description": "The custom splash URL of the click-through splash page."
},
"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": {
"type": "string",
"description": "The custom redirect URL where the users will go after the splash page."
},
"useRedirectUrl": {
"type": "boolean",
"description": "The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page."
},
"welcomeMessage": {
"type": "string",
"description": "The welcome message for the users on the splash page."
},
"userConsent": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Whether users must provide consent"
},
"message": {
"type": "string",
"description": "Consent message displayed to users"
}
},
"description": "User consent settings"
},
"themeId": {
"type": "string",
"description": "The id of the selected splash theme."
},
"splashLogo": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the logo file."
},
"extension": {
"type": "string",
"description": "The extension of the logo file."
}
},
"description": "The logo used in the splash page."
},
"splashImage": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the image file."
},
"extension": {
"type": "string",
"description": "The extension of the image file."
}
},
"description": "The image used in the splash page."
},
"splashPrepaidFront": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the prepaid front image file."
},
"extension": {
"type": "string",
"description": "The extension of the prepaid front image file."
}
},
"description": "The prepaid front image used in the splash page."
},
"guestSponsorship": {
"type": "object",
"properties": {
"durationInMinutes": {
"type": "integer",
"description": "Duration in minutes of sponsored guest authorization."
},
"guestCanRequestTimeframe": {
"type": "boolean",
"description": "Whether or not guests can specify how much time they are requesting."
}
},
"description": "Details associated with guest sponsored splash"
},
"blockAllTrafficBeforeSignOn": {
"type": "boolean",
"description": "How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged."
},
"controllerDisconnectionBehavior": {
"type": "string",
"description": "How login attempts should be handled when the controller is unreachable."
},
"allowSimultaneousLogins": {
"type": "boolean",
"description": "Whether or not to allow simultaneous logins from different devices."
},
"billing": {
"type": "object",
"properties": {
"freeAccess": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not free access is enabled."
},
"durationInMinutes": {
"type": "integer",
"description": "How long a device can use a network for free."
}
},
"description": "Details associated with a free access plan with limits"
},
"prepaidAccessFastLoginEnabled": {
"type": "boolean",
"description": "Whether or not billing uses the fast login prepaid access option."
},
"replyToEmailAddress": {
"type": "string",
"description": "The email address that reeceives replies from clients"
}
},
"description": "Details associated with billing splash"
},
"sentryEnrollment": {
"type": "object",
"properties": {
"systemsManagerNetwork": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network ID of the Systems Manager network."
}
},
"description": "Systems Manager network targeted for sentry enrollment."
},
"strength": {
"type": "string",
"enum": [
"click-through",
"focused",
"strict"
],
"description": "The strength of the enforcement of selected system types."
},
"enforcedSystems": {
"type": "array",
"items": {
"type": "string"
},
"description": "The system types that the Sentry enforces."
}
},
"description": "Systems Manager sentry enrollment splash settings."
},
"selfRegistration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not to allow users to create their own account on the network."
},
"authorizationType": {
"type": "string",
"enum": [
"admin",
"auto",
"self_email"
],
"description": "How created user accounts should be authorized."
}
},
"description": "Self-registration for splash with Meraki authentication."
}
}
},
"example": {
"ssidNumber": 0,
"splashPage": "Click-through splash page",
"useSplashUrl": true,
"splashUrl": "https://www.custom_splash_url.com",
"splashTimeout": 1440,
"redirectUrl": "https://example.com",
"useRedirectUrl": true,
"welcomeMessage": "Welcome!",
"userConsent": {
"required": true,
"message": "By continuing, you agree to our terms and conditions."
},
"themeId": "c3ddcb4f16785ee747ab5ffc10867d6c8ea704be",
"splashLogo": {
"md5": "abcd1234",
"extension": "jpg"
},
"splashImage": {
"md5": "542cccac8d7dedee0f185311d154d194",
"extension": "jpg"
},
"splashPrepaidFront": {
"md5": "542cccac8d7dedee0f185311d154d194",
"extension": "jpg"
},
"guestSponsorship": {
"durationInMinutes": 30,
"guestCanRequestTimeframe": false
},
"blockAllTrafficBeforeSignOn": false,
"controllerDisconnectionBehavior": "default",
"allowSimultaneousLogins": false,
"billing": {
"freeAccess": {
"enabled": true,
"durationInMinutes": 120
},
"prepaidAccessFastLoginEnabled": true,
"replyToEmailAddress": "user@email.com"
},
"sentryEnrollment": {
"systemsManagerNetwork": {
"id": "N_1234"
},
"strength": "focused",
"enforcedSystems": [
"iOS"
]
},
"selfRegistration": {
"enabled": true,
"authorizationType": "admin"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Display the splash page settings for the given SSID",
"tags": [
"wireless",
"configure",
"ssids",
"splash",
"settings"
]
},
"put": {
"description": "Modify the splash page settings for the given SSID",
"operationId": "updateNetworkWirelessSsidSplashSettings",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"splashUrl": {
"type": "string",
"description": "[optional] The custom splash URL of the click-through splash page. Note that the URL can be configured without necessarily being used. In order to enable the custom URL, see 'useSplashUrl'"
},
"useSplashUrl": {
"type": "boolean",
"description": "[optional] Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID's access control settings, it may not be possible to use the custom splash URL."
},
"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": {
"type": "string",
"description": "The custom redirect URL where the users will go after the splash page."
},
"useRedirectUrl": {
"type": "boolean",
"description": "The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true."
},
"welcomeMessage": {
"type": "string",
"description": "The welcome message for the users on the splash page."
},
"userConsent": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Whether users must provide consent"
},
"message": {
"type": "string",
"description": "Consent message displayed to users"
}
},
"description": "User consent settings"
},
"themeId": {
"type": "string",
"description": "The id of the selected splash theme."
},
"splashLogo": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the logo file. Setting this to null will remove the logo from the splash page.",
"nullable": true
},
"extension": {
"type": "string",
"description": "The extension of the logo file."
},
"image": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"gif",
"jpg",
"png"
],
"description": "The format of the encoded contents. Supported formats are 'png', 'gif', and jpg'."
},
"contents": {
"type": "string",
"format": "byte",
"description": "The file contents (a base 64 encoded string) of your new logo."
}
},
"description": "Properties for setting a new image."
}
},
"description": "The logo used in the splash page."
},
"splashImage": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the image file. Setting this to null will remove the image from the splash page.",
"nullable": true
},
"extension": {
"type": "string",
"description": "The extension of the image file."
},
"image": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"gif",
"jpg",
"png"
],
"description": "The format of the encoded contents. Supported formats are 'png', 'gif', and jpg'."
},
"contents": {
"type": "string",
"format": "byte",
"description": "The file contents (a base 64 encoded string) of your new image."
}
},
"description": "Properties for setting a new image."
}
},
"description": "The image used in the splash page."
},
"splashPrepaidFront": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the prepaid front image file. Setting this to null will remove the prepaid front from the splash page.",
"nullable": true
},
"extension": {
"type": "string",
"description": "The extension of the prepaid front image file."
},
"image": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"gif",
"jpg",
"png"
],
"description": "The format of the encoded contents. Supported formats are 'png', 'gif', and jpg'."
},
"contents": {
"type": "string",
"format": "byte",
"description": "The file contents (a base 64 encoded string) of your new prepaid front."
}
},
"description": "Properties for setting a new image."
}
},
"description": "The prepaid front image used in the splash page."
},
"blockAllTrafficBeforeSignOn": {
"type": "boolean",
"description": "How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged."
},
"controllerDisconnectionBehavior": {
"type": "string",
"enum": [
"default",
"open",
"restricted"
],
"description": "How login attempts should be handled when the controller is unreachable. Can be either 'open', 'restricted', or 'default'."
},
"allowSimultaneousLogins": {
"type": "boolean",
"description": "Whether or not to allow simultaneous logins from different devices."
},
"guestSponsorship": {
"type": "object",
"properties": {
"durationInMinutes": {
"type": "integer",
"description": "Duration in minutes of sponsored guest authorization. Must be between 1 and 60480 (6 weeks)"
},
"guestCanRequestTimeframe": {
"type": "boolean",
"description": "Whether or not guests can specify how much time they are requesting."
}
},
"description": "Details associated with guest sponsored splash."
},
"billing": {
"type": "object",
"properties": {
"freeAccess": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not free access is enabled."
},
"durationInMinutes": {
"type": "integer",
"description": "How long a device can use a network for free."
}
},
"description": "Details associated with a free access plan with limits."
},
"prepaidAccessFastLoginEnabled": {
"type": "boolean",
"description": "Whether or not billing uses the fast login prepaid access option."
},
"replyToEmailAddress": {
"type": "string",
"description": "The email address that receives replies from clients."
}
},
"description": "Details associated with billing splash."
},
"sentryEnrollment": {
"type": "object",
"properties": {
"systemsManagerNetwork": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network ID of the Systems Manager network."
}
},
"required": [
"id"
],
"description": "Systems Manager network targeted for sentry enrollment."
},
"strength": {
"type": "string",
"enum": [
"click-through",
"focused",
"strict"
],
"description": "The strength of the enforcement of selected system types. Must be one of: 'focused', 'click-through', and 'strict'."
},
"enforcedSystems": {
"type": "array",
"items": {
"type": "string"
},
"description": "The system types that the Sentry enforces. Must be included in: 'iOS, 'Android', 'macOS', and 'Windows'."
}
},
"description": "Systems Manager sentry enrollment splash settings."
},
"selfRegistration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not to allow users to create their own account on the network."
},
"authorizationType": {
"type": "string",
"enum": [
"admin",
"auto",
"self_email"
],
"description": "How created user accounts should be authorized. Must be included in: [admin, auto, self_email]"
}
},
"description": "Self-registration settings for splash with Meraki authentication."
}
},
"example": {
"splashUrl": "https://www.custom_splash_url.com",
"useSplashUrl": true,
"splashTimeout": 1440,
"redirectUrl": "https://example.com",
"useRedirectUrl": true,
"welcomeMessage": "Welcome!",
"userConsent": {
"required": true,
"message": "By continuing, you agree to our terms and conditions."
},
"themeId": "c3ddcb4f16785ee747ab5ffc10867d6c8ea704be",
"splashLogo": {
"md5": "abcd1234",
"extension": "jpg",
"image": {
"format": "jpg",
"contents": "Q2lzY28gTWVyYWtp"
}
},
"splashImage": {
"md5": "542cccac8d7dedee0f185311d154d194",
"extension": "jpg",
"image": {
"format": "jpg",
"contents": "Q2lzY28gTWVyYWtp"
}
},
"splashPrepaidFront": {
"md5": "542cccac8d7dedee0f185311d154d194",
"extension": "jpg",
"image": {
"format": "jpg",
"contents": "Q2lzY28gTWVyYWtp"
}
},
"blockAllTrafficBeforeSignOn": false,
"controllerDisconnectionBehavior": "default",
"allowSimultaneousLogins": false,
"guestSponsorship": {
"durationInMinutes": 30,
"guestCanRequestTimeframe": false
},
"billing": {
"freeAccess": {
"enabled": true,
"durationInMinutes": 120
},
"prepaidAccessFastLoginEnabled": true,
"replyToEmailAddress": "user@email.com"
},
"sentryEnrollment": {
"systemsManagerNetwork": {
"id": "N_1234"
},
"strength": "focused",
"enforcedSystems": [
"iOS"
]
},
"selfRegistration": {
"enabled": true,
"authorizationType": "admin"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ssidNumber": {
"type": "integer",
"description": "SSID number"
},
"splashPage": {
"type": "string",
"description": "The type of splash page for this SSID"
},
"useSplashUrl": {
"type": "boolean",
"description": "Boolean indicating whether the users will be redirected to the custom splash url"
},
"splashUrl": {
"type": "string",
"description": "The custom splash URL of the click-through splash page."
},
"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": {
"type": "string",
"description": "The custom redirect URL where the users will go after the splash page."
},
"useRedirectUrl": {
"type": "boolean",
"description": "The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page."
},
"welcomeMessage": {
"type": "string",
"description": "The welcome message for the users on the splash page."
},
"userConsent": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Whether users must provide consent"
},
"message": {
"type": "string",
"description": "Consent message displayed to users"
}
},
"description": "User consent settings"
},
"themeId": {
"type": "string",
"description": "The id of the selected splash theme."
},
"splashLogo": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the logo file."
},
"extension": {
"type": "string",
"description": "The extension of the logo file."
}
},
"description": "The logo used in the splash page."
},
"splashImage": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the image file."
},
"extension": {
"type": "string",
"description": "The extension of the image file."
}
},
"description": "The image used in the splash page."
},
"splashPrepaidFront": {
"type": "object",
"properties": {
"md5": {
"type": "string",
"description": "The MD5 value of the prepaid front image file."
},
"extension": {
"type": "string",
"description": "The extension of the prepaid front image file."
}
},
"description": "The prepaid front image used in the splash page."
},
"guestSponsorship": {
"type": "object",
"properties": {
"durationInMinutes": {
"type": "integer",
"description": "Duration in minutes of sponsored guest authorization."
},
"guestCanRequestTimeframe": {
"type": "boolean",
"description": "Whether or not guests can specify how much time they are requesting."
}
},
"description": "Details associated with guest sponsored splash"
},
"blockAllTrafficBeforeSignOn": {
"type": "boolean",
"description": "How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged."
},
"controllerDisconnectionBehavior": {
"type": "string",
"description": "How login attempts should be handled when the controller is unreachable."
},
"allowSimultaneousLogins": {
"type": "boolean",
"description": "Whether or not to allow simultaneous logins from different devices."
},
"billing": {
"type": "object",
"properties": {
"freeAccess": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not free access is enabled."
},
"durationInMinutes": {
"type": "integer",
"description": "How long a device can use a network for free."
}
},
"description": "Details associated with a free access plan with limits"
},
"prepaidAccessFastLoginEnabled": {
"type": "boolean",
"description": "Whether or not billing uses the fast login prepaid access option."
},
"replyToEmailAddress": {
"type": "string",
"description": "The email address that reeceives replies from clients"
}
},
"description": "Details associated with billing splash"
},
"sentryEnrollment": {
"type": "object",
"properties": {
"systemsManagerNetwork": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network ID of the Systems Manager network."
}
},
"description": "Systems Manager network targeted for sentry enrollment."
},
"strength": {
"type": "string",
"enum": [
"click-through",
"focused",
"strict"
],
"description": "The strength of the enforcement of selected system types."
},
"enforcedSystems": {
"type": "array",
"items": {
"type": "string"
},
"description": "The system types that the Sentry enforces."
}
},
"description": "Systems Manager sentry enrollment splash settings."
},
"selfRegistration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not to allow users to create their own account on the network."
},
"authorizationType": {
"type": "string",
"enum": [
"admin",
"auto",
"self_email"
],
"description": "How created user accounts should be authorized."
}
},
"description": "Self-registration for splash with Meraki authentication."
}
}
},
"example": {
"ssidNumber": 0,
"splashPage": "Click-through splash page",
"useSplashUrl": true,
"splashUrl": "https://www.custom_splash_url.com",
"splashTimeout": 1440,
"redirectUrl": "https://example.com",
"useRedirectUrl": true,
"welcomeMessage": "Welcome!",
"userConsent": {
"required": true,
"message": "By continuing, you agree to our terms and conditions."
},
"themeId": "c3ddcb4f16785ee747ab5ffc10867d6c8ea704be",
"splashLogo": {
"md5": "abcd1234",
"extension": "jpg"
},
"splashImage": {
"md5": "542cccac8d7dedee0f185311d154d194",
"extension": "jpg"
},
"splashPrepaidFront": {
"md5": "542cccac8d7dedee0f185311d154d194",
"extension": "jpg"
},
"guestSponsorship": {
"durationInMinutes": 30,
"guestCanRequestTimeframe": false
},
"blockAllTrafficBeforeSignOn": false,
"controllerDisconnectionBehavior": "default",
"allowSimultaneousLogins": false,
"billing": {
"freeAccess": {
"enabled": true,
"durationInMinutes": 120
},
"prepaidAccessFastLoginEnabled": true,
"replyToEmailAddress": "user@email.com"
},
"sentryEnrollment": {
"systemsManagerNetwork": {
"id": "N_1234"
},
"strength": "focused",
"enforcedSystems": [
"iOS"
]
},
"selfRegistration": {
"enabled": true,
"authorizationType": "admin"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Modify the splash page settings for the given SSID",
"tags": [
"wireless",
"configure",
"ssids",
"splash",
"settings"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/trafficShaping/rules": {
"put": {
"description": "Update the traffic shaping rules for an SSID on an MR network.",
"operationId": "updateNetworkWirelessSsidTrafficShapingRules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"trafficShapingEnabled": {
"type": "boolean",
"description": "Whether traffic shaping rules are applied to clients on your SSID."
},
"defaultRulesEnabled": {
"type": "boolean",
"description": "Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"definitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"application",
"applicationCategory",
"host",
"ipRange",
"localNet",
"port"
],
"description": "The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'."
},
"value": {
"type": "string",
"description": " If \"type\" is 'host', 'port', 'ipRange' or 'localNet', then \"value\" must be a string, matching either\n a hostname (e.g. \"somesite.com\"), a port (e.g. 8080), or an IP range (\"192.1.0.0\",\n \"192.1.0.0/16\", or \"10.1.0.0/16:80\"). 'localNet' also supports CIDR notation, excluding\n custom ports.\n If \"type\" is 'application' or 'applicationCategory', then \"value\" must be an object\n with the structure { \"id\": \"meraki:layer7/...\" }, where \"id\" is the application category or\n application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories\n endpoint).\n"
}
},
"required": [
"type",
"value"
]
},
"description": " A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.\n"
},
"perClientBandwidthLimits": {
"type": "object",
"properties": {
"settings": {
"type": "string",
"description": "How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'."
},
"bandwidthLimits": {
"type": "object",
"properties": {
"limitUp": {
"type": "integer",
"description": "The maximum upload limit (integer, in Kbps)."
},
"limitDown": {
"type": "integer",
"description": "The maximum download limit (integer, in Kbps)."
}
},
"description": "The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'."
}
},
"description": " An object describing the bandwidth settings for your rule.\n"
},
"dscpTagValue": {
"type": "integer",
"description": " The DSCP tag applied by your rule. null means 'Do not change DSCP tag'.\n For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.\n",
"nullable": true
},
"pcpTagValue": {
"type": "integer",
"description": " The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority).\n null means 'Do not set PCP tag'.\n",
"nullable": true
}
},
"required": [
"definitions"
]
},
"description": " An array of traffic shaping rules. Rules are applied in the order that\n they are specified in. An empty list (or null) means no rules. Note that\n you are allowed a maximum of 8 rules.\n"
}
},
"example": {
"trafficShapingEnabled": true,
"defaultRulesEnabled": true,
"rules": [
{
"definitions": [
{
"type": "host",
"value": "google.com"
}
],
"perClientBandwidthLimits": {
"settings": "custom",
"bandwidthLimits": {
"limitUp": 1000000,
"limitDown": 1000000
}
},
"dscpTagValue": 0,
"pcpTagValue": 0
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"trafficShapingEnabled": {
"type": "boolean",
"description": "Whether traffic shaping rules are applied to clients on your SSID."
},
"defaultRulesEnabled": {
"type": "boolean",
"description": "Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"definitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"application",
"applicationCategory",
"host",
"ipRange",
"localNet",
"port"
],
"description": "The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'."
},
"value": {
"type": "string",
"description": " If \"type\" is 'host', 'port', 'ipRange' or 'localNet', then \"value\" must be a string, matching either\n a hostname (e.g. \"somesite.com\"), a port (e.g. 8080), or an IP range (\"192.1.0.0\",\n \"192.1.0.0/16\", or \"10.1.0.0/16:80\"). 'localNet' also supports CIDR notation, excluding\n custom ports.\n If \"type\" is 'application' or 'applicationCategory', then \"value\" must be an object\n with the structure { \"id\": \"meraki:layer7/...\" }, where \"id\" is the application category or\n application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories\n endpoint).\n"
}
},
"required": [
"type",
"value"
]
},
"description": " A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.\n"
},
"perClientBandwidthLimits": {
"type": "object",
"properties": {
"settings": {
"type": "string",
"description": "How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'."
},
"bandwidthLimits": {
"type": "object",
"properties": {
"limitUp": {
"type": "integer",
"description": "The maximum upload limit (integer, in Kbps)."
},
"limitDown": {
"type": "integer",
"description": "The maximum download limit (integer, in Kbps)."
}
},
"description": "The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'."
}
},
"description": " An object describing the bandwidth settings for your rule.\n"
},
"dscpTagValue": {
"type": "integer",
"description": " The DSCP tag applied by your rule. null means 'Do not change DSCP tag'.\n For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.\n",
"nullable": true
},
"pcpTagValue": {
"type": "integer",
"description": " The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority).\n null means 'Do not set PCP tag'.\n",
"nullable": true
}
},
"required": [
"definitions"
]
},
"description": " An array of traffic shaping rules. Rules are applied in the order that\n they are specified in. An empty list (or null) means no rules. Note that\n you are allowed a maximum of 8 rules.\n"
}
}
},
"example": {
"trafficShapingEnabled": true,
"defaultRulesEnabled": true,
"rules": [
{
"definitions": [
{
"type": "host",
"value": "google.com"
}
],
"perClientBandwidthLimits": {
"settings": "custom",
"bandwidthLimits": {
"limitUp": 1000000,
"limitDown": 1000000
}
},
"dscpTagValue": 0,
"pcpTagValue": 0
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the traffic shaping rules for an SSID on an MR network.",
"tags": [
"wireless",
"configure",
"ssids",
"trafficShaping",
"rules"
]
},
"get": {
"description": "Display the traffic shaping settings for a SSID on an MR network",
"operationId": "getNetworkWirelessSsidTrafficShapingRules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"trafficShapingEnabled": {
"type": "boolean",
"description": "Whether traffic shaping rules are applied to clients on your SSID."
},
"defaultRulesEnabled": {
"type": "boolean",
"description": "Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"definitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"application",
"applicationCategory",
"host",
"ipRange",
"localNet",
"port"
],
"description": "The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'."
},
"value": {
"type": "string",
"description": " If \"type\" is 'host', 'port', 'ipRange' or 'localNet', then \"value\" must be a string, matching either\n a hostname (e.g. \"somesite.com\"), a port (e.g. 8080), or an IP range (\"192.1.0.0\",\n \"192.1.0.0/16\", or \"10.1.0.0/16:80\"). 'localNet' also supports CIDR notation, excluding\n custom ports.\n If \"type\" is 'application' or 'applicationCategory', then \"value\" must be an object\n with the structure { \"id\": \"meraki:layer7/...\" }, where \"id\" is the application category or\n application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories\n endpoint).\n"
}
},
"required": [
"type",
"value"
]
},
"description": " A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.\n"
},
"perClientBandwidthLimits": {
"type": "object",
"properties": {
"settings": {
"type": "string",
"description": "How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'."
},
"bandwidthLimits": {
"type": "object",
"properties": {
"limitUp": {
"type": "integer",
"description": "The maximum upload limit (integer, in Kbps)."
},
"limitDown": {
"type": "integer",
"description": "The maximum download limit (integer, in Kbps)."
}
},
"description": "The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'."
}
},
"description": " An object describing the bandwidth settings for your rule.\n"
},
"dscpTagValue": {
"type": "integer",
"description": " The DSCP tag applied by your rule. null means 'Do not change DSCP tag'.\n For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.\n",
"nullable": true
},
"pcpTagValue": {
"type": "integer",
"description": " The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority).\n null means 'Do not set PCP tag'.\n",
"nullable": true
}
},
"required": [
"definitions"
]
},
"description": " An array of traffic shaping rules. Rules are applied in the order that\n they are specified in. An empty list (or null) means no rules. Note that\n you are allowed a maximum of 8 rules.\n"
}
}
},
"example": {
"trafficShapingEnabled": true,
"defaultRulesEnabled": true,
"rules": [
{
"definitions": [
{
"type": "host",
"value": "google.com"
}
],
"perClientBandwidthLimits": {
"settings": "custom",
"bandwidthLimits": {
"limitUp": 1000000,
"limitDown": 1000000
}
},
"dscpTagValue": 0,
"pcpTagValue": 0
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Display the traffic shaping settings for a SSID on an MR network",
"tags": [
"wireless",
"configure",
"ssids",
"trafficShaping",
"rules"
]
}
},
"/networks/{networkId}/wireless/ssids/{number}/vpn": {
"get": {
"description": "List the VPN settings for the SSID.",
"operationId": "getNetworkWirelessSsidVpn",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"concentrator": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network ID of the concentrator that should be set."
},
"vlanId": {
"type": "integer",
"description": "The VLAN that should be tagged for the concentrator."
},
"name": {
"type": "string",
"description": "The name of the concentrator."
}
},
"description": "The VPN concentrator settings for this SSID."
},
"failover": {
"type": "object",
"properties": {
"requestIp": {
"type": "string",
"description": "IP addressed reserved on DHCP server where SSID will terminate."
},
"heartbeatInterval": {
"type": "integer",
"description": "Idle timer interval in seconds."
},
"idleTimeout": {
"type": "integer",
"description": "Idle timer timeout in seconds."
}
},
"description": "Secondary VPN concentrator settings. This is only used when two VPN concentrators are configured on the SSID."
},
"splitTunnel": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, VPN split tunnel is enabled."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"description": "Protocol for this split tunnel rule."
},
"destCidr": {
"type": "string",
"description": "Destination for this split tunnel rule. IP address, fully-qualified domain names (FQDN) or 'any'."
},
"destPort": {
"type": "string",
"description": "Destination port for this split tunnel rule, (integer in the range 1-65535), or 'any'."
},
"policy": {
"type": "string",
"description": "Traffic policy specified for this split tunnel rule, 'allow' or 'deny'."
},
"comment": {
"type": "string",
"description": "Description for this split tunnel rule (optional)."
}
}
},
"description": "List of VPN split tunnel rules."
}
},
"description": "The VPN split tunnel settings for this SSID."
}
}
},
"example": {
"concentrator": {
"networkId": "N_123",
"vlanId": 44,
"name": "some concentrator name"
},
"failover": {
"requestIp": "1.1.1.1",
"heartbeatInterval": 10,
"idleTimeout": 30
},
"splitTunnel": {
"enabled": true,
"rules": [
{
"protocol": "Any",
"destCidr": "1.1.1.1/32",
"destPort": "any",
"policy": "allow",
"comment": "split tunnel rule 1"
}
]
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List the VPN settings for the SSID.",
"tags": [
"wireless",
"configure",
"ssids",
"vpn"
]
},
"put": {
"description": "Update the VPN settings for the SSID",
"operationId": "updateNetworkWirelessSsidVpn",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "number",
"in": "path",
"description": "Number",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"concentrator": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network ID of the concentrator that should be set."
},
"vlanId": {
"type": "integer",
"description": "The VLAN that should be tagged for the concentrator."
}
},
"description": "The VPN concentrator settings for this SSID."
},
"splitTunnel": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, VPN split tunnel is enabled."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"enum": [
"Any",
"TCP",
"UDP"
],
"description": "Protocol for this split tunnel rule."
},
"destCidr": {
"type": "string",
"description": "Destination for this split tunnel rule. IP address, fully-qualified domain names (FQDN) or 'any'."
},
"destPort": {
"type": "string",
"description": "Destination port for this split tunnel rule, (integer in the range 1-65535), or 'any'."
},
"policy": {
"type": "string",
"description": "Traffic policy specified for this split tunnel rule, 'allow' or 'deny'."
},
"comment": {
"type": "string",
"description": "Description for this split tunnel rule (optional)."
}
},
"required": [
"destCidr",
"policy"
]
},
"description": "List of VPN split tunnel rules."
}
},
"description": "The VPN split tunnel settings for this SSID."
},
"failover": {
"type": "object",
"properties": {
"requestIp": {
"type": "string",
"description": "IP addressed reserved on DHCP server where SSID will terminate."
},
"heartbeatInterval": {
"type": "integer",
"description": "Idle timer interval in seconds."
},
"idleTimeout": {
"type": "integer",
"description": "Idle timer timeout in seconds."
}
},
"description": "Secondary VPN concentrator settings. This is only used when two VPN concentrators are configured on the SSID."
}
},
"example": {
"concentrator": {
"networkId": "N_123",
"vlanId": 44
},
"splitTunnel": {
"enabled": true,
"rules": [
{
"protocol": "Any",
"destCidr": "1.1.1.1/32",
"destPort": "any",
"policy": "allow",
"comment": "split tunnel rule 1"
}
]
},
"failover": {
"requestIp": "1.1.1.1",
"heartbeatInterval": 10,
"idleTimeout": 30
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"concentrator": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network ID of the concentrator that should be set."
},
"vlanId": {
"type": "integer",
"description": "The VLAN that should be tagged for the concentrator."
},
"name": {
"type": "string",
"description": "The name of the concentrator."
}
},
"description": "The VPN concentrator settings for this SSID."
},
"failover": {
"type": "object",
"properties": {
"requestIp": {
"type": "string",
"description": "IP addressed reserved on DHCP server where SSID will terminate."
},
"heartbeatInterval": {
"type": "integer",
"description": "Idle timer interval in seconds."
},
"idleTimeout": {
"type": "integer",
"description": "Idle timer timeout in seconds."
}
},
"description": "Secondary VPN concentrator settings. This is only used when two VPN concentrators are configured on the SSID."
},
"splitTunnel": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, VPN split tunnel is enabled."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"description": "Protocol for this split tunnel rule."
},
"destCidr": {
"type": "string",
"description": "Destination for this split tunnel rule. IP address, fully-qualified domain names (FQDN) or 'any'."
},
"destPort": {
"type": "string",
"description": "Destination port for this split tunnel rule, (integer in the range 1-65535), or 'any'."
},
"policy": {
"type": "string",
"description": "Traffic policy specified for this split tunnel rule, 'allow' or 'deny'."
},
"comment": {
"type": "string",
"description": "Description for this split tunnel rule (optional)."
}
}
},
"description": "List of VPN split tunnel rules."
}
},
"description": "The VPN split tunnel settings for this SSID."
}
}
},
"example": {
"concentrator": {
"networkId": "N_123",
"vlanId": 44,
"name": "some concentrator name"
},
"failover": {
"requestIp": "1.1.1.1",
"heartbeatInterval": 10,
"idleTimeout": 30
},
"splitTunnel": {
"enabled": true,
"rules": [
{
"protocol": "Any",
"destCidr": "1.1.1.1/32",
"destPort": "any",
"policy": "allow",
"comment": "split tunnel rule 1"
}
]
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:write"
]
}
],
"summary": "Update the VPN settings for the SSID",
"tags": [
"wireless",
"configure",
"ssids",
"vpn"
]
}
},
"/networks/{networkId}/wireless/usageHistory": {
"get": {
"description": "Return AP usage over time for a device or network client",
"operationId": "getNetworkWirelessUsageHistory",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.",
"schema": {
"type": "integer"
}
},
{
"name": "autoResolution",
"in": "query",
"description": "Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.",
"schema": {
"type": "boolean"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history.",
"schema": {
"type": "string"
}
},
{
"name": "deviceSerial",
"in": "query",
"description": "Filter results by device. Requires :band.",
"schema": {
"type": "string"
}
},
{
"name": "apTag",
"in": "query",
"description": "Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.",
"schema": {
"type": "string"
}
},
{
"name": "band",
"in": "query",
"description": "Filter results by band (either '2.4', '5' or '6').",
"schema": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
]
}
},
{
"name": "ssid",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the query range"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the query range"
},
"totalKbps": {
"type": "integer",
"description": "Total usage in kilobytes-per-second"
},
"sentKbps": {
"type": "integer",
"description": "Sent kilobytes-per-second"
},
"receivedKbps": {
"type": "integer",
"description": "Received kilobytes-per-second"
}
}
}
},
"example": [
{
"startTs": "2020-01-01T00:00:00Z",
"endTs": "2020-01-01T01:00:00Z",
"totalKbps": 2590,
"sentKbps": 159,
"receivedKbps": 2431
}
]
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return AP usage over time for a device or network client",
"tags": [
"wireless",
"monitor",
"usageHistory"
]
}
},
"/networks/{networkId}/wireless/zigbee": {
"put": {
"description": "Update Zigbee Configs for specified network",
"operationId": "updateNetworkWirelessZigbee",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "To enable/disable Zigbee on the network"
},
"iotController": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Device Serial number",
"nullable": true
}
},
"description": "Zigbee's IoT controller details"
},
"lockManagement": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Valid hostname or IP address"
},
"username": {
"type": "string",
"description": "Username"
},
"password": {
"type": "string",
"description": "Password"
}
},
"description": "Login Credentials of on-premises lock management"
},
"defaults": {
"type": "object",
"properties": {
"transmitPowerLevel": {
"type": "integer",
"minimum": 10,
"maximum": 20,
"description": "Transmit Power Level"
},
"channel": {
"type": "string",
"description": "Channel"
}
},
"description": "Default Settings for Zigbee Devices"
}
},
"example": {}
}
}
},
"required": false
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique Meraki Identifier for the network"
}
},
"description": "Network details"
},
"enabled": {
"type": "boolean",
"description": "If Zigbee is enabled for the network"
},
"iotController": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the device"
},
"mac": {
"type": "string",
"description": "Mac address of the device"
},
"serial": {
"type": "string",
"description": "Serial number of the device"
},
"status": {
"type": "string",
"description": "Zigbee connectivity status of the device"
}
},
"description": "Device details setup the IoT controller"
},
"lockManagement": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Host address of the system"
},
"username": {
"type": "string",
"description": "Login user credentials"
},
"status": {
"type": "string",
"description": "Zigbee connectivity status of the management software"
}
},
"description": "Lock management details"
},
"defaults": {
"type": "object",
"properties": {
"transmitPowerLevel": {
"type": "integer",
"description": "Default transmit power level for the network"
},
"channel": {
"type": "string",
"description": "Channel the zigbee node will communicate on either, auto or between 11-25"
}
},
"description": "Default settings for the wireless devices in the network"
}
}
},
"example": {
"network": {
"id": "N_24329156"
},
"enabled": true,
"iotController": {
"name": "My AP",
"mac": "e4:55:a8:38:f2:06",
"serial": "Q234-ABCD-5678",
"status": "online"
},
"lockManagement": {
"address": "10.100.100.200",
"username": "user",
"status": "offline"
},
"defaults": {
"transmitPowerLevel": 10,
"channel": "25"
}
}
}
}
}
},
"summary": "Update Zigbee Configs for specified network",
"tags": [
"wireless",
"configure",
"zigbee"
]
}
},
"/organizations/{organizationId}/wireless/airMarshal/rules": {
"get": {
"description": "Returns the current Air Marshal rules for this organization",
"operationId": "getOrganizationWirelessAirMarshalRules",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "(optional) The set of network IDs to include.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network name"
}
},
"description": "Network details"
},
"ruleId": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"type": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Updated at timestamp"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Created at timestamp"
},
"match": {
"type": "object",
"properties": {
"string": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
},
"type": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
}
},
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs by default. (blocked by default)"
}
}
},
"description": "List of rules"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Count of rules"
}
},
"description": "Items"
}
},
"description": "Counts"
}
},
"description": "Meta details about the result"
}
}
},
"example": {
"items": [
{
"network": {
"id": "N_12345",
"name": "Network 1"
},
"ruleId": "5239",
"type": "allow",
"updatedAt": "2023-05-23 12:02:46.298",
"createdAt": "2023-05-23 12:02:46.298",
"match": {
"string": "ipsum",
"type": "contains"
}
}
],
"meta": {
"counts": {
"items": {
"total": 1
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Returns the current Air Marshal rules for this organization",
"tags": [
"wireless",
"configure",
"airMarshal",
"rules"
]
}
},
"/organizations/{organizationId}/wireless/airMarshal/settings/byNetwork": {
"get": {
"description": "Returns the current Air Marshal settings for this network",
"operationId": "getOrganizationWirelessAirMarshalSettingsByNetwork",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "The network IDs to include in the result set.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network ID"
},
"defaultPolicy": {
"type": "string",
"description": "Indicates whether or not clients are allowed to connect to rogue SSIDs. (blocked by default)"
}
}
},
"description": "List of settings"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of items"
},
"remaining": {
"type": "integer",
"description": "Remaining number of items"
}
},
"description": "Items"
}
},
"description": "Counts"
}
},
"description": "Metadata"
}
}
},
"example": {
"items": [
{
"networkId": "N_12345",
"defaultPolicy": "allow"
}
],
"meta": {
"counts": {
"items": {
"total": 1,
"remaining": 0
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "Returns the current Air Marshal settings for this network",
"tags": [
"wireless",
"configure",
"airMarshal",
"settings",
"byNetwork"
]
}
},
"/organizations/{organizationId}/wireless/clients/overview/byDevice": {
"get": {
"description": "List access point client count at the moment in an organization",
"operationId": "getOrganizationWirelessClientsOverviewByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter access points client counts by network ID. This filter uses multiple exact matches.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Optional parameter to filter access points client counts by its serial numbers. This filter uses multiple exact matches.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "campusGatewayClusterIds",
"in": "query",
"description": "Optional parameter to filter access points client counts by MCG cluster IDs. This filter uses multiple exact matches.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Access point network ID"
}
},
"description": "Access point network"
},
"serial": {
"type": "string",
"description": "Access point Serial number"
},
"counts": {
"type": "object",
"properties": {
"byStatus": {
"type": "object",
"properties": {
"online": {
"type": "integer",
"description": "Active client count"
}
},
"description": "Associated client count on access point by status"
}
},
"description": "Associated client count on access point"
}
}
},
"description": "Access point client count"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
}
},
"example": {
"items": [
{
"network": {
"id": "N_24329156"
},
"serial": "Q234-ABCD-5678",
"counts": {
"byStatus": {
"online": 1
}
}
}
],
"meta": {
"counts": {
"items": {
"total": 10,
"remaining": 0
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "List access point client count at the moment in an organization",
"tags": [
"wireless",
"monitor",
"clients",
"overview",
"byDevice"
]
}
},
"/organizations/{organizationId}/wireless/devices/channelUtilization/byDevice": {
"get": {
"description": "Get average channel utilization for all bands in a network, split by AP",
"operationId": "getOrganizationWirelessDevicesChannelUtilizationByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 90 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 less than or equal to 90 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 7776000
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The serial number for the device."
},
"mac": {
"type": "string",
"description": "The MAC address of the device."
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID of the given utilization metrics."
}
},
"description": "Network for the given utilization metrics."
},
"byBand": {
"type": "array",
"items": {
"type": "object",
"properties": {
"band": {
"type": "string",
"description": "The band for the given metrics."
},
"wifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of wifi channel utiliation for the given band."
}
},
"description": "An object containing wifi utilization."
},
"nonWifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of non-wifi channel utiliation for the given band."
}
},
"description": "An object containing non-wifi utilization."
},
"total": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of total channel utiliation for the given band."
}
},
"description": "An object containing total channel utilization."
}
}
},
"description": "Channel utilization broken down by band."
}
}
}
},
"example": [
{
"serial": "Q234-ABCD-5678",
"mac": "00:11:22:33:44:55",
"network": {
"id": "N_24329156"
},
"byBand": [
{
"band": "5",
"wifi": {
"percentage": 33.12
},
"nonWifi": {
"percentage": 1.84
},
"total": {
"percentage": 34.96
}
}
]
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Get average channel utilization for all bands in a network, split by AP",
"tags": [
"wireless",
"monitor",
"devices",
"channelUtilization",
"byDevice"
]
}
},
"/organizations/{organizationId}/wireless/devices/channelUtilization/byNetwork": {
"get": {
"description": "Get average channel utilization across all bands for all networks in the organization",
"operationId": "getOrganizationWirelessDevicesChannelUtilizationByNetwork",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 90 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 less than or equal to 90 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 7776000
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID of the given utilization metrics."
}
},
"description": "Network for the given utilization metrics."
},
"byBand": {
"type": "array",
"items": {
"type": "object",
"properties": {
"band": {
"type": "string",
"description": "The band for the given metrics."
},
"wifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of wifi channel utiliation for the given band."
}
},
"description": "An object containing wifi utilization."
},
"nonWifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of non-wifi channel utiliation for the given band."
}
},
"description": "An object containing non-wifi utilization."
},
"total": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of total channel utiliation for the given band."
}
},
"description": "An object containing total channel utilization."
}
}
},
"description": "Channel utilization broken down by band."
}
}
}
},
"example": [
{
"network": {
"id": "N_24329156"
},
"byBand": [
{
"band": "5",
"wifi": {
"percentage": 33.12
},
"nonWifi": {
"percentage": 1.84
},
"total": {
"percentage": 34.96
}
}
]
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Get average channel utilization across all bands for all networks in the organization",
"tags": [
"wireless",
"monitor",
"devices",
"channelUtilization",
"byNetwork"
]
}
},
"/organizations/{organizationId}/wireless/devices/channelUtilization/history/byDevice/byInterval": {
"get": {
"description": "Get a time-series of average channel utilization for all bands, segmented by device.",
"operationId": "getOrganizationWirelessDevicesChannelUtilizationHistoryByDeviceByInterval",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the channel utilization interval."
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the channel utilization interval."
},
"serial": {
"type": "string",
"description": "The serial number for the device."
},
"mac": {
"type": "string",
"description": "The MAC address of the device."
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID of the given utilization metrics."
}
},
"description": "Network for the given utilization metrics."
},
"byBand": {
"type": "array",
"items": {
"type": "object",
"properties": {
"band": {
"type": "string",
"description": "The band for the given metrics."
},
"wifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of wifi channel utiliation for the given band."
}
},
"description": "An object containing wifi utilization."
},
"nonWifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of non-wifi channel utiliation for the given band."
}
},
"description": "An object containing non-wifi utilization."
},
"total": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of total channel utiliation for the given band."
}
},
"description": "An object containing total channel utilization."
}
}
},
"description": "Channel utilization broken down by band."
}
}
}
},
"example": [
{
"startTs": "2018-02-11T00:00:00Z",
"endTs": "2018-05-12T00:00:00Z",
"serial": "Q234-ABCD-5678",
"mac": "00:11:22:33:44:55",
"network": {
"id": "N_24329156"
},
"byBand": [
{
"band": "5",
"wifi": {
"percentage": 33.12
},
"nonWifi": {
"percentage": 1.84
},
"total": {
"percentage": 34.96
}
}
]
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Get a time-series of average channel utilization for all bands, segmented by device.",
"tags": [
"wireless",
"monitor",
"devices",
"channelUtilization",
"history",
"byDevice",
"byInterval"
]
}
},
"/organizations/{organizationId}/wireless/devices/channelUtilization/history/byNetwork/byInterval": {
"get": {
"description": "Get a time-series of average channel utilization for all bands",
"operationId": "getOrganizationWirelessDevicesChannelUtilizationHistoryByNetworkByInterval",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today.",
"schema": {
"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.",
"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 less than or equal to 31 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"maximum": 2678400
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval in seconds for returned data. The valid intervals are: 300, 600, 3600, 7200, 14400, 21600. The default is 3600.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time of the channel utilization interval."
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time of the channel utilization interval."
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID of the given utilization metrics."
}
},
"description": "Network for the given utilization metrics."
},
"byBand": {
"type": "array",
"items": {
"type": "object",
"properties": {
"band": {
"type": "string",
"description": "The band for the given metrics."
},
"wifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of wifi channel utiliation for the given band."
}
},
"description": "An object containing wifi utilization."
},
"nonWifi": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of non-wifi channel utiliation for the given band."
}
},
"description": "An object containing non-wifi utilization."
},
"total": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "float",
"description": "Percentage of total channel utiliation for the given band."
}
},
"description": "An object containing total channel utilization."
}
}
},
"description": "Channel utilization broken down by band."
}
}
}
},
"example": [
{
"startTs": "2018-02-11T00:00:00Z",
"endTs": "2018-05-12T00:00:00Z",
"network": {
"id": "N_24329156"
},
"byBand": [
{
"band": "5",
"wifi": {
"percentage": 33.12
},
"nonWifi": {
"percentage": 1.84
},
"total": {
"percentage": 34.96
}
}
]
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Get a time-series of average channel utilization for all bands",
"tags": [
"wireless",
"monitor",
"devices",
"channelUtilization",
"history",
"byNetwork",
"byInterval"
]
}
},
"/organizations/{organizationId}/wireless/devices/ethernet/statuses": {
"get": {
"description": "List the most recent Ethernet link speed, duplex, aggregation and power mode and status information for wireless devices.",
"operationId": "getOrganizationWirelessDevicesEthernetStatuses",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "The serial number of the AP"
},
"name": {
"type": "string",
"description": "The name of the AP"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network ID the AP is associated to"
}
},
"description": "Network details object"
},
"power": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "The PoE power mode for the AP. Can be 'full' or 'low'"
},
"ac": {
"type": "object",
"properties": {
"isConnected": {
"type": "boolean",
"description": "AC power connected"
}
},
"description": "AC power details object"
},
"poe": {
"type": "object",
"properties": {
"isConnected": {
"type": "boolean",
"description": "PoE power connected"
}
},
"description": "PoE power details object"
}
},
"description": "Power details object"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Label of the port"
},
"poe": {
"type": "object",
"properties": {
"standard": {
"type": "string",
"description": "The PoE Standard for the port. Can be '802.3at', '802.3af', '802.3bt', or null"
}
},
"description": "PoE details object for the port"
},
"linkNegotiation": {
"type": "object",
"properties": {
"duplex": {
"type": "string",
"description": "The duplex mode of the port. Can be 'full' or 'half' will return null on Catalyst devices"
},
"speed": {
"type": "integer",
"description": "Show the speed of the port. The port speed will return null on Catalyst devices"
}
},
"description": "Link negotiation details object for the port"
}
}
},
"description": "List of port details"
},
"aggregation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Link Aggregation enabled flag will return null on Catalyst devices"
},
"speed": {
"type": "integer",
"description": "Link Aggregation speed will return null on Catalyst devices"
}
},
"description": "Aggregation details object"
}
}
}
},
"example": [
{
"serial": "Q234-ABCD-5678",
"name": "My appliance",
"network": {
"id": "N_24329156"
},
"power": {
"mode": "full",
"ac": {
"isConnected": false
},
"poe": {
"isConnected": true
}
},
"ports": [
{
"name": "Ethernet 0",
"poe": {
"standard": "802.3at"
},
"linkNegotiation": {
"duplex": "full",
"speed": 5000
}
}
],
"aggregation": {
"enabled": true,
"speed": 10000
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "List the most recent Ethernet link speed, duplex, aggregation and power mode and status information for wireless devices.",
"tags": [
"wireless",
"monitor",
"devices",
"ethernet",
"statuses"
]
}
},
"/organizations/{organizationId}/wireless/devices/packetLoss/byClient": {
"get": {
"description": "Get average packet loss for the given timespan for all clients in the organization.",
"operationId": "getOrganizationWirelessDevicesPacketLossByClient",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ssids",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
{
"name": "bands",
"in": "query",
"description": "Filter results by band. Valid bands are: 2.4, 5, and 6.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "macs",
"in": "query",
"description": "Filter results by client mac address(es).",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 90 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 5 minutes and be less than or equal to 90 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"minimum": 300,
"maximum": 7776000
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"downstream": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total packets received by a client."
},
"lost": {
"type": "integer",
"description": "Total packets sent by an AP that did not reach the client."
},
"lossPercentage": {
"type": "number",
"format": "float",
"description": "Percentage of lost packets."
}
},
"description": "Packets sent from an AP to a client."
},
"upstream": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total packets sent by a client to an AP."
},
"lost": {
"type": "integer",
"description": "Total packets sent by a client and did not reach the AP."
},
"lossPercentage": {
"type": "number",
"format": "float",
"description": "Percentage of lost packets."
}
},
"description": "Packets sent from a client to an AP."
},
"client": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Client ID."
},
"mac": {
"type": "string",
"description": "MAC address."
}
},
"description": "Client."
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID."
},
"name": {
"type": "string",
"description": "Name of the network."
}
},
"description": "Network."
}
}
}
},
"example": [
{
"downstream": {
"total": 1000,
"lost": 10,
"lossPercentage": 1.0
},
"upstream": {
"total": 1200,
"lost": 15,
"lossPercentage": 1.3
},
"client": {
"id": "k74272e",
"mac": "22:33:44:55:66:77"
},
"network": {
"id": "N_24329156",
"name": "Main Office"
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "Get average packet loss for the given timespan for all clients in the organization.",
"tags": [
"wireless",
"monitor",
"devices",
"packetLoss",
"byClient"
]
}
},
"/organizations/{organizationId}/wireless/devices/packetLoss/byDevice": {
"get": {
"description": "Get average packet loss for the given timespan for all devices in the organization. Does not include device's own traffic.",
"operationId": "getOrganizationWirelessDevicesPacketLossByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ssids",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
{
"name": "bands",
"in": "query",
"description": "Filter results by band. Valid bands are: 2.4, 5, and 6.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 90 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 5 minutes and be less than or equal to 90 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"minimum": 300,
"maximum": 7776000
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"downstream": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total packets received by a client."
},
"lost": {
"type": "integer",
"description": "Total packets sent by an AP that did not reach the client."
},
"lossPercentage": {
"type": "number",
"format": "float",
"description": "Percentage of lost packets."
}
},
"description": "Packets sent from an AP to a client."
},
"upstream": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total packets sent by a client to an AP."
},
"lost": {
"type": "integer",
"description": "Total packets sent by a client and did not reach the AP."
},
"lossPercentage": {
"type": "number",
"format": "float",
"description": "Percentage of lost packets."
}
},
"description": "Packets sent from a client to an AP."
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID."
},
"name": {
"type": "string",
"description": "Name of the network."
}
},
"description": "Network."
},
"device": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"serial": {
"type": "string",
"description": "Serial Number"
},
"mac": {
"type": "string",
"description": "MAC address"
}
},
"description": "Device."
}
}
}
},
"example": [
{
"downstream": {
"total": 1000,
"lost": 10,
"lossPercentage": 1.0
},
"upstream": {
"total": 1200,
"lost": 15,
"lossPercentage": 1.3
},
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"device": {
"name": "My AP",
"serial": "Q234-ABCD-5678",
"mac": "00:11:22:33:44:55"
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Get average packet loss for the given timespan for all devices in the organization",
"tags": [
"wireless",
"monitor",
"devices",
"packetLoss",
"byDevice"
]
}
},
"/organizations/{organizationId}/wireless/devices/packetLoss/byNetwork": {
"get": {
"description": "Get average packet loss for the given timespan for all networks in the organization.",
"operationId": "getOrganizationWirelessDevicesPacketLossByNetwork",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Filter results by device.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ssids",
"in": "query",
"description": "Filter results by SSID number.",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
{
"name": "bands",
"in": "query",
"description": "Filter results by band. Valid bands are: 2.4, 5, and 6.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 90 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 90 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 5 minutes and be less than or equal to 90 days. The default is 7 days.",
"schema": {
"type": "number",
"format": "float",
"minimum": 300,
"maximum": 7776000
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"downstream": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total packets received by a client."
},
"lost": {
"type": "integer",
"description": "Total packets sent by an AP that did not reach the client."
},
"lossPercentage": {
"type": "number",
"format": "float",
"description": "Percentage of lost packets."
}
},
"description": "Packets sent from an AP to a client."
},
"upstream": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total packets sent by a client to an AP."
},
"lost": {
"type": "integer",
"description": "Total packets sent by a client and did not reach the AP."
},
"lossPercentage": {
"type": "number",
"format": "float",
"description": "Percentage of lost packets."
}
},
"description": "Packets sent from a client to an AP."
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID."
},
"name": {
"type": "string",
"description": "Name of the network."
}
},
"description": "Network."
}
}
}
},
"example": [
{
"downstream": {
"total": 1000,
"lost": 10,
"lossPercentage": 1.0
},
"upstream": {
"total": 1200,
"lost": 15,
"lossPercentage": 1.3
},
"network": {
"id": "N_24329156",
"name": "Main Office"
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Get average packet loss for the given timespan for all networks in the organization.",
"tags": [
"wireless",
"monitor",
"devices",
"packetLoss",
"byNetwork"
]
}
},
"/organizations/{organizationId}/wireless/devices/power/mode/history": {
"get": {
"description": "Return a record of power mode changes for wireless devices in the organization. For each device, it provides a series of events with timestamps indicating when a power mode change occurred and the new mode. The events are ordered by timestamp.",
"operationId": "getOrganizationWirelessDevicesPowerModeHistory",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 1 day from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 1 day 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 less than or equal to 1 day. The default is 1 day.",
"schema": {
"type": "number",
"format": "float",
"maximum": 86400
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 20. Default is 10.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter the result set by the included set of network IDs",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Optional parameter to filter device availabilities history by device serial numbers",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Unique serial number for the device"
},
"model": {
"type": "string",
"description": "Model of the device"
},
"name": {
"type": "string",
"description": "Name of the device"
},
"mac": {
"type": "string",
"description": "MAC address of the device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of custom tags for the device"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network ID"
},
"name": {
"type": "string",
"description": "The name of the network"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of custom tags for the network"
}
},
"description": "Information regarding the network the device belongs to"
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ts": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the event"
},
"powerMode": {
"type": "string",
"description": "The power mode of the device"
}
}
},
"description": "Events indicating power mode changes for the device"
}
}
},
"description": "The top-level property containing all power mode data."
}
}
},
"example": {
"items": [
{
"serial": "Q234-ABCD-0001",
"model": "MR",
"name": "My AP",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"network": {
"id": "N_24329156",
"name": "Main Office",
"tags": [
"tag1",
"tag2"
]
},
"events": [
{
"ts": "2018-02-11T00:00:00.090210Z",
"powerMode": "full power"
}
]
}
]
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "Return a record of power mode changes for wireless devices in the organization",
"tags": [
"wireless",
"monitor",
"devices",
"power",
"mode",
"history"
]
}
},
"/organizations/{organizationId}/wireless/devices/provisioning/deployments": {
"get": {
"description": "List the zero touch deployments for wireless access points in an organization",
"operationId": "getOrganizationWirelessDevicesProvisioningDeployments",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 20.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "Filter by MAC address, serial number, new device name, old device name, or model.",
"schema": {
"type": "string"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field used to sort results. Default is 'status'.",
"schema": {
"type": "string",
"enum": [
"afterAction",
"createdAt",
"deploymentId",
"name",
"status"
]
}
},
{
"name": "sortOrder",
"in": "query",
"description": "Sort order. Default is 'asc'.",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "deploymentType",
"in": "query",
"description": "Filter deployments by type.",
"schema": {
"type": "string",
"enum": [
"deploy",
"replace"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "zero touch deployment request identifier"
},
"devices": {
"type": "object",
"properties": {
"old": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the old device"
},
"afterAction": {
"type": "string",
"description": "Action to be taken on the old device"
},
"name": {
"type": "string",
"description": "Name of the old device"
},
"model": {
"type": "string",
"description": "Model of the old device"
},
"mac": {
"type": "string",
"description": "MAC address of the old device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the old device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the old device"
}
},
"description": "Old device"
},
"new": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the new device"
},
"name": {
"type": "string",
"description": "Name of the new device"
},
"model": {
"type": "string",
"description": "Model of the new device"
},
"mac": {
"type": "string",
"description": "MAC address of the new device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the new device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the new device"
}
},
"required": [
"serial",
"name",
"model",
"mac"
],
"description": "New device"
}
},
"required": [
"new"
],
"description": "An array composed of old and new devices"
},
"status": {
"type": "string",
"description": "Status of the zero touch deployment request. enum = [ready, in progress, completed, failed]"
},
"type": {
"type": "string",
"description": "Type of the zero touch deployment request. enum = [deploy, replace]"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the network the device is being added to"
},
"name": {
"type": "string",
"description": "Name of the network the device is being added to"
}
},
"description": "Network information"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"requestedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was last updated"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was completed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of error message(s) if any"
}
},
"required": [
"deploymentId",
"devices",
"status",
"type"
]
},
"description": "List of zero touch deployments"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
},
"required": [
"items"
]
}
},
"example": [
{
"items": [
{
"deploymentId": "1284392014819",
"devices": {
"old": {
"serial": "Q234-ABCD-5678",
"afterAction": "unclaim",
"name": "My AP",
"model": "MR34",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
},
"new": {
"serial": "Q234-ABCD-5678",
"name": "My AP",
"model": "CW9166I",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
}
},
"status": "ready",
"type": "replace",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"createdAt": "2018-02-11T00:00:00.090210Z",
"requestedAt": "2018-02-11T00:00:00.090210Z",
"lastUpdatedAt": "2018-02-11T00:00:00.090210Z",
"completedAt": "2018-02-11T00:00:00.090210Z",
"errors": [
"error message1",
"error message2"
]
}
],
"meta": {
"counts": {
"items": {
"total": 20,
"remaining": 0
}
}
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "List the zero touch deployments for wireless access points in an organization",
"tags": [
"wireless",
"configure",
"devices",
"provisioning",
"deployments"
]
},
"post": {
"description": "Create a zero touch deployment for a wireless access point",
"operationId": "createOrganizationWirelessDevicesProvisioningDeployment",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "zero touch deployment request identifier"
},
"devices": {
"type": "object",
"properties": {
"old": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the old device"
},
"afterAction": {
"type": "string",
"description": "Action to be taken on the old device"
},
"name": {
"type": "string",
"description": "Name of the old device"
},
"model": {
"type": "string",
"description": "Model of the old device"
},
"mac": {
"type": "string",
"description": "MAC address of the old device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the old device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the old device"
}
},
"description": "Old device"
},
"new": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the new device"
},
"name": {
"type": "string",
"description": "Name of the new device or serial number if not named"
},
"model": {
"type": "string",
"description": "Model of the new device"
},
"mac": {
"type": "string",
"description": "MAC address of the new device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the new device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of RfProfile for new device"
},
"name": {
"type": "string",
"description": "Name of RfProfile for new device"
}
},
"description": "RF profile of the new device"
}
},
"description": "New device"
}
},
"required": [
"new"
],
"description": "An array composed of old and new devices"
},
"status": {
"type": "string",
"description": "Status of the zero touch deployment request. enum = [ready, in progress, completed, failed]"
},
"type": {
"type": "string",
"description": "Type of the zero touch deployment request. enum = [deploy, replace]"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the network the device is being added to"
},
"name": {
"type": "string",
"description": "Name of the network the device is being added to"
}
},
"description": "Network information"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"requestedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was last updated"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was completed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of error message(s) if any"
}
},
"required": [
"devices",
"status",
"type"
]
},
"description": "List of zero touch deployments to create"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
},
"example": {
"items": [
{
"deploymentId": "1284392014819",
"devices": {
"old": {
"serial": "Q234-ABCD-5678",
"afterAction": "unclaim",
"name": "My AP",
"model": "MR34",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
},
"new": {
"serial": "Q234-ABCD-5678",
"name": "My AP",
"model": "CW9166I",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
}
},
"status": "ready",
"type": "replace",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"createdAt": "2018-02-11T00:00:00.090210Z",
"requestedAt": "2018-02-11T00:00:00.090210Z",
"lastUpdatedAt": "2018-02-11T00:00:00.090210Z",
"completedAt": "2018-02-11T00:00:00.090210Z",
"errors": [
"error message1",
"error message2"
]
}
],
"meta": {
"counts": {
"items": {
"total": 20,
"remaining": 0
}
}
}
},
"required": [
"items"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "zero touch deployment request identifier"
},
"devices": {
"type": "object",
"properties": {
"old": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the old device"
},
"afterAction": {
"type": "string",
"description": "Action to be taken on the old device"
},
"name": {
"type": "string",
"description": "Name of the old device"
},
"model": {
"type": "string",
"description": "Model of the old device"
},
"mac": {
"type": "string",
"description": "MAC address of the old device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the old device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the old device"
}
},
"description": "Old device"
},
"new": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the new device"
},
"name": {
"type": "string",
"description": "Name of the new device"
},
"model": {
"type": "string",
"description": "Model of the new device"
},
"mac": {
"type": "string",
"description": "MAC address of the new device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the new device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the new device"
}
},
"required": [
"serial",
"name",
"model",
"mac"
],
"description": "New device"
}
},
"required": [
"new"
],
"description": "An array composed of old and new devices"
},
"status": {
"type": "string",
"description": "Status of the zero touch deployment request. enum = [ready, in progress, completed, failed]"
},
"type": {
"type": "string",
"description": "Type of the zero touch deployment request. enum = [deploy, replace]"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the network the device is being added to"
},
"name": {
"type": "string",
"description": "Name of the network the device is being added to"
}
},
"description": "Network information"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"requestedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was last updated"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was completed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of error message(s) if any"
}
},
"required": [
"deploymentId",
"devices",
"status",
"type"
]
},
"description": "List of zero touch deployments"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
},
"required": [
"items"
]
},
"example": {
"items": [
{
"deploymentId": "1284392014819",
"devices": {
"old": {
"serial": "Q234-ABCD-5678",
"afterAction": "unclaim",
"name": "My AP",
"model": "MR34",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
},
"new": {
"serial": "Q234-ABCD-5678",
"name": "My AP",
"model": "CW9166I",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
}
},
"status": "ready",
"type": "replace",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"createdAt": "2018-02-11T00:00:00.090210Z",
"requestedAt": "2018-02-11T00:00:00.090210Z",
"lastUpdatedAt": "2018-02-11T00:00:00.090210Z",
"completedAt": "2018-02-11T00:00:00.090210Z",
"errors": [
"error message1",
"error message2"
]
}
],
"meta": {
"counts": {
"items": {
"total": 20,
"remaining": 0
}
}
}
}
}
}
}
},
"summary": "Create a zero touch deployment for a wireless access point",
"tags": [
"wireless",
"configure",
"devices",
"provisioning",
"deployments"
]
},
"put": {
"description": "Update a zero touch deployment",
"operationId": "updateOrganizationWirelessDevicesProvisioningDeployments",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "zero touch deployment request identifier"
},
"devices": {
"type": "object",
"properties": {
"old": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the old device"
},
"afterAction": {
"type": "string",
"description": "Action to be taken on the old device"
},
"name": {
"type": "string",
"description": "Name of the old device"
},
"model": {
"type": "string",
"description": "Model of the old device"
},
"mac": {
"type": "string",
"description": "MAC address of the old device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the old device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the old device"
}
},
"description": "Old device"
},
"new": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the new device"
},
"name": {
"type": "string",
"description": "Name of the new device or serial number if not named"
},
"model": {
"type": "string",
"description": "Model of the new device"
},
"mac": {
"type": "string",
"description": "MAC address of the new device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the new device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of RfProfile for new device"
},
"name": {
"type": "string",
"description": "Name of RfProfile for new device"
}
},
"description": "RF profile of the new device"
}
},
"description": "New device"
}
},
"required": [
"new"
],
"description": "An array composed of old and new devices"
},
"status": {
"type": "string",
"description": "Status of the zero touch deployment request. enum = [ready, in progress, completed, failed]"
},
"type": {
"type": "string",
"description": "Type of the zero touch deployment request. enum = [deploy, replace]"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the network the device is being added to"
},
"name": {
"type": "string",
"description": "Name of the network the device is being added to"
}
},
"description": "Network information"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"requestedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was last updated"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was completed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of error message(s) if any"
}
},
"required": [
"devices",
"status",
"type"
]
},
"description": "List of zero touch deployments to create"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
},
"example": {
"items": [
{
"deploymentId": "1284392014819",
"devices": {
"old": {
"serial": "Q234-ABCD-5678",
"afterAction": "unclaim",
"name": "My AP",
"model": "MR34",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
},
"new": {
"serial": "Q234-ABCD-5678",
"name": "My AP",
"model": "CW9166I",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
}
},
"status": "ready",
"type": "replace",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"createdAt": "2018-02-11T00:00:00.090210Z",
"requestedAt": "2018-02-11T00:00:00.090210Z",
"lastUpdatedAt": "2018-02-11T00:00:00.090210Z",
"completedAt": "2018-02-11T00:00:00.090210Z",
"errors": [
"error message1",
"error message2"
]
}
],
"meta": {
"counts": {
"items": {
"total": 20,
"remaining": 0
}
}
}
},
"required": [
"items"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "zero touch deployment request identifier"
},
"devices": {
"type": "object",
"properties": {
"old": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the old device"
},
"afterAction": {
"type": "string",
"description": "Action to be taken on the old device"
},
"name": {
"type": "string",
"description": "Name of the old device"
},
"model": {
"type": "string",
"description": "Model of the old device"
},
"mac": {
"type": "string",
"description": "MAC address of the old device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the old device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the old device"
}
},
"description": "Old device"
},
"new": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial number of the new device"
},
"name": {
"type": "string",
"description": "Name of the new device"
},
"model": {
"type": "string",
"description": "Model of the new device"
},
"mac": {
"type": "string",
"description": "MAC address of the new device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag(s) of the new device"
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the RF profile"
},
"name": {
"type": "string",
"description": "Name of the RF profile"
}
},
"description": "RF profile of the new device"
}
},
"required": [
"serial",
"name",
"model",
"mac"
],
"description": "New device"
}
},
"required": [
"new"
],
"description": "An array composed of old and new devices"
},
"status": {
"type": "string",
"description": "Status of the zero touch deployment request. enum = [ready, in progress, completed, failed]"
},
"type": {
"type": "string",
"description": "Type of the zero touch deployment request. enum = [deploy, replace]"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the network the device is being added to"
},
"name": {
"type": "string",
"description": "Name of the network the device is being added to"
}
},
"description": "Network information"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"requestedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was created"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was last updated"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the zero touch deployment request was completed"
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of error message(s) if any"
}
},
"required": [
"deploymentId",
"devices",
"status",
"type"
]
},
"description": "List of zero touch deployments"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
},
"required": [
"items"
]
},
"example": {
"items": [
{
"deploymentId": "1284392014819",
"devices": {
"old": {
"serial": "Q234-ABCD-5678",
"afterAction": "unclaim",
"name": "My AP",
"model": "MR34",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
},
"new": {
"serial": "Q234-ABCD-5678",
"name": "My AP",
"model": "CW9166I",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"rfProfile": {
"id": "1284392014819",
"name": "RF Profile Name"
}
}
},
"status": "ready",
"type": "replace",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"createdAt": "2018-02-11T00:00:00.090210Z",
"requestedAt": "2018-02-11T00:00:00.090210Z",
"lastUpdatedAt": "2018-02-11T00:00:00.090210Z",
"completedAt": "2018-02-11T00:00:00.090210Z",
"errors": [
"error message1",
"error message2"
]
}
],
"meta": {
"counts": {
"items": {
"total": 20,
"remaining": 0
}
}
}
}
}
}
}
},
"summary": "Update a zero touch deployment",
"tags": [
"wireless",
"configure",
"devices",
"provisioning",
"deployments"
]
}
},
"/organizations/{organizationId}/wireless/devices/provisioning/deployments/{deploymentId}": {
"delete": {
"description": "Delete a zero touch deployment",
"operationId": "deleteOrganizationWirelessDevicesProvisioningDeployment",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "deploymentId",
"in": "path",
"description": "Deployment ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"summary": "Delete a zero touch deployment",
"tags": [
"wireless",
"configure",
"devices",
"provisioning",
"deployments"
]
}
},
"/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities": {
"get": {
"description": "Query for details on the organization's RadSec device Certificate Authority certificates (CAs). The primary CA signs all the certificates that devices present when establishing a secure connection to RADIUS servers via RadSec protocol. This API returns an array of the status of all of the CAs as well as their contents, if they've been generated. An organization will have at most one CA unless the CA is being rotated.",
"operationId": "getOrganizationWirelessDevicesRadsecCertificatesAuthorities",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "certificateAuthorityIds",
"in": "query",
"description": "Optional parameter to filter CAs by one or more CA IDs. All returned CAs will have an ID that is an exact match.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"certificateAuthorityId": {
"type": "string",
"description": "The ID of the Certificate Authority"
},
"status": {
"type": "string",
"description": "The status of the Certificate Authority"
},
"contents": {
"type": "string",
"description": "The PEM encoded contents of the Certificate Authority - with newlines as \"\n\".\n Contents can be null, if the cert has not yet been generated."
}
}
},
"description": "List of Certificate Authorities"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of Certificate Authorities"
},
"remaining": {
"type": "integer",
"description": "Number of remaining Certificate Authorities"
}
},
"description": "Counts of the Certificate Authorities"
}
},
"description": "Counts of the Certificate Authorities"
}
},
"description": "Metadata about the Certificate Authorities"
}
}
}
},
"example": [
{
"items": [
{
"certificateAuthorityId": "1234",
"status": "trusted",
"contents": "-----BEGIN CERTIFICATE-----\nMIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n...\numkqeYeO30g1uYvDuWLXVA==\n-----END CERTIFICATE-----\n"
}
],
"meta": {
"counts": {
"items": {
"total": 2,
"remaining": 0
}
}
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"dashboard:iam:config:read"
]
}
],
"summary": "Query for details on the organization's RadSec device Certificate Authority certificates (CAs)",
"tags": [
"wireless",
"configure",
"devices",
"radsec",
"certificates",
"authorities"
]
},
"put": {
"description": "Update an organization's RadSec device Certificate Authority (CA) state. Note this CA is generated and controlled by Meraki. Call this endpoint to update the state to \"trusted\", at which point Meraki will generate device certificates. \"trusted\" means the CA is placed on your RadSec server(s) and devices establishing a secure connection using certs signed by this CA will pass verification.",
"operationId": "updateOrganizationWirelessDevicesRadsecCertificatesAuthorities",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The \"status\" to update the Certificate Authority to. Only valid option is \"trusted\"."
},
"certificateAuthorityId": {
"type": "string",
"description": "The ID of the Certificate Authority to update."
}
},
"example": {
"status": "trusted",
"certificateAuthorityId": "1234"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificateAuthorityId": {
"type": "string",
"description": "The ID of the Certificate Authority"
},
"status": {
"type": "string",
"description": "The status of the Certificate Authority"
},
"contents": {
"type": "string",
"description": "The PEM encoded contents of the Certificate Authority - with newlines as \"\n\". Contents can be null, if the cert has not yet been generated."
}
}
},
"example": {
"certificateAuthorityId": "1234",
"status": "trusted",
"contents": "-----BEGIN CERTIFICATE-----\nMIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n...\numkqeYeO30g1uYvDuWLXVA==\n-----END CERTIFICATE-----\n"
}
}
}
}
},
"security": [
{
"oauth2": [
"dashboard:iam:config:write"
]
}
],
"summary": "Update an organization's RadSec device Certificate Authority (CA) state",
"tags": [
"wireless",
"configure",
"devices",
"radsec",
"certificates",
"authorities"
]
},
"post": {
"description": "Create an organization's RadSec device Certificate Authority (CA). Call this endpoint when turning on RadSec in the firmware for the first time. Calling this endpoint starts an asynchronous process to generate the CA; call GET afterwards to retrieve the contents of the CA. Note this CA is generated and controlled by Meraki. Subsequent calls will not generate a new CA.",
"operationId": "createOrganizationWirelessDevicesRadsecCertificatesAuthority",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"202": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificateAuthorityId": {
"type": "string",
"description": "The ID of the Certificate Authority"
},
"status": {
"type": "string",
"description": "The status of the Certificate Authority"
},
"contents": {
"type": "string",
"description": "The PEM encoded contents of the Certificate Authority - with newlines as \"\n\". Contents can be null, if the cert has not yet been generated."
}
}
},
"example": {
"certificateAuthorityId": "1234",
"status": "trusted",
"contents": "-----BEGIN CERTIFICATE-----\nMIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n...\numkqeYeO30g1uYvDuWLXVA==\n-----END CERTIFICATE-----\n"
}
}
}
}
},
"security": [
{
"oauth2": [
"dashboard:iam:config:write"
]
}
],
"summary": "Create an organization's RadSec device Certificate Authority (CA)",
"tags": [
"wireless",
"configure",
"devices",
"radsec",
"certificates",
"authorities"
]
}
},
"/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls": {
"get": {
"description": "Query for certificate revocation list (CRL) for the organization's RadSec device Certificate Authorities (CAs).",
"operationId": "getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrls",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "certificateAuthorityIds",
"in": "query",
"description": "Optional parameter to filter CAs by one or more CA IDs. All returned CAs will have an ID that is an exact match.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"certificateAuthorityId": {
"type": "string",
"description": "The ID of the Certificate Authority"
},
"crl": {
"type": "string",
"description": "The PEM encoded CRL for the Certificate Authority"
}
}
},
"description": "List of CRLs for the specified CAs"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of CRLs"
},
"remaining": {
"type": "integer",
"description": "Number of remaining CRLs"
}
},
"description": "Counts of the CRLs"
}
},
"description": "Counts of the CRLs"
}
},
"description": "Metadata about the CRLs"
}
}
},
"example": {
"items": [
{
"certificateAuthorityId": "1234",
"crl": "-----BEGIN X509 CRL-----\nMIICVjCCAj8CAQEwQQD\n...\n-----END X509 CRL-----\n"
}
],
"meta": {
"counts": {
"items": {
"total": 2,
"remaining": 0
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"dashboard:iam:config:read"
]
}
],
"summary": "Query for certificate revocation list (CRL) for the organization's RadSec device Certificate Authorities (CAs).",
"tags": [
"wireless",
"configure",
"devices",
"radsec",
"certificates",
"authorities",
"crls"
]
}
},
"/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls/deltas": {
"get": {
"description": "Query for all delta certificate revocation list (CRL) for the organization's RadSec device Certificate Authority (CA) with the given id.",
"operationId": "getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrlsDeltas",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "certificateAuthorityIds",
"in": "query",
"description": "Parameter to filter CAs by one or more CA IDs. All returned CAs will have an ID that is an exact match.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"certificateAuthorityId": {
"type": "string",
"description": "The ID of the Certificate Authority"
},
"crl": {
"type": "string",
"description": "The PEM encoded CRL for the Certificate Authority"
}
}
},
"description": "List of CRLs for the specified CAs"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of CRLs"
},
"remaining": {
"type": "integer",
"description": "Number of remaining CRLs"
}
},
"description": "Counts of the CRLs"
}
},
"description": "Counts of the CRLs"
}
},
"description": "Metadata about the CRLs"
}
}
},
"example": {
"items": [
{
"certificateAuthorityId": "1234",
"crl": "-----BEGIN X509 CRL-----\nMIICVjCCAj8CAQEwQQD\n...\n-----END X509 CRL-----\n"
}
],
"meta": {
"counts": {
"items": {
"total": 2,
"remaining": 0
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"dashboard:iam:config:read"
]
}
],
"summary": "Query for all delta certificate revocation list (CRL) for the organization's RadSec device Certificate Authority (CA) with the given id.",
"tags": [
"wireless",
"configure",
"devices",
"radsec",
"certificates",
"authorities",
"crls",
"deltas"
]
}
},
"/organizations/{organizationId}/wireless/devices/system/cpu/load/history": {
"get": {
"description": "Return the CPU Load history for a list of wireless devices in the organization.",
"operationId": "getOrganizationWirelessDevicesSystemCpuLoadHistory",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 1 day from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 1 day 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 less than or equal to 1 day. The default is 1 day.",
"schema": {
"type": "number",
"format": "float",
"maximum": 86400
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 20. Default is 10.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter the result set by the included set of network IDs",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Optional parameter to filter device availabilities history by device serial numbers",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Unique serial number for the device"
},
"model": {
"type": "string",
"description": "Model of the device"
},
"name": {
"type": "string",
"description": "Name of the device"
},
"mac": {
"type": "string",
"description": "MAC address of the device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of custom tags for the device"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network ID"
},
"name": {
"type": "string",
"description": "The name of the network"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of custom tags for the network"
}
},
"description": "Information regarding the network the device belongs to"
},
"cpuCount": {
"type": "integer",
"description": "Number of CPU cores on the device"
},
"series": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ts": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the cpu load measurement"
},
"cpuLoad5": {
"type": "integer",
"description": "The 5 minutes cpu load average of the device"
}
}
},
"description": "Series of cpu load average measurements on the device"
}
}
},
"description": "The top-level property containing all cpu load data."
}
}
},
"example": {
"items": [
{
"serial": "Q234-ABCD-0001",
"model": "MR",
"name": "My AP",
"mac": "00:11:22:33:44:55",
"tags": [
"tag1",
"tag2"
],
"network": {
"id": "N_24329156",
"name": "Main Office",
"tags": [
"tag1",
"tag2"
]
},
"cpuCount": 4,
"series": [
{
"ts": "2018-02-11T00:00:00.090210Z",
"cpuLoad5": 1000
}
]
}
]
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return the CPU Load history for a list of wireless devices in the organization.",
"tags": [
"wireless",
"monitor",
"devices",
"system",
"cpu",
"load",
"history"
]
}
},
"/organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice": {
"get": {
"description": "List of Catalyst access points information",
"operationId": "getOrganizationWirelessDevicesWirelessControllersByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter access points by network ID. This filter uses multiple exact matches.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Optional parameter to filter access points by its cloud ID. This filter uses multiple exact matches.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "controllerSerials",
"in": "query",
"description": "Optional parameter to filter access points by its wireless LAN controller cloud ID. This filter uses multiple exact matches.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Catalyst access point network ID"
}
},
"description": "Catalyst access point network"
},
"serial": {
"type": "string",
"description": "AP cloud ID"
},
"controller": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Associated wireless controller cloud ID"
}
},
"description": "Associated wireless controller"
},
"joinedAt": {
"type": "string",
"description": "The time when AP joins wireless controller"
},
"model": {
"type": "string",
"description": "AP model"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"policy": {
"type": "string",
"description": "Policy tag"
},
"site": {
"type": "string",
"description": "Site tag"
},
"rf": {
"type": "string",
"description": "RF tag"
}
}
},
"description": "The tags of the catalyst access point"
},
"mode": {
"type": "string",
"description": "AP mode (local, flex, etc.)"
},
"countryCode": {
"type": "string",
"description": "Country code (2 characters)"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Item name"
},
"value": {
"type": "string",
"description": "Item value"
}
}
},
"description": "Catalyst access point details"
}
}
},
"description": "List of Catalyst access points information"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
}
},
"example": {
"items": [
{
"network": {
"id": "N_24329156"
},
"serial": "Q234-ABCD-5678",
"controller": {
"serial": "Q234-ABCD-5678"
},
"joinedAt": "2020-01-01T00:00:00Z",
"model": "C9115AXI-H",
"tags": [
{
"policy": "4F",
"site": "default-site-tag",
"rf": "default-rf-tag"
}
],
"mode": "local",
"countryCode": "CA",
"details": [
{
"name": "catalyst serial",
"value": "FGL2446L7QQ"
}
]
}
],
"meta": {
"counts": {
"items": {
"total": 10,
"remaining": 0
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List of Catalyst access points information",
"tags": [
"wireless",
"monitor",
"devices",
"wirelessControllers",
"byDevice"
]
}
},
"/organizations/{organizationId}/wireless/location/scanning/byNetwork": {
"get": {
"description": "Return scanning API settings",
"operationId": "getOrganizationWirelessLocationScanningByNetwork",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 250. Default is 50.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter scanning settings by network ID.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network Name"
},
"enabled": {
"type": "boolean",
"description": "Whether to enable collection of location and scanning analytics"
},
"api": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable push API for scanning events. Analytics must be enabled to enable scanning API."
},
"validator": {
"type": "object",
"properties": {
"string": {
"type": "string",
"description": "Validator for push API"
}
},
"description": "Validator for push API"
}
},
"description": "Whether to enable collection of location and scanning analytics."
}
}
},
"description": "Paginated list of scanning settings by network ID."
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
}
},
"example": {
"items": [
{
"networkId": "L_1234",
"name": "My Network",
"enabled": true,
"api": {
"enabled": true,
"validator": {
"string": "sample_validator"
}
}
}
],
"meta": {
"counts": {
"items": {
"total": 10,
"remaining": 0
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return scanning API settings",
"tags": [
"wireless",
"configure",
"location",
"scanning",
"byNetwork"
]
}
},
"/organizations/{organizationId}/wireless/location/scanning/receivers": {
"get": {
"description": "Return scanning API receivers",
"operationId": "getOrganizationWirelessLocationScanningReceivers",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 250. Default is 50.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter scanning API receivers by network ID.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network Name"
}
},
"description": "Add scanning API receiver for network"
},
"receiverId": {
"type": "string",
"description": "Receiver ID"
},
"url": {
"type": "string",
"description": "Receiver Url"
},
"version": {
"type": "string",
"description": "Scanning API Version"
},
"radio": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Bluetooth",
"Wi-Fi"
],
"description": "Radio Type. Valid types are: Wi-Fi, Bluetooth"
}
},
"description": "Add scanning API Radio"
}
}
},
"description": "Paginated list of scanning api receivers by network ID."
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
}
},
"example": {
"items": [
{
"network": {
"id": "L_1234",
"name": "My Network"
},
"receiverId": "1234567",
"url": "https://www.myreceiver.com",
"version": "3",
"radio": {
"type": "Wi-Fi"
}
}
],
"meta": {
"counts": {
"items": {
"total": 10,
"remaining": 0
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return scanning API receivers",
"tags": [
"wireless",
"configure",
"location",
"scanning",
"receivers"
]
},
"post": {
"description": "Add new receiver for scanning API",
"operationId": "createOrganizationWirelessLocationScanningReceiver",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
}
},
"description": "Add scanning API receiver for network"
},
"url": {
"type": "string",
"description": "Receiver Url"
},
"version": {
"type": "string",
"description": "Scanning API Version"
},
"radio": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Radio Type whether WiFi or Bluetooth"
}
},
"description": "Add scanning API Radio"
},
"sharedSecret": {
"type": "string",
"description": "Secret Value for Receiver"
}
},
"example": {
"network": {
"id": "L_1234"
},
"url": "https://www.myreceiver.com",
"version": "3",
"radio": {
"type": "Wi-Fi"
},
"sharedSecret": "mysecretvalue"
},
"required": [
"network",
"url",
"version",
"radio",
"sharedSecret"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network Name"
}
},
"description": "Add scanning API receiver for network"
},
"receiverId": {
"type": "string",
"description": "Receiver ID"
},
"url": {
"type": "string",
"description": "Receiver Url"
},
"version": {
"type": "string",
"description": "Scanning API Version"
},
"radio": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Bluetooth",
"Wi-Fi"
],
"description": "Radio Type. Valid types are: Wi-Fi, Bluetooth"
}
},
"description": "Add scanning API Radio"
}
}
},
"example": {
"network": {
"id": "L_1234",
"name": "My Network"
},
"receiverId": "1234567",
"url": "https://www.myreceiver.com",
"version": "3",
"radio": {
"type": "Wi-Fi"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:write"
]
}
],
"summary": "Add new receiver for scanning API",
"tags": [
"wireless",
"configure",
"location",
"scanning",
"receivers"
]
}
},
"/organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}": {
"put": {
"description": "Change scanning API receiver settings",
"operationId": "updateOrganizationWirelessLocationScanningReceiver",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "receiverId",
"in": "path",
"description": "Receiver ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Receiver Url"
},
"version": {
"type": "string",
"description": "Scanning API Version"
},
"radio": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Radio Type whether WiFi or Bluetooth"
}
},
"description": "Add scanning API Radio"
}
},
"example": {
"url": "https://www.myreceiver.com",
"version": "3",
"radio": {
"type": "Wi-Fi"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network Name"
}
},
"description": "Add scanning API receiver for network"
},
"receiverId": {
"type": "string",
"description": "Receiver ID"
},
"url": {
"type": "string",
"description": "Receiver Url"
},
"version": {
"type": "string",
"description": "Scanning API Version"
},
"radio": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Bluetooth",
"Wi-Fi"
],
"description": "Radio Type. Valid types are: Wi-Fi, Bluetooth"
}
},
"description": "Add scanning API Radio"
}
}
},
"example": {
"network": {
"id": "L_1234",
"name": "My Network"
},
"receiverId": "1234567",
"url": "https://www.myreceiver.com",
"version": "3",
"radio": {
"type": "Wi-Fi"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:write"
]
}
],
"summary": "Change scanning API receiver settings",
"tags": [
"wireless",
"configure",
"location",
"scanning",
"receivers"
]
},
"delete": {
"description": "Delete a scanning API receiver",
"operationId": "deleteOrganizationWirelessLocationScanningReceiver",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "receiverId",
"in": "path",
"description": "Receiver ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:write"
]
}
],
"summary": "Delete a scanning API receiver",
"tags": [
"wireless",
"configure",
"location",
"scanning",
"receivers"
]
}
},
"/organizations/{organizationId}/wireless/mqtt/settings": {
"get": {
"description": "Return MQTT Settings for networks",
"operationId": "getOrganizationWirelessMqttSettings",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 250. Default is 50.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter mqtt settings by network ID.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network Name"
}
},
"description": "Add MQTT Settings for network"
},
"mqtt": {
"type": "object",
"properties": {
"settingsId": {
"type": "string",
"description": "MQTT ID"
},
"enabled": {
"type": "boolean",
"description": "MQTT Enabled"
},
"topic": {
"type": "string",
"description": "MQTT Topic"
},
"messageFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Select fields to populate in MQTT messages. Valid types are: RSSI, AP MAC address, Client MAC address, Timestamp, Radio, Network ID, Beacon type, Raw payload, Client UUID, Client major value, Client minor value, Signal power, Band, Slot ID"
},
"publishing": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "MQTT Publishing Frequency in seconds. Will be between 1 and 2147483647. Default is 1 second"
},
"qos": {
"type": "integer",
"enum": [
0,
1,
2
],
"description": "MQTT Publishing QoS. Valid types are: 0, 1, 2"
}
},
"description": "MQTT Publishing Settings"
},
"broker": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Broker Config ID"
},
"name": {
"type": "string",
"description": "Broker Config Name"
}
},
"description": "MQTT Broker Settings for network"
}
},
"description": "MQTT Settings for network"
},
"ble": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "BLE Enabled"
},
"type": {
"type": "string",
"enum": [
"all",
"eddystone",
"ibeacon",
"unknown"
],
"description": "BLE type of clients to publish telemetry. Valid types are: all, ibeacon, eddystone, unknown"
},
"flush": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "BLE Flush frequency in seconds. Will be between 1 and 2147483647. Default is 60 seconds"
}
},
"description": "BLE Flush frequency"
},
"allowLists": {
"type": "object",
"properties": {
"uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed UUID List"
},
"macs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed MAC List"
}
},
"description": "Allowed List for MAC and UUID"
},
"hysteresis": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "BLE Hysteresis Enabled"
},
"threshold": {
"type": "integer",
"description": "BLE Threshold. Will be between 1 and 2147483647. Default is 1 second"
}
},
"description": "BLE Hysteresis Settings for network"
}
},
"description": "MQTT BLE Settings for network"
},
"wifi": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Wi-Fi Enabled"
},
"type": {
"type": "string",
"enum": [
"associated",
"visible"
],
"description": "Wi-Fi client type. Valid types are: visible, associated"
},
"flush": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "Wi-Fi Flush frequency in seconds. Will be between 1 and 2147483647. Default is 60 seconds"
}
},
"description": "BLE Flush frequency"
},
"allowLists": {
"type": "object",
"properties": {
"macs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed MAC List"
}
},
"description": "Allowed List for MAC and UUID"
},
"hysteresis": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Wi-Fi Hysteresis Enabled "
},
"threshold": {
"type": "integer",
"description": "Wi-Fi Threshold. Will be between 1 and 2147483647. Default is 1 second"
}
},
"description": "Wi-Fi Hysteresis Settings for network"
}
},
"description": "MQTT Wi-Fi Settings for network"
}
}
},
"description": "Paginated list of mqtt settings by network ID."
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
}
},
"example": {
"items": [
{
"network": {
"id": "L_1234",
"name": "My Network"
},
"mqtt": {
"settingsId": "1234567",
"enabled": true,
"topic": "Test Topic",
"messageFields": [
"RSSI",
"AP MAC address",
"Client MAC address",
"Timestamp",
"Radio",
"Network ID",
"Beacon type",
"Raw payload",
"Client UUID",
"Client major value",
"Client minor value",
"Signal power",
"Band",
"Slot ID"
],
"publishing": {
"frequency": 1,
"qos": 1
},
"broker": {
"id": "1234",
"name": "My Broker"
}
},
"ble": {
"enabled": false,
"type": "ibeacon",
"flush": {
"frequency": 60
},
"allowLists": {
"uuids": [],
"macs": []
},
"hysteresis": {
"enabled": true,
"threshold": 1
}
},
"wifi": {
"enabled": false,
"type": "associated",
"flush": {
"frequency": 60
},
"allowLists": {
"macs": []
},
"hysteresis": {
"enabled": false,
"threshold": 1
}
}
}
],
"meta": {
"counts": {
"items": {
"total": 10,
"remaining": 0
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "Return MQTT Settings for networks",
"tags": [
"wireless",
"configure",
"mqtt",
"settings"
]
},
"put": {
"description": "Add new broker config for wireless MQTT",
"operationId": "updateOrganizationWirelessMqttSettings",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
}
},
"description": "Add MQTT Settings for network"
},
"mqtt": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "MQTT Enabled"
},
"topic": {
"type": "string",
"description": "MQTT Topic"
},
"messageFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Select fields to populate in MQTT messages. Valid types are: RSSI, AP MAC address, Client MAC address, Timestamp, Radio, Network ID, Beacon type, Raw payload, Client UUID, Client major value, Client minor value, Signal power, Band, Slot ID"
},
"publishing": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "MQTT Publishing Frequency in seconds. Will be between 1 and 2147483647. Default is 1 second"
},
"qos": {
"type": "integer",
"enum": [
0,
1,
2
],
"description": "MQTT Publishing QoS. Valid types are: 0, 1, 2"
}
},
"description": "MQTT Publishing Settings"
},
"broker": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Broker Config Name"
}
},
"description": "MQTT Broker Settings for network"
}
},
"description": "MQTT Settings for network"
},
"ble": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "BLE Enabled"
},
"type": {
"type": "string",
"enum": [
"all",
"eddystone",
"ibeacon",
"unknown"
],
"description": "BLE type of clients to publish telemetry. Valid types are: all, ibeacon, eddystone, unknown"
},
"flush": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "BLE Flush frequency in seconds. Will be between 1 and 2147483647. Default is 60 seconds"
}
},
"description": "BLE Flush frequency"
},
"allowLists": {
"type": "object",
"properties": {
"uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed UUID List"
},
"macs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed MAC List"
}
},
"description": "Allowed List for MAC and UUID"
},
"hysteresis": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "BLE Hysteresis Enabled"
},
"threshold": {
"type": "integer",
"description": "BLE Threshold. Will be between 1 and 2147483647. Default is 1 second"
}
},
"description": "BLE Hysteresis Settings for network"
}
},
"description": "MQTT BLE Settings for network"
},
"wifi": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Wi-Fi Enabled"
},
"type": {
"type": "string",
"enum": [
"associated",
"visible"
],
"description": "Wi-Fi client type. Valid types are: visible, associated"
},
"flush": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "Wi-Fi Flush frequency in seconds. Will be between 1 and 2147483647. Default is 60 seconds"
}
},
"description": "BLE Flush frequency"
},
"allowLists": {
"type": "object",
"properties": {
"macs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed MAC List"
}
},
"description": "Allowed List for MAC and UUID"
},
"hysteresis": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Wi-Fi Hysteresis Enabled "
},
"threshold": {
"type": "integer",
"description": "Wi-Fi Threshold. Will be between 1 and 2147483647. Default is 1 second"
}
},
"description": "Wi-Fi Hysteresis Settings for network"
}
},
"description": "MQTT Wi-Fi Settings for network"
}
},
"example": {
"network": {
"id": "L_1234"
},
"mqtt": {
"enabled": true,
"topic": "Test Topic",
"messageFields": [
"RSSI",
"AP MAC address",
"Client MAC address",
"Timestamp",
"Radio",
"Network ID",
"Beacon type",
"Raw payload",
"Client UUID",
"Client major value",
"Client minor value",
"Signal power",
"Band",
"Slot ID"
],
"publishing": {
"frequency": 1,
"qos": 1
},
"broker": {
"name": "My Broker"
}
},
"ble": {
"enabled": false,
"type": "ibeacon",
"flush": {
"frequency": 60
},
"allowLists": {
"uuids": [],
"macs": []
},
"hysteresis": {
"enabled": true,
"threshold": 1
}
},
"wifi": {
"enabled": false,
"type": "associated",
"flush": {
"frequency": 60
},
"allowLists": {
"macs": []
},
"hysteresis": {
"enabled": false,
"threshold": 1
}
}
},
"required": [
"network",
"mqtt"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network Name"
}
},
"description": "Add MQTT Settings for network"
},
"mqtt": {
"type": "object",
"properties": {
"settingsId": {
"type": "string",
"description": "MQTT ID"
},
"enabled": {
"type": "boolean",
"description": "MQTT Enabled"
},
"topic": {
"type": "string",
"description": "MQTT Topic"
},
"messageFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Select fields to populate in MQTT messages. Valid types are: RSSI, AP MAC address, Client MAC address, Timestamp, Radio, Network ID, Beacon type, Raw payload, Client UUID, Client major value, Client minor value, Signal power, Band, Slot ID"
},
"publishing": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "MQTT Publishing Frequency in seconds. Will be between 1 and 2147483647. Default is 1 second"
},
"qos": {
"type": "integer",
"enum": [
0,
1,
2
],
"description": "MQTT Publishing QoS. Valid types are: 0, 1, 2"
}
},
"description": "MQTT Publishing Settings"
},
"broker": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Broker Config ID"
},
"name": {
"type": "string",
"description": "Broker Config Name"
}
},
"description": "MQTT Broker Settings for network"
}
},
"description": "MQTT Settings for network"
},
"ble": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "BLE Enabled"
},
"type": {
"type": "string",
"enum": [
"all",
"eddystone",
"ibeacon",
"unknown"
],
"description": "BLE type of clients to publish telemetry. Valid types are: all, ibeacon, eddystone, unknown"
},
"flush": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "BLE Flush frequency in seconds. Will be between 1 and 2147483647. Default is 60 seconds"
}
},
"description": "BLE Flush frequency"
},
"allowLists": {
"type": "object",
"properties": {
"uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed UUID List"
},
"macs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed MAC List"
}
},
"description": "Allowed List for MAC and UUID"
},
"hysteresis": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "BLE Hysteresis Enabled"
},
"threshold": {
"type": "integer",
"description": "BLE Threshold. Will be between 1 and 2147483647. Default is 1 second"
}
},
"description": "BLE Hysteresis Settings for network"
}
},
"description": "MQTT BLE Settings for network"
},
"wifi": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Wi-Fi Enabled"
},
"type": {
"type": "string",
"enum": [
"associated",
"visible"
],
"description": "Wi-Fi client type. Valid types are: visible, associated"
},
"flush": {
"type": "object",
"properties": {
"frequency": {
"type": "integer",
"description": "Wi-Fi Flush frequency in seconds. Will be between 1 and 2147483647. Default is 60 seconds"
}
},
"description": "BLE Flush frequency"
},
"allowLists": {
"type": "object",
"properties": {
"macs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed MAC List"
}
},
"description": "Allowed List for MAC and UUID"
},
"hysteresis": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Wi-Fi Hysteresis Enabled "
},
"threshold": {
"type": "integer",
"description": "Wi-Fi Threshold. Will be between 1 and 2147483647. Default is 1 second"
}
},
"description": "Wi-Fi Hysteresis Settings for network"
}
},
"description": "MQTT Wi-Fi Settings for network"
}
}
},
"example": {
"network": {
"id": "L_1234",
"name": "My Network"
},
"mqtt": {
"settingsId": "1234567",
"enabled": true,
"topic": "Test Topic",
"messageFields": [
"RSSI",
"AP MAC address",
"Client MAC address",
"Timestamp",
"Radio",
"Network ID",
"Beacon type",
"Raw payload",
"Client UUID",
"Client major value",
"Client minor value",
"Signal power",
"Band",
"Slot ID"
],
"publishing": {
"frequency": 1,
"qos": 1
},
"broker": {
"id": "1234",
"name": "My Broker"
}
},
"ble": {
"enabled": false,
"type": "ibeacon",
"flush": {
"frequency": 60
},
"allowLists": {
"uuids": [],
"macs": []
},
"hysteresis": {
"enabled": true,
"threshold": 1
}
},
"wifi": {
"enabled": false,
"type": "associated",
"flush": {
"frequency": 60
},
"allowLists": {
"macs": []
},
"hysteresis": {
"enabled": false,
"threshold": 1
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:write"
]
}
],
"summary": "Add new broker config for wireless MQTT",
"tags": [
"wireless",
"configure",
"mqtt",
"settings"
]
}
},
"/organizations/{organizationId}/wireless/radio/autoRf/channels/recalculate": {
"post": {
"description": "Recalculates automatically assigned channels for every AP within specified the specified network(s). Note: This could cause a brief loss in connectivity for wireless clients.",
"operationId": "recalculateOrganizationWirelessRadioAutoRfChannels",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"networkIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of network ids (limit: 15)."
}
},
"example": {
"networkIds": [
"N_678910",
"L_12345"
]
},
"required": [
"networkIds"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"estimatedCompletedAt": {
"type": "string",
"description": "Estimated time of completion."
}
}
},
"example": {
"estimatedCompletedAt": "2019-01-01T00:00:00Z"
}
}
}
}
},
"summary": "Recalculates automatically assigned channels for every AP within specified the specified network(s)",
"tags": [
"wireless",
"configure",
"radio",
"autoRf",
"channels"
]
}
},
"/organizations/{organizationId}/wireless/radio/rrm/byNetwork": {
"get": {
"description": "List the AutoRF settings of an organization by network",
"operationId": "getOrganizationWirelessRadioRrmByNetwork",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter results by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "startingAfter",
"in": "query",
"description": "Retrieving items after this network ID",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"description": "Retrieving items before this network ID",
"schema": {
"type": "string"
}
},
{
"name": "perPage",
"in": "query",
"description": "Number of items per page",
"schema": {
"type": "integer"
}
},
{
"name": "sortOrder",
"in": "query",
"description": "The sort order of items",
"schema": {
"type": "string",
"enum": [
"ascending",
"descending"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "Id of the network"
},
"name": {
"type": "string",
"description": "Name of the network"
},
"timeZone": {
"type": "string",
"description": "Time zone of the network"
},
"busyHour": {
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"automatic",
"manual"
],
"description": "The Busy Hour mode applied to the network when minimizeChanges is enabled. Must be one of 'automatic' or 'manual'. Automatic busy hour is only available on firmware versions >= MR 27.0"
},
"automatic": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "The hour that Automatic Busy Hour starts each day, in the network time zone"
},
"end": {
"type": "string",
"description": "The hour that Automatic Busy Hour ends each day, in the network time zone"
}
},
"description": "Automatic Busy Hour settings"
},
"manual": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "The hour that Manual Busy Hour starts each day, in the network time zone"
},
"end": {
"type": "string",
"description": "The hour that Manual Busy Hour ends each day, in the network time zone"
}
},
"description": "Manual Busy Hour settings"
}
},
"description": "Busy hour mode settings"
},
"minimizeChanges": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling Busy Hour in a network"
}
},
"description": "Minimize Changes settings"
}
},
"description": "Busy Hour settings"
},
"channel": {
"type": "object",
"properties": {
"avoidance": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling channel avoidance in a network"
}
},
"description": "Channel avoidance settings"
}
},
"description": "Channel settings"
},
"fra": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled."
}
},
"description": "FRA settings"
},
"ai": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Toggle for enabling or disabling AI in a network"
},
"lastEnabledAt": {
"type": "string",
"description": "Time at which AI was last enabled in the network"
}
},
"description": "AI settings"
}
}
},
"description": "List of RRM settings"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of items available"
},
"remaining": {
"type": "integer",
"description": "Number of items remaining after this page"
}
},
"description": "Item counts"
}
},
"description": "Counts for pagination"
}
},
"description": "Metadata about the response"
}
}
},
"example": {
"items": [
{
"networkId": "L_12345",
"name": "My Network",
"timeZone": "America/Los_Angeles",
"busyHour": {
"schedule": {
"mode": "automatic",
"automatic": {
"start": "08:00",
"end": "17:00"
},
"manual": {
"start": "10:00",
"end": "15:00"
}
},
"minimizeChanges": {
"enabled": true
}
},
"channel": {
"avoidance": {
"enabled": true
}
},
"fra": {
"enabled": false
},
"ai": {
"enabled": true,
"lastEnabledAt": "2026-06-01T08:07:01Z"
}
}
],
"meta": {
"counts": {
"items": {
"total": 42,
"remaining": 5
}
}
}
}
}
}
}
},
"summary": "List the AutoRF settings of an organization by network",
"tags": [
"wireless",
"configure",
"radio",
"rrm",
"byNetwork"
]
}
},
"/organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice": {
"get": {
"description": "List the RF profiles of an organization by device",
"operationId": "getOrganizationWirelessRfProfilesAssignmentsByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter devices by network.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "productTypes",
"in": "query",
"description": "Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway, and secureConnect.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"appliance",
"camera",
"campusGateway",
"cellularGateway",
"secureConnect",
"sensor",
"switch",
"systemsManager",
"wireless",
"wirelessController"
]
}
}
},
{
"name": "name",
"in": "query",
"description": "Optional parameter to filter RF profiles by device name. All returned devices will have a name that contains the search term or is an exact match.",
"schema": {
"type": "string"
}
},
{
"name": "mac",
"in": "query",
"description": "Optional parameter to filter RF profiles by device MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.",
"schema": {
"type": "string"
}
},
{
"name": "serial",
"in": "query",
"description": "Optional parameter to filter RF profiles by device serial number. All returned devices will have a serial number that contains the search term or is an exact match.",
"schema": {
"type": "string"
}
},
{
"name": "model",
"in": "query",
"description": "Optional parameter to filter RF profiles by device model. All returned devices will have a model that contains the search term or is an exact match.",
"schema": {
"type": "string"
}
},
{
"name": "macs",
"in": "query",
"description": "Optional parameter to filter RF profiles by one or more device MAC addresses. All returned devices will have a MAC address that is an exact match.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "Optional parameter to filter RF profiles by one or more device serial numbers. All returned devices will have a serial number that is an exact match.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "models",
"in": "query",
"description": "Optional parameter to filter RF profiles by one or more device models. All returned devices will have a model that is an exact match.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network ID."
}
},
"description": "Information regarding the network the device belongs to."
},
"name": {
"type": "string",
"description": "Name of the device."
},
"serial": {
"type": "string",
"description": "Unique serial number for device."
},
"model": {
"type": "string",
"description": "Model number of the device."
},
"rfProfile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the RF Profile the device belongs to."
},
"name": {
"type": "string",
"description": "The name of the RF Profile the device belongs to."
},
"isIndoorDefault": {
"type": "boolean",
"description": "Status to show if this profile is default indoor profile."
},
"isOutdoorDefault": {
"type": "boolean",
"description": "Status to show if this profile is default outdoor profile."
}
},
"description": "Information regarding the RF Profile of the device."
}
}
},
"description": "The top-level propery containing all status data."
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of serials."
},
"remaining": {
"type": "integer",
"description": "The number of serials remaining based on current pagination location within the dataset."
}
},
"description": "The count metadata."
}
},
"description": "Count metadata related to this result set."
}
},
"description": "Other metadata related to this result set."
}
}
}
},
"example": [
{
"items": [
{
"network": {
"id": "1234"
},
"name": "Device_name",
"serial": "Q234-ABCD-0001",
"model": "MR34",
"rfProfile": {
"id": "123456",
"name": "Basic Outdoor Profile",
"isIndoorDefault": false,
"isOutdoorDefault": true
}
}
],
"meta": {
"counts": {
"items": {
"total": 1200,
"remaining": 200
}
}
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "List the RF profiles of an organization by device",
"tags": [
"wireless",
"configure",
"rfProfiles",
"assignments",
"byDevice"
]
}
},
"/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries": {
"get": {
"description": "List the L2 isolation allow list MAC entry in an organization",
"operationId": "getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "networkIds array to filter out results",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ssids",
"in": "query",
"description": "ssids number array to filter out results",
"schema": {
"type": "array",
"items": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entryId": {
"type": "string",
"description": "The id of entry"
},
"createdAt": {
"type": "string",
"description": "Created at timestamp for the adaptive policy group"
},
"lastUpdatedAt": {
"type": "string",
"description": "Updated at timestamp for the adaptive policy group"
},
"description": {
"type": "string",
"description": "The description of mac address"
},
"client": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "L2 Isolation mac address"
}
},
"required": [
"mac"
],
"description": "The client of allowlist"
},
"ssid": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The index of SSID"
},
"name": {
"type": "string",
"description": "The name of SSID"
},
"number": {
"type": "integer",
"description": "The number of SSID"
}
},
"required": [
"id"
],
"description": "The SSID that allowlist belongs to"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The index of network"
},
"name": {
"type": "string",
"description": "The name of network"
}
},
"required": [
"id"
],
"description": "The network that allowlist SSID belongs to"
}
},
"required": [
"entryId"
]
},
"description": "L2 isolation allowlist items"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relevant to the paginated dataset"
}
}
},
"example": {
"items": [
{
"entryId": "1",
"createdAt": "2024-11-11T07:16:38Z",
"lastUpdatedAt": "2024-11-11T07:16:38Z",
"description": "Example mac address",
"client": {
"mac": "A1:B2:C3:D4:E5:F6"
},
"ssid": {
"id": "5",
"name": "Test SSID",
"number": 2
},
"network": {
"id": "N_123",
"name": "Test network"
}
}
],
"meta": {
"counts": {
"items": {
"total": 1,
"remaining": 0
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "List the L2 isolation allow list MAC entry in an organization",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"isolation",
"allowlist",
"entries"
]
},
"post": {
"description": "Create isolation allow list MAC entry for this organization",
"operationId": "createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description of mac address"
},
"client": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "L2 Isolation mac address"
}
},
"description": "The client of allowlist"
},
"ssid": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"description": "The number of SSID"
}
},
"description": "The SSID that allowlist belongs to"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of network"
}
},
"description": "The Network that allowlist belongs to"
}
},
"example": {
"description": "Example mac address",
"client": {
"mac": "A1:B2:C3:D4:E5:F6"
},
"ssid": {
"number": 2
},
"network": {
"id": "N_123"
}
},
"required": [
"client",
"ssid",
"network"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"entryId": {
"type": "string",
"description": "The id of entry"
},
"createdAt": {
"type": "string",
"description": "Created at timestamp for the adaptive policy group"
},
"lastUpdatedAt": {
"type": "string",
"description": "Updated at timestamp for the adaptive policy group"
},
"description": {
"type": "string",
"description": "The description of mac address"
},
"client": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "L2 Isolation mac address"
}
},
"required": [
"mac"
],
"description": "The client of allowlist"
},
"ssid": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The index of SSID"
},
"name": {
"type": "string",
"description": "The name of SSID"
},
"number": {
"type": "integer",
"description": "The number of SSID"
}
},
"required": [
"id"
],
"description": "The SSID that allowlist belongs to"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The index of network"
},
"name": {
"type": "string",
"description": "The name of network"
}
},
"required": [
"id"
],
"description": "The network that allowlist SSID belongs to"
}
},
"required": [
"entryId"
]
},
"example": {
"entryId": "1",
"createdAt": "2024-11-11T07:16:38Z",
"lastUpdatedAt": "2024-11-11T07:16:38Z",
"description": "Example mac address",
"client": {
"mac": "A1:B2:C3:D4:E5:F6"
},
"ssid": {
"id": "5",
"name": "Test SSID",
"number": 2
},
"network": {
"id": "N_123",
"name": "Test network"
}
}
}
}
}
},
"summary": "Create isolation allow list MAC entry for this organization",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"isolation",
"allowlist",
"entries"
]
}
},
"/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}": {
"delete": {
"description": "Destroy isolation allow list MAC entry for this organization",
"operationId": "deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "entryId",
"in": "path",
"description": "Entry ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"summary": "Destroy isolation allow list MAC entry for this organization",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"isolation",
"allowlist",
"entries"
]
},
"put": {
"description": "Update isolation allow list MAC entry info",
"operationId": "updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "entryId",
"in": "path",
"description": "Entry ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description of mac address"
},
"client": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "L2 Isolation mac address"
}
},
"description": "The client of allowlist"
}
},
"example": {
"description": "Example mac address",
"client": {
"mac": "A1:B2:C3:D4:E5:F6"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"entryId": {
"type": "string",
"description": "The id of entry"
},
"createdAt": {
"type": "string",
"description": "Created at timestamp for the adaptive policy group"
},
"lastUpdatedAt": {
"type": "string",
"description": "Updated at timestamp for the adaptive policy group"
},
"description": {
"type": "string",
"description": "The description of mac address"
},
"client": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "L2 Isolation mac address"
}
},
"required": [
"mac"
],
"description": "The client of allowlist"
},
"ssid": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The index of SSID"
},
"name": {
"type": "string",
"description": "The name of SSID"
},
"number": {
"type": "integer",
"description": "The number of SSID"
}
},
"required": [
"id"
],
"description": "The SSID that allowlist belongs to"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The index of network"
},
"name": {
"type": "string",
"description": "The name of network"
}
},
"required": [
"id"
],
"description": "The network that allowlist SSID belongs to"
}
},
"required": [
"entryId"
]
},
"example": {
"entryId": "1",
"createdAt": "2024-11-11T07:16:38Z",
"lastUpdatedAt": "2024-11-11T07:16:38Z",
"description": "Example mac address",
"client": {
"mac": "A1:B2:C3:D4:E5:F6"
},
"ssid": {
"id": "5",
"name": "Test SSID",
"number": 2
},
"network": {
"id": "N_123",
"name": "Test network"
}
}
}
}
}
},
"summary": "Update isolation allow list MAC entry info",
"tags": [
"wireless",
"configure",
"ssids",
"firewall",
"isolation",
"allowlist",
"entries"
]
}
},
"/organizations/{organizationId}/wireless/ssids/openRoaming/byNetwork": {
"get": {
"description": "Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network",
"operationId": "getOrganizationWirelessSsidsOpenRoamingByNetwork",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter OpenRoaming configuration by Network Id.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "includeDisabledSsids",
"in": "query",
"description": "Optional parameter to include OpenRoaming configuration for disabled ssids.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network id"
},
"networkName": {
"type": "string",
"description": "The network name"
},
"ssid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The SSID name"
},
"number": {
"type": "integer",
"description": "The SSID number"
},
"enabled": {
"type": "boolean",
"description": "Whether the SSID is enabled"
},
"openRoaming": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether OpenRoaming is enabled"
},
"tenantId": {
"type": "string",
"description": "The OpenRoaming DNA Spaces tenant ID"
}
},
"description": "Openroaming information for the SSID"
}
}
},
"description": "The SSIDs for the network"
}
}
},
"description": "The paginated dataset"
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items in the dataset"
},
"remaining": {
"type": "integer",
"description": "The number of items in the dataset that are available on subsequent pages"
}
},
"description": "Counts relating to the paginated items"
}
},
"description": "Counts relating to the paginated dataset"
}
},
"description": "Metadata relating to the paginated dataset"
}
}
},
"example": {
"items": [
{
"networkId": "N_1234",
"networkName": "MR wireless 1",
"ssid": [
{
"name": "SSID 0",
"number": 0,
"enabled": true,
"openRoaming": {
"enabled": true,
"tenantId": "12345"
}
}
]
}
],
"meta": {
"counts": {
"items": {
"total": 105,
"remaining": 25
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:config:read"
]
}
],
"summary": "Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network",
"tags": [
"wireless",
"configure",
"ssids",
"openRoaming",
"byNetwork"
]
}
},
"/organizations/{organizationId}/wireless/ssids/statuses/byDevice": {
"get": {
"description": "List status information of all BSSIDs in your organization",
"operationId": "getOrganizationWirelessSsidsStatusesByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Optional parameter to filter the result set by the included set of network IDs",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serials",
"in": "query",
"description": "A list of serial numbers. The returned devices will be filtered to only include these serials.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "bssids",
"in": "query",
"description": "A list of BSSIDs. The returned devices will be filtered to only include these BSSIDs.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "hideDisabled",
"in": "query",
"description": "If true, the returned devices will not include disabled SSIDs. (default: true)",
"schema": {
"type": "boolean"
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 500. Default is 100.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Unique serial number for device."
},
"name": {
"type": "string",
"description": "Name of device."
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for network."
},
"name": {
"type": "string",
"description": "Name of network."
}
},
"description": "Group of devices and settings."
},
"basicServiceSets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bssid": {
"type": "string",
"description": "Unique identifier for wireless access point."
},
"ssid": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of wireless network."
},
"number": {
"type": "integer",
"description": "Unique identifier for wireless network."
},
"enabled": {
"type": "boolean",
"description": "Status of wireless network."
},
"advertised": {
"type": "boolean",
"description": "Availability of wireless network for devices to connect to."
}
},
"description": "Wireless access point and network identifier."
},
"radio": {
"type": "object",
"properties": {
"band": {
"type": "string",
"enum": [
"2.4",
"5",
"6"
],
"description": "Frequency range used for wireless communication."
},
"channel": {
"type": "integer",
"description": "Frequency channel used for wireless communication."
},
"channelWidth": {
"type": "integer",
"description": "Width of frequency channel used for wireless communication."
},
"power": {
"type": "integer",
"description": "Strength of wireless signal."
},
"isBroadcasting": {
"type": "boolean",
"description": "Indicates whether or not this radio is currently broadcasting."
},
"index": {
"type": "string",
"description": "The radio index."
}
},
"description": "Wireless access point radio identifier."
}
}
},
"description": "Status information for wireless access points."
}
}
},
"description": "The top-level propery containing all status data."
},
"meta": {
"type": "object",
"properties": {
"counts": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items."
},
"remaining": {
"type": "integer",
"description": "The number of items remaining based on current pagination location within the dataset."
}
},
"description": "The count metadata."
}
},
"description": "Count metadata related to this result set."
}
},
"description": "Other metadata related to this result set."
}
}
},
"example": {
"items": [
{
"serial": "QQ3A-QHWY-DQ2Z",
"name": "My AP",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"basicServiceSets": [
{
"bssid": "8A:15:04:00:00:00",
"ssid": {
"name": "My SSID",
"number": 0,
"enabled": true,
"advertised": true
},
"radio": {
"band": "2.4",
"channel": 11,
"channelWidth": 20,
"power": 18,
"isBroadcasting": true,
"index": "0"
}
}
]
}
],
"meta": {
"counts": {
"items": {
"total": 1738,
"remaining": 1238
}
}
}
}
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"security": [
{
"oauth2": [
"wireless:telemetry:read"
]
}
],
"summary": "List status information of all BSSIDs in your organization",
"tags": [
"wireless",
"monitor",
"ssids",
"statuses",
"byDevice"
]
}
},
"/organizations/{organizationId}/wireless/zigbee/byNetwork": {
"get": {
"description": "Return list of Zigbee configs",
"operationId": "getOrganizationWirelessZigbeeByNetwork",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Filter by specified Network IDs",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique Meraki Identifier for the network"
}
},
"description": "Network details"
},
"enabled": {
"type": "boolean",
"description": "If Zigbee is enabled for the network"
},
"iotController": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the device"
},
"mac": {
"type": "string",
"description": "Mac address of the device"
},
"serial": {
"type": "string",
"description": "Serial number of the device"
},
"status": {
"type": "string",
"description": "Zigbee connectivity status of the device"
}
},
"description": "Device details setup the IoT controller"
},
"lockManagement": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Host address of the system"
},
"username": {
"type": "string",
"description": "Login user credentials"
},
"status": {
"type": "string",
"description": "Zigbee connectivity status of the management software"
}
},
"description": "Lock management details"
},
"defaults": {
"type": "object",
"properties": {
"transmitPowerLevel": {
"type": "integer",
"description": "Default transmit power level for the network"
},
"channel": {
"type": "string",
"description": "Channel the zigbee node will communicate on either, auto or between 11-25"
}
},
"description": "Default settings for the wireless devices in the network"
}
}
}
},
"example": [
{
"network": {
"id": "N_24329156"
},
"enabled": true,
"iotController": {
"name": "My AP",
"mac": "e4:55:a8:38:f2:06",
"serial": "Q234-ABCD-5678",
"status": "online"
},
"lockManagement": {
"address": "10.100.100.200",
"username": "user",
"status": "offline"
},
"defaults": {
"transmitPowerLevel": 10,
"channel": "25"
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "Return list of Zigbee configs",
"tags": [
"wireless",
"configure",
"zigbee",
"byNetwork"
]
}
},
"/organizations/{organizationId}/wireless/zigbee/devices": {
"get": {
"description": "List the Zigbee wireless devices for an organization or the supplied network(s)",
"operationId": "getOrganizationWirelessZigbeeDevices",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
},
{
"name": "networkIds",
"in": "query",
"description": "Parameter of networks you want the zigbee devices for. E.g.: networkIds[]=N_12345678&networkIds[]=N_3456",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "isEnrolled",
"in": "query",
"description": "Filter devices based on if they are enrolled or not",
"schema": {
"type": "boolean"
}
},
{
"name": "search",
"in": "query",
"description": "Filter devices by their name, tag or serial",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network id the zigbee device belongs too"
},
"name": {
"type": "string",
"description": "The name of the network"
}
},
"description": "Network zigbee device is on"
},
"panId": {
"type": "string",
"description": "Unique id for the zigbee device node"
},
"channel": {
"type": "string",
"description": "Channel the zigbee node will communicate on either auto or between 11-25"
},
"transmitPowerLevel": {
"type": "integer",
"description": "Power level for the zigbee devices will be a int between 10-20"
},
"enrolled": {
"type": "boolean",
"description": "Whether this zigbee node is enrolled or not"
},
"status": {
"type": "string",
"enum": [
"offline",
"online"
],
"description": "The node status, either online or offline"
},
"gateway": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the wireless device"
},
"mac": {
"type": "string",
"description": "The mac address of the wireless device"
},
"serial": {
"type": "string",
"description": "The serial number of the wireless device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tags assocated with the wireless device"
}
},
"description": "Wireless device the zigbee device is on"
},
"counts": {
"type": "object",
"properties": {
"doorLocks": {
"type": "object",
"properties": {
"byStatus": {
"type": "object",
"properties": {
"online": {
"type": "integer",
"description": "Online door locks"
},
"offline": {
"type": "integer",
"description": "Offline door locks"
},
"dormant": {
"type": "integer",
"description": "Dormant door locks"
}
},
"description": "Status stats"
}
},
"description": "Door locks stats"
}
},
"description": "Stats"
}
}
}
},
"example": [
{
"network": {
"id": "N_1234",
"name": "Main office"
},
"panId": "0x0100",
"channel": "auto",
"transmitPowerLevel": 12,
"enrolled": true,
"status": "online",
"gateway": {
"name": "Wireless gateway",
"mac": "e4:55:a8:38:f2:06",
"serial": "1234-4567-5678",
"tags": [
"tag1",
"tag2"
]
},
"counts": {
"doorLocks": {
"byStatus": {
"online": 5,
"offline": 2,
"dormant": 0
}
}
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "List the Zigbee wireless devices for an organization or the supplied network(s)",
"tags": [
"wireless",
"configure",
"zigbee",
"devices"
]
}
},
"/organizations/{organizationId}/wireless/zigbee/devices/{id}": {
"put": {
"description": "Endpoint to update zigbee gateways",
"operationId": "updateOrganizationWirelessZigbeeDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "id",
"in": "path",
"description": "ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enrolled": {
"type": "boolean",
"description": "Parameter to enroll or unenroll the zigbee devices"
},
"channel": {
"type": "string",
"description": "The new channel for the zigbee device"
}
},
"example": {
"enrolled": true,
"channel": "11"
},
"required": [
"enrolled"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The network id the zigbee device belongs too"
},
"name": {
"type": "string",
"description": "The name of the network"
}
},
"description": "Network zigbee device is on"
},
"panId": {
"type": "string",
"description": "Unique id for the zigbee device node"
},
"channel": {
"type": "string",
"description": "Channel the zigbee node will communicate on either auto or between 11-25"
},
"transmitPowerLevel": {
"type": "integer",
"description": "Power level for the zigbee devices will be a int between 10-20"
},
"enrolled": {
"type": "boolean",
"description": "Whether this zigbee node is enrolled or not"
},
"status": {
"type": "string",
"enum": [
"offline",
"online"
],
"description": "The node status, either online or offline"
},
"gateway": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the wireless device"
},
"mac": {
"type": "string",
"description": "The mac address of the wireless device"
},
"serial": {
"type": "string",
"description": "The serial number of the wireless device"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tags assocated with the wireless device"
}
},
"description": "Wireless device the zigbee device is on"
},
"counts": {
"type": "object",
"properties": {
"doorLocks": {
"type": "object",
"properties": {
"byStatus": {
"type": "object",
"properties": {
"online": {
"type": "integer",
"description": "Online door locks"
},
"offline": {
"type": "integer",
"description": "Offline door locks"
},
"dormant": {
"type": "integer",
"description": "Dormant door locks"
}
},
"description": "Status stats"
}
},
"description": "Door locks stats"
}
},
"description": "Stats"
}
}
},
"example": {
"network": {
"id": "N_1234",
"name": "Main office"
},
"panId": "0x0100",
"channel": "auto",
"transmitPowerLevel": 12,
"enrolled": true,
"status": "online",
"gateway": {
"name": "Wireless gateway",
"mac": "e4:55:a8:38:f2:06",
"serial": "1234-4567-5678",
"tags": [
"tag1",
"tag2"
]
},
"counts": {
"doorLocks": {
"byStatus": {
"online": 5,
"offline": 2,
"dormant": 0
}
}
}
}
}
}
}
},
"summary": "Endpoint to update zigbee gateways",
"tags": [
"wireless",
"configure",
"zigbee",
"devices"
]
}
},
"/organizations/{organizationId}/wireless/zigbee/disenrollments": {
"post": {
"description": "Enqueue a job to start disenrolling door locks on zigbee configured wireless devices",
"operationId": "createOrganizationWirelessZigbeeDisenrollment",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"doorLockIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of Meraki door lock ids to disenroll from the device"
}
},
"example": {}
}
}
},
"required": false
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"disenrollmentId": {
"type": "string",
"description": "Id to check the status of your disenrollment"
},
"url": {
"type": "string",
"description": "Url to check the status of your disenrollment"
},
"request": {
"type": "object",
"properties": {
"doorLockIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of door lock ids"
}
},
"description": "Disenrollment parameters"
},
"status": {
"type": "string",
"description": "Status of the disenrollment"
}
}
},
"example": {
"disenrollmentId": "1234",
"url": "/organization/{organizationId}/wireless/zigbee/disenrollments/1234",
"request": {
"doorLockIds": [
"1234"
]
},
"status": "complete"
}
}
}
}
},
"summary": "Enqueue a job to start disenrolling door locks on zigbee configured wireless devices",
"tags": [
"wireless",
"configure",
"zigbee",
"disenrollments"
]
}
},
"/organizations/{organizationId}/wireless/zigbee/disenrollments/{disenrollmentId}": {
"get": {
"description": "Return a disenrollment",
"operationId": "getOrganizationWirelessZigbeeDisenrollment",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "disenrollmentId",
"in": "path",
"description": "Disenrollment ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"disenrollmentId": {
"type": "string",
"description": "Id to check the status of your disenrollment"
},
"url": {
"type": "string",
"description": "Url to check the status of your disenrollment"
},
"request": {
"type": "object",
"properties": {
"doorLockIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of door lock ids"
}
},
"description": "Disenrollment parameters"
},
"status": {
"type": "string",
"description": "Status of the disenrollment"
},
"doorLocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"doorLockId": {
"type": "string",
"description": "Meraki door lock identifier"
},
"status": {
"type": "string",
"enum": [
"failure",
"success"
],
"description": "Disenrollment status"
}
}
},
"description": "Door locks"
}
}
},
"example": {
"disenrollmentId": "1234",
"url": "/organization/{organizationId}/wireless/zigbee/disenrollments/1234",
"request": {
"doorLockIds": [
"1234"
]
},
"status": "complete",
"doorLocks": [
{
"doorLockId": "1234",
"status": "success"
}
]
}
}
}
}
},
"summary": "Return a disenrollment",
"tags": [
"wireless",
"configure",
"zigbee",
"disenrollments"
]
}
},
"/organizations/{organizationId}/wireless/zigbee/doorLocks": {
"get": {
"description": "Return the list of door locks for a network",
"operationId": "getOrganizationWirelessZigbeeDoorLocks",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "networkIds",
"in": "query",
"description": "Filter by specified Network IDs",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serial",
"in": "query",
"description": "Filter by device serial",
"schema": {
"type": "string"
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 3 - 500. Default is 50.",
"schema": {
"type": "integer"
}
},
{
"name": "startingAfter",
"in": "query",
"description": "A token used by the server to indicate the start 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.",
"schema": {
"type": "string"
}
},
{
"name": "endingBefore",
"in": "query",
"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.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"doorLockId": {
"type": "string",
"description": "The Door Lock ID"
},
"name": {
"type": "string",
"description": "The Door lock name"
},
"shortId": {
"type": "string",
"description": "The Door lock short ID"
},
"lqi": {
"type": "string",
"description": "The Door lock L quality index"
},
"rssi": {
"type": "string",
"description": "The Door lock received signal strength indicator"
},
"status": {
"type": "string",
"enum": [
"offline",
"online"
],
"description": "The Door lock status, either online or offline."
},
"eui64": {
"type": "string",
"description": "The Door lock unique identifier per network"
},
"enrolledAt": {
"type": "string",
"format": "date-time",
"description": "Date time the door lock was enrolled"
},
"lastSeenAt": {
"type": "string",
"format": "date-time",
"description": "Date time the door lock last send any messages"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network name"
}
},
"description": "Network this door lock is connected to"
},
"gateway": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "MR Device Name"
},
"serial": {
"type": "string",
"description": "Gateway serial"
}
},
"description": "Gateway this door lock is connected to"
}
}
}
},
"example": [
{
"doorLockId": "1",
"name": "Door Lock 123",
"shortId": "ABE123",
"lqi": "1",
"rssi": "1",
"status": "online",
"eui64": "DL403",
"enrolledAt": "2023-08-14T19:57:06Z",
"lastSeenAt": "2023-08-14T19:59:01Z",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"gateway": {
"name": "My AP",
"serial": "Q234-ABCD-5678"
}
}
]
}
},
"headers": {
"Link": {
"schema": {
"type": "string"
},
"description": "A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."
}
}
}
},
"summary": "Return the list of door locks for a network",
"tags": [
"wireless",
"configure",
"zigbee",
"doorLocks"
]
}
},
"/organizations/{organizationId}/wireless/zigbee/doorLocks/{doorLockId}": {
"put": {
"description": "Endpoint to batch update door locks params",
"operationId": "updateOrganizationWirelessZigbeeDoorLock",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "doorLockId",
"in": "path",
"description": "Door lock ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Door lock name to update"
}
},
"example": {
"name": "door #123"
}
}
}
},
"required": false
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"doorLockId": {
"type": "string",
"description": "The Door Lock ID"
},
"name": {
"type": "string",
"description": "The Door lock name"
},
"shortId": {
"type": "string",
"description": "The Door lock short ID"
},
"lqi": {
"type": "string",
"description": "The Door lock L quality index"
},
"rssi": {
"type": "string",
"description": "The Door lock received signal strength indicator"
},
"status": {
"type": "string",
"enum": [
"offline",
"online"
],
"description": "The Door lock status, either online or offline."
},
"eui64": {
"type": "string",
"description": "The Door lock unique identifier per network"
},
"enrolledAt": {
"type": "string",
"format": "date-time",
"description": "Date time the door lock was enrolled"
},
"lastSeenAt": {
"type": "string",
"format": "date-time",
"description": "Date time the door lock last send any messages"
},
"network": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Network name"
}
},
"description": "Network this door lock is connected to"
},
"gateway": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "MR Device Name"
},
"serial": {
"type": "string",
"description": "Gateway serial"
}
},
"description": "Gateway this door lock is connected to"
}
}
},
"example": {
"doorLockId": "1",
"name": "Door Lock 123",
"shortId": "ABE123",
"lqi": "1",
"rssi": "1",
"status": "online",
"eui64": "DL403",
"enrolledAt": "2023-08-14T19:57:06Z",
"lastSeenAt": "2023-08-14T19:59:01Z",
"network": {
"id": "N_24329156",
"name": "Main Office"
},
"gateway": {
"name": "My AP",
"serial": "Q234-ABCD-5678"
}
}
}
}
}
},
"summary": "Endpoint to batch update door locks params",
"tags": [
"wireless",
"configure",
"zigbee",
"doorLocks"
]
}
}
}
}