{
"openapi": "3.0.1",
"info": {
"title": "RUCKUS Cloud - Wi-Fi APIs and Model Documentation",
"license": {
"name": "RUCKUS Cloud Privacy Policy",
"url": "https://support.ruckuswireless.com/ruckus-cloud-privacy-policy"
},
"version": "v22.07.11",
"termsOfService": "https://support.ruckuswireless.com/ruckus-cloud-wifi-legal-terms-and-conditions",
"description": "APIs published in this document are subject to strict change control by RUCKUS. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated and a replacement API or some other workaround will be provided. Support for deprecated API endpoints will continue for at least six months prior to removal in order to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by the RUCKUS cloud, not included in this API document. RUCKUS reserves the right to change these experimental APIs without notice to API client developers.
RUCKUS Cloud API Documents
\nThis document, Wi-Fi APIs and Model Documentation, is one of four documents describing the RUCKUS Cloud public API. Different API endpoints are described in each of the four documents, which are arranged according to the resources managed. Corresponding to each of the 4 HTML documents is an Open API v3 JSON document, which can be used to generate code for API clients.\n\n\nDocument Name | Resources Managed |
\nwifi-ns-220711.html | Wi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks. |
\nmsp-ns-220711.html | MSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks. |
\nplatform-ns-220711.html | Platform related resources. This document describes API endpoints related to your account including administrators and their notification preferences, venues and your entitlements/licenses. |
\nswitch-ns-220711.html | ICX switch related resources. This document describes API endpoints related to managing your switches and wired networks. |
\n
Cloud Hosts
\nDeprecated API Endpoints
API clients may continue to use deprecated API endpoints for up to 6 months after the release was made generally available (GA). After that, official support for these deprecated endpoints concludes and they may be removed by RUCKUS at any time thereafter without further notice.
Release v21.06.11
The following endpoints were deprecated in release v21.06.11. The new (replacement) URL should be used instead.
Deprecated URL | Replacement URL |
/api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp | /api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp/usage |
Non-Backward Compatible Changes to Wi-Fi APIs
\nOne of the new features in RUCKUS cloud version 21.04.12 is improved integration of Cloudpath services. As of v21.04.12, it’s possible to use Cloudpath AAA services for 802.1X, DPSK, Guest and Open (MAC address authentication) WLANs. Support for client-device onboarding using Cloudpath enrollment services was retained.
However, in making these changes, support for the API schema objects “CloudpathNetwork”, “CloudpathNetworkDeep”, “CloudpathPortal” and “HotspotWlan” was removed. As of v21.04.12, API clients using these objects will no longer work. Management of Cloudpath services is provided by the “Cloudpath” API group. Refer to this group’s description below for further information.Introduction to Wi-Fi Workflows
\nAs an introduction to the Wi-Fi API endpoints, a basic workflow to install and configure a Wi-Fi network is described. The order of steps described below is merely an example. The description below is not meant to be comprehensive; rather, it’s meant to be a guide to get you started with API client development.\n\n\n- Create a venue for your APs. The API group for creating venues is described in the Platform API document, in the “Venue” API group. You can create as many venues as you like. Typically, one venue is created for each building in which you install APs. Or you can also use just one “venue” for all the buildings on a campus; alternatively, a “venue” might be just a single floor in a multi-story building or an outdoor park.
\n\n- Provision your APs. To provision an AP, add the AP using the “Add APs“ endpoint in the AP API group. Once your APs are provisioned, physically install them. They will automatically contact and join the RUCKUS cloud. You can physically install your APs prior to provisioning, but they won’t join the cloud until provisioned. In order to install an AP, your account must possess activated licenses. Purchased licenses are activated on the RUCKUS support website. Use endpoints in the entitlement API group (cf. Platform API documentation) to manage your entitlements (aka licenses). If you don’t have any activated entitlements, the “Add APs“ endpoint will return an error response.
\n\n- Verify your APs have connected to the cloud. To check an AP’s connection, use the “Get APs“ endpoint in the AP API group. The API response provides the AP’s connection status. If your APs are having trouble connecting, you can locally log into your AP and use its troubleshooting utilities to diagnose the problem.
\n\n- Create a WLAN. Use the endpoints in the “Network” API group to create a WLAN. Note that WLANs are global resources that can be activated in as many venues as you like. Simply creating a WLAN does not deploy it to APs. To deploy the WLAN, it must be “activated” on a venue. Use the endpoints in the “Network-Venue” API group for managing WLAN deployments.
\n\n- Customize the configuration of your APs. AP configuration can be customized on three different levels.
\n\n- All the APs in a venue can be collectively customized using endpoints in the “AP-Venue” API group. On a per-venue basis, you can customize the radio or LAN-port settings of your APs as well as enable and manage mesh networking.
\n\n- APs can be grouped together using endpoints in the “AP Group” API group. Each venue can have one or more AP groups; if you don’t explicitly configure AP groups, all APs in a venue are members of the “default” group. Grouping APs is typically done to restrict the deployment of certain WLANs to the APs in a group rather than all the APs in a venue. You might want to do this, for example, to only enable your guest WLAN in the lobby of your venue. Also, using AP groups, WLANs can be enabled on either the 2.4-GHz or 5-GHz band instead of both bands (which is the default). Use the endpoints in the “Network-Venue” API group for managing WLAN (network) assignments to AP Groups.
\n\n- APs can be individually customized using endpoints in the “AP” API group. On a per-AP basis, you can customize an AP’s radio or LAN-port settings. Individual AP configuration override group-level and venue-level configuration.
\n\n - Protect your network. Enable rogue AP detection, configure rogue AP classification policies and view reports on detected rogue APs. Use the endpoints in the “AP-Venue” API group for this purpose. Note: once an administrator is informed of the presence of a rogue AP, he/she can take steps to manually remove it.
\n\n- Add sophistication to your WLAN. Use the endpoints in the “L2AclPolicy”, “L3AclPolicy”, “Device Policy”, and “Application Policy” API groups to create and manage WLAN policies that manage your wireless clients (end-user devices) and their connections to online services more effectively.
\n\n- Add new services to your wireless network. Services such as Wi-Fi calling, location (aka vSPoT) are available; they can be configured and managed using the endpoints in their respective API groups. APs can provide DHCP service with sufficient scale for small offices or branch offices - use the endpoints in “DHCP Service Profile” API group to configure the service and endpoints in “DHCP Service Profile Venue” to activate them on your venues.
\n\n- Manage your network’s client devices. If you have a guest WLAN which uses guest passes, you can create and manage guest users with endpoints in the “Guest User“ API group. If you find client devices which should not be on your network, you can disconnect them using an endpoint in the “Client Disconnect“ API group.
"
},
"servers": [
{
"url": "https://ruckus.cloud",
"description": "Cloud host for North American region."
},
{
"url": "https://eu.ruckus.cloud",
"description": "Cloud host for European region."
},
{
"url": "https://asia.ruckus.cloud",
"description": "Cloud host for Asian region."
}
],
"tags": [
{
"name": "Guest User",
"description": "Manage guest passes for guest users."
},
{
"name": "Recovery",
"description": "Manage the recovery PSK."
},
{
"name": "View",
"description": "View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration."
}
],
"paths": {
"/api/tenant/{tenantId}/wifi/wifi-calling-profile/{wifiCallingProfileId}": {
"get": {
"tags": [
"Wi-Fi Calling"
],
"summary": "Get Wi-Fi Calling Profile",
"description": "Get the Wi-Fi calling profile details.",
"operationId": "getWiFiCallingProfile",
"parameters": [
{
"name": "wifiCallingProfileId",
"in": "path",
"description": "Wi-Fi calling profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WifiCallingProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Wi-Fi Calling"
],
"summary": "Update Wi-Fi Calling Profile",
"description": "Update a Wi-Fi calling profile.",
"operationId": "updateWiFiCallingProfile",
"parameters": [
{
"name": "wifiCallingProfileId",
"in": "path",
"description": "Wi-Fi calling profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WifiCallingProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseWifiCallingProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Wi-Fi Calling"
],
"summary": "Delete Wi-Fi Calling Profile",
"description": "Delete a Wi-Fi calling profile.",
"operationId": "deleteWiFiCallingProfile",
"parameters": [
{
"name": "wifiCallingProfileId",
"in": "path",
"description": "Wi-Fi calling profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/vlan-pool/{vlanPoolId}": {
"get": {
"tags": [
"VLAN Pool"
],
"summary": "Get VLAN Pool",
"description": "Use this API command to get the VLAN pool details.",
"operationId": "getVlanPool",
"parameters": [
{
"name": "vlanPoolId",
"in": "path",
"description": "VLAN Pool ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VlanPool"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"VLAN Pool"
],
"summary": "Update VLAN Pool",
"description": "Use this API command to update a VLAN pool.",
"operationId": "updateVlanPool",
"parameters": [
{
"name": "vlanPoolId",
"in": "path",
"description": "VLAN Pool ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VlanPool"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVlanPool"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10129: \"VLAN Pool name must be unique\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"VLAN Pool"
],
"summary": "Delete VLAN Pool",
"description": "Use this API command to delete a VLAN pool.",
"operationId": "deleteVlanPool",
"parameters": [
{
"name": "vlanPoolId",
"in": "path",
"description": "VLAN Pool ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/syslog": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue Syslog",
"description": "Get the venue syslog settings.",
"operationId": "getVenueSyslog",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueSyslog"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue Syslog",
"description": "Update the venue syslog settings.",
"operationId": "updateVenueSyslog",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueSyslog"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVenueSyslog"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP-Venue"
],
"summary": "Reset Venue Syslog",
"description": "Reset venue syslog settings to default values.",
"operationId": "resetVenueSyslog",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVenueSyslog"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/rogue/ap": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Rogue-AP Settings",
"description": "Get this venue's rogue-AP configuration settings.",
"operationId": "getVenueRogueAp",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueRogueAp"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Rogue-AP Settings",
"description": "Update this venue's rogue-AP configuration settings.",
"operationId": "updateVenueRogueAp",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueRogueAp"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVenueRogueAp"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/radio": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue Radio",
"description": "Get the venue radio.",
"operationId": "getVenueRadio",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueRadioCustomization"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue Radio",
"description": "Update the venue radio.",
"operationId": "updateVenueRadio",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueRadioCustomization"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVenueRadioCustomization"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP-Venue"
],
"summary": "Reset Venue Radio",
"description": "Reset venue radio to default values.",
"operationId": "resetVenueRadio",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVenueRadioCustomization"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/mesh": {
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Mesh",
"description": "Enable/disable the venue mesh.",
"operationId": "updateMesh",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Mesh"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseMesh"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFIB-10001: \"Mesh Network cannot be disabled when APs are active\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/led": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue LED",
"description": "Get venue LED settings. The settings are defined per AP model.",
"operationId": "getVenueLed",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelLed"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue LED",
"description": "Update venue LED settings. The settings are defined per AP model.",
"operationId": "updateVenueLed",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelLed"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListApModelLed"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/lan-port": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue LAN-Ports",
"description": "List venue LAN-port settings. The settings are defined per AP model.",
"operationId": "getVenueLanPorts",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelLanPort"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue LAN-Ports",
"description": "Update a venue LAN-port settings. The settings are defined per AP model.",
"operationId": "updateVenueLanPorts",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelLanPort"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListApModelLanPort"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/externalAntenna": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue External Antenna",
"description": "List venue external antenna settings. The settings are defined per AP model.",
"operationId": "getVenueExternalAntenna",
"parameters": [
{
"name": "venueId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelExternalAntenna"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue External Antenna",
"description": "Update a venue external antenna settings. The settings are defined per AP model.",
"operationId": "updateVenueExternalAntenna",
"parameters": [
{
"name": "venueId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelExternalAntenna"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListApModelExternalAntenna"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/dos-protection": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue DoS Protection",
"description": "Get DoS protection of this venue.",
"operationId": "getDenialOfServiceProtection",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DenialOfServiceProtection"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue DoS Protection",
"description": "Update DoS protection of this venue.",
"operationId": "updateDenialOfServiceProtection",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DenialOfServiceProtection"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDenialOfServiceProtection"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/cellular": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue AP-Model Cellular",
"description": "Get AP model cellular settings and LTE band lock channels of the venue.",
"operationId": "getVenueApModelCellular",
"parameters": [
{
"name": "venueId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueApModelCellular"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue AP-Model Cellular",
"description": "Update AP model cellular settings and LTE band lock channels of the venue.",
"operationId": "updateVenueApModelCellular",
"parameters": [
{
"name": "venueId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueApModelCellular"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVenueApModelCellular"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/rogue-policy/{roguePolicyId}": {
"get": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Get Rogue Classification Policy",
"description": "Get this rogue classification policy.",
"operationId": "getRoguePolicy",
"parameters": [
{
"name": "roguePolicyId",
"in": "path",
"description": "Rogue classification policy ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RogueClassificationPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Update Rogue Classification Policy",
"description": "Update this rogue classification policy.",
"operationId": "updateRoguePolicy",
"parameters": [
{
"name": "roguePolicyId",
"in": "path",
"description": "Rogue classification policy ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RogueClassificationPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseRogueClassificationPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10174: \"Policies currently assigned to venues cannot be deleted\", WIFI-10176: \"Policy name must be unique\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Delete Rogue Classification Policy",
"description": "Delete this rogue classification policy.",
"operationId": "deleteRoguePolicy",
"parameters": [
{
"name": "roguePolicyId",
"in": "path",
"description": "Rogue classification policy ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10174: \"Policies currently assigned to venues cannot be deleted\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/recovery": {
"get": {
"tags": [
"Recovery"
],
"summary": "Get Recovery PSK",
"description": "Get the PSK for the recovery network.",
"operationId": "getRecoveryPsk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecoveryPsk"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Recovery"
],
"summary": "Update Recovery PSK",
"description": "Update the PSK for the recovery network.",
"operationId": "updateRecoveryPsk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecoveryPsk"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseRecoveryPsk"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network/{networkId}/deep": {
"get": {
"tags": [
"Network"
],
"summary": "Get Network (Deep)",
"description": "Get network details, including nested details.",
"operationId": "getNetworkDeep",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetworkDeep"
},
{
"$ref": "#/components/schemas/DpskNetworkDeep"
},
{
"$ref": "#/components/schemas/GuestNetworkDeep"
},
{
"$ref": "#/components/schemas/OpenNetworkDeep"
},
{
"$ref": "#/components/schemas/PskNetworkDeep"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"aaa": "#/components/schemas/AAANetworkDeep",
"psk": "#/components/schemas/PskNetworkDeep",
"guest": "#/components/schemas/GuestNetworkDeep",
"open": "#/components/schemas/OpenNetworkDeep"
}
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Network"
],
"summary": "Update Network (Deep)",
"description": "Update a network and manage network-venue activations.",
"operationId": "updateNetworkDeep",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetworkDeep"
},
{
"$ref": "#/components/schemas/DpskNetworkDeep"
},
{
"$ref": "#/components/schemas/GuestNetworkDeep"
},
{
"$ref": "#/components/schemas/OpenNetworkDeep"
},
{
"$ref": "#/components/schemas/PskNetworkDeep"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"aaa": "#/components/schemas/AAANetworkDeep",
"psk": "#/components/schemas/PskNetworkDeep",
"guest": "#/components/schemas/GuestNetworkDeep",
"open": "#/components/schemas/OpenNetworkDeep"
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseNetworkDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network/{networkId}": {
"get": {
"tags": [
"Network"
],
"summary": "Get Network",
"description": "Get the network details.",
"operationId": "getNetwork",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetwork"
},
{
"$ref": "#/components/schemas/DpskNetwork"
},
{
"$ref": "#/components/schemas/GuestNetwork"
},
{
"$ref": "#/components/schemas/OpenNetwork"
},
{
"$ref": "#/components/schemas/PskNetwork"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"aaa": "#/components/schemas/AAANetwork",
"dpsk": "#/components/schemas/DpskNetwork",
"guest": "#/components/schemas/GuestNetwork",
"open": "#/components/schemas/OpenNetwork",
"psk": "#/components/schemas/PskNetwork"
}
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Network"
],
"summary": "Update Network",
"description": "Update this network, including nested details.",
"operationId": "updateNetwork",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetwork"
},
{
"$ref": "#/components/schemas/DpskNetwork"
},
{
"$ref": "#/components/schemas/GuestNetwork"
},
{
"$ref": "#/components/schemas/OpenNetwork"
},
{
"$ref": "#/components/schemas/PskNetwork"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"aaa": "#/components/schemas/AAANetwork",
"dpsk": "#/components/schemas/DpskNetwork",
"guest": "#/components/schemas/GuestNetwork",
"open": "#/components/schemas/OpenNetwork",
"psk": "#/components/schemas/PskNetwork"
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseNetwork"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Network"
],
"summary": "Delete Network",
"description": "Delete a network.",
"operationId": "deleteNetwork",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network-venue/{networkVenueId}": {
"get": {
"tags": [
"Network-Venue"
],
"summary": "Get Network-Venue Activation",
"description": "Get the network-venue activation details.",
"operationId": "getNetworkVenue",
"parameters": [
{
"name": "networkVenueId",
"in": "path",
"description": "Network-Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Network-Venue"
],
"summary": "Update Network-Venue",
"description": "Update this network-venue activation.",
"operationId": "updateNetworkVenue",
"parameters": [
{
"name": "networkVenueId",
"in": "path",
"description": "Network-Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkVenue"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseNetworkVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Network-Venue"
],
"summary": "Delete Network-Venue",
"description": "Delete a network-venue activation.",
"operationId": "deleteNetworkVenue",
"parameters": [
{
"name": "networkVenueId",
"in": "path",
"description": "Network-Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/l3-acl-policy/{l3AclPolicyId}": {
"get": {
"tags": [
"L3ACL Policy"
],
"summary": "Get Layer-3 ACL",
"description": "Get layer-3 ACL by profile id.",
"operationId": "getL3AclPolicy",
"parameters": [
{
"name": "l3AclPolicyId",
"in": "path",
"description": "L3Acl Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L3AclPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"L3ACL Policy"
],
"summary": "Update Layer-3 ACL",
"description": "Update layer-3 ACL by profile id.",
"operationId": "updateL3AclPolicy",
"parameters": [
{
"name": "l3AclPolicyId",
"in": "path",
"description": "L3Acl Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L3AclPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseL3AclPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"L3ACL Policy"
],
"summary": "Delete Layer-3 ACL",
"description": "Delete layer-3 ACL by profile id.",
"operationId": "deleteL3AclPolicy",
"parameters": [
{
"name": "l3AclPolicyId",
"in": "path",
"description": "L3Acl Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/l2-acl-policy/{l2AclPolicyId}": {
"get": {
"tags": [
"L2ACL Policy"
],
"summary": "Get Layer-2 ACL",
"description": "Get layer-2 ACL by profile id.",
"operationId": "getL2AclPolicy",
"parameters": [
{
"name": "l2AclPolicyId",
"in": "path",
"description": "L2Acl Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2AclPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"L2ACL Policy"
],
"summary": "Update Layer-2 ACL",
"description": "Update layer-2 ACL by profile id.",
"operationId": "updateL2AclPolicy",
"parameters": [
{
"name": "l2AclPolicyId",
"in": "path",
"description": "L2Acl Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2AclPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseL2AclPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"L2ACL Policy"
],
"summary": "Delete Layer-2 ACL",
"description": "Delete layer-2 ACL by profile id.",
"operationId": "deleteL2AclPolicy",
"parameters": [
{
"name": "l2AclPolicyId",
"in": "path",
"description": "L2Acl Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/isolation-allowlist/{clientIsolationAllowlistId}": {
"get": {
"tags": [
"Client Isolation Allowlist"
],
"summary": "Get Client Isolation Allowlist",
"description": "Get the details for this client isolation allowlist.",
"operationId": "getClientIsolationAllowlist",
"parameters": [
{
"name": "clientIsolationAllowlistId",
"in": "path",
"description": "Client Isolation Allowlist ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientIsolationAllowlist"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Client Isolation Allowlist"
],
"summary": "Update Client Isolation Allowlist",
"description": "Update this client isolation allowlist.",
"operationId": "updateClientIsolationAllowlist",
"parameters": [
{
"name": "clientIsolationAllowlistId",
"in": "path",
"description": "Client Isolation Allowlist ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientIsolationAllowlist"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseClientIsolationAllowlist"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Client Isolation Allowlist"
],
"summary": "Delete Client Isolation Allowlist",
"description": "Delete this client isolation allowlist.",
"operationId": "deleteClientIsolationAllowlist",
"parameters": [
{
"name": "clientIsolationAllowlistId",
"in": "path",
"description": "Client Isolation Allowlist ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dhcp-service-profile/{dhcpServiceProfileId}": {
"get": {
"tags": [
"DHCP Service"
],
"summary": "Get DHCP Service-Profile",
"description": "Get the DHCP service-profile details.",
"operationId": "getDhcpServiceProfile",
"parameters": [
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServiceProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"DHCP Service"
],
"summary": "Update DHCP Service Profile",
"description": "Update a DHCP service-profile.",
"operationId": "updateDhcpServiceProfile",
"parameters": [
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServiceProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDhcpServiceProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"DHCP Service"
],
"summary": "Delete DHCP Service-Profile",
"description": "Delete a DHCP service-profile.",
"operationId": "deleteDhcpServiceProfile",
"parameters": [
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/device-policy/{devicePolicyId}": {
"get": {
"tags": [
"Device Policy"
],
"summary": "Get Device-Policy",
"description": "Get the device-policy details.",
"operationId": "getDevicePolicy",
"parameters": [
{
"name": "devicePolicyId",
"in": "path",
"description": "Device-policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevicePolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Device Policy"
],
"summary": "Update Device-Policy",
"description": "Update a device-policy.",
"operationId": "updateDevicePolicy",
"parameters": [
{
"name": "devicePolicyId",
"in": "path",
"description": "Device-policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevicePolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDevicePolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Device Policy"
],
"summary": "Delete Device-Policy",
"description": "Delete a device-policy.",
"operationId": "deleteDevicePolicy",
"parameters": [
{
"name": "devicePolicyId",
"in": "path",
"description": "Device-policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/cloudpath/{cloudpathServerId}/position": {
"put": {
"tags": [
"Cloudpath"
],
"summary": "Update Cloudpath Server Position",
"description": "Update Cloudpath server floor-plan position.",
"operationId": "updateCloudpathServerPosition",
"parameters": [
{
"name": "cloudpathServerId",
"in": "path",
"description": "Cloudpath Server Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApPosition"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApPosition"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/cloudpath/{cloudpathServerId}": {
"get": {
"tags": [
"Cloudpath"
],
"summary": "Get Cloudpath Server",
"description": "Get details for this Cloudpath server.",
"operationId": "getCloudpathServer",
"parameters": [
{
"name": "cloudpathServerId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudpathServer"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Cloudpath"
],
"summary": "Update Cloudpath Server",
"description": "Update the configuration of this Cloudpath server.",
"operationId": "updateCloudpathServer",
"parameters": [
{
"name": "cloudpathServerId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudpathServer"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseCloudpathServer"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Cloudpath"
],
"summary": "Delete Cloudpath Server",
"description": "Delete this Cloudpath server.",
"operationId": "deleteCloudpathServer",
"parameters": [
{
"name": "cloudpathServerId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/application-policy/{applicationPolicyId}": {
"get": {
"tags": [
"Application Policy"
],
"summary": "Get Application Policy",
"description": "Use this API command to get the application policy details.",
"operationId": "getApplicationPolicy",
"parameters": [
{
"name": "applicationPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Application Policy"
],
"summary": "Update Application Policy",
"description": "Use this API command to update application policy.",
"operationId": "updateApplicationPolicy",
"parameters": [
{
"name": "applicationPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApplicationPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Application Policy"
],
"summary": "Delete Application Policy",
"description": "Use this API command to delete application policy.",
"operationId": "deleteApplicationPolicy",
"parameters": [
{
"name": "applicationPolicyId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/radio": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP Radio",
"description": "Get AP radio details.",
"operationId": "getAPRadio",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApRadioCustomization"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP"
],
"summary": "Update AP Radio",
"description": "Update an AP radio settings.",
"operationId": "updateAPRadio",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApRadioCustomization"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApRadioCustomization"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Reset AP Radio Customization",
"description": "Reset AP radio to default settings.",
"operationId": "resetAPRadio",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApRadioCustomization"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/position": {
"put": {
"tags": [
"AP"
],
"summary": "Update AP Position",
"description": "Update an AP floor-plan position.",
"operationId": "updateAPPosition",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApPosition"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApPosition"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/picture": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP Picture",
"description": "Get AP picture.",
"operationId": "getApPicture",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP"
],
"summary": "Upload AP Picture",
"description": "Upload AP picture.",
"operationId": "UploadApPicture",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Delete AP Picture",
"description": "Delete AP picture.",
"operationId": "DeleteApPicture",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/lan-port": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP LAN-Ports",
"description": "Get AP LAN-ports details.",
"operationId": "getAPLanPorts",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApLanPorts"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP"
],
"summary": "Update AP LAN-Ports",
"description": "Update LAN-ports of an AP.",
"operationId": "updateAPLanPorts",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApLanPorts"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApLanPorts"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Reset AP LAN-Ports",
"description": "Reset the LAN-ports of an AP to the default values.",
"operationId": "resetAPLanPorts",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/customization": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP Customization",
"description": "GET AP customization details.",
"operationId": "getApCustomization",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApModelSpecific"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP"
],
"summary": "Update AP Customization",
"description": "Update the customization of an AP.",
"operationId": "updateApCustomization",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApModelSpecific"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApModelSpecific"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Reset AP Customization",
"description": "Reset the customization of an AP to the default values.",
"operationId": "resetApCustomization",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/bonjour-gateway": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP Bonjour Gateway",
"description": "Get the AP Bonjour gateway details.",
"operationId": "getAPBonjourGateway",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BonjourGateway"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP"
],
"summary": "Update AP Bonjour Gateway",
"description": "Update the AP Bonjour gateway.",
"operationId": "updateAPBonjourGateway",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BonjourGateway"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseBonjourGateway"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Reset AP Bonjour Gateway",
"description": "Reset the AP Bonjour gateway.",
"operationId": "resetAPBonjourGateway",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP",
"description": "Get the AP operational and configuration data.",
"operationId": "getAP",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "operational",
"in": "query",
"description": "Include operational data in response",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP"
],
"summary": "Update AP",
"description": "Update an AP.",
"operationId": "updateAP",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseAp"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Insufficient license [ENT-10003: \"Insufficient Licenses\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10120: \"AP name must be unique per venue\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Delete AP",
"description": "Delete an AP.",
"operationId": "deleteAP",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap-group/{apGroupId}": {
"get": {
"tags": [
"AP-Group"
],
"summary": "Get AP-Group",
"description": "Get the AP-group details.",
"operationId": "getAPGroup",
"parameters": [
{
"name": "apGroupId",
"in": "path",
"description": "AP-group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApGroupDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AP-Group"
],
"summary": "Update AP-Group",
"description": "Update an AP-group.
Note: AP-Groups cannot be moved between venues, but a single AP can be moved between venues using the update AP endpoint.",
"operationId": "updateAPGroup",
"parameters": [
{
"name": "apGroupId",
"in": "path",
"description": "AP-group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApGroup"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApGroupDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP-Group"
],
"summary": "Delete AP-Group",
"description": "Delete an AP-group.",
"operationId": "deleteAPGroup",
"parameters": [
{
"name": "apGroupId",
"in": "path",
"description": "AP-group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/access-control-profile/{accessControlProfileId}": {
"get": {
"tags": [
"Access Control Profile"
],
"summary": "Get Access Control Profile",
"description": "Get an access control profile by profile identity.",
"operationId": "getAccessControlProfile",
"parameters": [
{
"name": "accessControlProfileId",
"in": "path",
"description": "Access control profile identity",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessControlProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Access Control Profile"
],
"summary": "Update Access Control Profile",
"description": "Update the specified access control profile.",
"operationId": "updateAccessControlProfile",
"parameters": [
{
"name": "accessControlProfileId",
"in": "path",
"description": "Access control profile identity",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessControlProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseAccessControlProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10176: \"Policy name must be unique\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Access Control Profile"
],
"summary": "Delete Access Control Profile",
"description": "Delete the specified access control profile.",
"operationId": "deleteAccessControlProfile",
"parameters": [
{
"name": "accessControlProfileId",
"in": "path",
"description": "Access control profile identity",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/wifi/x509-cert/validate": {
"post": {
"tags": [
"Network"
],
"summary": "Validate X509 Certificates",
"description": "Validate the X509 certificate chain issued by a trusted CA.",
"operationId": "validateX509Certificate",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrustedCAChain"
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/wifi-calling-profile": {
"get": {
"tags": [
"Wi-Fi Calling"
],
"summary": "Get Wi-Fi Calling Profiles",
"description": "Get the Wi-Fi calling profiles.",
"operationId": "getWiFiCallingProfiles",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WifiCallingProfile"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Wi-Fi Calling"
],
"summary": "Create Wi-Fi Calling Profile",
"description": "Create a new Wi-Fi calling profile.",
"operationId": "createWiFiCallingProfile",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WifiCallingProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseWifiCallingProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Wi-Fi Calling"
],
"summary": "Delete Wi-Fi Calling Profiles",
"description": "Delete a list of Wi-Fi calling profiles.",
"operationId": "deleteWiFiCallingProfilesBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of Wi-Fi Calling profile IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/vlan-pool/query": {
"post": {
"tags": [
"VLAN Pool"
],
"summary": "Query VLAN Pool",
"description": "Use this API command to get the VLAN pool list by query.",
"operationId": "getVlanPoolByQuery",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VlanPoolQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/vlan-pool": {
"get": {
"tags": [
"VLAN Pool"
],
"summary": "Get VLAN Pools",
"description": "Use this API command to get the VLAN pool list.",
"operationId": "getVlanPools",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VlanPool"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"VLAN Pool"
],
"summary": "Add VLAN Pool",
"description": "Use this API command to create a new VLAN pool.",
"operationId": "addVlanPool",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VlanPool"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVlanPool"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10129: \"VLAN Pool name must be unique\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"VLAN Pool"
],
"summary": "Query VLAN Pools",
"description": "Use this API command to delete a VLAN pool list.",
"operationId": "deleteVlanPools",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/dhcp/ap-settings": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue DHCP Service",
"description": "Get a list of this DHCP service settings of this venue.",
"operationId": "getVenueDhcpServiceApSetting",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueDhcpServiceSetting"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"AP-Venue"
],
"summary": "Update Venue DHCP Service",
"description": "Update DHCP service settings of this venue.",
"operationId": "updateVenueDhcpServiceApSetting",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueDhcpServiceSetting"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVenueDhcpServiceSetting"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/dhcp-service-profile/{dhcpServiceProfileId}": {
"post": {
"tags": [
"DHCP Service-Venue"
],
"summary": "Bind Venue DHCP Service-Profile",
"description": "Bind a DHCP service profile to a venue.",
"operationId": "bindVenueToDhcpServiceProfile",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDhcpServiceProfileVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10152: \"DHCP Service Profile and Venue mapping already exist\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"DHCP Service-Venue"
],
"summary": "Unbind Venue DHCP Service-Profile",
"description": "Unbind a DHCP service profile from a venue.",
"operationId": "unbindDhcpServiceProfileFromVenue",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/dhcp": {
"get": {
"tags": [
"DHCP Service"
],
"summary": "Get Venue DHCP Profiles",
"description": "Get a venue's DHCP service profiles.",
"operationId": "getDhcpServiceProfilesByVenue",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpServiceProfile"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"DHCP Service-Venue"
],
"summary": "Update DHCP Service-Profile Venue Bindings",
"description": "Update the DHCP service profiles bound to a venue.",
"operationId": "updateDhcpServiceProfilesBindToVenue",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListDhcpServiceProfileVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/rogue-policy/{roguePolicyId}/venue": {
"post": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Create Rogue Classification Venue Bindings",
"description": "Bind a rogue classification policy to a list of venues.",
"operationId": "bindRoguePolicyToVenues",
"parameters": [
{
"name": "roguePolicyId",
"in": "path",
"description": "Rogue classification policy ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of Venue IDs.",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListRogueClassificationPolicyVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10179: \"Policy and venue mapping already exist\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Unbind Rogue Classification Policy from Venues",
"description": "Delete the binding between a rogue classification policy and its list of venues and apply the default classification policy to those venues instead. Note that unbinding a policy from a venue does not disable rogue AP detection in that venue.",
"operationId": "unbindRoguePolicyFromVenues",
"parameters": [
{
"name": "roguePolicyId",
"in": "path",
"description": "Rogue classification policy ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of Venue IDs.",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/rogue-policy": {
"get": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Get Rogue Classification Policies",
"description": "Get a list of rogue classification policies.",
"operationId": "getRoguePolicies",
"parameters": [
{
"name": "excludeDefault",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RogueClassificationPolicy"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Create Rogue Classification Policy",
"description": "Create a rogue classification policy.",
"operationId": "addRoguePolicy",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RogueClassificationPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseRogueClassificationPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10176: \"Policy name must be unique\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Rogue Classification Policy"
],
"summary": "Delete Classification Policies",
"description": "Delete a list of rogue classification policies.",
"operationId": "deleteRoguePoliciesBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of rogue classification policy IDs.",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10174: \"Policies currently assigned to venues cannot be deleted\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network/deep": {
"post": {
"tags": [
"Network"
],
"summary": "Create Network (Deep)",
"description": "Create a new network (deep).",
"operationId": "createNetworkDeep",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetworkDeep"
},
{
"$ref": "#/components/schemas/DpskNetworkDeep"
},
{
"$ref": "#/components/schemas/GuestNetworkDeep"
},
{
"$ref": "#/components/schemas/OpenNetworkDeep"
},
{
"$ref": "#/components/schemas/PskNetworkDeep"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"aaa": "#/components/schemas/AAANetworkDeep",
"psk": "#/components/schemas/PskNetworkDeep",
"guest": "#/components/schemas/GuestNetworkDeep",
"open": "#/components/schemas/OpenNetworkDeep"
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseNetworkDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network-venue": {
"post": {
"tags": [
"Network-Venue"
],
"summary": "Create Network-Venue",
"description": "Create a new network-venue activation.",
"operationId": "createNetworkVenue",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkVenue"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseNetworkVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Network-Venue"
],
"summary": "Delete Network-Venues",
"description": "Delete a list of network-venue activation.",
"operationId": "deleteNetworkVenuesBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of network-venue IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network": {
"get": {
"tags": [
"Network"
],
"summary": "Get Networks",
"description": "Get the network list.",
"operationId": "getNetworks",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetwork"
},
{
"$ref": "#/components/schemas/DpskNetwork"
},
{
"$ref": "#/components/schemas/GuestNetwork"
},
{
"$ref": "#/components/schemas/OpenNetwork"
},
{
"$ref": "#/components/schemas/PskNetwork"
}
]
},
"discriminator": {
"propertyName": "type",
"mapping": {
"aaa": "#/components/schemas/AAANetwork",
"dpsk": "#/components/schemas/DpskNetwork",
"guest": "#/components/schemas/GuestNetwork",
"open": "#/components/schemas/OpenNetwork",
"psk": "#/components/schemas/PskNetwork"
}
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Network"
],
"summary": "Create Network",
"description": "Create a new network.",
"operationId": "createNetwork",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetwork"
},
{
"$ref": "#/components/schemas/DpskNetwork"
},
{
"$ref": "#/components/schemas/GuestNetwork"
},
{
"$ref": "#/components/schemas/OpenNetwork"
},
{
"$ref": "#/components/schemas/PskNetwork"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"aaa": "#/components/schemas/AAANetwork",
"dpsk": "#/components/schemas/DpskNetwork",
"guest": "#/components/schemas/GuestNetwork",
"open": "#/components/schemas/OpenNetwork",
"psk": "#/components/schemas/PskNetwork"
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseNetwork"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Network"
],
"summary": "Delete Networks",
"description": "Delete a list of networks.",
"operationId": "deleteNetworksBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of network IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/l3-acl-policy/query": {
"post": {
"tags": [
"L3ACL Policy"
],
"summary": "Query Layer-3 ACL",
"description": "Query layer-3 ACL profile.",
"operationId": "getL3AclPolicyByQuery",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessPolicyQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/l3-acl-policy": {
"get": {
"tags": [
"L3ACL Policy"
],
"summary": "Get Layer-3 ACL Profiles",
"description": "Get layer-3 ACL profile collection.",
"operationId": "getAllL3AclPolicies",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L3AclPolicy"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"L3ACL Policy"
],
"summary": "Add Layer-3 ACL",
"description": "Add layer-3 ACL by profile.",
"operationId": "addL3AclPolicy",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L3AclPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseL3AclPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"L3ACL Policy"
],
"summary": "Delete Layer-3 ACL Profiles",
"description": "Delete layer-3 ACL profiles.",
"operationId": "deleteBulkL3AclPolicies",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/l2-acl-policy/query": {
"post": {
"tags": [
"L2ACL Policy"
],
"summary": "Query Layer-2 ACL",
"description": "Query layer-2 ACL profile.",
"operationId": "getL2AclPolicyByQuery",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2AclPolicyQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/l2-acl-policy": {
"get": {
"tags": [
"L2ACL Policy"
],
"summary": "Get Layer-2 ACL Profiles",
"description": "Get layer-2 ACL profile collection.",
"operationId": "getAllL2AclPolicies",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2AclPolicy"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"L2ACL Policy"
],
"summary": "Add Layer-2 ACL",
"description": "Add layer-2 ACL by profile.",
"operationId": "addL2AclPolicy",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2AclPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseL2AclPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"L2ACL Policy"
],
"summary": "Delete Layer-2 ACL Profiles",
"description": "Delete layer-2 ACL profiles.",
"operationId": "deleteBulkL2AclPolicies",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/isolation-allowlist/query": {
"post": {
"tags": [
"Client Isolation Allowlist"
],
"summary": "Get Allowlists by Query",
"description": "Get the client isolation allowlists by query.",
"operationId": "GetClientIsolationAllowlistByQuery",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientIsolationAllowlistQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/isolation-allowlist": {
"get": {
"tags": [
"Client Isolation Allowlist"
],
"summary": "Get Client Isolation Allowlists",
"description": "Get the client isolation allowlists.",
"operationId": "getClientIsolationAllowlists",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientIsolationAllowlist"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Client Isolation Allowlist"
],
"summary": "Create Client Isolation Allowlist",
"description": "Create a new client isolation allowlist.",
"operationId": "createClientIsolationAllowlist",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientIsolationAllowlist"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseClientIsolationAllowlist"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Client Isolation Allowlist"
],
"summary": "Delete Isolation Allowlists",
"description": "Delete client isolation allowlists.",
"operationId": "deleteClientIsolationAllowlistsBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "Client isolation allowlist IDs.",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dpsk-passphrase/query": {
"post": {
"tags": [
"DPSK Passphrases"
],
"summary": "Query DPSK Passphrases",
"description": "Query for a list of DPSK passphrases.",
"operationId": "getDpskPassphraseByQuery",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DpskPassphraseQueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DpskPassphraseQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dpsk-passphrase/import": {
"post": {
"tags": [
"DPSK Passphrases"
],
"summary": "Import DPSK Passphrases",
"operationId": "importDpskPassphrasesFromFile",
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "networkId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "usernamePrefix",
"in": "query",
"required": false,
"schema": {
"maxLength": 190,
"minLength": 0,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDpskPassphraseImportResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"description": "Imports the DPSK passphrases provided in a CSV-formatted file."
}
},
"/api/tenant/{tenantId}/wifi/dpsk-passphrase/export": {
"post": {
"tags": [
"DPSK Passphrases"
],
"summary": "Export DPSK Passphrases",
"description": "Export all the unexpired DPSK passphrases in the database in a CSV-formatted file.",
"operationId": "exportDpskPassphrasesToCsv",
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "timezone",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "UTC"
}
},
{
"name": "date-format",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "dd/MM/yyyy HH:mm"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportDpskPassphraseQueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dpsk-passphrase": {
"get": {
"tags": [
"DPSK Passphrases"
],
"summary": "Get DPSK Passphrases",
"description": "Get the list of DPSK passphrases.",
"operationId": "getDpskPassphrases",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DpskPassphrase"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"DPSK Passphrases"
],
"summary": "Create DPSK Passphrases",
"description": "Create one or more DPSK passphrases.",
"operationId": "createDpskPassphrase",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DpskPassphraseRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDpskPassphraseRequest"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10003: \"Passphrase already exists in this DPSK network (each passphrase in the network must be unique)\", WIFI-10004: \"MAC address already exists in this DPSK network (cannot have duplicate MAC addresses in the same network)\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"DPSK Passphrases"
],
"summary": "Delete DPSK Passphrases",
"description": "Delete a list of DPSK passphrases.",
"operationId": "deleteDpskPassphrasesBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of DPSK passphrase IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/disconnect-client": {
"post": {
"tags": [
"Client Disconnect"
],
"summary": "Disconnect Clients",
"description": "Disconnect a list of clients.",
"operationId": "disconnectClient",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DisconnectClient"
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dhcp-service-profile/{dhcpServiceProfileId}/venue": {
"get": {
"tags": [
"DHCP Service-Venue"
],
"summary": "Get DHCP Venue Bindings",
"description": "Get the list of venues using a DHCP service profile.",
"operationId": "getDhcpServiceProfileVenues",
"parameters": [
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpServiceProfileVenue"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"DHCP Service-Venue"
],
"summary": "Bind DHCP Service-Profile Venues",
"description": "Bind a DHCP service profile to a list of venues.",
"operationId": "bindDhcpServiceProfileToVenues",
"parameters": [
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of venue IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListDhcpServiceProfileVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"DHCP Service-Venue"
],
"summary": "Unbind DHCP Service-Profile Venues",
"description": "Unbind a DHCP service profile from a list of venues.",
"operationId": "UnbindDhcpServiceProfileFromVenues",
"parameters": [
{
"name": "dhcpServiceProfileId",
"in": "path",
"description": "DHCP Service-Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of venue IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dhcp-service-profile": {
"get": {
"tags": [
"DHCP Service"
],
"summary": "Get DHCP Service-Profiles",
"description": "Get list of DHCP service-profiles.",
"operationId": "getDhcpServiceProfiles",
"parameters": [
{
"name": "excludeDefault",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpServiceProfile"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"DHCP Service"
],
"summary": "Create DHCP Service-Profile",
"description": "Create a new DHCP service-profile.",
"operationId": "addDhcpServiceProfile",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServiceProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDhcpServiceProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"DHCP Service"
],
"summary": "Delete DHCP Service-Profiles",
"description": "Delete a list of DHCP service-profiles.",
"operationId": "deleteDhcpServiceProfilesBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of DHCP service-profile IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/device-policy/query": {
"post": {
"tags": [
"Device Policy"
],
"summary": "Get Device-Policies",
"description": "Get the device-policy list.",
"operationId": "getDevicePolicies",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessPolicyQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/device-policy": {
"get": {
"tags": [
"Device Policy"
],
"summary": "Get All Device Policies",
"description": "Get the device-policy collection.",
"operationId": "getAllDevicePolicies",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePolicy"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Device Policy"
],
"summary": "Create Device-Policy",
"description": "Create a new device-policy.",
"operationId": "addDevicePolicy",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DevicePolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseDevicePolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Device Policy"
],
"summary": "Delete Device-Policies",
"description": "Delete a list of device-policies.",
"operationId": "deleteDevicePoliciesBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of device-policy IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/cloudpath": {
"get": {
"tags": [
"Cloudpath"
],
"summary": "Get Cloudpath Servers",
"description": "Get a list of Cloudpath servers.",
"operationId": "getCloudpathServers",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CloudpathServer"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Cloudpath"
],
"summary": "Add Cloudpath Server",
"description": "Add a new Cloudpath server.",
"operationId": "addCloudpathServer",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudpathServer"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseCloudpathServer"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Cloudpath"
],
"summary": "Delete Cloudpath Servers",
"description": "Delete a list of Cloudpath servers.",
"operationId": "deleteCloudpathServers",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/application-policy/query": {
"post": {
"tags": [
"Application Policy"
],
"summary": "Query Application Policy",
"description": "Use this API command to get the application policy list by query.",
"operationId": "getApplicationPolicyByQuery",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationPolicyQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/application-policy": {
"get": {
"tags": [
"Application Policy"
],
"summary": "Get Application Policies",
"description": "Use this API command to get the application policy list.",
"operationId": "getApplicationPolicies",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationPolicy"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Application Policy"
],
"summary": "Add Application Policy",
"description": "Use this API command to create a new application policy.",
"operationId": "addApplicationPolicy",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationPolicy"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApplicationPolicy"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Application Policy"
],
"summary": "Delete Application Policies",
"description": "Use this API command to delete an application policy list.",
"operationId": "deleteApplicationPolicies",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/trace-route": {
"post": {
"tags": [
"AP"
],
"summary": "Trace-Route AP",
"description": "Perform a trace-route on an AP.",
"operationId": "traceRouteAP",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApTraceRouteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApTraceRouteResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/reboot": {
"post": {
"tags": [
"AP"
],
"summary": "Reboot AP",
"description": "Reboot an AP.",
"operationId": "rebootAP",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/ping": {
"post": {
"tags": [
"AP"
],
"summary": "Ping AP",
"description": "Command requesting this AP ping a host on the network.",
"operationId": "pingAP",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApPingRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApPingResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/packet-capture": {
"get": {
"tags": [
"AP"
],
"summary": "Get Packet Capture State",
"description": "Get packet capture state.",
"operationId": "getPacketCaptureState",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"AP"
],
"summary": "Start Packet Capture",
"description": "Start packet capture.",
"operationId": "startPacketCapture",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApPacketCaptureStartRequest"
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Stop Packet Capture",
"description": "Stop packet capture.",
"operationId": "stopPacketCapture",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "serialNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/factory-reset": {
"post": {
"tags": [
"AP"
],
"summary": "Factory Reset AP",
"description": "Perform a factory reset on an AP.",
"operationId": "factoryResetAP",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/blink-led": {
"post": {
"tags": [
"AP"
],
"summary": "Blink LED AP",
"description": "Blink an AP's LED lights.",
"operationId": "blinkLedAp",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApBlinkLedResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/dhcp-ap": {
"post": {
"tags": [
"AP"
],
"summary": "Get APs DHCP Configurations",
"description": "Get a list of AP DHCP configurations by AP serial number.",
"operationId": "getDhcpAp",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of AP serial-numbers",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListDhcpApInfo"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap-group": {
"get": {
"tags": [
"AP-Group"
],
"summary": "Get AP-Groups",
"description": "Get the AP-group list.",
"operationId": "getApGroups",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApGroupDeep"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"AP-Group"
],
"summary": "Create AP-Group",
"description": "Create a new AP-group.",
"operationId": "createAPGroup",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApGroup"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseApGroupDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP-Group"
],
"summary": "Delete AP-Groups",
"description": "Delete a list of AP-groups.",
"operationId": "deleteAPGroupsBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of AP-group IDs",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap": {
"get": {
"tags": [
"AP"
],
"summary": "Get APs",
"description": "Get the AP list.",
"operationId": "getAps",
"parameters": [
{
"name": "operational",
"in": "query",
"description": "Include operational data in response",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ap"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"AP"
],
"summary": "Add APs",
"description": "Add a list of new APs.",
"operationId": "addAps_1",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseListAp"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Insufficient license [ENT-10003: \"Insufficient Licenses\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10120: \"AP name must be unique per venue\", WIFI-10130: \"AP serial-number already registered\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AP"
],
"summary": "Delete APs",
"description": "Delete a list of APs.",
"operationId": "deleteApsBulk",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of AP serial-numbers",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/access-control-profile/query": {
"post": {
"tags": [
"Access Control Profile"
],
"summary": "Query Access Control Profiles",
"description": "Get access control profiles by query.",
"operationId": "getAccessControlProfileByQuery",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessControlProfileQueryResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/access-control-profile": {
"get": {
"tags": [
"Access Control Profile"
],
"summary": "Get All Access Control Profiles",
"description": "Get all access control profiles.",
"operationId": "getAllAccessControlProfiles",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessControlProfile"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Access Control Profile"
],
"summary": "Add Access Control Profile",
"description": "Add an access control profile.",
"operationId": "addAccessControlProfile",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessControlProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseAccessControlProfile"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict [WIFI-10176: \"Policy name must be unique\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Access Control Profile"
],
"summary": "Delete Multiple Access Control Profiles",
"description": "Delete multiple access control profiles by profile identities.",
"operationId": "deleteBulkAccessControlProfiles",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/venue-network": {
"get": {
"tags": [
"Network-Venue"
],
"summary": "Get Venue-Network Activation",
"description": "Get venue-network activation list.",
"operationId": "getVenueNetworks",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkVenue"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/valid-channels": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue Default Regulatory-Channels",
"description": "Get venue default regulatory channels.",
"operationId": "getVenueDefaultRegulatoryChannels",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueRegulatoryChannels"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/radio/default": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Default Radio",
"description": "Get the venue radio default values.",
"operationId": "getDefaultRadio",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueRadioCustomization"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/dhcp/usage": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue DHCP Pools",
"description": "Get a list of DHCP pool usage of the venue.",
"operationId": "getDhcpPoolUsageByVenue",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpServiceProfileUsage"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/dhcp/client": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue DHCP Leases",
"description": "Get a list of DHCP leases of the venue.",
"operationId": "getDhcpLeaseByVenue",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpClientLeaseTime"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/default-ap-group": {
"get": {
"tags": [
"AP-Group"
],
"summary": "Get Venue Default AP-Group",
"description": "Get venue default AP-group details.",
"operationId": "getVenueDefaultAPGroup",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApGroupDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}/ap-group": {
"get": {
"tags": [
"AP-Group"
],
"summary": "Get AP-Groups by Venue",
"description": "Get the AP-group list by venue.",
"operationId": "getAPGroupsByVenue",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApGroupDeep"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue/{venueId}": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venue",
"description": "Get the venue Wi-Fi details.",
"operationId": "getVenue",
"parameters": [
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Venue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/venue": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Venues",
"description": "Get the venue list of Wi-Fi details.",
"operationId": "getVenues",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Venue"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network/{networkId}/venue/{venueId}/network-venue": {
"get": {
"tags": [
"Network-Venue"
],
"summary": "Get Network-Venue Activation",
"description": "Get a network-venue activation by network and venue.",
"operationId": "getNetworkVenueByNetworkAndVenue",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkVenue"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network/{networkId}/network-venue": {
"get": {
"tags": [
"Network-Venue"
],
"summary": "Get Network-Venues Activation",
"description": "Get network-venue activation list.",
"operationId": "getNetworkVenues",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkVenue"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network/external-providers": {
"get": {
"tags": [
"Network"
],
"summary": "Get External WISPr Providers",
"description": "Get the list of external WISPr providers for a captive portal network. Note: these providers have integrated their service with the RUCKUS cloud.",
"operationId": "getExternalProviders",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalProviders"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/network/dpsk": {
"get": {
"tags": [
"Network"
],
"summary": "Get DPSK Passphrase Formats",
"description": "Get the DPSK passphrase format list.",
"operationId": "getNetworkDpskPassphraseFormat",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DpskNetworkPassphraseGeneration"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/lte-band": {
"get": {
"tags": [
"AP-Venue"
],
"summary": "Get Available LTE Bands",
"description": "Get available LTE bands for each region.",
"operationId": "getAvailableLteBands",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableLteBands"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dpsk-passphrase/count": {
"get": {
"tags": [
"DPSK Passphrases"
],
"summary": "Count DPSK Passphrases",
"description": "Get a count of DPSK passphrases in the database.",
"operationId": "countDpskPassphrases",
"parameters": [
{
"name": "active",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DpskPassphraseCount"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/cloudpath/{cloudpathServerId}/connection": {
"get": {
"tags": [
"Cloudpath"
],
"summary": "Test Cloudpath Server Connection",
"description": "Test the connection to this Cloudpath server. Note: for on-premise deployments, the network using the Cloudpath server must be activated on the venue for this command to work properly.",
"operationId": "testCloudpathServerConnection",
"parameters": [
{
"name": "cloudpathServerId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestCloudpathConnectionResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/valid-channel": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP Regulatory Channels",
"description": "Get this AP's regulatory channels. Note: these channel numbers are specific to the country in which the AP is deployed.",
"operationId": "getValidChannelsBySerialNumber",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "AP serialNumber",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VenueRegulatoryChannels"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/download-log": {
"get": {
"tags": [
"AP"
],
"summary": "Download AP Log",
"description": "Download the AP log file.",
"operationId": "downloadAPLog",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApDownloadLog"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp/usage": {
"get": {
"tags": [
"AP"
],
"summary": "Get DHCP Pool Usages",
"description": "Get DHCP pool usage.",
"operationId": "getDhcpPoolUsages",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpServiceProfileUsage"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/dhcp/client": {
"get": {
"tags": [
"AP"
],
"summary": "Get DHCP Leases",
"description": "Get the IP address leases issued by the DHCP server instance running on this AP.",
"operationId": "getDhcpLeaseTimes",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpClientLeaseTime"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap/{serialNumber}/deep": {
"get": {
"tags": [
"AP"
],
"summary": "Get AP (Deep)",
"description": "Get the AP operational and configuration data, including nested details.",
"operationId": "getApDeep",
"parameters": [
{
"name": "serialNumber",
"in": "path",
"description": "The serial number of the AP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/ap-group/{apGroupId}/ap": {
"get": {
"tags": [
"AP"
],
"summary": "Get APs by AP-Group",
"description": "Get the APs in the AP-group.",
"operationId": "getApsByAPGroup",
"parameters": [
{
"name": "apGroupId",
"in": "path",
"description": "AP-group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ap"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/dpsk-passphrase/{dpskPassphraseId}": {
"delete": {
"tags": [
"DPSK Passphrases"
],
"summary": "Delete DPSK Passphrase",
"description": "Delete this DPSK passphrase.",
"operationId": "deleteDpskPassphrase",
"parameters": [
{
"name": "dpskPassphraseId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/tenant/{tenantId}/wifi/guest-user": {
"get": {
"tags": [
"Guest User"
],
"summary": "Get Guest-users",
"description": "Get user details for the list of provisioned guest users.",
"operationId": "GetGuestUsers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page index",
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "1"
}
},
{
"name": "size",
"in": "query",
"description": "The size of the page to be returned",
"allowEmptyValue": false,
"schema": {
"type": "string",
"default": "50"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageResponseOfGuestUser"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Guest User"
],
"summary": "Add Guest-users",
"description": "Provision one or more guest users as defined in the payload.",
"operationId": "AddGuestUsers",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "guestsPayload",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuestUser"
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfstring"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "guestsPayload"
},
"delete": {
"tags": [
"Guest User"
],
"summary": "Delete Guest-users",
"description": "Delete one or more guest users per their IDs as defined in the payload.",
"operationId": "DeleteGuestUsersByIds",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "ids",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "ids"
}
},
"/api/tenant/{tenantId}/wifi/guest-user/import": {
"post": {
"tags": [
"Guest User"
],
"summary": "Import Guest-users",
"description": "Import one or more guest pass users from the payload's CSV file.",
"operationId": "ImportGuestUsers",
"parameters": [
{
"name": "deliveryMethods",
"in": "query",
"description": "At least one delivery method.",
"allowEmptyValue": false,
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"MAIL",
"SMS",
"STUB",
"PRINT"
]
},
"enum": [
"MAIL",
"SMS",
"STUB",
"PRINT"
]
}
},
{
"name": "expiration.activationType",
"in": "query",
"description": "When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.",
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"Creation",
"Login"
]
}
},
{
"name": "expiration.duration",
"in": "query",
"description": "expiration.duration",
"required": true,
"schema": {
"maximum": 8760,
"exclusiveMaximum": false,
"minimum": 1,
"exclusiveMinimum": false,
"type": "integer",
"format": "int32"
}
},
{
"name": "expiration.unit",
"in": "query",
"description": "expiration.unit",
"required": true,
"schema": {
"type": "string",
"enum": [
"Minute",
"Hour",
"Day",
"Week",
"Month",
"Year",
"Never"
]
}
},
{
"name": "maxDevices",
"in": "query",
"description": "Maximum number of devices the guest user can simultaneously connect to the guest network. If set to -1, no limit is enforced.",
"allowEmptyValue": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "networkId",
"in": "query",
"description": "Network ID of the guest network to which the guest user will connect.",
"allowEmptyValue": false,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"description": "file",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfGuestUserImport"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}": {
"get": {
"tags": [
"Guest User"
],
"summary": "Get Guest-user by ID",
"description": "Get a guest user.",
"operationId": "GetGuestUserById",
"parameters": [
{
"name": "guestUserId",
"in": "path",
"description": "guestUserId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuestUser"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Guest User"
],
"summary": "Delete Guest-user by ID",
"description": "Delete a guest user.",
"operationId": "DeleteGuestUserById",
"parameters": [
{
"name": "guestUserId",
"in": "path",
"description": "guestUserId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/disable": {
"post": {
"tags": [
"Guest User"
],
"summary": "Disable Guest-user by ID",
"description": "Disable an enabled guest user.",
"operationId": "DisableGuestUserById",
"parameters": [
{
"name": "guestUserId",
"in": "path",
"description": "guestUserId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/enable": {
"post": {
"tags": [
"Guest User"
],
"summary": "Enable Guest-user by ID",
"description": "Enable a previously disabled guest user.",
"operationId": "EnableGuestUserById",
"parameters": [
{
"name": "guestUserId",
"in": "path",
"description": "guestUserId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/wifi/guest-user/{guestUserId}/regenerate": {
"post": {
"tags": [
"Guest User"
],
"summary": "Regenerate Guest-user Credential",
"description": "Create new password for the guest user. Note: only password hash is saved (not the actual password), so the original password cannot be retrieved.",
"operationId": "RegenerateCredentialByGuestUserId",
"parameters": [
{
"name": "guestUserId",
"in": "path",
"description": "guestUserId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "At least one delivery method.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"MAIL",
"SMS",
"STUB",
"PRINT"
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfGuestUser"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "deliveryMethods"
}
},
"/api/tenant/{tenantId}/wifi/client": {
"get": {
"tags": [
"View"
],
"summary": "Get Clients",
"description": "Get client (i.e., end-user devices) parameters and operational data.",
"operationId": "Get Clients",
"parameters": [
{
"name": "apSerialNumber",
"in": "query",
"description": "apSerialNumber",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "page",
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "size",
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Client"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/wifi/client/{mac}": {
"get": {
"tags": [
"View"
],
"summary": "Get Client by MAC",
"description": "Get extended set of parameters and operational data for the client having this MAC address.",
"operationId": "GetClientbyMAC",
"parameters": [
{
"name": "mac",
"in": "path",
"description": "mac",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientDeep"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/viewmodel/tenant/{tenantId}/guests": {
"post": {
"tags": [
"View"
],
"summary": "Get Guests",
"description": "Get guests.",
"operationId": "Get Guests",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "payload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicQueryPayloadDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponseOfGuestDto"
}
}
}
},
"400": {
"description": "Invalid tenantId supplied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "Tenant ID not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"501": {
"description": "Not implemented",
"content": {}
}
},
"deprecated": false,
"x-codegen-request-body-name": "payload"
}
},
"/api/viewmodel/tenant/{tenantId}/venue/{venueId}/ap-models": {
"get": {
"tags": [
"View"
],
"summary": "Get Venue AP Models",
"description": "Get the AP models deployed in this venue.",
"operationId": "Get Venue AP Models",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatedDeviceModelDto"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "Requested resource or related-entity not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/viewmodel/tenant/{tenantId}/venue/{venueId}/rogue/ap": {
"post": {
"tags": [
"View"
],
"summary": "Get Rogue APs",
"description": "Get the rogue APs detected in this venue.",
"operationId": "Get Venue Rogue APs",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "Venue ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "payload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicQueryPayloadDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponseOfRogueApDto"
}
}
}
},
"400": {
"description": "Invalid tenant_id supplied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "Tenant ID not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"501": {
"description": "Not implemented",
"content": {}
}
},
"deprecated": false,
"x-codegen-request-body-name": "payload"
}
},
"/api/viewmodel/{tenantId}/aps": {
"post": {
"tags": [
"View"
],
"summary": "Get APs",
"description": "Get parameters and operational data for a list of APs.",
"operationId": "Get APs",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "payload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicQueryPayloadDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponseOfDeviceDto"
}
}
}
},
"400": {
"description": "Invalid tenant_id supplied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "tenant_id not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "payload"
}
},
"/api/viewmodel/{tenantId}/aps/mesh": {
"post": {
"tags": [
"View"
],
"summary": "Get Mesh APs",
"description": "Get parameters and operational data for a list of mesh APs.",
"operationId": "Get Mesh APs",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "payload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicQueryPayloadDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponseOfDeviceDto"
}
}
}
},
"400": {
"description": "Invalid tenant_id supplied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "tenant_id not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "payload"
}
},
"/api/viewmodel/{tenantId}/cloudpath": {
"post": {
"tags": [
"View"
],
"summary": "Get Cloudpath Servers",
"description": "Get a list of Cloudpath server information.",
"operationId": "Cloudpath server",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "payload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicQueryPayloadDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponseOfCloudpathServerDto"
}
}
}
},
"400": {
"description": "Invalid tenant ID supplied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"404": {
"description": "tenant ID not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"423": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"500": {
"description": "internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "payload"
}
}
},
"components": {
"schemas": {
"Epdg": {
"required": [
"domain"
],
"type": "object",
"properties": {
"ip": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"domain": {
"pattern": "(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\\b((?=[A-Za-z0-9-]{1,63}\\.)(xn--)?[A-Za-z0-9]+(-[A-Za-z0-9]+)*\\.)+[A-Za-z]{2,63}\\b)$)",
"type": "string"
}
},
"description": "Information of ePDG"
},
"WifiCallingProfile": {
"required": [
"ePDGs",
"profileName"
],
"type": "object",
"properties": {
"profileName": {
"maxLength": 32,
"minLength": 2,
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 180,
"minLength": 2,
"type": "string"
},
"qosPriority": {
"type": "string",
"default": "QosPriorityEnum.WIFICALLING_PRI_VOICE",
"enum": [
"WIFICALLING_PRI_VOICE",
"WIFICALLING_PRI_VIDEO",
"WIFICALLING_PRI_BE",
"WIFICALLING_PRI_BG"
]
},
"id": {
"type": "string",
"readOnly": true
},
"ePDGs": {
"maxItems": 5,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Epdg"
}
}
},
"description": "Wi-Fi calling profile configuration"
},
"OperationResponseWifiCallingProfile": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/WifiCallingProfile"
}
}
},
"VlanPool": {
"required": [
"name",
"vlanMembers"
],
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"readOnly": true
},
"name": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"description": {
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"vlanMembers": {
"maxItems": 16,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "VLAN pool"
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"object": {
"type": "string"
},
"value": {
"type": "object"
}
},
"title": "Error"
},
"ErrorResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"downloadUrl": {
"type": "string"
}
},
"title": "ErrorResponse"
},
"OperationResponseVlanPool": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/VlanPool"
}
}
},
"VenueSyslog": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"server": {
"pattern": "(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\\.[a-zA-Z]{2,3})$)",
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 514
},
"facility": {
"type": "string",
"default": "FacilityEnum.KEEP_ORIGINAL",
"enum": [
"KEEP_ORIGINAL",
"LOCAL0",
"LOCAL1",
"LOCAL2",
"LOCAL3",
"LOCAL4",
"LOCAL5",
"LOCAL6",
"LOCAL7"
]
},
"priority": {
"type": "string",
"default": "PriorityEnum.INFO",
"enum": [
"EMERGENCY",
"ALERT",
"CRITICAL",
"ERROR",
"WARNING",
"NOTICE",
"INFO",
"ALL"
]
},
"protocol": {
"type": "string",
"default": "ProtocolEnum.UDP",
"enum": [
"TCP",
"UDP"
]
},
"flowLevel": {
"type": "string",
"default": "FlowLevelEnum.CLIENT_FLOW",
"enum": [
"GENERAL_LOGS",
"CLIENT_FLOW",
"ALL"
]
},
"secondaryServer": {
"pattern": "(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(([a-zA-Z]{1})|([a-zA-Z]{1}[a-zA-Z]{1})|([a-zA-Z]{1}[0-9]{1})|([0-9]{1}[a-zA-Z]{1})|([a-zA-Z0-9][a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]))\\.([a-zA-Z]{2,6}|[a-zA-Z0-9-]{2,30}\\.[a-zA-Z]{2,3})$)",
"type": "string"
},
"secondaryPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 514
},
"secondaryProtocol": {
"type": "string",
"default": "ProtocolEnum.TCP",
"enum": [
"TCP",
"UDP"
]
}
},
"description": "Venue syslog"
},
"OperationResponseVenueSyslog": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/VenueSyslog"
}
}
},
"VenueRogueAp": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"reportThreshold": {
"maximum": 100,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"roguePolicyId": {
"type": "string"
}
},
"description": "Rogue Ap configuration for venue."
},
"OperationResponseVenueRogueAp": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/VenueRogueAp"
}
}
},
"RadioParams24G": {
"type": "object",
"properties": {
"allowedChannels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13"
]
}
},
"channelBandwidth": {
"type": "string",
"default": "ChannelBandwidth24GEnum.AUTO",
"enum": [
"AUTO",
"20MHz",
"40MHz"
]
},
"method": {
"type": "string",
"default": "ScanMethodEnum.BACKGROUND_SCANNING",
"enum": [
"MANUAL",
"BACKGROUND_SCANNING",
"CHANNELFLY"
]
},
"changeInterval": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 33
},
"scanInterval": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 20
},
"txPower": {
"type": "string",
"default": "TxPowerEnum.MAX",
"enum": [
"Auto",
"MAX",
"-1",
"-2",
"-3",
"-4",
"-5",
"-6",
"-7",
"-8",
"-9",
"-10",
"MIN"
]
}
},
"description": "Radio customization for 2.4GHz."
},
"RadioParams50G": {
"type": "object",
"properties": {
"allowedIndoorChannels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
},
"allowedOutdoorChannels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
},
"channelBandwidth": {
"type": "string",
"default": "ChannelBandwidth5GEnum.AUTO",
"enum": [
"AUTO",
"20MHz",
"40MHz",
"80MHz",
"160MHz"
]
},
"method": {
"type": "string",
"default": "ScanMethodEnum.BACKGROUND_SCANNING",
"enum": [
"MANUAL",
"BACKGROUND_SCANNING",
"CHANNELFLY"
]
},
"changeInterval": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 33
},
"scanInterval": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 20
},
"txPower": {
"type": "string",
"default": "TxPowerEnum.MAX",
"enum": [
"Auto",
"MAX",
"-1",
"-2",
"-3",
"-4",
"-5",
"-6",
"-7",
"-8",
"-9",
"-10",
"MIN"
]
}
},
"description": "Radio customization for 5GHz."
},
"VenueRadioCustomization": {
"type": "object",
"properties": {
"radioParams24G": {
"$ref": "#/components/schemas/RadioParams24G"
},
"radioParams50G": {
"$ref": "#/components/schemas/RadioParams50G"
}
},
"description": "Venue radio customization"
},
"OperationResponseVenueRadioCustomization": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/VenueRadioCustomization"
}
}
},
"Mesh": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
}
},
"description": "Venue mesh"
},
"OperationResponseMesh": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/Mesh"
}
}
},
"ApModelLed": {
"type": "object",
"properties": {
"ledEnabled": {
"type": "boolean",
"default": false
},
"model": {
"maxLength": 64,
"minLength": 0,
"type": "string"
}
},
"description": "Venue AP-model specific attribute"
},
"OperationResponseListApModelLed": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelLed"
}
}
}
},
"ApModelLanPort": {
"type": "object",
"properties": {
"lanPorts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VenueLanPort"
}
},
"model": {
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"poeOut": {
"type": "boolean",
"default": false
},
"poeMode": {
"type": "string",
"enum": [
"Auto",
"802.3af",
"802.3at",
"802.3bt-Class_5",
"802.3bt-Class_6",
"802.3bt-Class_7",
"802.3bt-Class_8"
]
}
},
"description": "Venue AP-model specific attribute"
},
"VenueLanPort": {
"required": [
"type",
"untagId",
"vlanMembers"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ACCESS",
"GENERAL",
"TRUNK"
]
},
"untagId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"vlanMembers": {
"pattern": "^(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4])(?: *- *(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4]))?(?: *, *(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4])(?: *- *(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4]))?)*$",
"type": "string"
},
"portId": {
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
}
},
"description": "Venue LAN-port"
},
"OperationResponseListApModelLanPort": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelLanPort"
}
}
}
},
"ApModelExternalAntenna": {
"type": "object",
"properties": {
"enable24G": {
"type": "boolean",
"default": false
},
"enable50G": {
"type": "boolean",
"default": false
},
"gain24G": {
"maximum": 60,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"gain50G": {
"maximum": 60,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"model": {
"maxLength": 64,
"minLength": 0,
"type": "string"
}
},
"description": "Venue AP-model specific attribute"
},
"OperationResponseListApModelExternalAntenna": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApModelExternalAntenna"
}
}
}
},
"DenialOfServiceProtection": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"blockingPeriod": {
"maximum": 600,
"minimum": 30,
"type": "integer",
"format": "int32",
"default": 60
},
"failThreshold": {
"maximum": 25,
"minimum": 2,
"type": "integer",
"format": "int32",
"default": 5
},
"checkPeriod": {
"maximum": 600,
"minimum": 30,
"type": "integer",
"format": "int32",
"default": 30
}
},
"description": "This feature hinders a client (end-user device) from originating a DoS attack on an authentication server."
},
"OperationResponseDenialOfServiceProtection": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/DenialOfServiceProtection"
}
}
},
"LteBandLockChannel": {
"required": [
"region"
],
"type": "object",
"properties": {
"band3G": {
"type": "array",
"items": {
"type": "string"
}
},
"band4G": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "string",
"enum": [
"DOMAIN_1",
"DOMAIN_2",
"USA_CANADA",
"JAPAN"
]
}
},
"description": "LTE band lock channel settings."
},
"SimSettings": {
"required": [
"networkSelection"
],
"type": "object",
"properties": {
"lteBands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LteBandLockChannel"
}
},
"enabled": {
"type": "boolean",
"default": true
},
"apn": {
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$",
"type": "string"
},
"roaming": {
"type": "boolean",
"default": true
},
"networkSelection": {
"type": "string",
"enum": [
"AUTO",
"LTE",
"ThreeG"
]
}
},
"description": "SIM setting object."
},
"VenueApModelCellular": {
"required": [
"primaryWanRecoveryTimer",
"wanConnection"
],
"type": "object",
"properties": {
"model": {
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"primarySim": {
"$ref": "#/components/schemas/SimSettings"
},
"secondarySim": {
"$ref": "#/components/schemas/SimSettings"
},
"wanConnection": {
"type": "string",
"enum": [
"ETH_WITH_CELLULAR_FAILOVER",
"CELLULAR_WITH_ETH_FAILOVER",
"ETH",
"CELLULAR"
]
},
"primaryWanRecoveryTimer": {
"maximum": 300,
"minimum": 10,
"type": "integer",
"format": "int32"
}
},
"description": "Venue cellular settings"
},
"OperationResponseVenueApModelCellular": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/VenueApModelCellular"
}
}
},
"IdAndName": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Entity ID and name"
},
"RogueClassificationPolicy": {
"required": [
"name"
],
"type": "object",
"properties": {
"venues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdAndName"
}
},
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RogueClassificationPolicyRule"
}
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Rogue classification policy."
},
"RogueClassificationPolicyRule": {
"required": [
"classification",
"name",
"priority",
"type"
],
"type": "object",
"properties": {
"moreInfo": {
"type": "string",
"description": "Used to communicate additional information about the rogue AP. This parameter’s value is dependent on the rogue classification policy rule used."
},
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"type": {
"type": "string",
"description": "| ENUM | Meaning |\n |-|-|\n | ExcessivePowerRule | Rule classifying as rogue an AP whose transmissions are being received above a certain SNR threshold. The default SNR threshold is 90 dB. |\n | CustomSsidRule| Custom rule to classify an AP which is broadcasting an SSID matching the one provided by this rule. |\n | CustomSnrRule | Custom rule to classify an AP whose frames are received at an SNR below the threshold provided by this rule. |\n | CustomMacOuiRule | Custom rule to classify an AP which is broadcasting a BSSID OUI (i.e. an organizationally unique identifier, the first 3 bytes of the MAC address) matching the one provided by this rule. |\n | AdHocRule | Rule classifying ad hoc networks as rogue networks. An ad hoc network, also known as an Independent Basic Service Set (IBSS) is one in which the transmitting stations are not in infrastructure mode (i.e., they don’t have a wired network connection). |\n | SsidSpoofingRule | Rule classifying as rogue an AP which is broadcasting the same SSID as one of the WLANs in the venue but is not managed by the cloud. |\n | MacSpoofingRule | Rule classifying as rogue an AP which is broadcasting the same BSSID (AP MAC address) as one of the WLANs in the venue but is not managed by the cloud. |\n | CTSAbuseRule | Rule classifying as rogue an AP which is transmitting to a specific receiver MAC address more CTS (clear to send) frames/second than the detection threshold (the default threshold is 50 frames/second). |\n | RTSAbuseRule | Rule classifying as rogue an AP which is transmitting to a specific receiver MAC address more RTS (request to send) frames/second than the detection threshold (the default threshold is 50 frames/second). |\n | DeauthFloodRule | Rule classifying as rogue an AP which is transmitting more Deauthentication frames/second than the detection threshold (the default threshold is 50 frames/second). |\n | DisassocFloodRule | Rule classifying as rogue an AP which is transmitting more Disassociation frames/second than the detection threshold (the default threshold is 50 frames/second). |\n | NullSSIDRule | Rule classifying as rogue an AP which is broadcasting a null SSID. |\n | SameNetworkRule | Rule classifying as rogue an AP whose MAC address received via an Ethernet interface matches the upper 2 bytes of a rogue AP’s BSSID (MAC address) and its lower 4 bytes in all but 2 bit locations. |",
"enum": [
"AdhocRule",
"SsidSpoofingRule",
"MacSpoofingRule",
"SameNetworkRule",
"CTSAbuseRule",
"RTSAbuseRule",
"DeauthFloodRule",
"DisassocFloodRule",
"ExcessivePowerRule",
"NullSSIDRule",
"CustomSsidRule",
"CustomSnrRule",
"CustomMacOuiRule"
]
},
"classification": {
"type": "string",
"description": "| ENUM | Meaning |\n |-|-|\n | Known | Identified and permitted devices. examples include hot spots in allowed areas, permitted secondary networks installed by local users, temporary venue use, etc. |\n | Malicious | Identified and un-permitted devices. examples include unauthorized hot spots, unapproved secondary networks installed by local users, nefarious users trying to spoof traffic or steal data, etc. |\n | Ignore | Identified and ignored devices. examples include known wireless from adjacent buildings, \"built-in\" carrier provided wireless like Xfinity or COX, etc. |\n | Unclassified | Unidentified devices that have not been classified by policy or by admin. This is the default class. |",
"enum": [
"Ignored",
"Known",
"Unclassified",
"Malicious"
]
},
"priority": {
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
"description": "Rogue classification policy rule."
},
"OperationResponseRogueClassificationPolicy": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/RogueClassificationPolicy"
}
}
},
"RecoveryPsk": {
"type": "object",
"properties": {
"psk": {
"pattern": "^([0-9]{4}){4}$",
"type": "string"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"obsolete": {
"type": "boolean",
"default": false
}
},
"description": "PSK of the recovery network."
},
"OperationResponseRecoveryPsk": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/RecoveryPsk"
}
}
},
"AAANetworkDeep": {
"required": [
"name",
"wlan"
],
"type": "object",
"description": "AAA Wi-Fi network (deep)",
"allOf": [
{
"$ref": "#/components/schemas/NetworkDeep"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/AAAWlan"
},
"authRadius": {
"$ref": "#/components/schemas/Radius"
},
"accountingRadius": {
"$ref": "#/components/schemas/Radius"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"enableAuthProxy": {
"type": "boolean",
"default": false
},
"enableAccountingProxy": {
"type": "boolean",
"default": false
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"AAAWlan": {
"required": [
"ssid"
],
"type": "object",
"properties": {
"wlanSecurity": {
"type": "string",
"default": "AAAWlanSecurityEnum.WPA2Enterprise",
"enum": [
"WPA2Enterprise",
"WPA3"
]
},
"advancedCustomization": {
"$ref": "#/components/schemas/AAAWlanAdvancedCustomization"
},
"managementFrameProtection": {
"type": "string",
"enum": [
"Disabled",
"Optional",
"Required"
]
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"ssid": {
"pattern": "[^`\\s]([^`\\t\\r\\n]){0,30}[^`\\s]",
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
},
"bypassCPUsingMacAddressAuthentication": {
"type": "boolean",
"default": false
},
"bypassCNA": {
"type": "boolean",
"default": false
}
},
"description": "WLAN"
},
"AAAWlanAdvancedCustomization": {
"type": "object",
"properties": {
"devicePolicyId": {
"type": "string"
},
"l2AclPolicyId": {
"type": "string"
},
"l3AclPolicyId": {
"type": "string"
},
"applicationPolicyId": {
"type": "string"
},
"accessControlProfileId": {
"type": "string"
},
"userUplinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"userDownlinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalUplinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalDownlinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"maxClientsOnWlanPerRadio": {
"maximum": 512,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
},
"enableBandBalancing": {
"type": "boolean",
"default": true
},
"clientIsolation": {
"type": "boolean",
"default": false
},
"clientIsolationOptions": {
"$ref": "#/components/schemas/ClientIsolationOptions"
},
"hideSsid": {
"type": "boolean",
"default": false
},
"forceMobileDeviceDhcp": {
"type": "boolean",
"default": false
},
"clientLoadBalancingEnable": {
"type": "boolean",
"default": true
},
"enableAaaVlanOverride": {
"type": "boolean",
"default": true
},
"directedThreshold": {
"maximum": 128,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 5
},
"enableNeighborReport": {
"type": "boolean",
"default": true
},
"enableFastRoaming": {
"type": "boolean",
"default": false
},
"mobilityDomainId": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"radioCustomization": {
"$ref": "#/components/schemas/WlanRadioCustomization"
},
"enableSyslog": {
"type": "boolean",
"default": false
},
"clientInactivityTimeout": {
"maximum": 86400,
"minimum": 60,
"type": "integer",
"format": "int32",
"default": 120
},
"accessControlEnable": {
"type": "boolean",
"default": false
},
"respectiveAccessControl": {
"type": "boolean",
"default": true
},
"vlanPool": {
"$ref": "#/components/schemas/VlanPool"
},
"applicationPolicyEnable": {
"type": "boolean",
"default": false
},
"l2AclEnable": {
"type": "boolean",
"default": false
},
"l3AclEnable": {
"type": "boolean",
"default": false
},
"wifiCallingEnabled": {
"type": "boolean",
"default": false
},
"wifiCallingIds": {
"maxItems": 5,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"singleSessionIdAccounting": {
"type": "boolean",
"default": false
},
"proxyARP": {
"type": "boolean",
"default": false
},
"enableAirtimeDecongestion": {
"type": "boolean",
"default": false
},
"enableJoinRSSIThreshold": {
"type": "boolean",
"default": false
},
"joinRSSIThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -85
},
"enableTransientClientManagement": {
"type": "boolean",
"default": false
},
"joinWaitTime": {
"maximum": 60,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 30
},
"joinExpireTime": {
"maximum": 300,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 300
},
"joinWaitThreshold": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 10
},
"enableOptimizedConnectivityExperience": {
"type": "boolean",
"default": false
},
"broadcastProbeResponseDelay": {
"maximum": 120,
"minimum": 8,
"type": "integer",
"format": "int32",
"default": 15
},
"rssiAssociationRejectionThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -75
},
"enableAntiSpoofing": {
"type": "boolean",
"default": false
},
"enableArpRequestRateLimit": {
"type": "boolean",
"default": true
},
"arpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"enableDhcpRequestRateLimit": {
"type": "boolean",
"default": true
},
"dhcpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"dnsProxyEnabled": {
"type": "boolean",
"default": false
},
"dnsProxy": {
"$ref": "#/components/schemas/DnsProxy"
}
},
"description": "WLAN advanced customization"
},
"ClientIsolationOptions": {
"type": "object",
"properties": {
"packetsType": {
"type": "string",
"enum": [
"UNICAST",
"MULTICAST",
"UNICAST_MULTICAST"
]
},
"autoVrrp": {
"type": "boolean",
"default": false
}
},
"description": "Client isolation options"
},
"DnsProxy": {
"type": "object",
"properties": {
"dnsProxyRules": {
"maxItems": 64,
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/DnsProxyRule"
}
}
},
"description": "DNS proxy"
},
"DnsProxyRule": {
"required": [
"domainName",
"ipList"
],
"type": "object",
"properties": {
"domainName": {
"pattern": "^(\\*(\\.[0-9A-Za-z]{1,63})+(\\.\\*)?|([0-9A-Za-z]{1,63}\\.)+\\*|([0-9A-Za-z]{1,63}(\\.[0-9A-Za-z]{1,63})+))$",
"type": "string"
},
"ipList": {
"maxItems": 8,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "DNS proxy rule"
},
"DpskNetworkDeep": {
"required": [
"dpskPassphraseGeneration",
"name",
"wlan"
],
"type": "object",
"description": "DPSK Wi-Fi network (deep)",
"allOf": [
{
"$ref": "#/components/schemas/NetworkDeep"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/DpskWlan"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"dpskPassphraseGeneration": {
"$ref": "#/components/schemas/DpskPassphraseGeneration"
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"DpskPassphraseGeneration": {
"type": "object",
"properties": {
"length": {
"maximum": 63,
"minimum": 8,
"type": "integer",
"format": "int32",
"default": 18
},
"format": {
"type": "string",
"default": "PassphraseFormatEnum.MOST_SECURED",
"enum": [
"MOST_SECURED",
"KEYBOARD_FRIENDLY",
"NUMBERS_ONLY"
]
},
"expiration": {
"type": "string",
"default": "PassphraseExpirationEnum.UNLIMITED",
"enum": [
"UNLIMITED",
"ONE_DAY",
"TWO_DAYS",
"ONE_WEEK",
"TWO_WEEKS",
"ONE_MONTH",
"SIX_MONTHS",
"ONE_YEAR",
"TWO_YEARS"
]
}
},
"description": "Entity domain object representing DPSK generation parameters."
},
"DpskWlan": {
"required": [
"ssid"
],
"type": "object",
"properties": {
"wlanSecurity": {
"type": "string",
"default": "DpskWlanSecurityEnum.WPA2Personal",
"enum": [
"WPAPersonal",
"WPA2Personal"
]
},
"advancedCustomization": {
"$ref": "#/components/schemas/DpskWlanAdvancedCustomization"
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"ssid": {
"pattern": "[^`\\s]([^`\\t\\r\\n]){0,30}[^`\\s]",
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
}
},
"description": "WLAN"
},
"DpskWlanAdvancedCustomization": {
"type": "object",
"properties": {
"devicePolicyId": {
"type": "string"
},
"l2AclPolicyId": {
"type": "string"
},
"l3AclPolicyId": {
"type": "string"
},
"applicationPolicyId": {
"type": "string"
},
"accessControlProfileId": {
"type": "string"
},
"userUplinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"userDownlinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalUplinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalDownlinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"maxClientsOnWlanPerRadio": {
"maximum": 512,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
},
"enableBandBalancing": {
"type": "boolean",
"default": true
},
"clientIsolation": {
"type": "boolean",
"default": false
},
"clientIsolationOptions": {
"$ref": "#/components/schemas/ClientIsolationOptions"
},
"hideSsid": {
"type": "boolean",
"default": false
},
"forceMobileDeviceDhcp": {
"type": "boolean",
"default": false
},
"clientLoadBalancingEnable": {
"type": "boolean",
"default": true
},
"enableAaaVlanOverride": {
"type": "boolean",
"default": true
},
"directedThreshold": {
"maximum": 128,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 5
},
"enableNeighborReport": {
"type": "boolean",
"default": true
},
"radioCustomization": {
"$ref": "#/components/schemas/WlanRadioCustomization"
},
"enableSyslog": {
"type": "boolean",
"default": false
},
"clientInactivityTimeout": {
"maximum": 86400,
"minimum": 60,
"type": "integer",
"format": "int32",
"default": 120
},
"accessControlEnable": {
"type": "boolean",
"default": false
},
"respectiveAccessControl": {
"type": "boolean",
"default": true
},
"vlanPool": {
"$ref": "#/components/schemas/VlanPool"
},
"applicationPolicyEnable": {
"type": "boolean",
"default": false
},
"l2AclEnable": {
"type": "boolean",
"default": false
},
"l3AclEnable": {
"type": "boolean",
"default": false
},
"wifiCallingEnabled": {
"type": "boolean",
"default": false
},
"wifiCallingIds": {
"maxItems": 5,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"proxyARP": {
"type": "boolean",
"default": false
},
"enableAirtimeDecongestion": {
"type": "boolean",
"default": false
},
"enableJoinRSSIThreshold": {
"type": "boolean",
"default": false
},
"joinRSSIThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -85
},
"enableTransientClientManagement": {
"type": "boolean",
"default": false
},
"joinWaitTime": {
"maximum": 60,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 30
},
"joinExpireTime": {
"maximum": 300,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 300
},
"joinWaitThreshold": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 10
},
"enableOptimizedConnectivityExperience": {
"type": "boolean",
"default": false
},
"broadcastProbeResponseDelay": {
"maximum": 120,
"minimum": 8,
"type": "integer",
"format": "int32",
"default": 15
},
"rssiAssociationRejectionThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -75
},
"enableAntiSpoofing": {
"type": "boolean",
"default": false
},
"enableArpRequestRateLimit": {
"type": "boolean",
"default": true
},
"arpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"enableDhcpRequestRateLimit": {
"type": "boolean",
"default": true
},
"dhcpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"dnsProxyEnabled": {
"type": "boolean",
"default": false
},
"dnsProxy": {
"$ref": "#/components/schemas/DnsProxy"
}
},
"description": "WLAN advanced customization"
},
"File": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 2147483647,
"minLength": 1,
"type": "string"
}
},
"description": "Describe a file"
},
"GuestNetworkDeep": {
"required": [
"guestPortal",
"name",
"wlan"
],
"type": "object",
"description": "Guest Wi-Fi network (deep)",
"allOf": [
{
"$ref": "#/components/schemas/NetworkDeep"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/GuestWlan"
},
"guestPortal": {
"$ref": "#/components/schemas/GuestPortal"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"enableDhcp": {
"type": "boolean",
"default": false
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"GuestPage": {
"type": "object",
"properties": {
"langCode": {
"type": "string"
},
"title": {
"type": "string"
},
"tagLine": {
"maxLength": 140,
"minLength": 0,
"type": "string"
},
"welcomeMessage": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"termsAndConditions": {
"maxLength": 100000,
"minLength": 0,
"type": "string"
},
"logoImage": {
"$ref": "#/components/schemas/File"
},
"advertImage": {
"$ref": "#/components/schemas/File"
},
"wifi4Eu": {
"type": "boolean",
"default": false
},
"wifi4EuNetworkId": {
"maxLength": 128,
"minLength": 0,
"type": "string"
}
},
"description": "Captive portal guest page"
},
"GuestPortal": {
"required": [
"guestNetworkType"
],
"type": "object",
"properties": {
"smsPasswordDuration": {
"$ref": "#/components/schemas/GuestSmsPasswordDuration"
},
"guestNetworkType": {
"type": "string",
"enum": [
"ClickThrough",
"SelfSignIn",
"HostApproval",
"GuestPass",
"WISPr",
"Cloudpath"
]
},
"externalPortalKey": {
"type": "string"
},
"enableSelfService": {
"type": "boolean",
"default": true
},
"enableSmsLogin": {
"type": "boolean",
"default": false
},
"maxDevices": {
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 1
},
"endOfDayReauthDelay": {
"type": "boolean",
"default": false
},
"macCredentialsDuration": {
"maximum": 1440,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 240
},
"lockoutPeriod": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 120
},
"lockoutPeriodEnabled": {
"type": "boolean",
"default": false
},
"wisprPage": {
"$ref": "#/components/schemas/WisprPage"
},
"guestPage": {
"$ref": "#/components/schemas/GuestPage"
},
"socialIdentities": {
"$ref": "#/components/schemas/SocialIdentities"
},
"socialEmails": {
"type": "boolean",
"default": false
},
"socialDomains": {
"type": "array",
"items": {
"type": "string"
}
},
"hostGuestConfig": {
"$ref": "#/components/schemas/HostGuestConfig"
},
"externalPortalUrl": {
"pattern": "^https?:\\/\\/([A-Za-z0-9]+([\\-\\.]{1}[A-Za-z0-9]+)*\\.[A-Za-z]{2,}|(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|localhost)(:([1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?(\\/.*)?([?#].*)?$",
"type": "string"
},
"redirectUrl": {
"pattern": "^https?:\\/\\/([A-Za-z0-9]+([\\-\\.]{1}[A-Za-z0-9]+)*\\.[A-Za-z]{2,}|(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|localhost)(:([1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?(\\/.*)?([?#].*)?$",
"type": "string"
},
"userSessionTimeout": {
"maximum": 14400,
"minimum": 2,
"type": "integer",
"format": "int32",
"default": 1440
},
"userSessionGracePeriod": {
"maximum": 14399,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 60
},
"walledGardens": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Network configuration of guest access including captive portal settings and authentication settings."
},
"GuestSmsPasswordDuration": {
"type": "object",
"properties": {
"duration": {
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 12
},
"unit": {
"type": "string",
"default": "TimeUnitEnum.HOUR",
"enum": [
"YEAR",
"MONTH",
"DAY",
"HOUR",
"MINUTE",
"SECOND"
]
}
},
"description": "SMS password duration"
},
"GuestWlan": {
"required": [
"ssid"
],
"type": "object",
"properties": {
"wlanSecurity": {
"type": "string",
"default": "GuestWlanSecurityEnum.None",
"enum": [
"WPAPersonal",
"WPA2Personal",
"WEP",
"WPA23Mixed",
"WPA3",
"None"
]
},
"bypassCPUsingMacAddressAuthentication": {
"type": "boolean",
"default": true
},
"advancedCustomization": {
"$ref": "#/components/schemas/GuestWlanAdvancedCustomization"
},
"macAddressAuthentication": {
"type": "boolean",
"default": false
},
"macAuthMacFormat": {
"type": "string",
"enum": [
"Lower",
"UpperDash",
"UpperColon",
"Upper",
"LowerDash",
"LowerColon"
]
},
"managementFrameProtection": {
"type": "string",
"enum": [
"Disabled",
"Optional",
"Required"
]
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"ssid": {
"pattern": "[^`\\s]([^`\\t\\r\\n]){0,30}[^`\\s]",
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
},
"bypassCNA": {
"type": "boolean",
"default": false
},
"passphrase": {
"maxLength": 64,
"minLength": 8,
"pattern": "^[!-_a-~]((?!\\$\\()[ !-_a-~]){6,61}[!-_a-~]$|^[A-Fa-f0-9]{64}$",
"type": "string"
},
"saePassphrase": {
"maxLength": 64,
"minLength": 8,
"pattern": "^[!-_a-~]((?!\\$\\()[ !-_a-~]){6,61}[!-_a-~]$|^[A-Fa-f0-9]{64}$",
"type": "string"
},
"wepHexKey": {
"pattern": "[0-9a-fA-F]{26}",
"type": "string"
}
},
"description": "Guest WLAN"
},
"GuestWlanAdvancedCustomization": {
"type": "object",
"properties": {
"clientIsolation": {
"type": "boolean",
"default": true
},
"devicePolicyId": {
"type": "string"
},
"l2AclPolicyId": {
"type": "string"
},
"l3AclPolicyId": {
"type": "string"
},
"applicationPolicyId": {
"type": "string"
},
"accessControlProfileId": {
"type": "string"
},
"userUplinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"userDownlinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalUplinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalDownlinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"maxClientsOnWlanPerRadio": {
"maximum": 512,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
},
"enableBandBalancing": {
"type": "boolean",
"default": true
},
"clientIsolationOptions": {
"$ref": "#/components/schemas/ClientIsolationOptions"
},
"hideSsid": {
"type": "boolean",
"default": false
},
"forceMobileDeviceDhcp": {
"type": "boolean",
"default": false
},
"clientLoadBalancingEnable": {
"type": "boolean",
"default": true
},
"enableAaaVlanOverride": {
"type": "boolean",
"default": true
},
"directedThreshold": {
"maximum": 128,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 5
},
"enableNeighborReport": {
"type": "boolean",
"default": true
},
"enableFastRoaming": {
"type": "boolean",
"default": false
},
"mobilityDomainId": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"radioCustomization": {
"$ref": "#/components/schemas/WlanRadioCustomization"
},
"enableSyslog": {
"type": "boolean",
"default": false
},
"clientInactivityTimeout": {
"maximum": 86400,
"minimum": 60,
"type": "integer",
"format": "int32",
"default": 120
},
"accessControlEnable": {
"type": "boolean",
"default": false
},
"respectiveAccessControl": {
"type": "boolean",
"default": true
},
"vlanPool": {
"$ref": "#/components/schemas/VlanPool"
},
"applicationPolicyEnable": {
"type": "boolean",
"default": false
},
"l2AclEnable": {
"type": "boolean",
"default": false
},
"l3AclEnable": {
"type": "boolean",
"default": false
},
"wifiCallingEnabled": {
"type": "boolean",
"default": false
},
"wifiCallingIds": {
"maxItems": 5,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"singleSessionIdAccounting": {
"type": "boolean",
"default": false
},
"proxyARP": {
"type": "boolean",
"default": false
},
"enableAirtimeDecongestion": {
"type": "boolean",
"default": false
},
"enableJoinRSSIThreshold": {
"type": "boolean",
"default": false
},
"joinRSSIThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -85
},
"enableTransientClientManagement": {
"type": "boolean",
"default": false
},
"joinWaitTime": {
"maximum": 60,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 30
},
"joinExpireTime": {
"maximum": 300,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 300
},
"joinWaitThreshold": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 10
},
"enableOptimizedConnectivityExperience": {
"type": "boolean",
"default": false
},
"broadcastProbeResponseDelay": {
"maximum": 120,
"minimum": 8,
"type": "integer",
"format": "int32",
"default": 15
},
"rssiAssociationRejectionThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -75
},
"enableAntiSpoofing": {
"type": "boolean",
"default": false
},
"enableArpRequestRateLimit": {
"type": "boolean",
"default": true
},
"arpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"enableDhcpRequestRateLimit": {
"type": "boolean",
"default": true
},
"dhcpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"dnsProxyEnabled": {
"type": "boolean",
"default": false
},
"dnsProxy": {
"$ref": "#/components/schemas/DnsProxy"
}
},
"description": "WLAN advanced customization"
},
"HostGuestConfig": {
"required": [
"hostDomains",
"hostDurationChoices"
],
"type": "object",
"properties": {
"hostDomains": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"hostDurationChoices": {
"maxItems": 5,
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"description": "Host guest configuration"
},
"NetworkApGroup": {
"type": "object",
"properties": {
"apGroupId": {
"type": "string"
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"radio": {
"type": "string",
"default": "RadioEnum.Both",
"enum": [
"Both",
"2.4-GHz",
"5-GHz"
]
},
"isDefault": {
"type": "boolean",
"default": false
},
"apGroupName": {
"maxLength": 64,
"minLength": 2,
"type": "string"
},
"validationErrorReachedMaxConnectedNetworksLimit": {
"type": "boolean",
"readOnly": true,
"default": false
},
"validationErrorSsidAlreadyActivated": {
"type": "boolean",
"default": false
},
"validationErrorReachedMaxConnectedCaptiveNetworksLimit": {
"type": "boolean",
"default": false
},
"validationError": {
"type": "boolean",
"default": false
},
"vlanPoolId": {
"type": "string"
},
"vlanPoolName": {
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Network to AP-Group activation"
},
"NetworkDeep": {
"required": [
"type"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"venues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkVenue"
}
},
"tenantId": {
"type": "string"
},
"type": {
"type": "string"
}
},
"description": "Wi-Fi network",
"discriminator": {
"propertyName": "type"
}
},
"NetworkVenue": {
"type": "object",
"properties": {
"venueId": {
"type": "string"
},
"networkId": {
"type": "string"
},
"clientIsolationAllowlistId": {
"type": "string"
},
"apGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkApGroup"
}
},
"allApGroupsRadio": {
"type": "string",
"default": "RadioEnum.Both",
"enum": [
"Both",
"2.4-GHz",
"5-GHz"
]
},
"scheduler": {
"$ref": "#/components/schemas/NetworkVenueScheduler"
},
"isAllApGroups": {
"type": "boolean",
"default": true
},
"allApGroupsVlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"vlanPoolId": {
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Network venue association"
},
"NetworkVenueScheduler": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "SchedulerTypeEnum.ALWAYS_ON",
"enum": [
"ALWAYS_ON",
"ALWAYS_OFF",
"CUSTOM"
]
},
"sun": {
"pattern": "[0-1]{96}",
"type": "string"
},
"mon": {
"pattern": "[0-1]{96}",
"type": "string"
},
"tue": {
"pattern": "[0-1]{96}",
"type": "string"
},
"wed": {
"pattern": "[0-1]{96}",
"type": "string"
},
"thu": {
"pattern": "[0-1]{96}",
"type": "string"
},
"fri": {
"pattern": "[0-1]{96}",
"type": "string"
},
"sat": {
"pattern": "[0-1]{96}",
"type": "string"
}
},
"description": "Network-Venue scheduler"
},
"OauthAppConfig": {
"required": [
"appId",
"appSecret"
],
"type": "object",
"properties": {
"appId": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"appSecret": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"description": "OAUTH configuration"
},
"OpenNetworkDeep": {
"required": [
"name",
"wlan"
],
"type": "object",
"description": "Open Wi-Fi network (deep)",
"allOf": [
{
"$ref": "#/components/schemas/NetworkDeep"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/OpenWlan"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"OpenWlan": {
"required": [
"ssid"
],
"type": "object",
"properties": {
"advancedCustomization": {
"$ref": "#/components/schemas/OpenWlanAdvancedCustomization"
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"ssid": {
"pattern": "[^`\\s]([^`\\t\\r\\n]){0,30}[^`\\s]",
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
}
},
"description": "WLAN"
},
"OpenWlanAdvancedCustomization": {
"type": "object",
"properties": {
"clientIsolation": {
"type": "boolean",
"default": true
},
"devicePolicyId": {
"type": "string"
},
"l2AclPolicyId": {
"type": "string"
},
"l3AclPolicyId": {
"type": "string"
},
"applicationPolicyId": {
"type": "string"
},
"accessControlProfileId": {
"type": "string"
},
"userUplinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"userDownlinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalUplinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalDownlinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"maxClientsOnWlanPerRadio": {
"maximum": 512,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
},
"enableBandBalancing": {
"type": "boolean",
"default": true
},
"clientIsolationOptions": {
"$ref": "#/components/schemas/ClientIsolationOptions"
},
"hideSsid": {
"type": "boolean",
"default": false
},
"forceMobileDeviceDhcp": {
"type": "boolean",
"default": false
},
"clientLoadBalancingEnable": {
"type": "boolean",
"default": true
},
"directedThreshold": {
"maximum": 128,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 5
},
"enableNeighborReport": {
"type": "boolean",
"default": true
},
"radioCustomization": {
"$ref": "#/components/schemas/WlanRadioCustomization"
},
"enableSyslog": {
"type": "boolean",
"default": false
},
"clientInactivityTimeout": {
"maximum": 86400,
"minimum": 60,
"type": "integer",
"format": "int32",
"default": 120
},
"accessControlEnable": {
"type": "boolean",
"default": false
},
"respectiveAccessControl": {
"type": "boolean",
"default": true
},
"vlanPool": {
"$ref": "#/components/schemas/VlanPool"
},
"applicationPolicyEnable": {
"type": "boolean",
"default": false
},
"l2AclEnable": {
"type": "boolean",
"default": false
},
"l3AclEnable": {
"type": "boolean",
"default": false
},
"wifiCallingEnabled": {
"type": "boolean",
"default": false
},
"wifiCallingIds": {
"maxItems": 5,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"proxyARP": {
"type": "boolean",
"default": false
},
"enableAirtimeDecongestion": {
"type": "boolean",
"default": false
},
"enableJoinRSSIThreshold": {
"type": "boolean",
"default": false
},
"joinRSSIThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -85
},
"enableTransientClientManagement": {
"type": "boolean",
"default": false
},
"joinWaitTime": {
"maximum": 60,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 30
},
"joinExpireTime": {
"maximum": 300,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 300
},
"joinWaitThreshold": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 10
},
"enableOptimizedConnectivityExperience": {
"type": "boolean",
"default": false
},
"broadcastProbeResponseDelay": {
"maximum": 120,
"minimum": 8,
"type": "integer",
"format": "int32",
"default": 15
},
"rssiAssociationRejectionThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -75
},
"enableAntiSpoofing": {
"type": "boolean",
"default": false
},
"enableArpRequestRateLimit": {
"type": "boolean",
"default": true
},
"arpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"enableDhcpRequestRateLimit": {
"type": "boolean",
"default": true
},
"dhcpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"dnsProxyEnabled": {
"type": "boolean",
"default": false
},
"dnsProxy": {
"$ref": "#/components/schemas/DnsProxy"
}
},
"description": "WLAN advanced customization"
},
"PskNetworkDeep": {
"required": [
"name",
"wlan"
],
"type": "object",
"description": "PSK Wi-Fi network (deep)",
"allOf": [
{
"$ref": "#/components/schemas/NetworkDeep"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/PskWlan"
},
"authRadius": {
"$ref": "#/components/schemas/Radius"
},
"accountingRadius": {
"$ref": "#/components/schemas/Radius"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"PskWlan": {
"required": [
"ssid"
],
"type": "object",
"properties": {
"wlanSecurity": {
"type": "string",
"default": "PskWlanSecurityEnum.WPA2Personal",
"enum": [
"WPAPersonal",
"WPA2Personal",
"WEP",
"WPA23Mixed",
"WPA3"
]
},
"advancedCustomization": {
"$ref": "#/components/schemas/PskWlanAdvancedCustomization"
},
"macAddressAuthentication": {
"type": "boolean",
"default": false
},
"macAuthMacFormat": {
"type": "string",
"enum": [
"Lower",
"UpperDash",
"UpperColon",
"Upper",
"LowerDash",
"LowerColon"
]
},
"managementFrameProtection": {
"type": "string",
"enum": [
"Disabled",
"Optional",
"Required"
]
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"ssid": {
"pattern": "[^`\\s]([^`\\t\\r\\n]){0,30}[^`\\s]",
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
},
"passphrase": {
"maxLength": 64,
"minLength": 8,
"pattern": "^[!-_a-~]((?!\\$\\()[ !-_a-~]){6,61}[!-_a-~]$|^[A-Fa-f0-9]{64}$",
"type": "string"
},
"saePassphrase": {
"maxLength": 64,
"minLength": 8,
"pattern": "^[!-_a-~]((?!\\$\\()[ !-_a-~]){6,61}[!-_a-~]$|^[A-Fa-f0-9]{64}$",
"type": "string"
},
"wepHexKey": {
"pattern": "[0-9a-fA-F]{26}",
"type": "string"
}
},
"description": "WLAN"
},
"PskWlanAdvancedCustomization": {
"type": "object",
"properties": {
"devicePolicyId": {
"type": "string"
},
"l2AclPolicyId": {
"type": "string"
},
"l3AclPolicyId": {
"type": "string"
},
"applicationPolicyId": {
"type": "string"
},
"accessControlProfileId": {
"type": "string"
},
"userUplinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"userDownlinkRateLimiting": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalUplinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"totalDownlinkRateLimiting": {
"maximum": 650,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"maxClientsOnWlanPerRadio": {
"maximum": 512,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
},
"enableBandBalancing": {
"type": "boolean",
"default": true
},
"clientIsolation": {
"type": "boolean",
"default": false
},
"clientIsolationOptions": {
"$ref": "#/components/schemas/ClientIsolationOptions"
},
"hideSsid": {
"type": "boolean",
"default": false
},
"forceMobileDeviceDhcp": {
"type": "boolean",
"default": false
},
"clientLoadBalancingEnable": {
"type": "boolean",
"default": true
},
"directedThreshold": {
"maximum": 128,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 5
},
"enableNeighborReport": {
"type": "boolean",
"default": true
},
"enableFastRoaming": {
"type": "boolean",
"default": false
},
"mobilityDomainId": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"radioCustomization": {
"$ref": "#/components/schemas/WlanRadioCustomization"
},
"enableSyslog": {
"type": "boolean",
"default": false
},
"clientInactivityTimeout": {
"maximum": 86400,
"minimum": 60,
"type": "integer",
"format": "int32",
"default": 120
},
"accessControlEnable": {
"type": "boolean",
"default": false
},
"respectiveAccessControl": {
"type": "boolean",
"default": true
},
"vlanPool": {
"$ref": "#/components/schemas/VlanPool"
},
"applicationPolicyEnable": {
"type": "boolean",
"default": false
},
"l2AclEnable": {
"type": "boolean",
"default": false
},
"l3AclEnable": {
"type": "boolean",
"default": false
},
"wifiCallingEnabled": {
"type": "boolean",
"default": false
},
"wifiCallingIds": {
"maxItems": 5,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"proxyARP": {
"type": "boolean",
"default": false
},
"enableAirtimeDecongestion": {
"type": "boolean",
"default": false
},
"enableJoinRSSIThreshold": {
"type": "boolean",
"default": false
},
"joinRSSIThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -85
},
"enableTransientClientManagement": {
"type": "boolean",
"default": false
},
"joinWaitTime": {
"maximum": 60,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 30
},
"joinExpireTime": {
"maximum": 300,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 300
},
"joinWaitThreshold": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 10
},
"enableOptimizedConnectivityExperience": {
"type": "boolean",
"default": false
},
"broadcastProbeResponseDelay": {
"maximum": 120,
"minimum": 8,
"type": "integer",
"format": "int32",
"default": 15
},
"rssiAssociationRejectionThreshold": {
"maximum": -60,
"minimum": -90,
"type": "integer",
"format": "int32",
"default": -75
},
"enableAntiSpoofing": {
"type": "boolean",
"default": false
},
"enableArpRequestRateLimit": {
"type": "boolean",
"default": true
},
"arpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"enableDhcpRequestRateLimit": {
"type": "boolean",
"default": true
},
"dhcpRequestRateLimit": {
"maximum": 100,
"minimum": 15,
"type": "integer",
"format": "int32",
"default": 15
},
"dnsProxyEnabled": {
"type": "boolean",
"default": false
},
"dnsProxy": {
"$ref": "#/components/schemas/DnsProxy"
}
},
"description": "WLAN advanced customization"
},
"Radius": {
"required": [
"primary"
],
"type": "object",
"properties": {
"primary": {
"$ref": "#/components/schemas/RadiusServer"
},
"secondary": {
"$ref": "#/components/schemas/RadiusServer"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Primary and secondary radius servers."
},
"RadiusServer": {
"required": [
"ip",
"port"
],
"type": "object",
"properties": {
"ip": {
"pattern": "^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"sharedSecret": {
"maxLength": 255,
"minLength": 1,
"pattern": "^[\\x21-\\x7E]+([\\x20-\\x7E]*[\\x21-\\x7E]+)*$",
"type": "string"
}
},
"description": "RADIUS server"
},
"SocialIdentities": {
"type": "object",
"properties": {
"google": {
"$ref": "#/components/schemas/SocialIdentity"
},
"facebook": {
"$ref": "#/components/schemas/SocialIdentity"
},
"linkedin": {
"$ref": "#/components/schemas/SocialIdentity"
},
"twitter": {
"$ref": "#/components/schemas/SocialIdentity"
}
},
"description": "Social media configuration"
},
"SocialIdentity": {
"type": "object",
"properties": {
"source": {
"type": "string",
"default": "SocialIdentitySource.RUCKUS",
"enum": [
"RUCKUS",
"CUSTOM"
]
},
"config": {
"$ref": "#/components/schemas/OauthAppConfig"
}
},
"description": "Social media configuration"
},
"WisprPage": {
"required": [
"captivePortalUrl"
],
"type": "object",
"properties": {
"captivePortalUrl": {
"pattern": "^https?:\\/\\/([A-Za-z0-9]+([\\-\\.]{1}[A-Za-z0-9]+)*\\.[A-Za-z]{2,}|(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|localhost)(:([1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?(\\/.*)?([?#].*)?$",
"type": "string"
},
"integrationKey": {
"pattern": "[a-zA-Z0-9]{16}",
"type": "string"
},
"externalProviderName": {
"type": "string"
},
"externalProviderRegion": {
"type": "string"
},
"customExternalProvider": {
"type": "boolean",
"default": false
},
"authRadius": {
"$ref": "#/components/schemas/Radius"
},
"accountingRadius": {
"$ref": "#/components/schemas/Radius"
}
},
"description": "Configuration for WISPr network"
},
"WlanRadioCustomization": {
"type": "object",
"properties": {
"rfBandUsage": {
"type": "string",
"default": "RfBandUsageEnum.BOTH",
"enum": [
"2.4GHZ",
"5.0GHZ",
"BOTH"
]
},
"bssMinimumPhyRate": {
"type": "string",
"default": "BssMinimumPhyRateEnum._default",
"enum": [
"1",
"2",
"5.5",
"12",
"24",
"default"
]
},
"phyTypeConstraint": {
"type": "string",
"default": "PhyTypeConstraintEnum.OFDM",
"enum": [
"OFDM",
"NONE"
]
},
"managementFrameMinimumPhyRate": {
"type": "string",
"default": "ManagementFrameMinimumPhyRateEnum._6",
"enum": [
"1",
"2",
"5.5",
"6",
"9",
"11",
"12",
"18",
"24"
]
}
},
"description": "WLAN radio customization"
},
"OperationResponseNetworkDeep": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"oneOf": [
{
"$ref": "#/components/schemas/AAANetworkDeep"
},
{
"$ref": "#/components/schemas/DpskNetworkDeep"
},
{
"$ref": "#/components/schemas/GuestNetworkDeep"
},
{
"$ref": "#/components/schemas/OpenNetworkDeep"
},
{
"$ref": "#/components/schemas/PskNetworkDeep"
}
]
}
}
},
"AAANetwork": {
"required": [
"name",
"wlan"
],
"type": "object",
"description": "AAA Wi-Fi network",
"allOf": [
{
"$ref": "#/components/schemas/Network"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/AAAWlan"
},
"authRadiusId": {
"type": "string"
},
"accountingRadiusId": {
"type": "string"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"enableAuthProxy": {
"type": "boolean",
"default": false
},
"enableAccountingProxy": {
"type": "boolean",
"default": false
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"DpskNetwork": {
"required": [
"dpskPassphraseGeneration",
"name",
"wlan"
],
"type": "object",
"description": "DPSK Wi-Fi network",
"allOf": [
{
"$ref": "#/components/schemas/Network"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/DpskWlan"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"dpskPassphraseGeneration": {
"$ref": "#/components/schemas/DpskPassphraseGeneration"
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"GuestNetwork": {
"required": [
"guestPortal",
"name",
"wlan"
],
"type": "object",
"description": "Guest Wi-Fi network",
"allOf": [
{
"$ref": "#/components/schemas/Network"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/GuestWlan"
},
"guestPortal": {
"$ref": "#/components/schemas/GuestPortal"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"enableDhcp": {
"type": "boolean",
"default": false
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"Network": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"description": "Wi-Fi network",
"discriminator": {
"propertyName": "type"
}
},
"OpenNetwork": {
"required": [
"name",
"wlan"
],
"type": "object",
"description": "Open Wi-Fi network",
"allOf": [
{
"$ref": "#/components/schemas/Network"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/OpenWlan"
},
"tenantId": {
"type": "string",
"readOnly": true
},
"cloudpathServerId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"PskNetwork": {
"required": [
"name",
"wlan"
],
"type": "object",
"description": "PSK Wi-Fi network",
"allOf": [
{
"$ref": "#/components/schemas/Network"
},
{
"type": "object",
"properties": {
"wlan": {
"$ref": "#/components/schemas/PskWlan"
},
"authRadiusId": {
"type": "string",
"readOnly": true
},
"accountingRadiusId": {
"type": "string",
"readOnly": true
},
"tenantId": {
"type": "string",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
}
}
]
},
"OperationResponseNetwork": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"oneOf": [
{
"$ref": "#/components/schemas/Network"
},
{
"$ref": "#/components/schemas/AAANetwork"
},
{
"$ref": "#/components/schemas/DpskNetwork"
},
{
"$ref": "#/components/schemas/GuestNetwork"
},
{
"$ref": "#/components/schemas/OpenNetwork"
},
{
"$ref": "#/components/schemas/PskNetwork"
}
]
}
}
},
"OperationResponseNetworkVenue": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/NetworkVenue"
}
}
},
"L3AclPolicy": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"description": {
"type": "string"
},
"defaultAccess": {
"type": "string",
"default": "AccessEnum.ALLOW",
"enum": [
"ALLOW",
"BLOCK"
]
},
"l3Rules": {
"maxItems": 128,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/L3Rule"
}
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "L3 access control policy"
},
"L3IpPort": {
"type": "object",
"properties": {
"enableIpSubnet": {
"type": "boolean",
"default": false
},
"ip": {
"pattern": "^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
"ipMask": {
"pattern": "^((128|192|224|240|248|252|254)\\.0\\.0\\.0)|(255\\.(((0|128|192|224|240|248|252|254)\\.0\\.0)|(255\\.(((0|128|192|224|240|248|252|254)\\.0)|255\\.(0|128|192|224|240|248|252|254)))))$",
"type": "string"
},
"port": {
"pattern": "^([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(?:-([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$",
"type": "string"
}
},
"description": "L3 IP port"
},
"L3Rule": {
"required": [
"priority"
],
"type": "object",
"properties": {
"priority": {
"maximum": 128,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"description": {
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"access": {
"type": "string",
"default": "AccessEnum.ALLOW",
"enum": [
"ALLOW",
"BLOCK"
]
},
"protocol": {
"type": "string",
"enum": [
"L3ProtocolEnum_TCP",
"L3ProtocolEnum_UDP",
"L3ProtocolEnum_UDPLITE",
"L3ProtocolEnum_ICMP_ICMPV4",
"L3ProtocolEnum_ICMPV6",
"L3ProtocolEnum_IGMP",
"L3ProtocolEnum_ESP",
"L3ProtocolEnum_AH",
"L3ProtocolEnum_SCTP",
"L3ProtocolEnum_CUSTOM"
]
},
"customProtocol": {
"maximum": 255,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"source": {
"$ref": "#/components/schemas/L3IpPort"
},
"destination": {
"$ref": "#/components/schemas/L3IpPort"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Layer-3 rule"
},
"OperationResponseL3AclPolicy": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/L3AclPolicy"
}
}
},
"L2AclPolicy": {
"required": [
"macAddresses",
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"description": {
"type": "string"
},
"access": {
"type": "string",
"default": "AccessEnum.BLOCK",
"enum": [
"ALLOW",
"BLOCK"
]
},
"macAddresses": {
"maxItems": 128,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "L2 access control policy"
},
"OperationResponseL2AclPolicy": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/L2AclPolicy"
}
}
},
"ClientIsolationAllowlist": {
"required": [
"allowlist",
"name",
"venueId"
],
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"readOnly": true
},
"venueId": {
"type": "string"
},
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"description": {
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"allowlist": {
"maxItems": 64,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientIsolationAllowlistEntry"
}
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Client isolation allowlist configuration."
},
"ClientIsolationAllowlistEntry": {
"required": [
"mac"
],
"type": "object",
"properties": {
"mac": {
"pattern": "^(?!((([fF]{2}:){5}[fF]{2})|((00:){5}00)|(01:00:5[eE]:[0-7])))([0-9A-Fa-f]{2}:){5}([0-9A-Fa-f]{2})$",
"type": "string"
},
"description": {
"maxLength": 64,
"minLength": 0,
"type": "string"
}
},
"description": "Client isolation allowlist entry. Note: use two client isolation allowlist entries for dual-stack clients (i.e., one for the IPv4 address and a second for the IPv6 address)."
},
"OperationResponseClientIsolationAllowlist": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ClientIsolationAllowlist"
}
}
},
"DhcpServiceProfile": {
"required": [
"endIpAddress",
"leaseTimeHours",
"leaseTimeMinutes",
"name",
"startIpAddress",
"subnetAddress",
"subnetMask",
"vlanId"
],
"type": "object",
"properties": {
"venues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdAndName"
}
},
"name": {
"maxLength": 32,
"minLength": 2,
"pattern": "^[!-~]([ -~])*[!-~]$",
"type": "string"
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"subnetAddress": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"subnetMask": {
"pattern": "^(?:(?:(?:255\\.){3}(?:252|248|240|224|192|128|0+))|(?:(?:255\\.){2}(?:255|254|252|248|240|224|192|128|0+)\\.0)|(?:(?:255\\.)(?:255|254|252|248|240|224|192|128|0+)(?:\\.0+){2})|(?:(?:255|254|252|248|240|224|192|128|0+)(?:\\.0+){3}))$",
"type": "string"
},
"startIpAddress": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"endIpAddress": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"primaryDnsIp": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"secondaryDnsIp": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"leaseTimeHours": {
"maximum": 24,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"leaseTimeMinutes": {
"maximum": 59,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "DHCP Service Profile Configuration."
},
"OperationResponseDhcpServiceProfile": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/DhcpServiceProfile"
}
}
},
"DevicePolicy": {
"required": [
"name"
],
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"readOnly": true
},
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"description": {
"maxLength": 180,
"minLength": 2,
"type": "string"
},
"defaultAccess": {
"type": "string",
"default": "AccessEnum.ALLOW",
"enum": [
"ALLOW",
"BLOCK"
]
},
"rules": {
"maxItems": 32,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePolicyRule"
}
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Network device-policy"
},
"DevicePolicyRule": {
"required": [
"deviceType",
"name",
"osVendor"
],
"type": "object",
"properties": {
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"action": {
"type": "string",
"default": "AccessEnum.ALLOW",
"enum": [
"ALLOW",
"BLOCK"
]
},
"deviceType": {
"type": "string",
"enum": [
"Laptop",
"Smartphone",
"Tablet",
"Voip",
"Gaming",
"Printer",
"IotDevice",
"HomeAvEquipment",
"WdsDevice"
]
},
"osVendor": {
"type": "string",
"enum": [
"All",
"Windows",
"MacOs",
"ChromeOs",
"Linux",
"Ubuntu",
"Ios",
"Android",
"BlackBerry",
"AmazonKindle",
"CiscoIpPhone",
"AvayaIpPhone",
"LinksysPapVoip",
"NortelIpPhone",
"Xbox360",
"PlayStation2",
"GameCube",
"Wii",
"PlayStation3",
"Xbox",
"Nintendo",
"HpPrinter",
"CanonPrinter",
"XeroxPrinter",
"DellPrinter",
"BrotherPrinter",
"EpsonPrinter",
"NestCamera",
"NestThermostat",
"WemoSmartSwitch",
"WifiSmartPlug",
"SonyPlayer",
"PanasonicG20Tv",
"SamsungSmartTv",
"AppleTv",
"LibratoneSpeakers",
"BoseSpeakers",
"SonosSpeakers",
"RokuStreamingStick",
"TelnetCpe"
]
},
"downloadRateLimit": {
"maximum": 200,
"minimum": 0,
"type": "number",
"format": "float"
},
"uploadRateLimit": {
"maximum": 200,
"minimum": 0,
"type": "number",
"format": "float"
},
"vlan": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
"description": "Network device-policy rule"
},
"OperationResponseDevicePolicy": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/DevicePolicy"
}
}
},
"ApPosition": {
"type": "object",
"properties": {
"floorplanId": {
"type": "string"
},
"yPercent": {
"maximum": 100,
"minimum": 0,
"type": "number",
"format": "float",
"default": 0
},
"xPercent": {
"maximum": 100,
"minimum": 0,
"type": "number",
"format": "float",
"default": 0
}
},
"description": "AP position object"
},
"OperationResponseApPosition": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApPosition"
}
}
},
"CloudpathServer": {
"required": [
"authRadius",
"name"
],
"type": "object",
"properties": {
"deployedInVenueId": {
"type": "string"
},
"deployedInVenueName": {
"type": "string"
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"deploymentType": {
"type": "string",
"default": "CloudpathDeploymentTypeEnum.OnPremise",
"enum": [
"OnPremise",
"Cloud"
]
},
"authRadius": {
"$ref": "#/components/schemas/Radius"
},
"accountingRadius": {
"$ref": "#/components/schemas/Radius"
},
"position": {
"$ref": "#/components/schemas/ApPosition"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Object used to configure Cloudpath service."
},
"OperationResponseCloudpathServer": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/CloudpathServer"
}
}
},
"ApplicationPolicy": {
"required": [
"name"
],
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"readOnly": true
},
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"description": {
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"rules": {
"maxItems": 128,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationPolicyRule"
}
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Application policy"
},
"ApplicationPolicyRule": {
"required": [
"accessControl",
"name",
"priority",
"ruleType"
],
"type": "object",
"properties": {
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"ruleType": {
"type": "string",
"enum": [
"SIGNATURE",
"USER_DEFINED"
]
},
"accessControl": {
"type": "string",
"enum": [
"DENY",
"QOS",
"RATE_LIMIT"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"category": {
"type": "string"
},
"categoryId": {
"type": "integer",
"format": "int32"
},
"applicationName": {
"type": "string"
},
"applicationId": {
"type": "integer",
"format": "int32"
},
"uplink": {
"maximum": 20000,
"minimum": 250,
"type": "integer",
"format": "int32"
},
"downlink": {
"maximum": 20000,
"minimum": 250,
"type": "integer",
"format": "int32"
},
"markingPriority": {
"type": "string",
"enum": [
"IEEE802_1P",
"DSCP",
"BOTH"
]
},
"upLinkMarkingType": {
"type": "string",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
},
"downLinkMarkingType": {
"type": "string",
"enum": [
"VOICE",
"VIDEO",
"BEST_EFFORT",
"BACKGROUND"
]
},
"portMapping": {
"type": "string",
"enum": [
"IP_WITH_PORT",
"PORT_ONLY"
]
},
"destinationIp": {
"pattern": "^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
"netmask": {
"pattern": "^((128|192|224|240|248|252|254)\\.0\\.0\\.0)|(255\\.(((0|128|192|224|240|248|252|254)\\.0\\.0)|(255\\.(((0|128|192|224|240|248|252|254)\\.0)|255\\.(0|128|192|224|240|248|252|254)))))$",
"type": "string"
},
"destinationPort": {
"maximum": 65535,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"protocol": {
"type": "string",
"enum": [
"TCP",
"UDP"
]
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Application policy rule"
},
"OperationResponseApplicationPolicy": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApplicationPolicy"
}
}
},
"ApRadioCustomization": {
"type": "object",
"properties": {
"apRadioParams24G": {
"$ref": "#/components/schemas/ApRadioParams24G"
},
"apRadioParams50G": {
"$ref": "#/components/schemas/ApRadioParams50G"
},
"useVenueSettings": {
"type": "boolean",
"default": true
},
"enable24G": {
"type": "boolean",
"default": false
},
"enable50G": {
"type": "boolean",
"default": false
}
},
"description": "AP radio customization"
},
"ApRadioParams24G": {
"type": "object",
"properties": {
"manualChannel": {
"type": "integer",
"format": "int32",
"default": 0
},
"operativeTxPower": {
"type": "string",
"readOnly": true
},
"operativeChannel": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"snr_dB": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"allowedChannels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13"
]
}
},
"channelBandwidth": {
"type": "string",
"default": "ChannelBandwidth24GEnum.AUTO",
"enum": [
"AUTO",
"20MHz",
"40MHz"
]
},
"method": {
"type": "string",
"default": "ScanMethodEnum.BACKGROUND_SCANNING",
"enum": [
"MANUAL",
"BACKGROUND_SCANNING",
"CHANNELFLY"
]
},
"changeInterval": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 33
},
"txPower": {
"type": "string",
"default": "TxPowerEnum.MAX",
"enum": [
"Auto",
"MAX",
"-1",
"-2",
"-3",
"-4",
"-5",
"-6",
"-7",
"-8",
"-9",
"-10",
"MIN"
]
}
},
"description": "AP radio customization for 2.4GHz."
},
"ApRadioParams50G": {
"type": "object",
"properties": {
"allowedChannels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
},
"channelBandwidth": {
"type": "string",
"default": "ChannelBandwidth5GEnum.AUTO",
"enum": [
"AUTO",
"20MHz",
"40MHz",
"80MHz",
"160MHz"
]
},
"manualChannel": {
"type": "integer",
"format": "int32",
"default": 0
},
"operativeTxPower": {
"type": "string"
},
"operativeChannel": {
"type": "integer",
"format": "int32"
},
"snr_dB": {
"type": "integer",
"format": "int32"
},
"method": {
"type": "string",
"default": "ScanMethodEnum.BACKGROUND_SCANNING",
"enum": [
"MANUAL",
"BACKGROUND_SCANNING",
"CHANNELFLY"
]
},
"changeInterval": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 33
},
"txPower": {
"type": "string",
"default": "TxPowerEnum.MAX",
"enum": [
"Auto",
"MAX",
"-1",
"-2",
"-3",
"-4",
"-5",
"-6",
"-7",
"-8",
"-9",
"-10",
"MIN"
]
}
},
"description": "AP radio customization for 5GHz."
},
"OperationResponseApRadioCustomization": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApRadioCustomization"
}
}
},
"ApLanPort": {
"required": [
"type",
"untagId",
"vlanMembers"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ACCESS",
"GENERAL",
"TRUNK"
]
},
"untagId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"vlanMembers": {
"pattern": "^(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4])(?: *- *(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4]))?(?: *, *(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4])(?: *- *(?:[1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-3][0-9]{3}|40[0-8][0-9]|409[0-4]))?)*$",
"type": "string"
},
"portId": {
"type": "string"
},
"enabled": {
"type": "boolean",
"default": true
}
},
"description": "AP LAN-port"
},
"ApLanPorts": {
"type": "object",
"properties": {
"poeOut": {
"type": "boolean",
"default": false
},
"lanPorts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApLanPort"
}
},
"useVenueSettings": {
"type": "boolean",
"default": false
}
},
"description": "AP model specific configuration for AP LAN ports and external antenna."
},
"OperationResponseApLanPorts": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApLanPorts"
}
}
},
"ApModelSpecific": {
"type": "object",
"properties": {
"externalAntenna": {
"$ref": "#/components/schemas/ExternalAntenna"
},
"poeOut": {
"type": "boolean",
"default": false
},
"lanPorts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApLanPort"
}
},
"useVenueSettings": {
"type": "boolean",
"default": false
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "AP model specific configuration for AP LAN ports and external antenna."
},
"ExternalAntenna": {
"type": "object",
"properties": {
"enable24G": {
"type": "boolean",
"default": false
},
"enable50G": {
"type": "boolean",
"default": false
},
"gain24G": {
"maximum": 60,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"gain50G": {
"maximum": 60,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"supportDisable": {
"type": "boolean",
"default": false
},
"coupled": {
"type": "boolean",
"default": false
}
},
"description": "External antenna settings"
},
"OperationResponseApModelSpecific": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApModelSpecific"
}
}
},
"BonjourGateway": {
"required": [
"rules"
],
"type": "object",
"properties": {
"rules": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/BonjourGatewayRule"
}
}
},
"description": "The Bonjour policy for venue."
},
"BonjourGatewayRule": {
"required": [
"fromVlan",
"service",
"toVlan"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"service": {
"type": "string",
"enum": [
"AIRDISK",
"AIRPLAY",
"AIRPORT_MANAGEMENT",
"AIRPRINT",
"AIRTUNES",
"APPLE_FILE_SHARING",
"APPLE_MOBILE_DEVICES",
"APPLETV",
"ICLOUD_SYNC",
"ITUNES_REMOTE",
"ITUNES_SHARING",
"OPEN_DIRECTORY_MASTER",
"OPTICAL_DISK_SHARING",
"OTHER",
"SCREEN_SHARING",
"SECURE_FILE_SHARING",
"SECURE_SHELL",
"WWW_HTTP",
"WWW_HTTPS",
"XGRID",
"GOOGLE_CHROMECAST"
]
},
"mdnsName": {
"maxLength": 64,
"minLength": 2,
"pattern": "^[!-~][ -~]*[!-~]$",
"type": "string"
},
"mdnsProtocol": {
"type": "string",
"enum": [
"TCP",
"UDP"
]
},
"fromVlan": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"toVlan": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
"description": "The Bonjour gateway rule"
},
"OperationResponseBonjourGateway": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/BonjourGateway"
}
}
},
"ApRequest": {
"required": [
"name",
"serialNumber",
"venueId"
],
"type": "object",
"properties": {
"serialNumber": {
"pattern": "^[1-9][0-9]{11}$",
"type": "string"
},
"apGroupId": {
"type": "string"
},
"venueId": {
"type": "string"
},
"name": {
"pattern": "(?=^((?!`|\\$\\()[ -_a-~]){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 180,
"minLength": 0,
"type": "string"
},
"tags": {
"maxItems": 24,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"model": {
"maxLength": 64,
"minLength": 0,
"type": "string",
"default": "null"
},
"position": {
"$ref": "#/components/schemas/ApPosition"
}
},
"description": "AP request payload"
},
"Ap": {
"required": [
"name",
"serialNumber",
"venueId"
],
"type": "object",
"properties": {
"serialNumber": {
"pattern": "^[1-9][0-9]{11}$",
"type": "string"
},
"apGroupId": {
"type": "string"
},
"venueId": {
"type": "string"
},
"radio": {
"$ref": "#/components/schemas/ApRadioCustomization"
},
"clientCount": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"lastContacted": {
"type": "string",
"readOnly": true,
"default": "null"
},
"lastUpdated": {
"type": "string",
"readOnly": true,
"default": "null"
},
"indoorModel": {
"type": "boolean",
"readOnly": true,
"default": false
},
"firmware": {
"type": "string",
"readOnly": true,
"default": "null"
},
"state": {
"type": "string",
"readOnly": true,
"default": "null",
"enum": [
"InSetupPhase",
"Operational",
"RequiresAttention",
"TransientIssue"
]
},
"subState": {
"type": "string",
"readOnly": true,
"default": "null",
"enum": [
"NeverContactedCloud",
"Initializing",
"Operational",
"ApplyingFirmware",
"ApplyingConfiguration",
"FirmwareUpdateFailed",
"ConfigurationUpdateFailed",
"DisconnectedFromCloud",
"Rebooting"
]
},
"mac": {
"type": "string",
"readOnly": true,
"default": "null"
},
"ip": {
"type": "string",
"readOnly": true,
"default": "null"
},
"externalIp": {
"type": "string",
"readOnly": true,
"default": "null"
},
"meshRole": {
"type": "string",
"readOnly": true,
"default": "null"
},
"uptime_seconds": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!`|\\$\\()[ -_a-~]){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 180,
"minLength": 0,
"type": "string"
},
"tags": {
"maxItems": 24,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"model": {
"maxLength": 64,
"minLength": 0,
"type": "string",
"default": "null"
},
"position": {
"$ref": "#/components/schemas/ApPosition"
}
},
"description": "AP for requests"
},
"OperationResponseAp": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/Ap"
}
}
},
"ApGroup": {
"required": [
"name",
"venueId"
],
"type": "object",
"properties": {
"venueId": {
"type": "string"
},
"apSerialNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApSerialNumber"
}
},
"name": {
"maxLength": 64,
"minLength": 2,
"type": "string"
},
"description": {
"maxLength": 180,
"minLength": 2,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "AP-Group per venue containing an optional list of AP serial numbers for association."
},
"ApSerialNumber": {
"required": [
"serialNumber"
],
"type": "object",
"properties": {
"serialNumber": {
"pattern": "^[1-9][0-9]{11}$",
"type": "string"
},
"softDeleted": {
"type": "boolean",
"default": false
},
"softDeletedDate": {
"type": "string",
"format": "date-time"
}
},
"description": "AP serial-number for AP group association."
},
"ApDeep": {
"required": [
"name",
"serialNumber",
"venueId"
],
"type": "object",
"properties": {
"serialNumber": {
"pattern": "^[1-9][0-9]{11}$",
"type": "string"
},
"apGroupId": {
"type": "string"
},
"venueId": {
"type": "string"
},
"lanPorts": {
"$ref": "#/components/schemas/ApLanPorts"
},
"bonjourGateway": {
"$ref": "#/components/schemas/BonjourGateway"
},
"radio": {
"$ref": "#/components/schemas/ApRadioCustomization"
},
"clientCount": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"lastContacted": {
"type": "string",
"readOnly": true,
"default": "null"
},
"lastUpdated": {
"type": "string",
"readOnly": true,
"default": "null"
},
"indoorModel": {
"type": "boolean",
"readOnly": true,
"default": false
},
"firmware": {
"type": "string",
"readOnly": true,
"default": "null"
},
"state": {
"type": "string",
"readOnly": true,
"default": "null",
"enum": [
"InSetupPhase",
"Operational",
"RequiresAttention",
"TransientIssue"
]
},
"subState": {
"type": "string",
"readOnly": true,
"default": "null",
"enum": [
"NeverContactedCloud",
"Initializing",
"Operational",
"ApplyingFirmware",
"ApplyingConfiguration",
"FirmwareUpdateFailed",
"ConfigurationUpdateFailed",
"DisconnectedFromCloud",
"Rebooting"
]
},
"mac": {
"type": "string",
"readOnly": true,
"default": "null"
},
"ip": {
"type": "string",
"readOnly": true,
"default": "null"
},
"externalIp": {
"type": "string",
"readOnly": true,
"default": "null"
},
"meshRole": {
"type": "string",
"readOnly": true,
"default": "null"
},
"uptime_seconds": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"name": {
"pattern": "(?=^((?!`|\\$\\()[ -_a-~]){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"description": {
"maxLength": 180,
"minLength": 0,
"type": "string"
},
"tags": {
"maxItems": 24,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"softDeleted": {
"type": "boolean",
"default": false
},
"softDeletedDate": {
"type": "string",
"format": "date-time"
},
"model": {
"maxLength": 64,
"minLength": 0,
"type": "string",
"default": "null"
},
"position": {
"$ref": "#/components/schemas/ApPosition"
},
"updatedDate": {
"type": "string",
"format": "date-time"
}
},
"description": "AP (deep)"
},
"ApGroupDeep": {
"required": [
"name"
],
"type": "object",
"properties": {
"venueId": {
"type": "string"
},
"aps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApDeep"
}
},
"isDefault": {
"type": "boolean",
"default": false
},
"name": {
"maxLength": 64,
"minLength": 2,
"type": "string"
},
"description": {
"maxLength": 180,
"minLength": 2,
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "AP-Group per venue containing a list of AP."
},
"OperationResponseApGroupDeep": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApGroupDeep"
}
}
},
"AccessControlProfile": {
"required": [
"name"
],
"type": "object",
"properties": {
"devicePolicy": {
"$ref": "#/components/schemas/IdAndEnabled"
},
"l2AclPolicy": {
"$ref": "#/components/schemas/IdAndEnabled"
},
"l3AclPolicy": {
"$ref": "#/components/schemas/IdAndEnabled"
},
"applicationPolicy": {
"$ref": "#/components/schemas/IdAndEnabled"
},
"name": {
"maxLength": 32,
"minLength": 2,
"type": "string"
},
"description": {
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"rateLimiting": {
"$ref": "#/components/schemas/RateLimiting"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Access control profile"
},
"IdAndEnabled": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"enabled": {
"type": "boolean",
"default": false
}
},
"description": "Profile ID and enabled"
},
"RateLimiting": {
"type": "object",
"properties": {
"uplinkLimit": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"downlinkLimit": {
"maximum": 200,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"enabled": {
"type": "boolean",
"default": false
}
},
"description": "Client traffic rate limiting"
},
"OperationResponseAccessControlProfile": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/AccessControlProfile"
}
}
},
"TrustedCAChain": {
"required": [
"rootCert"
],
"type": "object",
"properties": {
"rootCert": {
"$ref": "#/components/schemas/X509Certificate"
},
"interCerts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/X509Certificate"
}
},
"info": {
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Trusted certificate authority chain"
},
"X509Certificate": {
"required": [
"certData",
"fileName"
],
"type": "object",
"properties": {
"certData": {
"maxLength": 8192,
"minLength": 0,
"pattern": "^-+BEGIN CERTIFICATE-+[A-Za-z0-9/+\n]*={0,2}\n?-+END CERTIFICATE-+\n?$",
"type": "string"
},
"isRootCert": {
"type": "boolean",
"default": false
},
"fileName": {
"type": "string"
}
},
"description": "X509 certificate"
},
"QueryRequest": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"page": {
"type": "integer",
"format": "int32",
"default": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"default": 25
},
"sortField": {
"type": "string"
},
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"searchTargetFields": {
"type": "array",
"items": {
"type": "string"
}
},
"searchString": {
"type": "string"
}
},
"description": "Query request"
},
"VlanPoolQueryData": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"networksCount": {
"type": "integer",
"format": "int64"
},
"networksNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "VLAN pool query data"
},
"VlanPoolQueryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VlanPoolQueryData"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
}
},
"description": "VLAN pool query response"
},
"DhcpServiceAp": {
"required": [
"role",
"serialNumber"
],
"type": "object",
"properties": {
"serialNumber": {
"maxLength": 12,
"minLength": 12,
"type": "string"
},
"role": {
"type": "string",
"enum": [
"PrimaryServer",
"BackupServer",
"NatGateway"
]
},
"dhcpIps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "DHCP Service AP information."
},
"VenueDhcpServiceSetting": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"mode": {
"type": "string",
"default": "DhcpModeEnum.EnableOnEachAPs",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs",
"EnableOnHierarchicalAPs"
]
},
"wanPortSelectionMode": {
"type": "string",
"default": "DhcpWanPortSelectionModeEnum.Dynamic",
"enum": [
"Dynamic",
"Manual"
]
},
"dhcpServiceProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"dhcpServiceAps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpServiceAp"
}
},
"enableClientIsolationAllowlist": {
"type": "boolean",
"default": false
}
},
"description": "AP-Venue"
},
"OperationResponseVenueDhcpServiceSetting": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/VenueDhcpServiceSetting"
}
}
},
"DhcpServiceProfileVenue": {
"required": [
"dhcpServiceProfileId",
"venueId"
],
"type": "object",
"properties": {
"venueId": {
"type": "string"
},
"dhcpServiceProfileId": {
"type": "string"
}
},
"description": "Relations of DHCP service profiles and venues mapping."
},
"OperationResponseDhcpServiceProfileVenue": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/DhcpServiceProfileVenue"
}
}
},
"OperationResponseListDhcpServiceProfileVenue": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpServiceProfileVenue"
}
}
}
},
"OperationResponseListRogueClassificationPolicyVenue": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RogueClassificationPolicyVenue"
}
}
}
},
"RogueClassificationPolicyVenue": {
"required": [
"policyName"
],
"type": "object",
"properties": {
"venueId": {
"type": "string",
"readOnly": true
},
"policyId": {
"type": "string",
"readOnly": true
},
"policyName": {
"maxLength": 32,
"minLength": 2,
"type": "string"
}
},
"description": "Relationship of a rogue classification policy to a venue."
},
"AccessPolicyQueryData": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"rulesCount": {
"type": "integer",
"format": "int64"
},
"networksCount": {
"type": "integer",
"format": "int64"
},
"networksNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Access policy query input."
},
"AccessPolicyQueryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessPolicyQueryData"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
}
},
"description": "Access policy query response."
},
"L2AclPolicyQueryData": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"macAddressesCount": {
"type": "integer",
"format": "int64"
},
"networksCount": {
"type": "integer",
"format": "int64"
},
"networksNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Layer-2 ACL policy query data."
},
"L2AclPolicyQueryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2AclPolicyQueryData"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
}
},
"description": "Layer-2 ACL policy query response."
},
"ClientIsolationAllowlistQueryData": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"clientCount": {
"type": "integer",
"format": "int64"
},
"clientMacs": {
"type": "array",
"items": {
"type": "string"
}
},
"networkCount": {
"type": "integer",
"format": "int64"
},
"networkNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Client isolation allowlist query data."
},
"ClientIsolationAllowlistQueryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientIsolationAllowlistQueryData"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
}
},
"description": "Client isolation allowlist query response."
},
"DpskPassphraseFilters": {
"type": "object",
"properties": {
"networkId": {
"type": "array",
"items": {
"type": "string"
}
},
"vlanId": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"includeExpired": {
"type": "array",
"items": {
"type": "boolean"
}
},
"passphrase": {
"type": "array",
"items": {
"type": "string"
}
},
"mac": {
"type": "array",
"items": {
"type": "string"
}
},
"username": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Filters used to query DPSK passphrase."
},
"DpskPassphraseQueryRequest": {
"type": "object",
"properties": {
"filters": {
"$ref": "#/components/schemas/DpskPassphraseFilters"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"page": {
"type": "integer",
"format": "int32",
"default": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"default": 25
},
"sortField": {
"type": "string"
},
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"searchTargetFields": {
"type": "array",
"items": {
"type": "string"
}
},
"searchString": {
"type": "string"
}
},
"description": "DPSK passphrase query request"
},
"DpskPassphrase": {
"required": [
"networkSsid"
],
"type": "object",
"properties": {
"networkId": {
"type": "string"
},
"networkSsid": {
"pattern": "[^`\\s]([^`\\t\\r\\n]){0,30}[^`\\s]",
"type": "string"
},
"username": {
"maxLength": 190,
"minLength": 0,
"type": "string"
},
"numberOfDevices": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"mac": {
"pattern": "^([0-9A-Fa-f]{2}[.:-]){5}([0-9A-Fa-f]{2})$|^([0-9A-Fa-f]{3}[.:-]){3}([0-9A-Fa-f]{3})$|^([0-9A-Fa-f]{4}[.:-]){2}([0-9A-Fa-f]{4})$|^([0-9A-Fa-f]{12})$",
"type": "string"
},
"passphrase": {
"maxLength": 63,
"minLength": 8,
"pattern": "^[ -~]{8,63}$",
"type": "string"
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"numberOfDevicesType": {
"type": "string",
"default": "DpskNumberOfDevicesEnum.LIMITED",
"enum": [
"LIMITED",
"UNLIMITED"
]
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"readOnly": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"description": "Dynamic pre-shared key passphrase for delete request."
},
"DpskPassphraseQueryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DpskPassphrase"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
}
},
"description": "DPSK passphrase query response"
},
"DpskPassphraseImportResponse": {
"type": "object",
"properties": {
"downloadUrl": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DpskPassphrase"
}
}
}
},
"OperationResponseDpskPassphraseImportResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/DpskPassphraseImportResponse"
}
}
},
"ExportDpskPassphraseQueryRequest": {
"type": "object",
"properties": {
"filters": {
"$ref": "#/components/schemas/DpskPassphraseFilters"
},
"sortField": {
"type": "string"
},
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"searchTargetFields": {
"type": "array",
"items": {
"type": "string"
}
},
"searchString": {
"type": "string"
}
},
"description": "DPSK passphrase query request"
},
"DpskPassphraseRequest": {
"required": [
"networkId"
],
"type": "object",
"properties": {
"networkId": {
"type": "string",
"readOnly": true
},
"numberOfPassphrases": {
"maximum": 5000,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"override": {
"type": "boolean",
"default": false
},
"passphrase": {
"maxLength": 63,
"minLength": 8,
"pattern": "^[ -~]{8,63}$",
"type": "string"
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"numberOfDevicesType": {
"type": "string",
"default": "DpskNumberOfDevicesEnum.LIMITED",
"enum": [
"LIMITED",
"UNLIMITED"
]
},
"numberOfDevices": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
},
"username": {
"maxLength": 190,
"minLength": 0,
"type": "string"
},
"mac": {
"pattern": "^([0-9A-Fa-f]{2}[.:-]){5}([0-9A-Fa-f]{2})$|^([0-9A-Fa-f]{3}[.:-]){3}([0-9A-Fa-f]{3})$|^([0-9A-Fa-f]{4}[.:-]){2}([0-9A-Fa-f]{4})$|^([0-9A-Fa-f]{12})$",
"type": "string"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "Request to create single or multiple DPSK passphrase(s)."
},
"OperationResponseDpskPassphraseRequest": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/DpskPassphraseRequest"
}
}
},
"DisconnectClient": {
"required": [
"apMac",
"clientMac"
],
"type": "object",
"properties": {
"clientMac": {
"type": "string"
},
"apMac": {
"type": "string"
}
},
"description": "Disconnect client payload info"
},
"ApplicationPolicyQueryData": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"rulesCount": {
"type": "integer",
"format": "int64"
},
"networksCount": {
"type": "integer",
"format": "int64"
},
"networksNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Application policy query data"
},
"ApplicationPolicyQueryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationPolicyQueryData"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
}
},
"description": "Application policy query response"
},
"ApTraceRouteRequest": {
"required": [
"targetHost"
],
"type": "object",
"properties": {
"targetHost": {
"pattern": "(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\\b((?=[a-z0-9-]{1,63}\\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,63}\\b)$)",
"type": "string"
}
},
"description": "AP troubleshooting trace route request."
},
"ApTraceRouteResponse": {
"type": "object",
"properties": {
"response": {
"type": "string"
}
},
"description": "AP troubleshooting trace route response."
},
"OperationResponseApTraceRouteResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApTraceRouteResponse"
}
}
},
"OperationResponseVoid": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "object"
}
}
},
"ApPingRequest": {
"required": [
"targetHost"
],
"type": "object",
"properties": {
"targetHost": {
"pattern": "(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9]?)\\.)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){2}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$)|(^(\\b((?=[a-z0-9-]{1,63}\\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,63}\\b)$)",
"type": "string"
}
},
"description": "AP troubleshooting ping request"
},
"ApPingResponse": {
"type": "object",
"properties": {
"response": {
"type": "string"
}
},
"description": "AP troubleshooting ping response"
},
"OperationResponseApPingResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApPingResponse"
}
}
},
"ApPacketCaptureStartRequest": {
"required": [
"captureInterface"
],
"type": "object",
"properties": {
"captureInterface": {
"type": "string",
"enum": [
"RADIO24",
"RADIO50",
"ETH0",
"ETH1",
"ETH2",
"ETH3",
"ETH4",
"ETH5",
"ETH6",
"ETH7"
]
},
"macAddressFilter": {
"pattern": "^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$|^([0-9A-Fa-f]{12})$|^([0-9A-Fa-f]{4}[.]){2}([0-9A-Fa-f]{4})$",
"type": "string"
},
"frameTypeFilter": {
"type": "array",
"items": {
"type": "string",
"enum": [
"MANAGEMENT",
"CONTROL",
"DATA"
]
}
}
},
"description": "AP packet capture start info."
},
"ApBlinkLedResponse": {
"type": "object",
"properties": {
"response": {
"type": "string"
}
},
"description": "AP blink LED response"
},
"OperationResponseApBlinkLedResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/ApBlinkLedResponse"
}
}
},
"DhcpApInfo": {
"required": [
"dhcpApRole",
"serialNumber"
],
"type": "object",
"properties": {
"serialNumber": {
"maxLength": 12,
"minLength": 12,
"type": "string"
},
"dhcpApRole": {
"type": "string",
"enum": [
"PrimaryServer",
"BackupServer",
"NatGateway"
]
},
"venueId": {
"type": "string",
"readOnly": true
},
"venueDhcpEnabled": {
"type": "boolean"
},
"venueDhcpMode": {
"type": "string",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs",
"EnableOnHierarchicalAPs"
]
}
},
"description": "DHCP Service AP information."
},
"OperationResponseListDhcpApInfo": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DhcpApInfo"
}
}
}
},
"OperationResponseListAp": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Ap"
}
}
}
},
"AccessControlProfileQueryData": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"l2AclPolicyName": {
"type": "string"
},
"l2AclEnable": {
"type": "boolean",
"default": false
},
"l3AclPolicyName": {
"type": "string"
},
"l3AclEnable": {
"type": "boolean",
"default": false
},
"devicePolicyName": {
"type": "string"
},
"devicePolicyEnable": {
"type": "boolean",
"default": false
},
"applicationPolicyName": {
"type": "string"
},
"applicationPolicyEnable": {
"type": "boolean",
"default": false
},
"urlFilteringPolicyName": {
"type": "string"
},
"urlFilteringPolicyEnable": {
"type": "boolean",
"default": false
},
"userUplinkRateLimiting": {
"type": "integer",
"format": "int32",
"default": 0
},
"userDownlinkRateLimiting": {
"type": "integer",
"format": "int32",
"default": 0
},
"rateLimitEnable": {
"type": "boolean",
"default": false
},
"networksCount": {
"type": "integer",
"format": "int64"
},
"networksNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Query data of access control profile"
},
"AccessControlProfileQueryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessControlProfileQueryData"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
}
},
"description": "Query response of access control profiles"
},
"Channels24G": {
"type": "object",
"properties": {
"auto": {
"type": "array",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13"
]
}
},
"20MHz": {
"type": "array",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13"
]
}
},
"40MHz": {
"type": "array",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13"
]
}
}
},
"description": "2.4-GHz channels"
},
"Channels5G": {
"type": "object",
"properties": {
"indoor": {
"$ref": "#/components/schemas/Channels5GIndoorOutdoor"
},
"outdoor": {
"$ref": "#/components/schemas/Channels5GIndoorOutdoor"
}
},
"description": "5-GHz channels"
},
"Channels5GIndoorOutdoor": {
"type": "object",
"properties": {
"auto": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
},
"20MHz": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
},
"40MHz": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
},
"80MHz": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
},
"160MHz": {
"type": "array",
"items": {
"type": "string",
"enum": [
"36",
"40",
"44",
"48",
"52",
"56",
"60",
"64",
"100",
"104",
"108",
"112",
"116",
"120",
"124",
"128",
"132",
"136",
"140",
"149",
"153",
"157",
"161",
"163",
"165",
"167",
"169",
"173"
]
}
}
},
"description": "Indoor and outdoor 5-GHz channels."
},
"VenueRegulatoryChannels": {
"type": "object",
"properties": {
"2.4GChannels": {
"$ref": "#/components/schemas/Channels24G"
},
"5GChannels": {
"$ref": "#/components/schemas/Channels5G"
}
},
"description": "Venue regulatory channels"
},
"DhcpServiceProfileUsage": {
"required": [
"endIpAddress",
"leaseTimeHours",
"leaseTimeMinutes",
"name",
"startIpAddress",
"subnetAddress",
"subnetMask",
"vlanId"
],
"type": "object",
"properties": {
"venues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdAndName"
}
},
"name": {
"maxLength": 32,
"minLength": 2,
"pattern": "^[!-~]([ -~])*[!-~]$",
"type": "string"
},
"vlanId": {
"maximum": 4094,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"subnetAddress": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"subnetMask": {
"pattern": "^(?:(?:(?:255\\.){3}(?:252|248|240|224|192|128|0+))|(?:(?:255\\.){2}(?:255|254|252|248|240|224|192|128|0+)\\.0)|(?:(?:255\\.)(?:255|254|252|248|240|224|192|128|0+)(?:\\.0+){2})|(?:(?:255|254|252|248|240|224|192|128|0+)(?:\\.0+){3}))$",
"type": "string"
},
"startIpAddress": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"endIpAddress": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"primaryDnsIp": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"secondaryDnsIp": {
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[1-9])\\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"leaseTimeHours": {
"maximum": 24,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"leaseTimeMinutes": {
"maximum": 59,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"totalIpCount": {
"type": "integer",
"format": "int32"
},
"usedIpCount": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "DHCP Service Profile Configuration."
},
"DhcpClientLeaseTime": {
"type": "object",
"properties": {
"leaseExpiration": {
"type": "string"
},
"hostname": {
"type": "string",
"readOnly": true
},
"ipAddress": {
"type": "string",
"readOnly": true
},
"dhcpProfileId": {
"type": "string",
"readOnly": true
},
"dhcpProfileName": {
"type": "string",
"readOnly": true
},
"macAddress": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string",
"readOnly": true
}
},
"description": "AP DHCP Client Lease Time Response"
},
"BandBalancing": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"clientPercent24": {
"type": "string",
"format": "byte"
}
},
"description": "Band balancing"
},
"Venue": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"readOnly": true
},
"wifiFirmwareVersion": {
"type": "string",
"readOnly": true
},
"countryCode": {
"type": "string"
},
"apPassword": {
"type": "string"
},
"mesh": {
"$ref": "#/components/schemas/Mesh"
},
"bandBalancing": {
"$ref": "#/components/schemas/BandBalancing"
},
"radioCustomization": {
"$ref": "#/components/schemas/VenueRadioCustomization"
},
"denialOfServiceProtection": {
"$ref": "#/components/schemas/DenialOfServiceProtection"
},
"syslog": {
"$ref": "#/components/schemas/VenueSyslog"
},
"dhcpServiceSetting": {
"$ref": "#/components/schemas/VenueDhcpServiceSetting"
},
"lteBandLockChannels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LteBandLockChannel"
}
},
"rogueAp": {
"$ref": "#/components/schemas/VenueRogueAp"
},
"enableClientIsolationAllowlist": {
"type": "boolean",
"default": false
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "AP-Venue"
},
"ExternalAccountingRadius": {
"type": "object",
"properties": {
"primary": {
"$ref": "#/components/schemas/ExternalRadiusTupple"
},
"secondary": {
"$ref": "#/components/schemas/ExternalRadiusTupple"
}
},
"description": "RADIUS accounting configuration"
},
"ExternalAuthRadius": {
"type": "object",
"properties": {
"primary": {
"$ref": "#/components/schemas/ExternalRadiusTupple"
},
"secondary": {
"$ref": "#/components/schemas/ExternalRadiusTupple"
}
},
"description": "Auth RADIUS"
},
"ExternalProviders": {
"type": "object",
"properties": {
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalProvidersModel"
}
}
},
"description": "External providers list"
},
"ExternalProvidersModel": {
"type": "object",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalProvidersRegion"
}
},
"name": {
"type": "string"
},
"customExternalProvider": {
"type": "boolean",
"default": false
}
},
"description": "External providers model"
},
"ExternalProvidersRegion": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"authRadius": {
"$ref": "#/components/schemas/ExternalAuthRadius"
},
"accountingRadius": {
"$ref": "#/components/schemas/ExternalAccountingRadius"
},
"captivePortalUrl": {
"type": "string"
},
"redirectUrl": {
"type": "string"
},
"showAnalyticsData": {
"type": "boolean",
"default": false
},
"externalProviderUrl": {
"type": "string"
}
},
"description": "External providers region"
},
"ExternalRadiusTupple": {
"type": "object",
"properties": {
"ip": {
"type": "string"
},
"port": {
"type": "string"
}
},
"description": "RADIUS tupple"
},
"DpskNetworkPassphraseGeneration": {
"required": [
"dpskPassphraseGeneration",
"name"
],
"type": "object",
"properties": {
"dpskPassphraseGeneration": {
"$ref": "#/components/schemas/DpskPassphraseGeneration"
},
"name": {
"pattern": "(?=^((?!(`|\\$\\()).){2,32}$)^(\\S.*\\S)$",
"type": "string"
},
"authRadius": {
"$ref": "#/components/schemas/Radius"
},
"accountingRadius": {
"$ref": "#/components/schemas/Radius"
},
"cloudpathServer": {
"$ref": "#/components/schemas/CloudpathServer"
},
"id": {
"type": "string",
"readOnly": true
}
},
"description": "DPSK network configuration"
},
"AvailableLteBands": {
"required": [
"region"
],
"type": "object",
"properties": {
"band3G": {
"type": "array",
"items": {
"type": "string"
}
},
"band4G": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "string",
"enum": [
"DOMAIN_1",
"DOMAIN_2",
"USA_CANADA",
"JAPAN"
]
},
"countryCodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "LTE band lock channel settings."
},
"DpskPassphraseCount": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
}
},
"description": "DPSK passphrase count"
},
"TestCloudpathConnectionResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"failureReason": {
"type": "string"
}
},
"description": "Cloudpath server connection test response."
},
"ApDownloadLog": {
"type": "object",
"properties": {
"fileURL": {
"type": "string"
}
},
"description": "AP troubleshooting download support log response."
},
"GuestUser": {
"title": "GuestUser",
"required": [
"deliveryMethods",
"expiration",
"maxDevices",
"mobilePhoneNumber",
"name",
"networkId"
],
"type": "object",
"properties": {
"createdDate": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"deliveryMethods": {
"type": "array",
"description": "At least one delivery method.",
"items": {
"type": "string",
"enum": [
"MAIL",
"SMS",
"STUB",
"PRINT"
]
}
},
"disabled": {
"type": "boolean",
"description": "If true, this guest user will not be permitted to join the guest network.",
"example": false
},
"email": {
"type": "string"
},
"expiration": {
"$ref": "#/components/schemas/GuestUserExpiration"
},
"expirationDate": {
"type": "integer",
"description": "Expiration date is calculated per the expiration configuration.",
"format": "int64",
"readOnly": true
},
"guestUserType": {
"type": "string",
"description": "This field is not editable after creation.",
"readOnly": true,
"example": "GuestPass",
"enum": [
"GuestPass",
"SelfSign",
"HostGuest"
]
},
"id": {
"type": "string",
"readOnly": true
},
"lastModified": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"macAddresses": {
"type": "array",
"description": "MAC addresses of the guest user's connected devices.",
"readOnly": true,
"items": {
"type": "string"
}
},
"maxDevices": {
"type": "integer",
"description": "Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.",
"format": "int32",
"example": 3
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number associated to the guest user."
},
"name": {
"type": "string",
"description": "The name assigned to the guest user."
},
"networkId": {
"type": "string",
"description": "Network ID of the guest network."
},
"notes": {
"maxLength": 180,
"minLength": 0,
"type": "string"
},
"password": {
"type": "string",
"description": "The password is auto-generated by the system.",
"readOnly": true
},
"ssid": {
"type": "string",
"description": "SSID of the network to which the guest connected.",
"readOnly": true
}
}
},
"GuestUserExpiration": {
"title": "GuestUserExpiration",
"required": [
"activationType"
],
"type": "object",
"properties": {
"activationType": {
"type": "string",
"description": "When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.",
"enum": [
"Creation",
"Login"
]
},
"duration": {
"type": "integer",
"format": "int32"
},
"unit": {
"type": "string",
"enum": [
"Minute",
"Hour",
"Day",
"Week",
"Month",
"Year",
"Never"
]
}
}
},
"GuestUserImport": {
"title": "GuestUserImport",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuestUser"
}
},
"downloadUrl": {
"type": "string",
"description": "Download the provisioned guest pass users in a CSV file format."
}
}
},
"OperationResponse": {
"title": "OperationResponse",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "object",
"properties": {}
}
}
},
"OperationResponseOfGuestUser": {
"title": "OperationResponseOfGuestUser",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/GuestUser"
}
}
},
"OperationResponseOfGuestUserImport": {
"title": "OperationResponseOfGuestUserImport",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/GuestUserImport"
}
}
},
"OperationResponseOfVoid": {
"title": "OperationResponseOfVoid",
"type": "object",
"properties": {
"requestId": {
"type": "string"
}
}
},
"OperationResponseOfstring": {
"title": "OperationResponseOfstring",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "string"
}
}
},
"PageResponseOfGuestUser": {
"title": "PageResponseOfGuestUser",
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuestUser"
}
},
"totalElements": {
"type": "integer",
"format": "int64"
}
}
},
"APRadioDto": {
"title": "APRadioDto",
"type": "object",
"properties": {
"Rssi": {
"type": "integer",
"description": "A relative indication of the received power level of a client device's wireless transmissions as measured at the AP. RSSI is scored on a scale of 0 to 100 with 100 indicating a very high (good) received power level and 0 indicating an extremely low (poor) power level.",
"format": "int32"
},
"band": {
"type": "string"
},
"channel": {
"type": "integer",
"format": "int32"
},
"operativeChannelBandwidth": {
"type": "string"
},
"radioId": {
"type": "integer",
"format": "int32"
},
"txPower": {
"type": "string",
"description": "The AP's transmitter power setting in dBm."
}
}
},
"APStatusDataDto": {
"title": "APStatusDataDto",
"type": "object",
"properties": {
"APRadio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APRadioDto"
}
},
"APSystem": {
"$ref": "#/components/schemas/APSystemDto"
},
"cellularInfo": {
"$ref": "#/components/schemas/CellularInfoDto"
}
}
},
"APSystemDto": {
"title": "APSystemDto",
"type": "object",
"properties": {
"uptime": {
"type": "integer",
"description": "The elapsed time in seconds between the time of the AP's last reboot and now.",
"format": "int64"
}
}
},
"AggregatedDeviceModelDto": {
"title": "AggregatedDeviceModelDto",
"type": "object",
"properties": {
"models": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CellularInfoDto": {
"title": "CellularInfoDto",
"type": "object",
"properties": {
"cellular3G4GChannel": {
"type": "integer",
"format": "int32"
},
"cellularActiveSim": {
"type": "string"
},
"cellularBand": {
"type": "string"
},
"cellularCardRemovalCountSIM0": {
"type": "string"
},
"cellularCardRemovalCountSIM1": {
"type": "string"
},
"cellularConnectionStatus": {
"type": "string"
},
"cellularCountry": {
"type": "string"
},
"cellularDHCPTimeoutCountSIM0": {
"type": "string"
},
"cellularDHCPTimeoutCountSIM1": {
"type": "string"
},
"cellularDefaultGateway": {
"type": "string"
},
"cellularDownlinkBandwidth": {
"type": "string"
},
"cellularECIO": {
"type": "integer",
"format": "int32"
},
"cellularICCIDSIM0": {
"type": "string"
},
"cellularICCIDSIM1": {
"type": "string"
},
"cellularIMEI": {
"type": "string"
},
"cellularIMSISIM0": {
"type": "string"
},
"cellularIMSISIM1": {
"type": "string"
},
"cellularIPaddress": {
"type": "string"
},
"cellularIsSIM0Present": {
"type": "string"
},
"cellularIsSIM1Present": {
"type": "string"
},
"cellularLTEFirmware": {
"type": "string"
},
"cellularNWLostCountSIM0": {
"type": "string"
},
"cellularNWLostCountSIM1": {
"type": "string"
},
"cellularOperator": {
"type": "string"
},
"cellularRSCP": {
"type": "integer",
"format": "int32"
},
"cellularRSRP": {
"type": "integer",
"format": "int32"
},
"cellularRSRQ": {
"type": "integer",
"format": "int32"
},
"cellularRadioUptime": {
"type": "integer",
"format": "int32"
},
"cellularRoamingStatus": {
"type": "string"
},
"cellularRxBytesSIM0": {
"type": "string"
},
"cellularRxBytesSIM1": {
"type": "string"
},
"cellularSINR": {
"type": "integer",
"format": "int32"
},
"cellularSignalStrength": {
"type": "string"
},
"cellularSubnetMask": {
"type": "string"
},
"cellularSwitchCountSIM0": {
"type": "string"
},
"cellularSwitchCountSIM1": {
"type": "string"
},
"cellularTxBytesSIM0": {
"type": "string"
},
"cellularTxBytesSIM1": {
"type": "string"
},
"cellularUplinkBandwidth": {
"type": "string"
},
"cellularWanInterface": {
"type": "string"
}
}
},
"Client": {
"title": "Client",
"type": "object",
"properties": {
"apMac": {
"type": "string"
},
"apSerialNumber": {
"type": "string"
},
"connectedSince": {
"type": "string"
},
"healthCheckStatus": {
"type": "string"
},
"hostname": {
"type": "string"
},
"ip": {
"type": "string"
},
"mac": {
"type": "string"
},
"networkId": {
"type": "string"
},
"osType": {
"type": "string"
},
"ssid": {
"type": "string"
},
"switchMac": {
"type": "string"
},
"switchSerialNumber": {
"type": "string"
},
"username": {
"type": "string"
},
"venueId": {
"type": "string"
},
"vlan": {
"type": "integer",
"format": "int32"
}
}
},
"ClientDeep": {
"title": "ClientDeep",
"type": "object",
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apSerialNumber": {
"type": "string"
},
"bssid": {
"type": "string"
},
"connectedSince": {
"type": "string"
},
"healthCheckStatus": {
"type": "string"
},
"hostname": {
"type": "string"
},
"ip": {
"type": "string"
},
"mac": {
"type": "string"
},
"networkId": {
"type": "string"
},
"noiseFloor_dBm": {
"type": "integer",
"format": "int32"
},
"osType": {
"type": "string"
},
"radioChannel": {
"type": "integer",
"format": "int32"
},
"receiveSignalStrength_dBm": {
"type": "integer",
"format": "int32"
},
"rxBytes": {
"type": "integer",
"format": "int64"
},
"rxPackets": {
"type": "integer",
"format": "int64"
},
"snr_dB": {
"type": "integer",
"format": "int32"
},
"ssid": {
"type": "string"
},
"switchMac": {
"type": "string"
},
"switchName": {
"type": "string"
},
"switchSerialNumber": {
"type": "string"
},
"txBytes": {
"type": "integer",
"format": "int64"
},
"txDropDataPacket": {
"type": "integer",
"format": "int32"
},
"txPackets": {
"type": "integer",
"format": "int64"
},
"username": {
"type": "string"
},
"venueId": {
"type": "string"
},
"venueName": {
"type": "string"
},
"vlan": {
"type": "integer",
"format": "int32"
}
}
},
"ClientDto": {
"title": "ClientDto",
"type": "object",
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"bssid": {
"type": "string"
},
"clientMac": {
"type": "string"
},
"connectSince": {
"type": "string"
},
"healthCheckStatus": {
"type": "string"
},
"hostname": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"networkId": {
"type": "string"
},
"noiseFloor_dBm": {
"type": "integer",
"format": "int32"
},
"osType": {
"type": "string"
},
"radioChannel": {
"type": "integer",
"format": "int32"
},
"receiveSignalStrength_dBm": {
"type": "integer",
"format": "int32"
},
"rxBytes": {
"type": "integer",
"format": "int64"
},
"rxPackets": {
"type": "integer",
"format": "int64"
},
"serialNumber": {
"type": "string"
},
"snr_dB": {
"type": "integer",
"format": "int32"
},
"ssid": {
"type": "string"
},
"switchMac": {
"type": "string"
},
"switchName": {
"type": "string"
},
"switchSerialNumber": {
"type": "string"
},
"txBytes": {
"type": "integer",
"format": "int64"
},
"txDropDataPacket": {
"type": "integer",
"format": "int32"
},
"txPackets": {
"type": "integer",
"format": "int64"
},
"username": {
"type": "string"
},
"venueId": {
"type": "string"
},
"venueName": {
"type": "string"
},
"vlan": {
"type": "integer",
"format": "int32"
}
}
},
"CloudpathServerDto": {
"title": "CloudpathServerDto",
"type": "object",
"properties": {
"acctServer": {
"type": "string",
"description": "IPv4 address and port of the Cloudpath accounting server in the following format: :. For example, 192.168.10.10:1813."
},
"authServer": {
"type": "string",
"description": "IPv4 address and port of the Cloudpath authentication server in the following format: :. For example, 192.168.10.10:1812."
},
"crtTime": {
"type": "string"
},
"deployedInVenueId": {
"type": "string"
},
"deploymentType": {
"type": "string",
"description": "Cloudpath deployment type (cloud or on-premise)."
},
"floorplanId": {
"type": "string"
},
"id": {
"type": "string"
},
"lastUpdTime": {
"type": "string"
},
"name": {
"type": "string"
},
"networksCount": {
"type": "integer",
"format": "int32"
},
"sharedSecret": {
"type": "string"
},
"venuesCount": {
"type": "integer",
"format": "int32"
},
"xPercent": {
"type": "number",
"format": "float"
},
"yPercent": {
"type": "number",
"format": "float"
}
}
},
"DeviceDto": {
"title": "DeviceDto",
"type": "object",
"properties": {
"IP": {
"type": "string"
},
"apGroupId": {
"type": "string"
},
"apGroupName": {
"type": "string"
},
"apMac": {
"type": "string"
},
"apStatusData": {
"$ref": "#/components/schemas/APStatusDataDto"
},
"clients": {
"type": "integer",
"format": "int32"
},
"configStatus": {
"type": "string"
},
"connectionStatus": {
"type": "string"
},
"crtTime": {
"type": "string",
"description": "The UTC time in milliseconds at which the device was provisioned (created) into the cloud."
},
"description": {
"type": "string"
},
"deviceGroupId": {
"type": "string"
},
"deviceGroupName": {
"type": "string"
},
"deviceModelType": {
"type": "string"
},
"deviceStatus": {
"type": "string"
},
"deviceStatusSeverity": {
"type": "string"
},
"downlink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownLinkDto"
}
},
"downlink.downMac": {
"type": "array",
"items": {
"type": "string"
}
},
"downlink.rssi": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"downlink.type": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"extIp": {
"type": "string"
},
"externalPort": {
"type": "string"
},
"floorplanId": {
"type": "string"
},
"fwVersion": {
"type": "string"
},
"hops": {
"type": "integer",
"format": "int32"
},
"isMeshEnable": {
"type": "boolean"
},
"lastSeenTime": {
"type": "string"
},
"lastUpdTime": {
"type": "string"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"meshRole": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"rogueCategory": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "The total amount of rogue devices for each category."
},
"serialNumber": {
"type": "string"
},
"switchName": {
"type": "string"
},
"switchSerialNumber": {
"type": "string"
},
"tags": {
"type": "string"
},
"uplink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpLinkDto"
}
},
"uplink.rssi": {
"type": "integer",
"format": "int32"
},
"uplink.upMac": {
"type": "string"
},
"venueId": {
"type": "string"
},
"venueName": {
"type": "string"
},
"wlanGroup24GId": {
"type": "string"
},
"wlanGroup5GId": {
"type": "string"
},
"wlanGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WlanGroupDto"
}
},
"xPercent": {
"type": "number",
"format": "float"
},
"yPercent": {
"type": "number",
"format": "float"
}
}
},
"DownLinkDto": {
"title": "DownLinkDto",
"type": "object",
"properties": {
"IP": {
"type": "string"
},
"apGroupId": {
"type": "string"
},
"apGroupName": {
"type": "string"
},
"apMac": {
"type": "string"
},
"apStatusData": {
"$ref": "#/components/schemas/APStatusDataDto"
},
"clients": {
"type": "integer",
"format": "int32"
},
"configStatus": {
"type": "string"
},
"connectionStatus": {
"type": "string"
},
"crtTime": {
"type": "string",
"description": "The UTC time in milliseconds at which the device was provisioned (created) into the cloud."
},
"description": {
"type": "string"
},
"deviceGroupId": {
"type": "string"
},
"deviceGroupName": {
"type": "string"
},
"deviceModelType": {
"type": "string"
},
"deviceStatus": {
"type": "string"
},
"deviceStatusSeverity": {
"type": "string"
},
"downMac": {
"type": "string"
},
"downlink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownLinkDto"
}
},
"downlink.downMac": {
"type": "array",
"items": {
"type": "string"
}
},
"downlink.rssi": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"downlink.type": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"extIp": {
"type": "string"
},
"externalPort": {
"type": "string"
},
"floorplanId": {
"type": "string"
},
"fwVersion": {
"type": "string"
},
"hops": {
"type": "integer",
"format": "int32"
},
"isMeshEnable": {
"type": "boolean"
},
"lastSeenTime": {
"type": "string"
},
"lastUpdTime": {
"type": "string"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"meshRole": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"rogueCategory": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "The total amount of rogue devices for each category."
},
"rssi": {
"type": "integer",
"format": "int32"
},
"rxBytes": {
"type": "string"
},
"rxFrames": {
"type": "string"
},
"serialNumber": {
"type": "string"
},
"switchName": {
"type": "string"
},
"switchSerialNumber": {
"type": "string"
},
"tags": {
"type": "string"
},
"txBytes": {
"type": "string"
},
"txFrames": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32"
},
"uplink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpLinkDto"
}
},
"uplink.rssi": {
"type": "integer",
"format": "int32"
},
"uplink.upMac": {
"type": "string"
},
"venueId": {
"type": "string"
},
"venueName": {
"type": "string"
},
"wlanGroup24GId": {
"type": "string"
},
"wlanGroup5GId": {
"type": "string"
},
"wlanGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WlanGroupDto"
}
},
"xPercent": {
"type": "number",
"format": "float"
},
"yPercent": {
"type": "number",
"format": "float"
}
}
},
"DynamicQueryPayloadDto": {
"title": "DynamicQueryPayloadDto",
"type": "object",
"properties": {
"exists": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"filters": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"matchFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchFieldDto"
}
},
"multiSortFields": {
"type": "array",
"items": {
"type": "string"
}
},
"mustHaveFields": {
"type": "array",
"items": {
"type": "string"
}
},
"mustNotHaveFields": {
"type": "array",
"items": {
"type": "string"
}
},
"mustNotMatchField": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MustNotMatchFieldDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageByDate": {
"$ref": "#/components/schemas/EntryOfstringAndstring"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"rangeDateFilter": {
"$ref": "#/components/schemas/RangeFilterDto"
},
"rangeFilter": {
"$ref": "#/components/schemas/RangeFilterDto"
},
"searchString": {
"type": "string"
},
"searchTargetFields": {
"type": "array",
"items": {
"type": "string"
}
},
"sortField": {
"type": "string"
},
"sortOrder": {
"type": "string"
},
"termField": {
"$ref": "#/components/schemas/TermFieldDto"
}
}
},
"EntryOfstringAndstring": {
"title": "EntryOfstringAndstring",
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"ViewErrorResponse": {
"title": "ViewErrorResponse",
"type": "object",
"properties": {
"downloadUrl": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"requestId": {
"type": "string"
}
}
},
"GuestDto": {
"title": "GuestDto",
"type": "object",
"properties": {
"clients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientDto"
}
},
"creationDate": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"expiryDate": {
"type": "string"
},
"guestStatus": {
"type": "string",
"description": "Guest status indicates whether the user is allowed to join network or not and the possible values are enabled and disabled."
},
"guestType": {
"type": "string",
"description": "It represents guest user type and possible values are GuestPass, SelfSign, HostGuest."
},
"id": {
"type": "string"
},
"maxNumberOfClients": {
"type": "integer",
"format": "int32"
},
"mobilePhoneNumber": {
"type": "string"
},
"name": {
"type": "string"
},
"networkId": {
"type": "string"
},
"notes": {
"type": "string"
},
"passDurationHours": {
"type": "integer",
"description": "The duration of how long this guest user can connect to this network. if the duration value is 7, the unit is day. the duration hours will be 7 x 24 = 168 hrs",
"format": "int32"
},
"socialLogin": {
"type": "boolean"
},
"ssid": {
"type": "string"
}
}
},
"MatchFieldDto": {
"title": "MatchFieldDto",
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"MustNotMatchFieldDto": {
"title": "MustNotMatchFieldDto",
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"QueryResponseOfCloudpathServerDto": {
"title": "QueryResponseOfCloudpathServerDto",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CloudpathServerDto"
}
},
"errorMessage": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"objectId": {
"type": "string"
},
"page": {
"type": "integer",
"format": "int32"
},
"subsequentQueries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubsequentQuery"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
}
}
},
"QueryResponseOfDeviceDto": {
"title": "QueryResponseOfDeviceDto",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceDto"
}
},
"errorMessage": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"objectId": {
"type": "string"
},
"page": {
"type": "integer",
"format": "int32"
},
"subsequentQueries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubsequentQuery"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
}
}
},
"QueryResponseOfGuestDto": {
"title": "QueryResponseOfGuestDto",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GuestDto"
}
},
"errorMessage": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"objectId": {
"type": "string"
},
"page": {
"type": "integer",
"format": "int32"
},
"subsequentQueries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubsequentQuery"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
}
}
},
"QueryResponseOfRogueApDto": {
"title": "QueryResponseOfRogueApDto",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RogueApDto"
}
},
"errorMessage": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"objectId": {
"type": "string"
},
"page": {
"type": "integer",
"format": "int32"
},
"subsequentQueries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubsequentQuery"
}
},
"totalCount": {
"type": "integer",
"format": "int64"
}
}
},
"RangeFilterDto": {
"title": "RangeFilterDto",
"type": "object",
"properties": {
"field": {
"type": "string"
},
"gte": {
"type": "integer",
"format": "int64"
},
"lt": {
"type": "integer",
"format": "int64"
},
"lte": {
"type": "integer",
"format": "int64"
}
}
},
"RogueApDto": {
"title": "RogueApDto",
"type": "object",
"properties": {
"band": {
"type": "string",
"description": "RF band on which the rogue AP was detected."
},
"category": {
"type": "string",
"description": "Category assigned to a rogue AP resulting from the application of classification policies."
},
"channel": {
"type": "integer",
"description": "RF channel on which the rogue AP was detected.",
"format": "int32"
},
"classificationPolicyName": {
"type": "string",
"description": "Classification policy name."
},
"classificationRuleName": {
"type": "string",
"description": "Classification rule name."
},
"closestAp": {
"$ref": "#/components/schemas/RogueDetectingApDto"
},
"detectingAps": {
"type": "array",
"description": "The list of AP detecting the rogue AP.",
"items": {
"$ref": "#/components/schemas/RogueDetectingApDto"
}
},
"lastDetectingAp": {
"$ref": "#/components/schemas/RogueDetectingApDto"
},
"lastUpdTime": {
"type": "string",
"description": "Timestamp at which the rogue AP was detected."
},
"locatable": {
"type": "boolean",
"description": "A parameter indicating whether the rogue device is locatable or not. If the value of locatable is set to true, the rogue deviceâs location can be queried and possibly found (is not guaranteed). If its value is set to false, the rogue device was not locatable on any floorplan."
},
"numberOfDetectingAps": {
"type": "integer",
"description": "The number of APs detecting the rogue AP.",
"format": "int32"
},
"rogueApMac": {
"type": "string",
"description": "Wired (MAC address) of the rogue AP."
},
"rogueMac": {
"type": "string",
"description": "BSSID (MAC address) of the rogue AP."
},
"ssid": {
"type": "string",
"description": "SSID of the rogue AP."
}
}
},
"RogueDetectingApDto": {
"title": "RogueDetectingApDto",
"type": "object",
"properties": {
"apMac": {
"type": "string",
"description": "Mac address of the detecting AP to the a AP."
},
"apName": {
"type": "string",
"description": "Name of the detecting AP closest to a rogue AP."
},
"apSerialNumber": {
"type": "string",
"description": "Serial number of the detecting AP closest to a rogue AP."
},
"lastUpdTime": {
"type": "string",
"description": "Timestamp at which the detecting AP was updated."
},
"snr": {
"type": "integer",
"description": "SNR of the rogue AP's transmissions, measured by the detecting AP.",
"format": "int32"
}
}
},
"SubsequentQuery": {
"title": "SubsequentQuery",
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"httpMethod": {
"type": "string",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"TRACE"
]
},
"payload": {
"type": "object",
"properties": {}
},
"url": {
"$ref": "#/components/schemas/URI"
}
}
},
"TermFieldDto": {
"title": "TermFieldDto",
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"URI": {
"title": "URI",
"type": "object",
"properties": {
"absolute": {
"type": "boolean"
},
"authority": {
"type": "string"
},
"fragment": {
"type": "string"
},
"host": {
"type": "string"
},
"opaque": {
"type": "boolean"
},
"path": {
"type": "string"
},
"port": {
"type": "integer",
"format": "int32"
},
"query": {
"type": "string"
},
"rawAuthority": {
"type": "string"
},
"rawFragment": {
"type": "string"
},
"rawPath": {
"type": "string"
},
"rawQuery": {
"type": "string"
},
"rawSchemeSpecificPart": {
"type": "string"
},
"rawUserInfo": {
"type": "string"
},
"scheme": {
"type": "string"
},
"schemeSpecificPart": {
"type": "string"
},
"userInfo": {
"type": "string"
}
}
},
"UpLinkDto": {
"title": "UpLinkDto",
"type": "object",
"properties": {
"IP": {
"type": "string"
},
"apGroupId": {
"type": "string"
},
"apGroupName": {
"type": "string"
},
"apMac": {
"type": "string"
},
"apStatusData": {
"$ref": "#/components/schemas/APStatusDataDto"
},
"clients": {
"type": "integer",
"format": "int32"
},
"configStatus": {
"type": "string"
},
"connectionStatus": {
"type": "string"
},
"crtTime": {
"type": "string",
"description": "The UTC time in milliseconds at which the device was provisioned (created) into the cloud."
},
"description": {
"type": "string"
},
"deviceGroupId": {
"type": "string"
},
"deviceGroupName": {
"type": "string"
},
"deviceModelType": {
"type": "string"
},
"deviceStatus": {
"type": "string"
},
"deviceStatusSeverity": {
"type": "string"
},
"downlink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownLinkDto"
}
},
"downlink.downMac": {
"type": "array",
"items": {
"type": "string"
}
},
"downlink.rssi": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"downlink.type": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"extIp": {
"type": "string"
},
"externalPort": {
"type": "string"
},
"floorplanId": {
"type": "string"
},
"fwVersion": {
"type": "string"
},
"hops": {
"type": "integer",
"format": "int32"
},
"isMeshEnable": {
"type": "boolean"
},
"lastSeenTime": {
"type": "string"
},
"lastUpdTime": {
"type": "string"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"meshRole": {
"type": "string"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"rogueCategory": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "The total amount of rogue devices for each category."
},
"rssi": {
"type": "integer",
"format": "int32"
},
"rxBytes": {
"type": "string"
},
"rxFrames": {
"type": "string"
},
"serialNumber": {
"type": "string"
},
"switchName": {
"type": "string"
},
"switchSerialNumber": {
"type": "string"
},
"tags": {
"type": "string"
},
"txBytes": {
"type": "string"
},
"txFrames": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32"
},
"upMac": {
"type": "string"
},
"uplink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpLinkDto"
}
},
"uplink.rssi": {
"type": "integer",
"format": "int32"
},
"uplink.upMac": {
"type": "string"
},
"venueId": {
"type": "string"
},
"venueName": {
"type": "string"
},
"wlanGroup24GId": {
"type": "string"
},
"wlanGroup5GId": {
"type": "string"
},
"wlanGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WlanGroupDto"
}
},
"xPercent": {
"type": "number",
"format": "float"
},
"yPercent": {
"type": "number",
"format": "float"
}
}
},
"WlanGroupDto": {
"title": "WlanGroupDto",
"type": "object",
"properties": {
"radioId": {
"type": "integer",
"format": "int32"
},
"wlanGroupId": {
"type": "string"
},
"wlanGroupName": {
"type": "string"
}
}
}
},
"securitySchemes": {
"Token": {
"type": "apiKey",
"description": "API clients use an API-KEY to access REST endpoints. In order to obtain an API-KEY, an administrator uses the endpoints in the \"API Client Authentication\" group, available on all cloud hosts. The API-KEY issued will have the same access privileges (aka role) as the administrator who obtained the key. Please see document platform-ns-220711.html for details.",
"name": "Cookie",
"in": "header"
}
}
},
"security": [
{
"Token": []
}
]
}