openapi: 3.2.0 info: version: 1.54.0 title: KPN SD-LAN SD-WAN Network View Wireless.configure API description: "The SD-LAN SD-WAN Network View API is a modern REST API based on the OpenAPI specification.\n \nThe Network View API gives users read rights to retrieve information from the `Network View API` resources. \n \n- **Note**: By default you have read only access but based on your requirements and contract you can be granted `Manager` access to this API which is more than read only. To request manager access, please contact us at api_developer@kpn.com.\n\n---\n## [Source view](https://app.swaggerhub.com/apis/kpn/kpn-sd_lan_sd_wan_network_view_api/)
[Documentation view](https://app.swaggerhub.com/apis-docs/kpn/kpn-sd_lan_sd_wan_network_view_api/)\n---\n## [KPN Developer](https://developer.kpn.com/)
[Getting Started](https://developer.kpn.com/getting-started)" servers: - url: https://api-prd.kpn.com/kpn/meraki security: - OAuth2ClientCredentials: [] tags: - name: wireless.configure 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 summary: Update alternate management interface IPv6 address tags: - wireless.configure /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 automatically generated value. major: type: integer description: Desired major value of the beacon. If the value is set to null it will reset to 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 Dashboard's automatically generated value. example: uuid: 00000000-0000-0000-000-000000000000 major: 13 minor: 125 summary: Return the bluetooth settings for a wireless device tags: - wireless.configure 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 description: Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value. major: type: integer description: Desired major value of the beacon. If the value is set to null it will reset to 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 Dashboard's automatically generated value. example: uuid: 00000000-0000-0000-000-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 automatically generated value. major: type: integer description: Desired major value of the beacon. If the value is set to null it will reset to 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 Dashboard's automatically generated value. example: uuid: 00000000-0000-0000-000-000000000000 major: 13 minor: 125 summary: Update the bluetooth settings for a wireless device tags: - wireless.configure /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 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 /devices/{serial}/wireless/radio/settings: get: description: Return the radio settings of a device 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 example: serial: Q234-ABCD-5678 rfProfileId: '1234' twoFourGhzSettings: channel: 11 targetPower: 21 fiveGhzSettings: channel: 149 channelWidth: 20 targetPower: 15 summary: Return the radio settings of a device tags: - wireless.configure put: description: Update the radio settings of a device 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 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. targetPower: type: integer description: Set a manual target power for 2.4 GHz (dBm). Enter null for using auto power range. description: Manual radio settings for 2.4 GHz. 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. channelWidth: type: integer enum: - 0 - 20 - 40 - 80 - 160 description: Sets a manual channel for 5 GHz. Can be '0', '20', '40', '80' or '160' or null for using auto channel width. targetPower: type: integer description: Set a manual target power for 5 GHz (dBm). Enter null for using auto power range. 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 example: serial: Q234-ABCD-5678 rfProfileId: '1234' twoFourGhzSettings: channel: 11 targetPower: 21 fiveGhzSettings: channel: 149 channelWidth: 20 targetPower: 15 summary: Update the radio settings of a device tags: - wireless.configure /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 /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 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 /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 /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 summary: Return alternate management interface and devices with IP assigned tags: - wireless.configure 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 summary: Update alternate management interface and device static IP tags: - wireless.configure /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 bandwidthLimits: limitUp: 1000 limitDown: 1000 timeLimit: 1 hour summary: Return the billing settings of this network tags: - wireless.configure 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 limitDown: type: integer description: The maximum download limit (integer, in Kbps). null indicates no limit 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 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 bandwidthLimits: limitUp: 1000 limitDown: 1000 timeLimit: 1 hour summary: Update the billing settings tags: - wireless.configure /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-000-000000000000 majorMinorAssignmentMode: Non-unique major: 1 minor: 1 eslEnabled: true summary: Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network. tags: - wireless.configure 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-000-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-000-000000000000 majorMinorAssignmentMode: Non-unique major: 1 minor: 1 eslEnabled: true summary: Update the Bluetooth settings for a network tags: - wireless.configure /networks/{networkId}/wireless/electronicShelfLabel: get: description: Return the ESL settings of a wireless network operationId: getNetworkWirelessElectronicShelfLabel parameters: - name: networkId in: path description: Network ID schema: type: string required: true responses: '200': description: Successful operation content: application/json: schema: type: object properties: hostname: type: string description: Desired ESL hostname of the network enabled: type: boolean description: Turn ESL features on and off for this network example: hostname: N_24329156 enabled: true summary: Return the ESL settings of a wireless network tags: - wireless.configure put: description: Update the ESL settings of a wireless network operationId: updateNetworkWirelessElectronicShelfLabel parameters: - name: networkId in: path description: Network ID schema: type: string required: true requestBody: content: application/json: schema: type: object properties: hostname: type: string description: Desired ESL hostname of the network enabled: type: boolean description: Turn ESL features on and off for this network example: hostname: N_24329156 enabled: true required: false responses: '200': description: Successful operation content: application/json: schema: type: object properties: hostname: type: string description: Desired ESL hostname of the network enabled: type: boolean description: Turn ESL features on and off for this network example: hostname: N_24329156 enabled: true summary: Update the ESL settings of a wireless network tags: - wireless.configure /networks/{networkId}/wireless/electronicShelfLabel/configuredDevices: get: description: Get a list of all ESL eligible devices of a network operationId: getNetworkWirelessElectronicShelfLabelConfiguredDevices parameters: - name: networkId in: path description: Network ID schema: type: string required: true responses: '200': description: Successful operation content: application/json: schema: type: array items: type: object properties: hostname: type: string description: Desired ESL hostname of the network enabled: type: boolean description: Turn ESL features on and off for this network example: - hostname: N_24329156 enabled: true summary: Get a list of all ESL eligible devices of a network tags: - wireless.configure /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 summary: List the AP port profiles for this network tags: - wireless.configure 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 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 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 summary: Create an AP port profile tags: - wireless.configure /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 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' summary: Assign AP port profile to list of APs tags: - wireless.configure /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 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' summary: Set the AP port profile to be default for this network tags: - wireless.configure /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 summary: Show the AP port profile by ID for this network tags: - wireless.configure 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 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 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 summary: Update the AP port profile by ID for this network tags: - wireless.configure 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 summary: Delete an AP port profile tags: - wireless.configure /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. 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. 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 auto. channelWidth: type: string description: Sets channel width (MHz) for 6Ghz band. Can be one of '0', '20', '40', '80' or '160'. 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. 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 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 summary: List RF profiles for this network tags: - wireless.configure 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. 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. 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 '0', '20', '40', '80' or '160'. Defaults to 0. 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. 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 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 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '1': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '2': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '3': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '4': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '5': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '6': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '7': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '8': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '9': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '10': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '11': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '12': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '13': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '14': minBitrate: 11 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. 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. 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 auto. channelWidth: type: string description: Sets channel width (MHz) for 6Ghz band. Can be one of '0', '20', '40', '80' or '160'. 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. 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 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 summary: Creates new RF profile for this network tags: - wireless.configure /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. 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. 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 '0', '20', '40', '80' or '160'. 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. 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 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 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '1': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '2': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '3': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '4': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '5': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '6': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '7': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '8': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '9': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '10': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '11': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '12': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '13': minBitrate: 11 bandOperationMode: dual bands: enabled: - '2.4' - '5' bandSteeringEnabled: true '14': minBitrate: 11 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. 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. 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 auto. channelWidth: type: string description: Sets channel width (MHz) for 6Ghz band. Can be one of '0', '20', '40', '80' or '160'. 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. 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 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 summary: Updates specified RF profile for this network tags: - wireless.configure 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 summary: Delete a RF Profile tags: - wireless.configure 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. 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. 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 auto. channelWidth: type: string description: Sets channel width (MHz) for 6Ghz band. Can be one of '0', '20', '40', '80' or '160'. 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. 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 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 summary: Return a RF profile tags: - wireless.configure /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. ledLightsOn: type: boolean description: Toggle for enabling or disabling LED lights on all APs in the network (making them run dark) 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 ledLightsOn: false namedVlans: poolDhcpMonitoring: enabled: true duration: 5 regulatoryDomain: name: FCC countryCode: US permits6e: true summary: Return the wireless settings for a network tags: - wireless.configure 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. ledLightsOn: type: boolean description: Toggle for enabling or disabling LED lights on all APs in the network (making them run dark) 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 ledLightsOn: false 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. ledLightsOn: type: boolean description: Toggle for enabling or disabling LED lights on all APs in the network (making them run dark) 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 ledLightsOn: false namedVlans: poolDhcpMonitoring: enabled: true duration: 5 regulatoryDomain: name: FCC countryCode: US permits6e: true summary: Update the wireless settings for a network tags: - wireless.configure /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 authMode: type: string enum: - 8021x-entra - 8021x-google - 8021x-localradius - 8021x-meraki - 8021x-nac - 8021x-radius - ipsk-with-nac - ipsk-with-radius - ipsk-without-radius - open - open-enhanced - open-with-nac - open-with-radius - psk description: The association control method for the SSID encryptionMode: type: string enum: - wep - wpa description: The psk encryption mode for the SSID 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 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 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 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 radiusAccountingEnabled: type: boolean description: Whether or not RADIUS accounting is enabled radiusEnabled: type: boolean description: Whether RADIUS authentication is enabled radiusAttributeForGroupPolicies: type: string enum: - Airespace-ACL-Name - Aruba-User-Role - Filter-Id - Reply-Message description: RADIUS attribute used to look up 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 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 ipAssignmentMode: type: string enum: - Bridge mode - 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 splashTimeout: type: string description: Splash page timeout walledGardenEnabled: type: boolean description: Allow users to access a configurable list of IP ranges prior to sign-on walledGardenRanges: type: array items: type: string description: Domain names and IP address ranges available in Walled Garden mode minBitrate: type: integer 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) mandatoryDhcpEnabled: type: boolean description: Whether clients connecting to this SSID must use the IP address assigned by the DHCP server example: - number: 0 name: My SSID enabled: true splashPage: Click-through splash page ssidAdminAccessible: false localAuth: false authMode: 8021x-radius encryptionMode: wpa wpaEncryptionMode: WPA2 only radiusServers: - host: 0.0.0.0 port: 3000 openRoamingCertificateId: 2 caCertificate: '-----BEGIN CERTIFICATE----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----END CERTIFICATE-----' radiusAccountingServers: - host: 0.0.0.0 port: 3000 openRoamingCertificateId: 2 caCertificate: '-----BEGIN CERTIFICATE----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----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 bandSelection: 5 GHz band only perClientBandwidthLimitUp: 0 perClientBandwidthLimitDown: 0 visible: true availableOnAllAps: false availabilityTags: - tag1 - tag2 perSsidBandwidthLimitUp: 0 perSsidBandwidthLimitDown: 0 mandatoryDhcpEnabled: false summary: List the MR SSIDs in a network tags: - wireless.configure /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 authMode: type: string enum: - 8021x-entra - 8021x-google - 8021x-localradius - 8021x-meraki - 8021x-nac - 8021x-radius - ipsk-with-nac - ipsk-with-radius - ipsk-without-radius - open - open-enhanced - open-with-nac - open-with-radius - psk description: The association control method for the SSID encryptionMode: type: string enum: - wep - wpa description: The psk encryption mode for the SSID 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 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 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 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 radiusAccountingEnabled: type: boolean description: Whether or not RADIUS accounting is enabled radiusEnabled: type: boolean description: Whether RADIUS authentication is enabled radiusAttributeForGroupPolicies: type: string enum: - Airespace-ACL-Name - Aruba-User-Role - Filter-Id - Reply-Message description: RADIUS attribute used to look up 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 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 ipAssignmentMode: type: string enum: - Bridge mode - 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 splashTimeout: type: string description: Splash page timeout walledGardenEnabled: type: boolean description: Allow users to access a configurable list of IP ranges prior to sign-on walledGardenRanges: type: array items: type: string description: Domain names and IP address ranges available in Walled Garden mode minBitrate: type: integer 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) mandatoryDhcpEnabled: type: boolean description: Whether clients connecting to this SSID must use the IP address assigned by the DHCP server example: number: 0 name: My SSID enabled: true splashPage: Click-through splash page ssidAdminAccessible: false localAuth: false authMode: 8021x-radius encryptionMode: wpa wpaEncryptionMode: WPA2 only radiusServers: - host: 0.0.0.0 port: 3000 openRoamingCertificateId: 2 caCertificate: '-----BEGIN CERTIFICATE----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----END CERTIFICATE-----' radiusAccountingServers: - host: 0.0.0.0 port: 3000 openRoamingCertificateId: 2 caCertificate: '-----BEGIN CERTIFICATE----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----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 bandSelection: 5 GHz band only perClientBandwidthLimitUp: 0 perClientBandwidthLimitDown: 0 visible: true availableOnAllAps: false availabilityTags: - tag1 - tag2 perSsidBandwidthLimitUp: 0 perSsidBandwidthLimitDown: 0 mandatoryDhcpEnabled: false summary: Return a single MR SSID tags: - wireless.configure 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-without-radius - open - open-enhanced - open-with-nac - open-with-radius - psk description: The association control method for the SSID ('open', 'open-enhanced', 'psk', 'open-with-radius', 'open-with-nac', '8021x-meraki', '8021x-nac', '8021x-radius', '8021x-google', '8021x-entra', '8021x-localradius', 'ipsk-with-radius', 'ipsk-without-radius' or 'ipsk-with-nac') enterpriseAdminAccess: type: string enum: - access disabled - access enabled description: Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled') 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. clientRootCaCertificate: type: object properties: contents: type: string description: The contents of the Client CA Certificate. Must be in PEM or DER format. 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).' password: type: string description: The password of the LDAP user account. 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. serverCaCertificate: type: object properties: contents: type: string description: The contents of the CA certificate. Must be in PEM or DER format. 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. password: type: string description: The password to the Active Directory user account. 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. caCertificate: type: string description: Certificate used for authorization for the RADSEC Server 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 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' or 'VPN') 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. 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. 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. example: name: My SSID enabled: true authMode: 8021x-radius enterpriseAdminAccess: access enabled 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----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----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----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----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----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----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----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----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 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 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 authMode: type: string enum: - 8021x-entra - 8021x-google - 8021x-localradius - 8021x-meraki - 8021x-nac - 8021x-radius - ipsk-with-nac - ipsk-with-radius - ipsk-without-radius - open - open-enhanced - open-with-nac - open-with-radius - psk description: The association control method for the SSID encryptionMode: type: string enum: - wep - wpa description: The psk encryption mode for the SSID 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 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 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 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 radiusAccountingEnabled: type: boolean description: Whether or not RADIUS accounting is enabled radiusEnabled: type: boolean description: Whether RADIUS authentication is enabled radiusAttributeForGroupPolicies: type: string enum: - Airespace-ACL-Name - Aruba-User-Role - Filter-Id - Reply-Message description: RADIUS attribute used to look up 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 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 ipAssignmentMode: type: string enum: - Bridge mode - 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 splashTimeout: type: string description: Splash page timeout walledGardenEnabled: type: boolean description: Allow users to access a configurable list of IP ranges prior to sign-on walledGardenRanges: type: array items: type: string description: Domain names and IP address ranges available in Walled Garden mode minBitrate: type: integer 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) mandatoryDhcpEnabled: type: boolean description: Whether clients connecting to this SSID must use the IP address assigned by the DHCP server example: number: 0 name: My SSID enabled: true splashPage: Click-through splash page ssidAdminAccessible: false localAuth: false authMode: 8021x-radius encryptionMode: wpa wpaEncryptionMode: WPA2 only radiusServers: - host: 0.0.0.0 port: 3000 openRoamingCertificateId: 2 caCertificate: '-----BEGIN CERTIFICATE----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----END CERTIFICATE-----' radiusAccountingServers: - host: 0.0.0.0 port: 3000 openRoamingCertificateId: 2 caCertificate: '-----BEGIN CERTIFICATE----- MIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw gYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT YW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ RE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx MTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu YXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD aXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3 MDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK uTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA ayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u pZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS KjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2 aEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU CwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML USopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E BAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE 1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa jON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh a/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/ uoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/ UR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ wTw70BVktzJnb0VLeDg= -----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 bandSelection: 5 GHz band only perClientBandwidthLimitUp: 0 perClientBandwidthLimitDown: 0 visible: true availableOnAllAps: false availabilityTags: - tag1 - tag2 perSsidBandwidthLimitUp: 0 perSsidBandwidthLimitDown: 0 mandatoryDhcpEnabled: false summary: Update the attributes of an MR SSID tags: - wireless.configure /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 summary: List the Bonjour forwarding setting and rules for the SSID tags: - wireless.configure 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 summary: Update the bonjour forwarding setting and rules for the SSID tags: - wireless.configure /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 summary: List the device type group policies for the SSID tags: - wireless.configure 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 summary: Update the device type group policies for the SSID tags: - wireless.configure /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 summary: Return the EAP overridden parameters for an SSID tags: - wireless.configure 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 summary: Update the EAP overridden parameters for an SSID. tags: - wireless.configure /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' 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 protocol: tcp destPort: '443' destCidr: 192.168.1.0/24 allowLanAccess: false summary: Return the L3 firewall rules for an SSID on an MR network tags: - wireless.configure 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' 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: 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 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' 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 protocol: tcp destPort: '443' destCidr: 192.168.1.0/24 allowLanAccess: false summary: Update the L3 firewall rules of an SSID on an MR network tags: - wireless.configure /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 summary: Return the L7 firewall rules for an SSID on an MR network tags: - wireless.configure 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 summary: Update the L7 firewall rules of an SSID on an MR network tags: - wireless.configure /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 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' - mcc: '563' mnc: '232' naiRealms: - format: '1' name: Realm 1 methods: - id: '1' authenticationTypes: nonEapInnerAuthentication: - MSCHAP eapInnerAuthentication: - EAP-TTLS with MSCHAPv2 credentials: [] tunneledEapMethodCredentials: [] summary: Return the Hotspot 2.0 settings for an SSID tags: - wireless.configure 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 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' - mcc: '563' mnc: '232' naiRealms: - format: '1' name: 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 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' - mcc: '563' mnc: '232' naiRealms: - format: '1' name: Realm 1 methods: - id: '1' authenticationTypes: nonEapInnerAuthentication: - MSCHAP eapInnerAuthentication: - EAP-TTLS with MSCHAPv2 credentials: [] tunneledEapMethodCredentials: [] summary: Update the Hotspot 2.0 settings of an SSID tags: - wireless.configure /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 example: - name: Sample Identity PSK id: '1284392014819' groupPolicyId: '101' passphrase: secret wifiPersonalNetworkId: '1284392014819' email: miles@meraki.com expiresAt: '2018-02-11T00:00:00.090210Z' summary: List all Identity PSKs in a wireless network tags: - wireless.configure 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 example: name: Sample Identity PSK id: '1284392014819' groupPolicyId: '101' passphrase: secret wifiPersonalNetworkId: '1284392014819' email: miles@meraki.com expiresAt: '2018-02-11T00:00:00.090210Z' summary: Create an Identity PSK tags: - wireless.configure /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 example: name: Sample Identity PSK id: '1284392014819' groupPolicyId: '101' passphrase: secret wifiPersonalNetworkId: '1284392014819' email: miles@meraki.com expiresAt: '2018-02-11T00:00:00.090210Z' summary: Return an Identity PSK tags: - wireless.configure 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 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 example: name: Sample Identity PSK id: '1284392014819' groupPolicyId: '101' passphrase: secret wifiPersonalNetworkId: '1284392014819' email: miles@meraki.com expiresAt: '2018-02-11T00:00:00.090210Z' summary: Update an Identity PSK tags: - wireless.configure 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 summary: Delete an Identity PSK tags: - wireless.configure /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 summary: List the outage schedule for the SSID tags: - wireless.configure 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 summary: Update the outage schedule for the SSID tags: - wireless.configure /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. 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! 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 summary: Display the splash page settings for the given SSID tags: - wireless.configure 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. 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. 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. 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. 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. example: splashUrl: https://www.custom_splash_url.com useSplashUrl: true splashTimeout: 1440 redirectUrl: https://example.com useRedirectUrl: true welcomeMessage: Welcome! 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 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. 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! 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 summary: Modify the splash page settings for the given SSID tags: - wireless.configure /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. ' 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. ' 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" 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" 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. ' 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. ' 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" 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" 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 summary: Update the traffic shaping rules for an SSID on an MR network. tags: - wireless.configure 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. ' 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. ' 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" 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" 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 summary: Display the traffic shaping settings for a SSID on an MR network tags: - wireless.configure /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 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 - destCidr: foo.com destPort: any policy: deny comment: split tunnel rule 2 summary: List the VPN settings for the SSID. tags: - wireless.configure 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 NAT 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 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 - destCidr: foo.com destPort: any policy: deny comment: split tunnel rule 2 required: false responses: '200': description: Successful operation content: application/json: schema: type: object 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 - destCidr: foo.com destPort: any policy: deny comment: split tunnel rule 2 summary: Update the VPN settings for the SSID tags: - wireless.configure /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. summary: Returns the current Air Marshal rules for this organization tags: - wireless.configure /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 /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 /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, and secureConnect. schema: type: array items: type: string enum: - appliance - camera - 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. summary: List the RF profiles of an organization by device tags: - wireless.configure components: securitySchemes: OAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: https://api-prd.kpn.com/oauth/client_credential/accesstoken?grant_type=client_credentials scopes: {}