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.
Region | Domain |
Asia | https://asia.ruckus.cloud |
Europe | https://eu.ruckus.cloud |
North America | https://ruckus.cloud |
Abbreviation | Description |
REC | RUCKUS end customer. RUCKUS end customers use API endpoints to manage their own account and networks. |
VAR | Value-added reseller. VARs can manage the account (including networks) of specific RECs. In order for a VAR to manage an REC’s account, the REC must first invite the VAR to manage their account and the VAR must accept the invitation. A successful invitation and acceptance process is modeled by a delegation resource. API endpoints in the ”Delegation” API group are used to manage these delegations. In order for a VAR to manage (configure and monitor) an REC’s account using API endpoints, the VAR’s API client must obtain an API token for that REC; an endpoint in the “API Client Authentication” group is used for this purpose. When a VAR is managing an REC’s network, the VAR may need to install devices in that network on behalf of the REC. Entitlements which the REC has purchased and activated used for this purpose. VAR accounts can have their own networks, just like an REC has its own networks. API endpoints can be used to manage the VAR’s account (including networks) in the same way endpoints are used to manage an REC’s account. A VAR must have their own entitlements to install devices in their own network. |
MSP | Managed service provider. MSPs have their own customers, referred to as MSP-ECs, which are not known to RUCKUS. MSPs manage the accounts (including networks) of all their MSP-ECs. MSP-ECs and the resources that represent them are “created” by an MSP. These resources are not visible to any other business entity. MSPs use the endpoints in the “MSP Service” API group to configure and brand their business as well as to create and manage MSP-EC resources. Note that MSP to MSP-EC relationships are modeled as a delegation resource (as is done for VARs and RECs). However, MSP to MSP-EC delegation resources are created automatically, requiring no action on the part of an MSP-EC. Moreover, an MSP to MSP-EC delegation cannot be revoked by the MSP-EC. In order for an MSP to manage (configure and monitor) an MSP-EC’s account using API endpoints, the MSP’s API client must obtain an API token for that MSP-EC; an endpoint in the “API Client Authentication” group is used for this purpose. MSP’s use MSP entitlements (aka bulk licenses) to enable the installation of networking devices in MSP-EC networks. In order to install a networking device, one or more MSP entitlements are assigned to an MSP-EC; this action creates an assignment resource. Once assignment resources are created, devices can be installed. MSP API clients use the endpoints in the “MSP Entitlement“ API group to manage their MSP entitlements and assignments. MSP accounts can have their own networks, just like an REC has its own networks. API endpoints can be used to manage the MSP’s account (including networks) in the same way endpoints are used to manage an REC’s account. Note that entitlements (i.e., not MSP entitlements), purchased by the MSP, are used to install devices in their own network. |
MSP-EC | MSP's end customer. MSP-ECs use API endpoints to manage their own networks, if permitted by their MSP. |
API Group | Purpose |
Account | 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. |
Administrator | Used to manage administrators (create, read, update and delete). Administrator access privileges (aka roles), are also assigned using endpoints in this group. |
User-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. |
Notification 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. |
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.
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:
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 roles) as the administrator who obtained the key.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API-KEY |
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.
User's credential.
password | string |
username | string |
{- "password": "string",
- "username": "string"
}
Get this account's details.
tenantId required | string tenantId |
deep | string deep |
{- "admins": [
- {
- "adminRoles": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegated": "string",
- "delegatedRoleType": "RKS_EC",
- "id": "string",
- "parentId": "string",
- "role": "PRIME_ADMIN",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "createdDate": "2019-08-24T14:15:22Z",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "externalId": "string",
- "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "username": "string"
}
], - "createdDate": "2019-08-24T14:15:22Z",
- "delegationsTo": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "parentId": "string",
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "externalId": "string",
- "externalModifiedDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isActivated": true,
- "maintenanceDate": "2019-08-24T14:15:22Z",
- "maintenanceState": true,
- "msp": {
- "alarmNotificationLogoUUID": "string",
- "changePasswordUrl": "string",
- "contactSupportUrl": "string",
- "contractSupportBehavior": "string",
- "defaultLogoUUID": "string",
- "email": "string",
- "isDisableNotification": true,
- "logoUUID": "string",
- "mlisaLogoUUID": "string",
- "mspFQDN": "string",
- "mspLabel": "string",
- "myOpenCaseBehavior": "string",
- "myOpenCaseUrl": "string",
- "openCaseBehavior": "string",
- "openCaseUrl": "string",
- "phone": "string",
- "pingLoginLogoUUID": "string",
- "pingNotificationLogoUUID": "string",
- "website": "string"
}, - "mspEc": {
- "parentMspId": "string",
- "serviceEffectiveDate": "2019-08-24T14:15:22Z",
- "serviceExpirationDate": "2019-08-24T14:15:22Z"
}, - "name": "string",
- "notificationRecipients": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "destination": "string",
- "id": "string",
- "parentId": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "obsolete": true,
- "oemName": "string",
- "parentId": "string",
- "ruckusUser": true,
- "status": "active",
- "tenantMFA": {
- "mfaStatus": "string",
- "recoveryCodes": "string"
}, - "tenantType": "REC",
- "updatedDate": "2019-08-24T14:15:22Z"
}
Get this account's postal address.
tenantId required | string tenantId |
{- "address": "string",
- "city": "string",
- "country": "string",
- "organization": "string",
- "stateOrProvince": "string",
- "zip": "string"
}
Manage administrators.
Administrator resources are assigned roles from the following table.
Role | Privileges |
PRIME_ADMIN | Role with the highest level of administrator privilege; all actions are permitted. For API-KEYs issued to administrators having this role, API clients have access to all API endpoints and methods. |
ADMIN | Role permitting administrator to perform any action except personnel assignments except those modifying personnel assignments (i.e., managing other administrators); for MSP's, this role is not permitted to modify any MSP-EC account. For API-KEYs issued to administrators having this role, API clients have access to all API endpoints and methods except those used to modify administrators and MSP-ECs. |
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. For API-KEYs issued to administrators having this role, API clients can access endpoints but are restricted to using their get and post methods (post method access is only permitted when used to invoke a query operation). |
OFFICE_ADMIN | Role permitting administrator the capability to manage guest Wi-Fi users. Refer to the Wi-Fi namespace API documentation for the endpoints and methods used to manage guests. |
[- {
- "delegateToAllECs": true,
- "delegatedECs": [
- "string"
], - "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "id": "string",
- "lastLogin": "string",
- "lastName": "string",
- "name": "string",
- "role": "PRIME_ADMIN"
}
]
tenantId required | string tenantId |
admin
delegateToAllECs | boolean |
delegatedECs | Array of strings |
detailLevel | string Enum: "ba" "it" "su" "debug" |
string | |
externalId | string |
id | string |
lastLogin | string |
lastName | string |
name | string |
role required | string Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN" |
{- "delegateToAllECs": true,
- "delegatedECs": [
- "string"
], - "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "id": "string",
- "lastLogin": "string",
- "lastName": "string",
- "name": "string",
- "role": "PRIME_ADMIN"
}
{- "requestId": "string",
- "response": {
- "adminRoles": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegated": "string",
- "delegatedRoleType": "RKS_EC",
- "id": "string",
- "parentId": "string",
- "role": "PRIME_ADMIN",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "createdDate": "2019-08-24T14:15:22Z",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "externalId": "string",
- "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "username": "string"
}
}
tenantId required | string tenantId |
admin
delegateToAllECs | boolean |
delegatedECs | Array of strings |
detailLevel | string Enum: "ba" "it" "su" "debug" |
string | |
externalId | string |
id | string |
lastLogin | string |
lastName | string |
name | string |
role required | string Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN" |
{- "delegateToAllECs": true,
- "delegatedECs": [
- "string"
], - "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "id": "string",
- "lastLogin": "string",
- "lastName": "string",
- "name": "string",
- "role": "PRIME_ADMIN"
}
{- "requestId": "string",
- "response": {
- "adminRoles": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegated": "string",
- "delegatedRoleType": "RKS_EC",
- "id": "string",
- "parentId": "string",
- "role": "PRIME_ADMIN",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "createdDate": "2019-08-24T14:15:22Z",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "externalId": "string",
- "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "username": "string"
}
}
adminId required | string adminId |
tenantId required | string tenantId |
{- "delegateToAllECs": true,
- "delegatedECs": [
- "string"
], - "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "id": "string",
- "lastLogin": "string",
- "lastName": "string",
- "name": "string",
- "role": "PRIME_ADMIN"
}
{- "adminId": "string",
- "allowedRegions": [
- {
- "current": true,
- "description": "string",
- "link": "string",
- "name": "string"
}
], - "companyName": "string",
- "dateFormat": "mm/dd/yyyy",
- "delegatedDogfood": true,
- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "firstName": "string",
- "lastName": "string",
- "region": "string",
- "role": "string",
- "roles": [
- "string"
], - "tenantId": "string",
- "username": "string",
- "var": true,
- "varTenantId": "string"
}
tenantId required | string tenantId |
userProfile
adminId | string |
Array of objects (Region) | |
companyName | string |
dateFormat required | string Enum: "mm/dd/yyyy" "dd/mm/yyyy" "yyyy/mm/dd" |
delegatedDogfood | boolean |
detailLevel required | string Enum: "ba" "it" "su" "debug" |
string | |
externalId | string |
firstName | string |
lastName | string |
region | string |
role | string |
roles | Array of strings |
tenantId | string |
username | string |
var | boolean |
varTenantId | string |
{- "adminId": "string",
- "allowedRegions": [
- {
- "current": true,
- "description": "string",
- "link": "string",
- "name": "string"
}
], - "companyName": "string",
- "dateFormat": "mm/dd/yyyy",
- "delegatedDogfood": true,
- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "firstName": "string",
- "lastName": "string",
- "region": "string",
- "role": "string",
- "roles": [
- "string"
], - "tenantId": "string",
- "username": "string",
- "var": true,
- "varTenantId": "string"
}
{- "requestId": "string",
- "response": {
- "adminId": "string",
- "allowedRegions": [
- {
- "current": true,
- "description": "string",
- "link": "string",
- "name": "string"
}
], - "companyName": "string",
- "dateFormat": "mm/dd/yyyy",
- "delegatedDogfood": true,
- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "firstName": "string",
- "lastName": "string",
- "region": "string",
- "role": "string",
- "roles": [
- "string"
], - "tenantId": "string",
- "username": "string",
- "var": true,
- "varTenantId": "string"
}
}
[- {
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "destination": "string",
- "id": "string",
- "parentId": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
]
tenantId required | string tenantId |
notificationRecipient
description required | string |
required | Array of objects (NotificationEndpoint) |
id | string |
{- "description": "string",
- "endpoints": [
- {
- "active": true,
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string"
}
], - "id": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "destination": "string",
- "id": "string",
- "parentId": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
tenantId required | string tenantId |
notificationRecipients
description required | string |
required | Array of objects (NotificationEndpoint) |
id | string |
[- {
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string"
}
], - "id": "string"
}
]
{- "requestId": "string"
}
notificationRecipientId required | string notificationRecipientId |
tenantId required | string tenantId |
{- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "destination": "string",
- "id": "string",
- "parentId": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
notificationRecipientId required | string notificationRecipientId |
tenantId required | string tenantId |
notificationRecipient
description required | string |
required | Array of objects (NotificationEndpoint) |
id | string |
{- "description": "string",
- "endpoints": [
- {
- "active": true,
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string"
}
], - "id": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "destination": "string",
- "id": "string",
- "parentId": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
[- {
- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
]
Create venue.
tenantId required | string tenantId |
venue
object (Address) | |
description | string |
Array of objects (FloorPlan) | |
id | string |
name | string [ 2 .. 32 ] characters \s*\S+\s*\S+.* |
{- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "description": "string",
- "floorPlans": [
- {
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "name": "string"
}
], - "id": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
Delete venues by list.
tenantId required | string tenantId |
venueIds
[- "string"
]
{- "requestId": "string"
}
Get venue.
tenantId required | string tenantId |
venueId required | string venueId |
{- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
Update venue.
tenantId required | string tenantId |
venueId required | string venueId |
venue
object (Address) | |
description | string |
Array of objects (FloorPlan) | |
id | string |
name | string [ 2 .. 32 ] characters \s*\S+\s*\S+.* |
{- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "description": "string",
- "floorPlans": [
- {
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "name": "string"
}
], - "id": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
Manage floor-plans and calibration-points (calibrations-points are used to establish, for example, precise AP positioning).
Get floor plan list.
tenantId required | string tenantId |
venueId required | string venueId |
[- {
- "createdDate": "2019-08-24T14:15:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
]
Create floor plan.
tenantId required | string tenantId |
venueId required | string venueId |
floorPlan
floorNumber | integer <int32> |
id | string |
imageId | string |
imageName | string |
name | string |
{- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
Get floor plan by ID.
floorPlanId required | string floorPlanId |
tenantId required | string tenantId |
venueId required | string venueId |
{- "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.
floorPlanId required | string floorPlanId |
tenantId required | string tenantId |
venueId required | string venueId |
floorPlan
floorNumber | integer <int32> |
id | string |
imageId | string |
imageName | string |
name | string |
{- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageName": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
Get floor plan calibrations points by floor plan ID.
floorPlanId required | string floorPlanId |
tenantId required | string tenantId |
venueId required | string venueId |
[- {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "latitude": "string",
- "longitude": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "xPercent": 0,
- "yPercent": 0
}
]
Update floor plan calibrations points by floor plan ID.
floorPlanId required | string floorPlanId |
tenantId required | string tenantId |
venueId required | string venueId |
calibrationPointList
id | string |
latitude | string |
longitude | string |
xPercent | number <float> |
yPercent | number <float> |
[- {
- "id": "string",
- "latitude": "string",
- "longitude": "string",
- "xPercent": 0,
- "yPercent": 0
}
]
{- "requestId": "string",
- "response": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "latitude": "string",
- "longitude": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "xPercent": 0,
- "yPercent": 0
}
]
}
Get the list of device entitlements.
tenantId required | string tenantId |
type | string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional) |
[- {
- "assignedLicense": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "graceEndDate": "2019-08-24T14:15:22Z",
- "historical": true,
- "id": "string",
- "parentId": "string",
- "quantity": 0,
- "sku": "string",
- "tempLicense": true,
- "updatedDate": "2019-08-24T14:15:22Z"
}
]
Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired.
tenantId required | string tenantId |
type | string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (Optional) |
[- {
- "deviceCount": 0,
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectDate": "2019-08-24T14:15:22Z",
- "effectDays": 0,
- "multipleLicense": true,
- "type": "INITIAL"
}
]
Refresh entitlements. Note: this endpoint can be used to retrieve recently activated licenses.
tenantId required | string tenantId |
type | string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (Optional) |
{- "entitlements": [
- {
- "assignedLicense": true,
- "createdDate": "2019-08-24T14:15:22Z",
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "graceEndDate": "2019-08-24T14:15:22Z",
- "historical": true,
- "id": "string",
- "parentId": "string",
- "quantity": 0,
- "sku": "string",
- "tempLicense": true,
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "summary": [
- {
- "closestLiceseQtty": 0,
- "deviceCount": 0,
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2019-08-24T14:15:22Z",
- "errorCode": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "internalMessage": "string",
- "quantity": 0,
- "remainingDays": 0,
- "remainingDevices": 0,
- "sku": "string"
}
]
}
Get summaries of the device entitlements.
tenantId required | string tenantId |
type | string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional) |
[- {
- "closestLiceseQtty": 0,
- "deviceCount": 0,
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2019-08-24T14:15:22Z",
- "errorCode": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "internalMessage": "string",
- "quantity": 0,
- "remainingDays": 0,
- "remainingDevices": 0,
- "sku": "string"
}
]
tenantId required | string tenantId |
type | string Enum: "REC" "VAR" "MSP" type |
[- {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "parentId": "string",
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
]
tenantId required | string tenantId |
inviteVARPayload
username | string |
{- "username": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "parentId": "string",
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "parentId": "string",
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
delegationId required | string delegationId |
tenantId required | string tenantId |
{- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "parentId": "string",
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
delegationId required | string delegationId |
tenantId required | string tenantId |
payload
accept | boolean |
fromTenantId | string |
{- "accept": true,
- "fromTenantId": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "parentId": "string",
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
Get MSP-EC account details.
mspEcTenantId required | string Tenant Id of the MSP-EC account to be retrieved. |
{- "msp_label": "acme-sales",
- "name": "Acme Sales",
- "street_address": "350 West Java st",
- "state": "CA",
- "country": "US",
- "postal_code": 95089,
- "phone_number": "650-123-4567",
- "fax_number": "650-123-9999",
- "city": "Sunnyvale",
- "mapping_url": "https//map.gogle.com/zsdweews",
- "service_effective_date": "2019-09-14 01:12:51Z",
- "service_expiration_date": "2020-09-14 01:12:51Z",
- "is_active": true,
- "tenant_id": "6173ca160495421c95be47b42b349067",
- "parent_tenant_id": "6173ca160495421c95be47b42b349067"
}
mspEcTenantId required | string Tenant Id of the MSP-EC account to be updated. |
updateMspEcRequest
name | string [ 0 .. 255 ] characters The Name of MSP-EC account. |
street_address | string [ 0 .. 255 ] characters The Street Address of MSP-EC account. |
state | string [ 0 .. 255 ] characters The state of MSP-EC account. |
country | string [ 0 .. 255 ] characters The country of MSP-EC account. |
postal_code | string [ 0 .. 255 ] characters The Postal code of MSP-EC account. |
phone_number | string [ 0 .. 255 ] characters The phone number of MSP-EC account. |
fax_number | string [ 0 .. 255 ] characters The fax number of MSP-EC account. |
city | string [ 0 .. 255 ] characters The city of MSP-EC account. |
mapping_url | string [ 0 .. 255 ] characters The map URL of MSP-EC account. |
service_effective_date | string <date-time> The effective date of MSP-EC account. |
service_expiration_date | string <date-time> The expiration date of MSP-EC account. |
{- "name": "acmesales",
- "street_address": "350 West Java st",
- "state": "CA",
- "country": "US",
- "postal_code": 95089,
- "phone_number": "650-123-4567",
- "fax_number": "650-123-9999",
- "city": "Sunnyvale",
- "mapping_url": "https//map.gogle.com/zsdweews",
- "service_effective_date": "2019-09-14 01:12:51.805Z",
- "service_expiration_date": "2020-09-14 01:12:51.805Z"
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
mspEcTenantId required | string Tenant Id of the MSP-EC account to be deleted. |
{- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "properties": { },
- "switchActivated": true,
- "tenantActivated": true,
- "updatedDate": "2019-08-24T14:15:22Z",
- "wifiActivated": true
}
Get activation status for this MSP-EC.
mspEcTenantId required | string Tenant Id of the tenant to get MSP data. |
{- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "properties": { },
- "switchActivated": true,
- "tenantActivated": true,
- "updatedDate": "2019-08-24T14:15:22Z",
- "wifiActivated": true
}
Get MSP-EC administrator data.
mspEcAdminId required | string Admin Id of the MSP-EC administrator to be retrieved. |
mspEcTenantId required | string Tenant Id of the MSP-EC administrator to be retrieved. |
{- "full_name": "John Doe",
- "first_name": "John",
- "last_name": "Doe"
}
Update MSP-EC administrator data.
mspEcAdminId required | string Admin Id of the MSP-EC administrator to be updated. |
mspEcTenantId required | string Tenant Id of the MSP-EC administrator to be updated. |
updateMspEcAdminRequest
string [ 0 .. 255 ] characters The email address of MSP-EC administrator. | |
user_name | string [ 0 .. 255 ] characters The user name of MSP-EC administrator. |
full_name | string [ 0 .. 255 ] characters The full name of MSP-EC administrator. |
first_name | string [ 0 .. 64 ] characters The first name of MSP-EC administrator. |
last_name | string [ 0 .. 64 ] characters The last name of MSP-EC administrator. |
{- "full_name": "John Doe",
- "first_name": "John",
- "last_name": "Doe"
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Delete MSP-EC administrator.
mspEcAdminId required | string Admin Id of the MSP-EC administrator to be deleted. |
mspEcTenantId required | string Tenant Id of the MSP-EC administrator to be deleted. |
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Deactivate the MSP-EC account.
mspEcTenantId required | string Tenant Id of the MSP-EC account to be deactivated. |
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "properties": { },
- "switchActivated": true,
- "tenantActivated": true,
- "updatedDate": "2019-08-24T14:15:22Z",
- "wifiActivated": true
}
}
Get the list of MSP administrators authorized to manage an MSP-EC.
mspEcTenantId required | string MSP-EC Tenant Id |
[- {
- "msp_admin_id": "4c2b196a205d11ea978f-2e728ce88125",
- "msp_admin_role": "PRIME_ADMIN"
}
]
Update the list of MSP administrators authorized to manage an MSP-EC.
mspEcTenantId required | string MSP-EC Tenant Id |
mspAdminRoleList
msp_admin_id | string The Admin ID of MSP Tenant. |
msp_admin_role | string [ 0 .. 255 ] characters The admin Role of the first MSP administrator. |
[- {
- "msp_admin_id": "4c2b196a205d11ea978f-2e728ce88125",
- "msp_admin_role": "PRIME_ADMIN"
}
]
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Email an MSP-EC administrator an invitation to join the account.
mspEcTenantId required | string Tenant Id of the MSP-EC account |
emailInvitation
admin_email | string [ 0 .. 255 ] characters The Email of the first MSP-EC administrator. |
resend | boolean Indicate if this is for resending |
{- "resend": false
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Reactivate the MSP-EC account.
mspEcTenantId required | string Tenant Id of the MSP-EC account to be reactivated. |
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "properties": { },
- "switchActivated": true,
- "tenantActivated": true,
- "updatedDate": "2019-08-24T14:15:22Z",
- "wifiActivated": true
}
}
Get the list of MSP-EC accounts.
mspTenantId required | string Tenant Id of the tenant to add MSP Label. |
[- {
- "msp_label": "acme-sales",
- "name": "Acme Sales",
- "street_address": "350 West Java st",
- "state": "CA",
- "country": "US",
- "postal_code": 95089,
- "phone_number": "650-123-4567",
- "fax_number": "650-123-9999",
- "city": "Sunnyvale",
- "mapping_url": "https//map.gogle.com/zsdweews",
- "service_effective_date": "2019-09-14 01:12:51Z",
- "service_expiration_date": "2020-09-14 01:12:51Z",
- "is_active": true,
- "tenant_id": "6173ca160495421c95be47b42b349067",
- "parent_tenant_id": "6173ca160495421c95be47b42b349067"
}
]
Create an MSP-EC account.
mspTenantId required | string Tenant Id of the tenant to create MSP-EC account. |
addMspEcRequest
name | string The Name of MSP-EC account. |
street_address | string [ 0 .. 255 ] characters The Street Address of MSP-EC account. |
state | string [ 0 .. 255 ] characters The state of MSP-EC account. |
country | string [ 0 .. 255 ] characters The country of MSP-EC account. |
postal_code | string [ 0 .. 255 ] characters The Postal code of MSP-EC account. |
phone_number | string [ 0 .. 255 ] characters The phone number of MSP-EC account. |
fax_number | string [ 0 .. 255 ] characters The fax number of MSP-EC account. |
city | string [ 0 .. 255 ] characters The city of MSP-EC account. |
mapping_url | string [ 0 .. 255 ] characters The map URL of MSP-EC account. |
service_effective_date | string <date-time> The effective date of MSP-EC account. |
service_expiration_date | string <date-time> The expiration date of MSP-EC account. |
admin_email | string [ 0 .. 255 ] characters The Email of the first MSP-EC administrator. |
admin_firstname | string [ 0 .. 64 ] characters The First name of the first MSP-EC administrator. |
admin_lastname | string [ 0 .. 64 ] characters The Last name of the first MSP-EC administrator. |
admin_role | string [ 0 .. 255 ] characters The admin Role of the first MSP-EC administrator. |
{- "name": "Acme Sales",
- "street_address": "123 Main Street",
- "state": "CA",
- "country": "US",
- "postal_code": 95089,
- "phone_number": "650-123-4567",
- "fax_number": "650-123-9999",
- "city": "Sunnyvale",
- "mapping_url": "https//map.gogle.com/zsdweews",
- "service_effective_date": "2019-09-14 01:12:51Z",
- "service_expiration_date": "2020-09-14 01:12:51Z",
- "admin_firstname": "John",
- "admin_lastname": "Doe",
- "admin_role": "PRIME_ADMIN,ADMIN,READ_ONLY"
}
"string"
Get customization data for MSP.
mspTenantId required | string Tenant Id of the tenant to get MSP data. |
{- "mspLogoFileDataList": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "logo_file_name": "string",
- "logo_fileuuid": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}
], - "preferredWisprProvider": {
- "acct": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "apiKey": "string",
- "apiSecret": "string",
- "auth": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "createdDate": "2019-08-24T14:15:22Z",
- "customExternalProvider": true,
- "id": "string",
- "parentId": "string",
- "providerName": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}, - "msp_label": "acme-sales",
- "logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "alarm_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "ping_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "mlisa_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "ping_login_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "default_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "msp_fqdn": "wifi.example.com",
- "contact_support_behavior": "redirect",
- "open_case_behavior": "redirect",
- "my_open_case_behavior": "redirect",
- "msp_phone": "+6501234567",
- "msp_external_id": "0015B000015bJEfQAM",
- "msp_tenant_name": "Acme Sales, Inc."
}
Add a new DNS label for MSP.
mspTenantId required | string Tenant Id of the tenant to add MSP Label. |
updateMspRequest
Array of objects (MspLogoFileData) | |
object (PreferredWisprProvider) | |
msp_label | string[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9] The MSP label. |
logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of Logo file. |
alarm_notification_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of alarmNotificationLogo Logo file. |
ping_notification_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of pingNotificationLogo file. |
mlisa_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of mlisaLogo file. |
ping_login_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of pingLoginLogo file. |
default_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of defaultLogo file. |
msp_fqdn | string [ 0 .. 255 ] characters ^$|[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\.[a... The FQDN of MSP Portal. |
contact_support_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The Contact support URL of MSP Tenant. |
contact_support_behavior | string [ 0 .. 255 ] characters The Contact support behavior of MSP Tenant. |
open_case_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The Open case URL of MSP Tenant. |
open_case_behavior | string [ 0 .. 255 ] characters The Open case behavior of MSP Tenant. |
my_open_case_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The My open case URL of MSP Tenant. |
my_open_case_behavior | string [ 0 .. 255 ] characters The My open case behavior of MSP Tenant. |
change_password_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The Change password URL of MSP Tenant. |
msp_phone | string [ 0 .. 255 ] characters The phone of MSP Tenant. |
msp_email | string [ 0 .. 255 ] characters The email of MSP Tenant. |
msp_website | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The website of MSP Tenant. |
{- "mspLogoFileDataList": [
- {
- "id": "string",
- "logo_file_name": "string",
- "logo_fileuuid": "string"
}
], - "preferredWisprProvider": {
- "acct": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "apiKey": "string",
- "apiSecret": "string",
- "auth": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "customExternalProvider": true,
- "id": "string",
- "providerName": "string"
}, - "msp_label": "acme-sales",
- "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "msp_fqdn": "wifi.example.com",
- "contact_support_behavior": "redirect",
- "open_case_behavior": "redirect",
- "my_open_case_behavior": "redirect",
- "msp_phone": "408-123-5678",
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Update data for MSP.
mspTenantId required | string Tenant Id of the tenant to update MSP data. |
updateMspRequest
Array of objects (MspLogoFileData) | |
object (PreferredWisprProvider) | |
msp_label | string[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9] The MSP label. |
logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of Logo file. |
alarm_notification_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of alarmNotificationLogo Logo file. |
ping_notification_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of pingNotificationLogo file. |
mlisa_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of mlisaLogo file. |
ping_login_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of pingLoginLogo file. |
default_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of defaultLogo file. |
msp_fqdn | string [ 0 .. 255 ] characters ^$|[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\.[a... The FQDN of MSP Portal. |
contact_support_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The Contact support URL of MSP Tenant. |
contact_support_behavior | string [ 0 .. 255 ] characters The Contact support behavior of MSP Tenant. |
open_case_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The Open case URL of MSP Tenant. |
open_case_behavior | string [ 0 .. 255 ] characters The Open case behavior of MSP Tenant. |
my_open_case_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The My open case URL of MSP Tenant. |
my_open_case_behavior | string [ 0 .. 255 ] characters The My open case behavior of MSP Tenant. |
change_password_url | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The Change password URL of MSP Tenant. |
msp_phone | string [ 0 .. 255 ] characters The phone of MSP Tenant. |
msp_email | string [ 0 .. 255 ] characters The email of MSP Tenant. |
msp_website | string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[... The website of MSP Tenant. |
{- "mspLogoFileDataList": [
- {
- "id": "string",
- "logo_file_name": "string",
- "logo_fileuuid": "string"
}
], - "preferredWisprProvider": {
- "acct": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "apiKey": "string",
- "apiSecret": "string",
- "auth": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "customExternalProvider": true,
- "id": "string",
- "providerName": "string"
}, - "msp_label": "acme-sales",
- "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "msp_fqdn": "wifi.example.com",
- "contact_support_behavior": "redirect",
- "open_case_behavior": "redirect",
- "my_open_case_behavior": "redirect",
- "msp_phone": "408-123-5678",
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Manage MSP entitlements (bulk licenses).
Note: this API group was formerly called "Entitlement-Assignment".
Retrieve all the assignments (created and revoked).
tenantId required | string tenantId of the MSP retrieving their MSP Assignments. |
[- {
- "status": "FUTURE",
- "id": 231,
- "mspEcTenantId": "d7c104ba608c41eb864279be2fc0d2e8",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 15,
- "dateEffective": "2019-09-14 00:08:00Z",
- "dateExpires": "2020-09-09 23:59:59Z",
- "trialAssignment": false,
- "dateAssignmentCreated": "2019-09-14 01:12:51.805Z",
- "dateAssignmentRevoked": "null",
- "mspTenantId": "15bebe3c3e7c40499d65b5b7f63f80ea",
- "revokedBy": "null"
}
]
Create a new entitlement assignment.
tenantId required | string tenantId of the MSP creating an MSP Assignment. |
assign
mspEcTenantId | string MSP-EC's tenantId. |
deviceType | string Enum: "MSP_WIFI" "MSP_SWITCH" MSP (Bulk) Entitlement device type. |
deviceSubType | string MSP (Bulk) Entitlement device sub-type; in this version of the API, this parameter is only used when deviceType is SWITCH. Valid string values for device sub-type are "ICX71L", "ICX71", "ICX75", "ICX76", "ICX78" and "ICX_ANY". |
quantity | integer <int64> Quantity of devices permitted by this assignment. |
useTemporaryMspEntitlement | boolean Trial (aka Temporary) MSP Entitlement to be used for this assignment (if this parameter is not supplied in the request, it defaults to false). |
{- "mspEcTenantId": "d7c104ba608c41eb864279be2fc0d2e8",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 15,
- "useTemporaryMspEntitlement": false
}
"string"
Bulk operations request to create, replace or revoke multiple (1-14) entitlement assignments.
tenantId required | string tenantId of the MSP creating an MSP Assignment. |
operationsRequest
bulkOperationRequest | Array of objects (AssignmentOperation) Object providing a list of requested assignment operations. |
{- "bulkOperationRequest": [
- { }
]
}
[- {
- "success": true,
- "assignmentId": 15,
- "code": 201,
- "status": "CREATED",
- "errors": {
- "code": "string",
- "errors": { },
- "internalMessage": "string",
- "message": "string",
- "method": "string",
- "path": "string",
- "requestId": "string",
- "service": "string",
- "status": "string",
- "timestamp": "string",
- "validationError": {
- "expected": "string",
- "object": "string",
- "objectName": "string",
- "value": "string"
}
}
}
]
Retrieve a summary by device type of all an MSP's Entitlement Assignments.
tenantId required | string tenantId of the MSP retrieving their MSP Assignments Summary. |
{- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 2000,
- "courtesyMspEntitlementsUsed": false,
- "remainingDevices": 1472,
- "trial": true
}
Replace an entitlement assignment.
assignmentId required | string Id of the assignment to replace. |
tenantId required | string tenantId of the MSP replacing this assignment. |
replacementAssignment
newQuantity | integer <int64> Quantity of devices permitted by this replacement assignment; the replacement assignment will be for the same MSP-EC and have the same deviceType, deviceSubType and isTrial values as the assignment being revoked. |
{- "newQuantity": 10
}
"string"
Retrieve all the MSP's MSP (Bulk) entitlements.
tenantId required | string tenantId of the MSP retrieving their MSP Entitlements. |
[- {
- "isTrial": true,
- "lastNotificationDate": "2019-08-24T14:15:22Z",
- "status": "FUTURE",
- "id": "5fb69a6e157d494f96e419d6eb541904",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "sku": "CLD-MW00-3001",
- "quantity": 2000,
- "effectiveDate": "2019-09-14 00:08:00Z",
- "expirationDate": "2020-09-09 23:59:59Z"
}
]
Refresh MSP entitlements. Note: this endpoint can be used to retrieve recently activated licenses.
tenantId required | string tenantId of the MSP refreshing their MSP Entitlements. |
{- "mspEntitlementBanners": [
- {
- "type": "INITIAL",
- "deviceType": "MSP_WIFI",
- "multipleLicense": true,
- "effectDate": "2019-09-14 01:12:51.805Z",
- "effectDays": 35,
- "deviceCount": 100,
- "affectedDeviceCount": 22
}
], - "mspEntitlementSummaries": [
- {
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 2000,
- "courtesyQuantity": 100,
- "remainingDays": 86,
- "effectiveDate": "2019-09-14 00:08:00Z",
- "expirationDate": "2020-09-09 23:59:59Z",
- "trial": true
}
], - "mspEntitlements": [
- {
- "isTrial": true,
- "lastNotificationDate": "2019-08-24T14:15:22Z",
- "status": "FUTURE",
- "id": "5fb69a6e157d494f96e419d6eb541904",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "sku": "CLD-MW00-3001",
- "quantity": 2000,
- "effectiveDate": "2019-09-14 00:08:00Z",
- "expirationDate": "2020-09-09 23:59:59Z"
}
]
}
Retrieve banner data for the MSP's MSP (Bulk) entitlements. Banners provide information about MSP (Bulk) Entitlements that are either near their expiry or have expired.
tenantId required | string tenantId of the MSP retrieving their MSP Entitlement Banners. |
[- {
- "type": "INITIAL",
- "deviceType": "MSP_WIFI",
- "multipleLicense": true,
- "effectDate": "2019-09-14 01:12:51.805Z",
- "effectDays": 35,
- "deviceCount": 100,
- "affectedDeviceCount": 22
}
]
Retrieve a summary of all an MSP's MSP (Bulk) Entitlements by device type.
tenantId required | string tenantId of the MSP retrieving their MSP Entitlements Summaries. |
[- {
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 2000,
- "courtesyQuantity": 100,
- "remainingDays": 86,
- "effectiveDate": "2019-09-14 00:08:00Z",
- "expirationDate": "2020-09-09 23:59:59Z",
- "trial": true
}
]
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".
status required | string Enum: "PENDING" "SUCCESS" "FAIL" status |
tenantId required | string tenantId |
page | string page |
size | string size |
[- {
- "body": "string",
- "method": "string",
- "url": "string"
}
]
View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.
Get the list of admins.
tenantId required | string Tenant ID |
payload
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "createDate": 0,
- "externalId": "string",
- "id": "string",
- "tenantId": "string",
- "updateDate": 0,
- "username": "string"
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": { },
- "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get the list of customer delegations.
tenant_id required | string Tenant ID |
payload
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "crtTime": "string",
- "delegatedToEmail": "string",
- "delegatedToId": "string",
- "delegatedToName": "string",
- "delegationType": "string",
- "entitlements": [
- {
- "consumed": "string",
- "entitlementDeviceSubType": "string",
- "entitlementDeviceType": "string",
- "expirationDate": "string",
- "quantity": "string",
- "tenantId": "string",
- "toBeRemovedQuantity": 0,
- "type": "string"
}
], - "id": "string",
- "lastUpdTime": "string",
- "status": "string",
- "tenantEmail": "string",
- "tenantId": "string",
- "tenantName": "string",
- "type": "string"
}
Get the list of your MSP-ECs.
tenant_id required | string Tenant ID |
delegation | string delegation |
payload
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "assignedMspEcList": [
- "string"
], - "city": "string",
- "country": "string",
- "creationDate": "string",
- "delegatedTo": "string",
- "delegationExpiryDate": 0,
- "entitlements": [
- {
- "consumed": "string",
- "entitlementDeviceSubType": "string",
- "entitlementDeviceType": "string",
- "expirationDate": "string",
- "quantity": "string",
- "tenantId": "string",
- "toBeRemovedQuantity": 0,
- "type": "string"
}
], - "id": "string",
- "installer": "string",
- "integrator": "string",
- "lastUpdTime": "string",
- "mspAdminCount": 0,
- "mspAdmins": [
- "string"
], - "mspEcAdminCount": 0,
- "mspInstallerAdminCount": 0,
- "mspInstallerAdmins": [
- "string"
], - "mspIntegratorAdminCount": 0,
- "mspIntegratorAdmins": [
- "string"
], - "mspLabel": "string",
- "mspName": "string",
- "mspTenantId": "string",
- "name": "string",
- "postalCode": "string",
- "state": "string",
- "status": "string",
- "streetAddress": "string",
- "tenantType": "string"
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": { },
- "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}