{
"openapi": "3.0.1",
"info": {
"title": "RUCKUS Cloud - Platform APIs and Model Documentation",
"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, Platform 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 |
\nplatform-ns-210412.html | Platform related resources. This document describes API endpoints related to your account including administrators and their notification preferences, venues and your entitlements/licenses. |
\nmsp-ns-210412.html | MSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks. |
\nswitch-ns-210412.html | ICX switch related resources. This document describes API endpoints related to managing your switches and wired networks. |
\nwifi-ns-210412.html | Wi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks. |
\n
\n\n\nDocumentation Change Notes for Release 21.04.12
\nThe following documentation changes were made in this release:\n\n- API endpoints related to VARs and MSPs have been moved to their own document, “MSP/VAR APIs and Model Documentation”. The following API groups which were formerly in this document were moved: Delegation, MSP Service and MSP Entitlements.
\n- The API endpoints to grant and revoke access to RUCKUS Support (i.e., customer support) can now be found in the “RUCKUS Support” API group. Formerly, they were included in the “Delegation” API group.
\n- The companion JSON document, “platform-ns-210412.json” has been upgraded to Open API version 3; the document for earlier releases used version 2.
\n
\n\nCloud Hosts
\n\n\nManaging Accounts
\nThe following is an overview of the API groups used to manage an account.\n\nAPI Group | Purpose |
\n\nAccount | Retrieve account details. Note: this API group only provides methods to retrieve resources (but not to create, update or delete them); account information is managed on the RUCKUS support website. |
\nAdministrator | Used to manage administrators (create, read, update and delete). Administrator access privileges (aka roles), are also assigned using endpoints in this group. |
\n\nUser Profile | Used to manage an administrator’s personal preferences. These preferences (e.g., date format) can be observed in notifications (email, SMS) sent from the RUCKUS cloud. |
\n\nNotification Recipient | Used to manage an account’s list of notification recipients and their preferred notification methods (email, SMS or none). Notifications generated as the result of circumstances in the RUCKUS cloud or account’s networks (typically alarms) that administrators should be aware of; some may require remedial action on the part of an administrator. Note that a notification recipient can anyone, not only an account administrator. |
\n
\n\n\nVenues
\nVenues are container resources for networking devices. Every networking device is installed into a venue resource. Venue resources are managed (created, read, updated and deleted) using endpoints in the “Venue” API group. Note that every account has a default venue, automatically created when the account is initialized.
\n\nWARNING: take care when deleting venues. Deleting a venue will also delete all networking devices contained therein.\n\n
Every venue can have a floorplan associated with it, if desired. On the floorplan, locations of networking devices can be provisioned using endpoints documented in the Wi-Fi or Switch namespace documents. This can be helpful in keeping track of your networking assets. The “Blink LED” endpoints (also in Wi-Fi or Switch namespace documents) be use used to be sure you have the right location marked for each device.
\n\nThe following workflow is used to associate a floorplan with a venue:\n
- Get an upload URL using an endpoint in the “File” API group. The endpoint responds with a file ID and a signed URL.
\n- Upload the file (typically a jpeg, png or pdf file) to that URL.
\n- Create (or update) the venue with the file ID of the new floorplan file.
\n\n\nEntitlements/Licenses
\nEntitlements (aka licenses) are purchased by an account holder and entitle that account to install networking devices in their venues. After purchase, entitlements must be “activated” using the RUCKUS Support website before becoming effective for device installation.\n\n\nGeneral Comments on using API Endpoints
\n\n- Many API endpoints described herein are asynchronous. This is indicated by a successful HTTP response status code of 202 \"Accepted”. To determine if the request succeeded, failed, is still pending or to get more information, invoke an endpoint in the ”Request” API group.
\n\n- After authenticating, all APIs require a Tenant ID. Find your Tenant ID by logging into your cloud host. Your tenant ID is the 32 character string in the URL after \"https://ruckus.cloud/api/ui/t/\".
",
"termsOfService": "https://support.ruckuswireless.com/ruckus-cloud-wifi-legal-terms-and-conditions",
"license": {
"name": "RUCKUS Cloud Privacy Policy",
"url": "https://support.ruckuswireless.com/ruckus-cloud-privacy-policy"
},
"version": "v21.04.12"
},
"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."
}
],
"security": [
{
"Token": []
}
],
"tags": [
{
"name": "API Client Authentication",
"description": "API client authentication operations."
},
{
"name": "Account",
"description": "Retrieve account details."
},
{
"name": "Administrator",
"description": "Manage administrators."
},
{
"name": "User Profile",
"description": "Manage user profiles."
},
{
"name": "Notification Recipient",
"description": "Manage notification recipients."
},
{
"name": "RUCKUS Support",
"description": "Grant access to RUCKUS Support."
},
{
"name": "Venue",
"description": "Manage venues.
WARNING: take care when deleting venues. Deleting a venue (or a list of venues) will also delete all networking devices contained therein."
},
{
"name": "Floor Plan",
"description": "Manage floor-plans and calibration-points (calibrations-points are used to establish, for example, precise AP positioning)."
},
{
"name": "File",
"description": "Manage upload or download files."
},
{
"name": "Entitlement",
"description": "Manage device entitlements (licenses)."
},
{
"name": "Request",
"description": "Retrieve the completion status or details of previously-invoked asynchronous endpoints (i.e., endpoints in other API groups). Note: asynchronous endpoints are indicated by a successful HTTP response status code of 202 \"Accepted\"."
},
{
"name": "View",
"description": "View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration."
}
],
"paths": {
"/token": {
"post": {
"tags": [
"API Client Authentication"
],
"summary": "Request Authentication",
"description": "Returns an API-KEY. An administrator must provide their Ruckus support credential to obtain the API-KEY.
Note: API clients might need manually set the API-KEY as a cookie if not automatically supported.",
"operationId": "loginUsingPOST",
"requestBody": {
"description": "User's credential.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Credential"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/TokenApiKey"
}
}
}
},
"201": {
"description": "Created",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
}
},
"x-codegen-request-body-name": "user"
}
},
"/api/login/tenant/token/{tenantId}": {
"post": {
"tags": [
"API Client Authentication"
],
"summary": "Access Sub-Account",
"description": "This endpoint returns an API-KEY which can be used to access your customer's account (e.g., an MSP-EC).",
"operationId": "switchTenantWithTokenUsingPOST",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant ID of the sub-account (e.g., MSP-EC) to which access is being requested.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/TokenApiKey"
}
}
}
},
"201": {
"description": "Created",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
}
}
}
},
"/api/tenant/{tenantId}": {
"get": {
"tags": [
"Account"
],
"summary": "Get Account Details",
"description": "Get this account's details.",
"operationId": "getTenantByID",
"parameters": [
{
"name": "deep",
"in": "query",
"description": "deep",
"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/Tenant"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/account": {
"get": {
"tags": [
"Account"
],
"summary": "Get Account Address",
"description": "Get this account's postal address.",
"operationId": "getAccountDetails",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountInfo"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/admin": {
"get": {
"tags": [
"Administrator"
],
"summary": "Get Admins",
"description": "Get admin list.",
"operationId": "getAdminList",
"parameters": [
{
"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/AdminView"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Administrator"
],
"summary": "Update Admin",
"description": "Update admin.",
"operationId": "updateAdminRole",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "admin",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminView"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfAdmin"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfAdmin"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "admin"
},
"post": {
"tags": [
"Administrator"
],
"summary": "Add Admin",
"description": "Add admin.",
"operationId": "addAdmin",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "admin",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminView"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfAdmin"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfAdmin"
}
}
}
},
"400": {
"description": "Bad/Malformed Request [TNT-10300: \"Admin already invited to different account\", TNT-10302: \"Admin already registered to Ruckus Support\", TNT-10303: \"Admin already exists\"]",
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "admin"
},
"delete": {
"tags": [
"Administrator"
],
"summary": "Delete Admins",
"description": "Delete admins in bulk.",
"operationId": "deleteBulkAdmin",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "adminIds",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "adminIds"
}
},
"/api/tenant/{tenantId}/admin/{adminId}": {
"get": {
"tags": [
"Administrator"
],
"summary": "Get Admin",
"description": "Get admin by ID.",
"operationId": "getAdminById",
"parameters": [
{
"name": "adminId",
"in": "path",
"description": "adminId",
"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/AdminView"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Administrator"
],
"summary": "Delete Admin",
"description": "Delete admin by ID.",
"operationId": "deleteAdmin",
"parameters": [
{
"name": "adminId",
"in": "path",
"description": "adminId",
"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"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/delegation/support": {
"post": {
"tags": [
"RUCKUS Support"
],
"summary": "Grant Access",
"description": "Grant Ruckus customer support access to my account.",
"operationId": "inviteSupport",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfDelegation"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfDelegation"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"RUCKUS Support"
],
"summary": "Revoke Access",
"description": "Revoke Ruckus customer support's access to my account.",
"operationId": "deleteSupportDelegation",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/notification-recipient": {
"get": {
"tags": [
"Notification Recipient"
],
"summary": "Get Notification Recipients",
"description": "Get notification recipient list.",
"operationId": "getNotificationRecipients",
"parameters": [
{
"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/NotificationRecipient"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Notification Recipient"
],
"summary": "Add Notification Recipient",
"description": "Add notification recipient.",
"operationId": "addNotificationRecipient",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "notificationRecipient",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationRecipient"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfNotificationRecipient"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfNotificationRecipient"
}
}
}
},
"400": {
"description": "Bad/Malformed Request [TNT-10100: \"Duplicate notification endpoint\"]",
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "notificationRecipient"
},
"delete": {
"tags": [
"Notification Recipient"
],
"summary": "Delete Notification Recipient",
"description": "Delete notification recipient list.",
"operationId": "deleteNotificationRecipients",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "notificationRecipients",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRecipient"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "notificationRecipients"
}
},
"/api/tenant/{tenantId}/notification-recipient/{notificationRecipientId}": {
"get": {
"tags": [
"Notification Recipient"
],
"summary": "Get Notification Recipient",
"description": "Get notification recipient by ID.",
"operationId": "getNotificationRecipient",
"parameters": [
{
"name": "notificationRecipientId",
"in": "path",
"description": "notificationRecipientId",
"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/NotificationRecipient"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Notification Recipient"
],
"summary": "Update Notification Recipient",
"description": "Update notification recipient.",
"operationId": "updateNotificationRecipient",
"parameters": [
{
"name": "notificationRecipientId",
"in": "path",
"description": "notificationRecipientId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "notificationRecipient",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationRecipient"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfNotificationRecipient"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfNotificationRecipient"
}
}
}
},
"400": {
"description": "Bad/Malformed Request [TNT-10100: \"Duplicate notification endpoint\"]",
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "notificationRecipient"
},
"delete": {
"tags": [
"Notification Recipient"
],
"summary": "Delete Notification Recipient",
"description": "Delete notification-recipient by ID.",
"operationId": "deleteNotificationRecipient",
"parameters": [
{
"name": "notificationRecipientId",
"in": "path",
"description": "notificationRecipientId",
"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"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/user-profile": {
"get": {
"tags": [
"User Profile"
],
"summary": "Get User Profile",
"description": "Get user profile.",
"operationId": "getUser",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserProfile"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"User Profile"
],
"summary": "Update User Profile",
"description": "Update user profile.",
"operationId": "updateUser",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "userProfile",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfUserProfile"
}
}
}
},
"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 [TNT-10001: \"Tenant is out of sync and requires repair\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "userProfile"
}
},
"/api/tenant/{tenantId}/venue": {
"get": {
"tags": [
"Venue"
],
"summary": "Get Venue List",
"description": "Get venue list.",
"operationId": "getVenues",
"parameters": [
{
"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/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"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Venue"
],
"summary": "Create Venue",
"description": "Create venue.",
"operationId": "createVenue",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "venue",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Venue"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVenue"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVenue"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", CFGC-10000: \"Internal Server Error\", WIFI-10000: \"Internal Server Error\", SWITCH-10000: \"Internal Server Error\", LTE-10000: \"Internal Server Error\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "venue"
},
"delete": {
"tags": [
"Venue"
],
"summary": "Delete Venues by List",
"description": "Delete venues by list.
WARNING: take care when deleting venues. Deleting a list of venues will also delete all networking devices contained therein.",
"operationId": "deleteVenues",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "venueIds",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", CFGC-10000: \"Internal Server Error\", WIFI-10000: \"Internal Server Error\", SWITCH-10000: \"Internal Server Error\", LTE-10000: \"Internal Server Error\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "venueIds"
}
},
"/api/tenant/{tenantId}/venue/{venueId}": {
"get": {
"tags": [
"Venue"
],
"summary": "Get Venue by ID",
"description": "Get venue.",
"operationId": "getVenue",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"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"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Venue"
],
"summary": "Update Venue",
"description": "Update venue.",
"operationId": "updateVenue",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "venue",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Venue"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVenue"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVenue"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", CFGC-10000: \"Internal Server Error\", WIFI-10000: \"Internal Server Error\", SWITCH-10000: \"Internal Server Error\", LTE-10000: \"Internal Server Error\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "venue"
},
"delete": {
"tags": [
"Venue"
],
"summary": "Delete Venue by ID",
"description": "WARNING: take care when deleting venues. Deleting a venue will also delete all networking devices contained therein.",
"operationId": "deleteVenue",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", CFGC-10000: \"Internal Server Error\", WIFI-10000: \"Internal Server Error\", SWITCH-10000: \"Internal Server Error\", LTE-10000: \"Internal Server Error\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/venue/{venueId}/floor-plan": {
"get": {
"tags": [
"Floor Plan"
],
"summary": "Get Floor Plan List",
"description": "Get floor plan list.",
"operationId": "getVenueFloorPlans",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FloorPlan"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Floor Plan"
],
"summary": "Create Floor Plan",
"description": "Create floor plan.",
"operationId": "createVenueFloorPlan",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "floorPlan",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloorPlan"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfFloorPlan"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfFloorPlan"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", WIFI-10000: \"Internal Server Error\", SWITCH-10000: \"Internal Server Error\", LTE-10000: \"Internal Server Error\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "floorPlan"
}
},
"/api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}": {
"get": {
"tags": [
"Floor Plan"
],
"summary": "Get Floor Plan",
"description": "Get floor plan by ID.",
"operationId": "getVenueFloorPlan",
"parameters": [
{
"name": "floorPlanId",
"in": "path",
"description": "floorPlanId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloorPlan"
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Floor Plan"
],
"summary": "Update Floor Plan",
"description": "Update floor plan.",
"operationId": "updateVenueFloorPlan",
"parameters": [
{
"name": "floorPlanId",
"in": "path",
"description": "floorPlanId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "floorPlan",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloorPlan"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfFloorPlan"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfFloorPlan"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", WIFI-10000: \"Internal Server Error\", SWITCH-10000: \"Internal Server Error\", LTE-10000: \"Internal Server Error\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "floorPlan"
},
"delete": {
"tags": [
"Floor Plan"
],
"summary": "Delete Floor Plan",
"description": "Delete floor plan.",
"operationId": "deleteVenueFloorPlan",
"parameters": [
{
"name": "floorPlanId",
"in": "path",
"description": "floorPlanId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfVoid"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", WIFI-10000: \"Internal Server Error\", SWITCH-10000: \"Internal Server Error\", LTE-10000: \"Internal Server Error\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/venue/{venueId}/floor-plan/{floorPlanId}/calibration-points": {
"get": {
"tags": [
"Floor Plan"
],
"summary": "Get Calibrations Points",
"description": "Get floor plan calibrations points by floor plan ID.",
"operationId": "getCalibrationPoints",
"parameters": [
{
"name": "floorPlanId",
"in": "path",
"description": "floorPlanId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalibrationPoint"
}
}
}
}
},
"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"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Floor Plan"
],
"summary": "Update Calibrations Points",
"description": "Update floor plan calibrations points by floor plan ID.",
"operationId": "updateCalibrationPoints",
"parameters": [
{
"name": "floorPlanId",
"in": "path",
"description": "floorPlanId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "venueId",
"in": "path",
"description": "venueId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "calibrationPointList",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalibrationPoint"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfListOfCalibrationPoint"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponseOfListOfCalibrationPoint"
}
}
}
},
"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": "When venue resources are updated, other resources may be affected. If an error occurs modifying a venue resource or other related resources, this status message is returned. [VENUE-10001: \"Tenant is out of sync and requires repair\", LTE-10000: \"Internal Server Error\", VENUE-10203: \"Calibration points must be two\"]",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"deprecated": false,
"x-codegen-request-body-name": "calibrationPointList"
}
},
"/api/file/tenant/{tenantId}/upload-url": {
"post": {
"tags": [
"File"
],
"summary": "Get Upload URL",
"description": "Get a URL with which to upload a file.",
"operationId": "getUploadUrl",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadUrlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SignedUrlResponse"
}
}
}
},
"201": {
"description": "Created",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
}
},
"deprecated": false,
"x-codegen-request-body-name": "request"
}
},
"/api/file/tenant/{tenantId}/{fileId}": {
"get": {
"tags": [
"File"
],
"summary": "Get Download URL",
"description": "Get the URL from which to download this file.",
"operationId": "getDownloadUrl",
"parameters": [
{
"name": "fileId",
"in": "path",
"description": "fileId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"302": {
"description": "Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEntity"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
}
},
"deprecated": false
}
},
"/api/tenant/{tenantId}/entitlement": {
"get": {
"tags": [
"Entitlement"
],
"summary": "Get Entitlements",
"description": "Get the list of device entitlements.",
"operationId": "getEntitlementsUsingGET",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "Tenant Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Filter by device type (optional)",
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"WIFI",
"LTE",
"SWITCH"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Entitlement"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authenticated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Not-authorized",
"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}/entitlement/banner": {
"get": {
"tags": [
"Entitlement"
],
"summary": "Get Banners",
"description": "Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired.",
"operationId": "getBannersUsingGET",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Filter by device type (Optional)",
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"WIFI",
"LTE",
"SWITCH"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseBannerDto"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authenticated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Not-authorized",
"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}/entitlement/refresh": {
"post": {
"tags": [
"Entitlement"
],
"summary": "Refresh Entitlements",
"description": "Refresh entitlements. Note: this endpoint can be used to retrieve recently activated licenses.",
"operationId": "refreshUsingPOST",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Filter by device type (Optional)",
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"WIFI",
"LTE",
"SWITCH"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshLicensesResponse"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authenticated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Not-authorized",
"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}/entitlement/summary": {
"get": {
"tags": [
"Entitlement"
],
"summary": "Get Entitlement Summaries",
"description": "Get summaries of the device entitlements.",
"operationId": "getSummaryUsingGET",
"parameters": [
{
"name": "tenantId",
"in": "path",
"description": "tenantId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Filter by device type (optional)",
"allowEmptyValue": false,
"schema": {
"type": "string",
"enum": [
"WIFI",
"LTE",
"SWITCH"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntitlementOperationInfo"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Not-authenticated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Not-authorized",
"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}/request/status/{status}": {
"get": {
"tags": [
"Request"
],
"summary": "Get Request by Status",
"description": "Retrieve the completion status or details of previously-invoked asynchronous endpoints (i.e., endpoints in other API groups). Note: asynchronous endpoints are indicated by a successful HTTP response status code of 202 \"Accepted\".",
"operationId": "Get Request By Status",
"parameters": [
{
"name": "page",
"in": "query",
"description": "page",
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "size",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "path",
"description": "status",
"required": true,
"schema": {
"type": "string",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
]
}
},
{
"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/Request"
}
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Not-authenticated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Not-authorized",
"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}/request/{requestId}": {
"get": {
"tags": [
"Request"
],
"summary": "Get Request",
"description": "Retrieve the completion status or details of previously-invoked asynchronous endpoints (i.e., endpoints in other API groups). Note: asynchronous endpoints are indicated by a successful HTTP response status code of 202 \"Accepted\".",
"operationId": "Get Request",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "requestId",
"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/Request"
}
}
}
},
"400": {
"description": "Bad/malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Not-authenticated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Not-authorized",
"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}/admin": {
"post": {
"tags": [
"View"
],
"summary": "Get Admins",
"description": "Get the list of admins.",
"operationId": "Get Admins",
"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/QueryResponseOfAdminDto"
}
}
}
},
"400": {
"description": "Invalid tenant_id supplied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"401": {
"description": "Not-authenticated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewErrorResponse"
}
}
}
},
"403": {
"description": "Not-authorized",
"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"
}
}
},
"components": {
"schemas": {
"Credential": {
"title": "Credential",
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"TokenApiKey": {
"title": "TokenApiKey",
"type": "object",
"properties": {
"API-KEY": {
"type": "string"
},
"tenantId": {
"type": "string"
}
}
},
"AccountInfo": {
"title": "AccountInfo",
"type": "object",
"properties": {
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"organization": {
"type": "string"
},
"stateOrProvince": {
"type": "string"
},
"zip": {
"type": "string"
}
}
},
"Admin": {
"title": "Admin",
"type": "object",
"properties": {
"adminRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminRole"
}
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dateFormat": {
"type": "string",
"description": "Admin's preference for the date format shown on the UI and in notifications.",
"enum": [
"mm/dd/yyyy",
"dd/mm/yyyy",
"yyyy/mm/dd"
]
},
"detailLevel": {
"type": "string",
"description": "Enum | Meaning |
ba | Show events appropriate for a basic user. |
it | Show events appropriate for someone having training as an IT administrator. |
su | Show events appropriate for a super user. |
debug | Show events useful for debugging purposes. |
",
"enum": [
"ba",
"it",
"su",
"debug"
]
},
"externalId": {
"type": "string",
"description": "Admin's ID used by Ruckus cloud's external authentication server."
},
"id": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"username": {
"type": "string"
}
}
},
"AdminRole": {
"title": "AdminRole",
"type": "object",
"properties": {
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"delegated": {
"type": "string"
},
"delegatedRoleType": {
"type": "string",
"enum": [
"REC",
"MSP_EC"
]
},
"id": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"role": {
"type": "string",
"description": "Enum | Meaning |
PRIME_ADMIN | Role with the highest level of administrator privilege; all actions are permitted. |
ADMIN | Role permitting administrator to perform any action except personnel assignments (i.e., manage other administrators); for MSP's, this role is not permitted to manage (e.g., create or delete) MSP-ECs. |
VAR_ADMIN | Role permitting VAR personnel the capability to manage delegated accounts. |
READ_ONLY | Role permitting administrator to observe network configuration and operational data, but not the capability to change any configuration. This role can be appropriate for personnel training. |
OFFICE_ADMIN | Role permitting administrator the capability to manage guest Wi-Fi users. |
SUPPORT | Role for Ruckus customer support; this role is not granted to any Ruckus customer (it's included here for the sake of completeness). |
DEVOPS | Role for Ruckus DEVOPS; this role is not granted to any Ruckus customer (it's included here for the sake of completeness). |
",
"enum": [
"PRIME_ADMIN",
"ADMIN",
"READ_ONLY",
"OFFICE_ADMIN"
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"AdminView": {
"title": "AdminView",
"type": "object",
"properties": {
"delegateToAllECs": {
"type": "boolean",
"description": "If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs)."
},
"delegatedECs": {
"type": "array",
"description": "List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.",
"items": {
"type": "string"
}
},
"detailLevel": {
"type": "string",
"description": "Enum | Meaning |
ba | Show events appropriate for a basic user. |
it | Show events appropriate for someone having training as an IT administrator. |
su | Show events appropriate for a super user. |
debug | Show events useful for debugging purposes. |
",
"enum": [
"ba",
"it",
"su",
"debug"
]
},
"email": {
"type": "string"
},
"externalId": {
"type": "string"
},
"id": {
"type": "string"
},
"lastLogin": {
"type": "string"
},
"lastName": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"description": "Enum | Meaning |
PRIME_ADMIN | Role with the highest level of administrator privilege; all actions are permitted. |
ADMIN | Role permitting administrator to perform any action except personnel assignments (i.e., manage other administrators); for MSP's, this role is not permitted to manage (e.g., create or delete) MSP-ECs. |
VAR_ADMIN | Role permitting VAR personnel the capability to manage delegated accounts. |
READ_ONLY | Role permitting administrator to observe network configuration and operational data, but not the capability to change any configuration. This role can be appropriate for personnel training. |
OFFICE_ADMIN | Role permitting administrator the capability to manage guest Wi-Fi users. |
SUPPORT | Role for Ruckus customer support; this role is not granted to any Ruckus customer (it's included here for the sake of completeness). |
DEVOPS | Role for Ruckus DEVOPS; this role is not granted to any Ruckus customer (it's included here for the sake of completeness). |
",
"enum": [
"PRIME_ADMIN",
"ADMIN",
"READ_ONLY",
"OFFICE_ADMIN"
]
}
},
"description": "AdminView View Model"
},
"Delegation": {
"title": "Delegation",
"type": "object",
"properties": {
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"delegatedBy": {
"type": "string"
},
"delegatedTo": {
"type": "string"
},
"delegatedToAdmin": {
"type": "string"
},
"delegatedToName": {
"type": "string"
},
"expiryDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"isValid": {
"type": "boolean"
},
"parentId": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string",
"enum": [
"INVITED",
"ACCEPTED",
"REJECTED",
"REVOKED"
]
},
"type": {
"type": "string",
"description": "Enum | Meaning |
VAR | Return delegations to this VAR. |
SUPPORT | Return delegations to Ruckus customer support. |
MSP | Return the MSP’s MSP-ECs. |
SUPPORT_EC | Return MSP-EC delegations to Ruckus customer support. |
MSP_INSTALLER | Return the MSP’s installers. |
MSP_INTEGRATOR | Return the MSP’s integrators. |
UNKNOWN | Unknown. |
",
"enum": [
"VAR",
"SUPPORT",
"MSP",
"SUPPORT_EC"
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"EmailNotificationEndpoint": {
"title": "EmailNotificationEndpoint",
"allOf": [
{
"$ref": "#/components/schemas/NotificationEndpoint"
},
{
"title": "EmailNotificationEndpoint",
"required": [
"type"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"destination": {
"type": "string"
},
"id": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string",
"enum": [
"OK",
"BOUNCED"
]
},
"type": {
"pattern": "EMAIL",
"type": "string",
"default": "EMAIL"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
]
},
"Error": {
"title": "Error",
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"object": {
"type": "string"
},
"value": {
"type": "object",
"properties": {}
}
}
},
"ErrorResponse": {
"title": "ErrorResponse",
"type": "object",
"properties": {
"requestUrl": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"requestId": {
"type": "string"
}
}
},
"InviteVAR": {
"title": "InviteVAR",
"type": "object",
"properties": {
"username": {
"type": "string"
}
}
},
"MobilePushNotificationEndpoint": {
"title": "MobilePushNotificationEndpoint",
"allOf": [
{
"$ref": "#/components/schemas/NotificationEndpoint"
},
{
"title": "MobilePushNotificationEndpoint",
"required": [
"type"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"deviceId": {
"type": "string"
},
"deviceToken": {
"type": "string"
},
"platform": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"OK",
"BOUNCED"
]
},
"type": {
"pattern": "MOBILE_PUSH",
"type": "string",
"default": "MOBILE_PUSH"
}
}
}
]
},
"Msp": {
"title": "Msp",
"type": "object",
"properties": {
"alarmNotificationLogoUUID": {
"type": "string"
},
"changePasswordUrl": {
"type": "string"
},
"contactSupportUrl": {
"type": "string"
},
"contractSupportBehavior": {
"type": "string"
},
"defaultLogoUUID": {
"type": "string"
},
"email": {
"type": "string"
},
"isDisableNotification": {
"type": "boolean"
},
"logoUUID": {
"type": "string"
},
"mlisaLogoUUID": {
"type": "string"
},
"mspFQDN": {
"type": "string"
},
"mspLabel": {
"type": "string"
},
"myOpenCaseBehavior": {
"type": "string"
},
"myOpenCaseUrl": {
"type": "string"
},
"openCaseBehavior": {
"type": "string"
},
"openCaseUrl": {
"type": "string"
},
"phone": {
"type": "string"
},
"pingLoginLogoUUID": {
"type": "string"
},
"pingNotificationLogoUUID": {
"type": "string"
},
"website": {
"type": "string"
}
}
},
"NotificationEndpoint": {
"title": "NotificationEndpoint",
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"destination": {
"type": "string"
},
"id": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string",
"enum": [
"OK",
"BOUNCED"
]
},
"type": {
"type": "string"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"description": "One Of:\nEmailNotificationEndpoint\nSmsNotificationEndpoint\nMobilePushNotificationEndpoint",
"discriminator": {
"propertyName": "type"
}
},
"NotificationRecipient": {
"title": "NotificationRecipient",
"required": [
"description",
"endpoints"
],
"type": "object",
"properties": {
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationEndpoint"
}
},
"id": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"OperationResponse": {
"title": "OperationResponse",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "object",
"properties": {}
}
}
},
"OperationResponseOfAdmin": {
"title": "OperationResponseOfAdmin",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/Admin"
}
}
},
"OperationResponseOfDelegation": {
"title": "OperationResponseOfDelegation",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/Delegation"
}
}
},
"OperationResponseOfNotificationRecipient": {
"title": "OperationResponseOfNotificationRecipient",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/NotificationRecipient"
}
}
},
"OperationResponseOfUserProfile": {
"title": "OperationResponseOfUserProfile",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/UserProfile"
}
}
},
"OperationResponseOfVoid": {
"title": "OperationResponseOfVoid",
"type": "object",
"properties": {
"requestId": {
"type": "string"
}
}
},
"Region": {
"title": "Region",
"type": "object",
"properties": {
"current": {
"type": "boolean"
},
"description": {
"type": "string"
},
"link": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"SmsNotificationEndpoint": {
"title": "SmsNotificationEndpoint",
"allOf": [
{
"$ref": "#/components/schemas/NotificationEndpoint"
},
{
"title": "SmsNotificationEndpoint",
"required": [
"type"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"destination": {
"type": "string"
},
"id": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string",
"enum": [
"OK",
"BOUNCED"
]
},
"type": {
"pattern": "SMS",
"type": "string",
"default": "SMS"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
]
},
"Tenant": {
"title": "Tenant",
"required": [
"externalId"
],
"type": "object",
"properties": {
"admins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Admin"
}
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"delegationsTo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Delegation"
}
},
"externalId": {
"type": "string"
},
"externalModifiedDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"isActivated": {
"type": "boolean"
},
"maintenanceDate": {
"type": "string",
"format": "date-time"
},
"maintenanceState": {
"type": "boolean"
},
"msp": {
"$ref": "#/components/schemas/Msp"
},
"name": {
"type": "string"
},
"notificationRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRecipient"
}
},
"obsolete": {
"type": "boolean"
},
"oemName": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"ruckusUser": {
"type": "boolean"
},
"status": {
"type": "string",
"description": "Enum | Meaning |
active | The account is active. |
suspended | The account has been administratively suspended for an indefinite period of time; while in this state, logins are disabled. |
maintenance | The account is temporarily undergoing maintenance; while in this state, logins are disabled. |
deleted | The account has been deleted; although a record of the account exists, all other network management configuration and data has been deleted. |
",
"enum": [
"active",
"suspended",
"deleted",
"maintenance"
]
},
"tenantMFA": {
"$ref": "#/components/schemas/TenantMFA"
},
"tenantType": {
"type": "string",
"description": "Enum | Meaning |
REC | Ruckus end customer. |
VAR | Value-added reseller. |
MSP | Managed service provider. |
MSP_EC | MSP's end customer. |
MSP_NON_VAR | This value is reserved for Ruckus purposes. |
MSP_INSTALLER | Installer organization which administratively reports to an MSP. |
MSP_INTEGRATOR | Installer organization which administratively reports to an MSP. |
UNKNOWN | Unknown. |
",
"enum": [
"REC",
"MSP",
"MSP_EC"
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"TenantMFA": {
"title": "TenantMFA",
"type": "object",
"properties": {
"mfaStatus": {
"type": "string"
},
"recoveryCodes": {
"type": "string"
}
}
},
"UserProfile": {
"title": "UserProfile",
"required": [
"dateFormat",
"detailLevel"
],
"type": "object",
"properties": {
"adminId": {
"type": "string"
},
"allowedRegions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
},
"cloudCertStatus": {
"type": "string"
},
"companyName": {
"type": "string"
},
"dateFormat": {
"type": "string",
"enum": [
"mm/dd/yyyy",
"dd/mm/yyyy",
"yyyy/mm/dd"
]
},
"delegatedDogfood": {
"type": "boolean"
},
"detailLevel": {
"type": "string",
"enum": [
"ba",
"it",
"su",
"debug"
]
},
"email": {
"type": "string"
},
"externalId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"region": {
"type": "string"
},
"role": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"tenantId": {
"type": "string"
},
"username": {
"type": "string"
},
"var": {
"type": "boolean"
},
"varTenantId": {
"type": "string"
}
}
},
"Address": {
"title": "Address",
"required": [
"city",
"country"
],
"type": "object",
"properties": {
"addressLine": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
},
"notes": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"CalibrationPoint": {
"title": "CalibrationPoint",
"type": "object",
"properties": {
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"id": {
"type": "string"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"xPercent": {
"type": "number",
"format": "float"
},
"yPercent": {
"type": "number",
"format": "float"
}
}
},
"FloorPlan": {
"title": "FloorPlan",
"type": "object",
"properties": {
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"floorNumber": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string"
},
"imageId": {
"type": "string"
},
"imageName": {
"type": "string"
},
"imageUrl": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"OperationResponseOfFloorPlan": {
"title": "OperationResponseOfFloorPlan",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/FloorPlan"
}
}
},
"OperationResponseOfListOfCalibrationPoint": {
"title": "OperationResponseOfListOfCalibrationPoint",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalibrationPoint"
}
}
}
},
"OperationResponseOfVenue": {
"title": "OperationResponseOfVenue",
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/Venue"
}
}
},
"Venue": {
"title": "Venue",
"required": [
"name"
],
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/Address"
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"floorPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FloorPlan"
}
},
"id": {
"type": "string"
},
"name": {
"maxLength": 32,
"minLength": 2,
"pattern": "\\s*\\S+\\s*\\S+.*",
"type": "string"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"ResponseEntity": {
"title": "ResponseEntity",
"type": "object",
"properties": {
"body": {
"type": "object",
"properties": {}
},
"statusCode": {
"type": "string"
},
"statusCodeValue": {
"type": "integer",
"format": "int32"
}
}
},
"SignedUrlResponse": {
"title": "SignedUrlResponse",
"type": "object",
"properties": {
"fileId": {
"type": "string"
},
"signedUrl": {
"type": "string",
"description": "A signed URL is a URL that provides limited permission and time to make a request."
}
}
},
"UploadUrlRequest": {
"title": "UploadUrlRequest",
"type": "object",
"properties": {
"fileExtension": {
"type": "string"
}
}
},
"Entitlement": {
"title": "Entitlement",
"type": "object",
"properties": {
"assignedLicense": {
"type": "boolean",
"description": "Used to determine if the entitlement (aka license) is an assigned license."
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"deviceSubType": {
"type": "string"
},
"deviceType": {
"type": "string",
"enum": [
"UNASSIGNED_DEVICE_TYPE",
"WIFI",
"LTE",
"SWITCH"
]
},
"effectiveDate": {
"type": "string",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"externalId": {
"type": "string"
},
"graceEndDate": {
"type": "string",
"description": "Grace period end date; after the grace period, installed device not covered by an entitlement may be subject to deletion.",
"format": "date-time"
},
"historical": {
"type": "boolean",
"description": "If true, this entitlement is expired and no longer in the grace period; it's provided for historical purposes."
},
"id": {
"type": "string"
},
"parentId": {
"type": "string",
"readOnly": true
},
"quantity": {
"type": "integer",
"format": "int64"
},
"sku": {
"type": "string"
},
"tempLicense": {
"type": "boolean",
"description": "If true, this entitlement is used for a product trial."
},
"updatedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"EntitlementOperationInfo": {
"title": "EntitlementOperationInfo",
"type": "object",
"properties": {
"closestLicenseQuantity": {
"type": "integer",
"format": "int64"
},
"closestLiceseQtty": {
"type": "integer",
"format": "int64"
},
"deviceCount": {
"type": "integer",
"format": "int64"
},
"deviceSubType": {
"type": "string"
},
"deviceType": {
"type": "string",
"enum": [
"UNASSIGNED_DEVICE_TYPE",
"WIFI",
"LTE",
"SWITCH"
]
},
"effectiveDate": {
"type": "string",
"format": "date-time"
},
"errorCode": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"internalMessage": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int64"
},
"remainingDays": {
"type": "integer",
"format": "int64"
},
"remainingDevices": {
"type": "integer",
"format": "int64"
},
"sku": {
"type": "string"
}
}
},
"LicenseBannerDto": {
"title": "LicenseBannerDto",
"type": "object",
"properties": {
"deviceCount": {
"type": "integer",
"format": "int64"
},
"deviceSubType": {
"type": "string"
},
"deviceType": {
"type": "string",
"enum": [
"UNASSIGNED_DEVICE_TYPE",
"WIFI",
"LTE",
"SWITCH"
]
},
"effectDate": {
"type": "string",
"format": "date-time"
},
"effectDays": {
"type": "integer",
"format": "int64"
},
"multipleLicense": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"INITIAL",
"CLOSE_TO_EXPIRATION",
"GRACE_PERIOD",
"AFTER_GRACE_PERIOD"
]
}
}
},
"RefreshLicensesResponse": {
"title": "RefreshLicensesResponse",
"type": "object",
"properties": {
"entitlements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Entitlement"
}
},
"summary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntitlementOperationInfo"
}
}
}
},
"AdminDto": {
"title": "AdminDto",
"type": "object",
"properties": {
"createDate": {
"type": "integer",
"format": "int64"
},
"externalId": {
"type": "string"
},
"id": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"updateDate": {
"type": "integer",
"description": "The entity's last modified timestamp in UTC milliseconds.",
"format": "int64"
},
"username": {
"type": "string"
}
}
},
"DhcpData": {
"title": "DhcpData",
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"mode": {
"type": "string"
}
}
},
"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"
}
},
"mustNotMatchField": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MustNotMatchFieldDto"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pageByDate": {
"$ref": "#/components/schemas/EntryOfstringAndstring"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"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"
}
}
},
"EntitlementDto": {
"title": "EntitlementDto",
"type": "object",
"properties": {
"consumed": {
"type": "string"
},
"entitlementDeviceSubType": {
"type": "string"
},
"entitlementDeviceType": {
"type": "string"
},
"expirationDate": {
"type": "string"
},
"quantity": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"toBeRemovedQuantity": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string"
}
}
},
"EntryOfstringAndstring": {
"title": "EntryOfstringAndstring",
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"ViewErrorResponse": {
"title": "ViewErrorResponse",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"requestId": {
"type": "string"
}
}
},
"JSONArray": {
"title": "JSONArray",
"type": "object"
},
"MatchFieldDto": {
"title": "MatchFieldDto",
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"MustNotMatchFieldDto": {
"title": "MustNotMatchFieldDto",
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"QueryResponseOfAdminDto": {
"title": "QueryResponseOfAdminDto",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminDto"
}
},
"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"
},
"lte": {
"type": "integer",
"format": "int64"
}
}
},
"Request": {
"title": "Request",
"type": "object",
"properties": {
"admin": {
"type": "string"
},
"count": {
"type": "integer",
"format": "int32"
},
"entityId": {
"type": "string"
},
"method": {
"type": "string"
},
"requestId": {
"type": "string"
},
"serviceName": {
"type": "string"
},
"status": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"timestamp": {
"type": "string"
}
}
},
"SubsequentQuery": {
"title": "SubsequentQuery",
"type": "object",
"properties": {
"fields": {
"$ref": "#/components/schemas/JSONArray"
},
"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"
}
}
}
},
"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.",
"name": "Cookie",
"in": "header"
}
}
}
}