Documentation Powered by Redocly

RUCKUS Cloud - Platform APIs and Model Documentation (v22.07.11)

License: RUCKUS Cloud Privacy Policy Terms of Service

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

This 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.

Document NameResources Managed
platform-ns-220711.htmlPlatform related resources. This document describes API endpoints related to your account including administrators and their notification preferences, venues and your entitlements/licenses.
msp-ns-220711.htmlMSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks.
switch-ns-220711.htmlICX switch related resources. This document describes API endpoints related to managing your switches and wired networks.
wifi-ns-220711.htmlWi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks.

Cloud Hosts

RegionDomain
Asiahttps://asia.ruckus.cloud
Europehttps://eu.ruckus.cloud
North Americahttps://ruckus.cloud

Introduction to Platform Concepts

Managing Accounts

The following is an overview of the API groups used to manage an account.
API GroupPurpose
AccountRetrieve 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.
AdministratorUsed to manage administrators (create, read, update and delete). Administrator access privileges (aka roles), are also assigned using endpoints in this group.
User ProfileUsed 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.
Notification RecipientUsed 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.

Venues

Venues 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.

WARNING: take care when deleting venues. Deleting a venue will also delete all networking devices contained therein.

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.

The following workflow is used to associate a floorplan with a venue:

  1. Get an upload URL using an endpoint in the “File” API group. The endpoint responds with a file ID and a signed URL.
  2. Upload the file (typically a jpeg, png or pdf file) to that URL.
  3. Create (or update) the venue with the file ID of the new floorplan file.

Entitlements/Licenses

Entitlements (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.

General Comments on using API Endpoints

  • 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.
  • 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/".

API Client Authentication

API client authentication operations.

Request Authentication

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.

Authorizations:
Token
Request Body schema: application/json

User's credential.

password
string
username
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "username": "string"
}

Access Sub-Account

This endpoint returns an API-KEY which can be used to access your customer's account (e.g., an MSP-EC).

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant ID of the sub-account (e.g., MSP-EC) to which access is being requested.

Responses

Account

Get Account Details

Get this account's details.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

query Parameters
deep
string

deep

Responses

Response samples

Content type
application/json
{
  • "admins": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "delegationsTo": [
    ],
  • "externalId": "string",
  • "externalModifiedDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "isActivated": true,
  • "msp": {
    },
  • "name": "string",
  • "notificationRecipients": [
    ],
  • "obsolete": true,
  • "oemName": "string",
  • "ruckusUser": true,
  • "status": "active",
  • "tenantMFA": {
    },
  • "tenantType": "REC",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Get Account Address

Get this account's postal address.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "organization": "string",
  • "stateOrProvince": "string",
  • "zip": "string"
}

Administrator

Get Admins

Get admin list.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Admin

Update admin.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

admin

delegateToAllECs
boolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECs
Array of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevel
string
Enum: "ba" "it" "su" "debug"
EnumMeaning
baShow events appropriate for a basic user.
itShow events appropriate for someone having training as an IT administrator.
suShow events appropriate for a super user.
debugShow events useful for debugging purposes.
email
string
externalId
string
id
string
lastLogin
string
lastName
string
name
string
role
string
Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN"
EnumMeaning
PRIME_ADMINRole with the highest level of administrator privilege; all actions are permitted.
ADMINRole 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_ADMINRole permitting VAR personnel the capability to manage delegated accounts.
READ_ONLYRole 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_ADMINRole permitting administrator the capability to manage guest Wi-Fi users.
SUPPORTRole for RUCKUS customer support; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).
DEVOPSRole for RUCKUS DEVOPS; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).

Responses

Request samples

Content type
application/json
{
  • "delegateToAllECs": true,
  • "delegatedECs": [
    ],
  • "detailLevel": "ba",
  • "email": "string",
  • "externalId": "string",
  • "id": "string",
  • "lastLogin": "string",
  • "lastName": "string",
  • "name": "string",
  • "role": "PRIME_ADMIN"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Add Admin

Add admin.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

admin

delegateToAllECs
boolean

If set to true, this admin is permitted to manage all delegated account IDs (RECs or MSP-ECs).

delegatedECs
Array of strings

List of delegated account IDs (RECs or MSP-ECs) that this admin is permitted to manage.

detailLevel
string
Enum: "ba" "it" "su" "debug"
EnumMeaning
baShow events appropriate for a basic user.
itShow events appropriate for someone having training as an IT administrator.
suShow events appropriate for a super user.
debugShow events useful for debugging purposes.
email
string
externalId
string
id
string
lastLogin
string
lastName
string
name
string
role
string
Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN"
EnumMeaning
PRIME_ADMINRole with the highest level of administrator privilege; all actions are permitted.
ADMINRole 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_ADMINRole permitting VAR personnel the capability to manage delegated accounts.
READ_ONLYRole 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_ADMINRole permitting administrator the capability to manage guest Wi-Fi users.
SUPPORTRole for RUCKUS customer support; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).
DEVOPSRole for RUCKUS DEVOPS; this role is not granted to any RUCKUS customer (it's included here for the sake of completeness).

Responses

Request samples

Content type
application/json
{
  • "delegateToAllECs": true,
  • "delegatedECs": [
    ],
  • "detailLevel": "ba",
  • "email": "string",
  • "externalId": "string",
  • "id": "string",
  • "lastLogin": "string",
  • "lastName": "string",
  • "name": "string",
  • "role": "PRIME_ADMIN"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Admins

Delete admins in bulk.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: */*

adminIds

Array
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Admin

Get admin by ID.

Authorizations:
Token
path Parameters
adminId
required
string

adminId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "delegateToAllECs": true,
  • "delegatedECs": [
    ],
  • "detailLevel": "ba",
  • "email": "string",
  • "externalId": "string",
  • "id": "string",
  • "lastLogin": "string",
  • "lastName": "string",
  • "name": "string",
  • "role": "PRIME_ADMIN"
}

Delete Admin

Delete admin by ID.

Authorizations:
Token
path Parameters
adminId
required
string

adminId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

User Profile

Get Cloud Certificate

Get cloud certificate.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "cloudCertStatus": "string"
}

Get User Profile

Get user profile.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "adminId": "string",
  • "allowedRegions": [
    ],
  • "companyName": "string",
  • "dateFormat": "mm/dd/yyyy",
  • "delegatedDogfood": true,
  • "detailLevel": "ba",
  • "email": "string",
  • "externalId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "region": "string",
  • "role": "string",
  • "roles": [
    ],
  • "tenantId": "string",
  • "username": "string",
  • "var": true,
  • "varTenantId": "string"
}

Update User Profile

Update user profile.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

userProfile

adminId
string
Array of objects (Region)

Regions are the continents to which the user is allowed. Currently permitted regions are North America, European Union and Asia.

companyName
string
dateFormat
required
string
Enum: "mm/dd/yyyy" "dd/mm/yyyy" "yyyy/mm/dd"
delegatedDogfood
boolean

Delegation to a dog food account (internal RUCKUS test accounts, named per the saying, eat your own dog food).

detailLevel
required
string
Enum: "ba" "it" "su" "debug"
email
string
externalId
string
firstName
string
lastName
string
region
string
role
string
roles
Array of strings
tenantId
string
username
string
var
boolean
varTenantId
string

Responses

Request samples

Content type
application/json
{
  • "adminId": "string",
  • "allowedRegions": [
    ],
  • "companyName": "string",
  • "dateFormat": "mm/dd/yyyy",
  • "delegatedDogfood": true,
  • "detailLevel": "ba",
  • "email": "string",
  • "externalId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "region": "string",
  • "role": "string",
  • "roles": [
    ],
  • "tenantId": "string",
  • "username": "string",
  • "var": true,
  • "varTenantId": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

RUCKUS Support

Grant Access

Grant Ruckus customer support access to my account.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Revoke Access

Revoke Ruckus customer support's access to my account.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Notification Recipient

Get Notification Recipients

Get notification recipient list.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Notification Recipient

Add notification recipient.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

notificationRecipient

description
required
string
required
Array of objects (NotificationEndpoint)
id
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "endpoints": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Notification Recipient

Delete notification recipient list.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: */*

notificationRecipients

Array
description
required
string
required
Array of objects (NotificationEndpoint)
id
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Notification Recipient

Get notification recipient by ID.

Authorizations:
Token
path Parameters
notificationRecipientId
required
string

notificationRecipientId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "endpoints": [
    ],
  • "id": "string",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Update Notification Recipient

Update notification recipient.

Authorizations:
Token
path Parameters
notificationRecipientId
required
string

notificationRecipientId

tenantId
required
string

tenantId

Request Body schema: application/json

notificationRecipient

description
required
string
required
Array of objects (NotificationEndpoint)
id
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "endpoints": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Notification Recipient

Delete notification-recipient by ID.

Authorizations:
Token
path Parameters
notificationRecipientId
required
string

notificationRecipientId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Venue

Get Venues

Get venue list.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Venue

Create venue.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

venueView

object (AddressView)
description
string
Array of objects (FloorPlanView)
name
required
string [ 2 .. 32 ] characters \s*\S+\s*\S+.*

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "description": "string",
  • "floorPlans": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Venues by IDs

Delete venues by list.

WARNING: take care when deleting venues. Deleting a list of venues will also delete all networking devices contained therein.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: */*

venueIds

Array
string

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Get Venue by ID

Get venue.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
{
  • "address": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "floorPlans": [
    ],
  • "id": "string",
  • "name": "string",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Update Venue

Update venue.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Request Body schema: application/json

venueView

object (AddressView)
description
string
Array of objects (FloorPlanView)
name
required
string [ 2 .. 32 ] characters \s*\S+\s*\S+.*

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "description": "string",
  • "floorPlans": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Venue by ID

WARNING: take care when deleting venues. Deleting a venue will also delete all networking devices contained therein.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

Floor Plan

Get Floor Plans

Get floor plans by a venue ID.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Floor Plan

Create floor plan.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Request Body schema: application/json

floorPlanView

floorNumber
integer <int32>
imageId
string
imageName
string
name
string
object (VenueView)

Responses

Request samples

Content type
application/json
{
  • "floorNumber": 0,
  • "imageId": "string",
  • "imageName": "string",
  • "name": "string",
  • "venue": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Get Floor Plan

Get floor plan by ID.

Authorizations:
Token
path Parameters
floorPlanId
required
string

floorPlanId

tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "floorNumber": 0,
  • "id": "string",
  • "imageId": "string",
  • "imageName": "string",
  • "imageUrl": "string",
  • "name": "string",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Update Floor Plan

Update floor plan.

Authorizations:
Token
path Parameters
floorPlanId
required
string

floorPlanId

tenantId
required
string

tenantId

venueId
required
string

venueId

Request Body schema: application/json

floorPlanView

floorNumber
integer <int32>
imageId
string
imageName
string
name
string
object (VenueView)

Responses

Request samples

Content type
application/json
{
  • "floorNumber": 0,
  • "imageId": "string",
  • "imageName": "string",
  • "name": "string",
  • "venue": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "response": {
    }
}

Delete Floor Plan

Delete floor plan.

Authorizations:
Token
path Parameters
floorPlanId
required
string

floorPlanId

tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
{
  • "requestId": "string"
}

File

Get Upload URL

Get a URL with which to upload a file.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

request

fileExtension
string

Responses

Request samples

Content type
application/json
{
  • "fileExtension": "string"
}

Get Download URL

Get the URL from which to download this file.

Authorizations:
Token
path Parameters
fileId
required
string

fileId

tenantId
required
string

tenantId

Responses

Entitlement

Get Entitlements

Get the list of device entitlements.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant Id

query Parameters
type
string
Enum: "WIFI" "LTE" "SWITCH"

Filter by device type (optional)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Banners

Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

query Parameters
type
string
Enum: "WIFI" "LTE" "SWITCH"

Filter by device type (Optional)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Refresh Entitlements

Refresh entitlements. Note: this endpoint can be used to retrieve recently activated licenses.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

query Parameters
type
string
Enum: "WIFI" "LTE" "SWITCH"

Filter by device type (Optional)

Responses

Response samples

Content type
application/json
{
  • "entitlements": [
    ],
  • "summary": [
    ]
}

Get Entitlement Summaries

Get summaries of the device entitlements.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId

query Parameters
type
string
Enum: "WIFI" "LTE" "SWITCH"

Filter by device type (optional)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Request

Get Request by Status

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".

Authorizations:
Token
path Parameters
status
required
string
Enum: "PENDING" "SUCCESS" "FAIL"

status

tenantId
required
string

tenantId

query Parameters
page
string

page

size
string

size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Request

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".

Authorizations:
Token
path Parameters
requestId
required
string

requestId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "admin": "string",
  • "count": 0,
  • "entityId": "string",
  • "method": "string",
  • "requestId": "string",
  • "serviceName": "string",
  • "status": "string",
  • "tenantId": "string",
  • "timestamp": "string"
}

View

Get Admins

Get the list of admins.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

exists
string
fields
Array of strings
object
Array of objects (MatchFieldDto)
multiSortFields
Array of strings
mustHaveFields
Array of strings
mustNotHaveFields
Array of strings
Array of objects (MustNotMatchFieldDto)
page
integer <int32>
object (EntryOfstringAndstring)
pageSize
integer <int32>
object (RangeFilterDto)
object (RangeFilterDto)
searchString
string
searchTargetFields
Array of strings
sortField
string
sortOrder
string
object (TermFieldDto)

Responses

Request samples

Content type
application/json
{
  • "exists": "string",
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustHaveFields": [
    ],
  • "mustNotHaveFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "rangeDateFilter": {
    },
  • "rangeFilter": {
    },
  • "searchString": "string",
  • "searchTargetFields": [
    ],
  • "sortField": "string",
  • "sortOrder": "string",
  • "termField": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errorMessage": "string",
  • "fields": [
    ],
  • "objectId": "string",
  • "page": 0,
  • "subsequentQueries": [
    ],
  • "totalCount": 0
}

Get Venue Status

Get venue status.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "addressLine": "string",
  • "city": "string",
  • "country": "string",
  • "crtTime": "string",
  • "description": "string",
  • "dhcp": {
    },
  • "id": "string",
  • "lastUpdTime": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "mesh": {
    },
  • "name": "string",
  • "notes": "string",
  • "rogueDetection": {
    },
  • "switchProfileId": "string",
  • "switchProfileName": "string",
  • "tenantId": "string",
  • "timeZone": "string",
  • "type": "string",
  • "wifiFirmwareVersion": "string"
}