RUCKUS Cloud - Platform APIs and Model Documentation (v21.03.11)

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.

Cloud Hosts

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

Business Entities

The following table describes the type of businesses (aka organizations) which use these API endpoints. Not all endpoints are useful for every business entity.
AbbreviationDescription
RECRUCKUS 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-ECMSP's end customer. MSP-ECs use API endpoints to manage their own networks, if permitted by their MSP.

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.

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. There are two classes of entitlements:
  • Device entitlements, referred to as simply “entitlements”, which entitle an account to provision/install one networking device per entitlement.
  • MSP entitlements, used only by MSPs, are assigned to MSP-EC accounts enabling the provision/installation of one networking device per assignment in an MSP-EC network.

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

Authentication

Token

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

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.

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

path Parameters
tenantId
required
string

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

Responses

Account

Retrieve account details.

Note: this API group was formerly called "Tenant".

Get Account Details

Get this account's details.

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,
  • "maintenanceDate": "2019-08-24T14:15:22Z",
  • "maintenanceState": true,
  • "msp": {
    },
  • "mspEc": {
    },
  • "name": "string",
  • "notificationRecipients": [
    ],
  • "obsolete": true,
  • "oemName": "string",
  • "parentId": "string",
  • "ruckusUser": true,
  • "status": "active",
  • "tenantMFA": {
    },
  • "tenantType": "REC",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Get Account Address

Get this account's postal address.

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

Manage administrators.

Administrator resources are assigned roles from the following table.

RolePrivileges
PRIME_ADMINRole 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.
ADMINRole 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_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. 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_ADMINRole 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.

Get Admin list

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Admin

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

admin

delegateToAllECs
boolean
delegatedECs
Array of strings
detailLevel
string
Enum: "ba" "it" "su" "debug"
email
string
externalId
string
id
string
lastLogin
string
lastName
string
name
string
role
required
string
Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN"

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": {
    }
}

Update Admin

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

admin

delegateToAllECs
boolean
delegatedECs
Array of strings
detailLevel
string
Enum: "ba" "it" "su" "debug"
email
string
externalId
string
id
string
lastLogin
string
lastName
string
name
string
role
required
string
Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN"

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 Admin List

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

adminIds

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Admin by ID

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 by ID

path Parameters
adminId
required
string

adminId

tenantId
required
string

tenantId

Responses

Response samples

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

User-Profile

Manage your user profile.

Get User Profile

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

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

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"
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": {
    }
}

Notification Recipient

Manage notification recipients.

Get notification-recipient list

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add notification-recipient

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 list

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

notificationRecipients

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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Get notification-recipient by ID

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",
  • "parentId": "string",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Update notification-recipient

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 by ID

path Parameters
notificationRecipientId
required
string

notificationRecipientId

tenantId
required
string

tenantId

Responses

Response samples

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

Venue

Manage venue.

Get Venue List

Get venue list.

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Venue

Create venue.

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

venue

object (Address)
description
string
Array of objects (FloorPlan)
id
string
name
string [ 2 .. 32 ] characters \s*\S+\s*\S+.*

Responses

Request samples

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

Response samples

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

Delete Venues by List

Delete venues by list.

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

venueIds

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Get Venue by ID

Get venue.

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.

path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Request Body schema: application/json

venue

object (Address)
description
string
Array of objects (FloorPlan)
id
string
name
string [ 2 .. 32 ] characters \s*\S+\s*\S+.*

Responses

Request samples

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

Response samples

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

Delete Venue by ID

Delete venues by ID.

path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

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

Floor-Plan

Manage floor-plans and calibration-points (calibrations-points are used to establish, for example, precise AP positioning).

Get Floor Plan List

Get floor plan list.

path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Floor Plan

Create floor plan.

path Parameters
tenantId
required
string

tenantId

venueId
required
string

venueId

Request Body schema: application/json

floorPlan

floorNumber
integer <int32>
id
string
imageId
string
imageName
string
name
string

Responses

Request samples

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

Response samples

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

Get Floor Plan

Get floor plan by ID.

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.

path Parameters
floorPlanId
required
string

floorPlanId

tenantId
required
string

tenantId

venueId
required
string

venueId

Request Body schema: application/json

floorPlan

floorNumber
integer <int32>
id
string
imageId
string
imageName
string
name
string

Responses

Request samples

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

Response samples

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

Delete Floor Plan

Delete floor plan.

path Parameters
floorPlanId
required
string

floorPlanId

tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

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

Get Calibrations Points

Get floor plan calibrations points by floor plan ID.

path Parameters
floorPlanId
required
string

floorPlanId

tenantId
required
string

tenantId

venueId
required
string

venueId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Calibrations Points

Update floor plan calibrations points by floor plan ID.

path Parameters
floorPlanId
required
string

floorPlanId

tenantId
required
string

tenantId

venueId
required
string

venueId

Request Body schema: application/json

calibrationPointList

Array ()
id
string
latitude
string
longitude
string
xPercent
number <float>
yPercent
number <float>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

File

Manage upload or download files.

Get Upload URL

Get a URL with which to upload a file.

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.

path Parameters
fileId
required
string

fileId

tenantId
required
string

tenantId

Responses

Entitlement

Manage device entitlements (licenses).

Get Entitlements

Get the list of device entitlements.

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
[
  • {
    }
]

Get Banners

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

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.

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.

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
[
  • {
    }
]

Delegation

Manage delegations.

Get Delegation List

path Parameters
tenantId
required
string

tenantId

query Parameters
type
string
Enum: "REC" "VAR" "MSP"

type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invite VAR Delegation

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

inviteVARPayload

username
string

Responses

Request samples

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

Response samples

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

Grant Support Access

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

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

Revoke Support Access

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

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

Get Delegation by ID

path Parameters
delegationId
required
string

delegationId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "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"
}

Accept or Reject Delegation

path Parameters
delegationId
required
string

delegationId

tenantId
required
string

tenantId

Request Body schema: application/json

payload

accept
boolean
fromTenantId
string

Responses

Request samples

Content type
application/json
{
  • "accept": true,
  • "fromTenantId": "string"
}

Response samples

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

Revoke VAR Delegation by ID

path Parameters
delegationId
required
string

delegationId

tenantId
required
string

tenantId

Responses

Response samples

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

MSP Service

Manage MSP service and MSP-ECs (MSP end customers).

Get Base URL

Get the MSP's base URL. Note: this is used by MSP-ECs for account login.

Responses

Response samples

Content type
application/json
"string"

Check MSP Label

Check whether this DNS label is already in use by another MSP.

path Parameters
mspLabel
required
string

MSP Label

Responses

Response samples

Content type
application/json
"string"

Get MSP-EC

Get MSP-EC account details.

path Parameters
mspEcTenantId
required
string

Tenant Id of the MSP-EC account to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "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"
}

Update MSP-EC

path Parameters
mspEcTenantId
required
string

Tenant Id of the MSP-EC account to be updated.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

Delete MSP-EC

path Parameters
mspEcTenantId
required
string

Tenant Id of the MSP-EC account to be deleted.

Responses

Response samples

Content type
application/json
{
  • "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 Status

Get activation status for this MSP-EC.

path Parameters
mspEcTenantId
required
string

Tenant Id of the tenant to get MSP data.

Responses

Response samples

Content type
application/json
{
  • "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 Admin

Get MSP-EC administrator data.

path Parameters
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.

Responses

Response samples

Content type
application/json
{}

Update MSP-EC Admin

Update MSP-EC administrator data.

path Parameters
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.

Request Body schema: application/json

updateMspEcAdminRequest

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

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

Delete MSP-EC Admin

Delete MSP-EC administrator.

path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

Get MSP-EC Admins

Get a list of MSP-EC administrators.

path Parameters
mspEcTenantId
required
string

Tenant Id of the MSP-EC administrator list to be retrieved.

Responses

Response samples

Content type
application/json
"string"

Deactivate MSP-EC

Deactivate the MSP-EC account.

path Parameters
mspEcTenantId
required
string

Tenant Id of the MSP-EC account to be deactivated.

Responses

Response samples

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

Get Authorized Admins

Get the list of MSP administrators authorized to manage an MSP-EC.

path Parameters
mspEcTenantId
required
string

MSP-EC Tenant Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Authorized Admins

Update the list of MSP administrators authorized to manage an MSP-EC.

path Parameters
mspEcTenantId
required
string

MSP-EC Tenant Id

Request Body schema: application/json

mspAdminRoleList

Array ()
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.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

Get MSP-EC Support Status

Get Ruckus Support delegation status.

path Parameters
mspEcTenantId
required
string

MSP-EC Tenant Id

Responses

Response samples

Content type
application/json
"string"

Grant MSP-EC Support Access

Allow Ruckus Support access to the MSP-EC.

path Parameters
mspEcTenantId
required
string

MSP-EC Tenant Id

Responses

Response samples

Content type
application/json
"string"

Revoke MSP-EC Support Access

Prevent Ruckus Support from accessing the MSP-EC.

path Parameters
mspEcTenantId
required
string

MSP-EC Tenant Id

Responses

Response samples

Content type
application/json
"string"

Email MSP-EC Admin

Email an MSP-EC administrator an invitation to join the account.

path Parameters
mspEcTenantId
required
string

Tenant Id of the MSP-EC account

Request Body schema: application/json

emailInvitation

admin_email
string [ 0 .. 255 ] characters

The Email of the first MSP-EC administrator.

resend
boolean

Indicate if this is for resending

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

Get Logo URL

Get the customized logo URL by MSP-EC Tenant Id. Note: this logo represents the MSP's brand.

path Parameters
mspEcTenantId
required
string

MSP-EC Tenant Id

Responses

Response samples

Content type
application/json
"string"

Reactivate MSP-EC

Reactivate the MSP-EC account.

path Parameters
mspEcTenantId
required
string

Tenant Id of the MSP-EC account to be reactivated.

Responses

Response samples

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

Get MSP-ECs

Get the list of MSP-EC accounts.

path Parameters
mspTenantId
required
string

Tenant Id of the tenant to add MSP Label.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create MSP-EC

Create an MSP-EC account.

path Parameters
mspTenantId
required
string

Tenant Id of the tenant to create MSP-EC account.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "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_email": "[email protected]",
  • "admin_firstname": "John",
  • "admin_lastname": "Doe",
  • "admin_role": "PRIME_ADMIN,ADMIN,READ_ONLY"
}

Response samples

Content type
application/json
"string"

Get MSP Customization Data

Get customization data for MSP.

path Parameters
mspTenantId
required
string

Tenant Id of the tenant to get MSP data.

Responses

Response samples

Content type
application/json
{
  • "mspLogoFileDataList": [
    ],
  • "preferredWisprProvider": {
    },
  • "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_url": "http://support.example.com/",
  • "contact_support_behavior": "redirect",
  • "open_case_behavior": "redirect",
  • "my_open_case_behavior": "redirect",
  • "change_password_url": "http://wifi.example.com/password",
  • "msp_phone": "+6501234567",
  • "msp_email": "[email protected]",
  • "msp_website": "http://wifi.example.com",
  • "msp_external_id": "0015B000015bJEfQAM",
  • "msp_tenant_name": "Acme Sales, Inc."
}

Create MSP Label

Add a new DNS label for MSP.

path Parameters
mspTenantId
required
string

Tenant Id of the tenant to add MSP Label.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "mspLogoFileDataList": [
    ],
  • "preferredWisprProvider": {
    },
  • "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_url": "http://support.example.com/",
  • "contact_support_behavior": "redirect",
  • "open_case_behavior": "redirect",
  • "my_open_case_behavior": "redirect",
  • "change_password_url": "http://wifi.example.com/password",
  • "msp_phone": "408-123-5678",
  • "msp_email": "[email protected]",
  • "msp_website": "http://wifi.example.com"
}

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

Update MSP Data

Update data for MSP.

path Parameters
mspTenantId
required
string

Tenant Id of the tenant to update MSP data.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "mspLogoFileDataList": [
    ],
  • "preferredWisprProvider": {
    },
  • "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_url": "http://support.example.com/",
  • "contact_support_behavior": "redirect",
  • "open_case_behavior": "redirect",
  • "my_open_case_behavior": "redirect",
  • "change_password_url": "http://wifi.example.com/password",
  • "msp_phone": "408-123-5678",
  • "msp_email": "[email protected]",
  • "msp_website": "http://wifi.example.com"
}

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "errors": [
    ],
  • "requestId": "string"
}

MSP Entitlement

Manage MSP entitlements (bulk licenses).

Note: this API group was formerly called "Entitlement-Assignment".

Get Assignments

Retrieve all the assignments (created and revoked).

path Parameters
tenantId
required
string

tenantId of the MSP retrieving their MSP Assignments.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Assignment

Create a new entitlement assignment.

path Parameters
tenantId
required
string

tenantId of the MSP creating an MSP Assignment.

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "mspEcTenantId": "d7c104ba608c41eb864279be2fc0d2e8",
  • "deviceType": "MSP_WIFI",
  • "deviceSubType": "ICX71",
  • "quantity": 15,
  • "useTemporaryMspEntitlement": false
}

Response samples

Content type
application/json
"string"

Bulk Assignment Operation

Bulk operations request to create, replace or revoke multiple (1-14) entitlement assignments.

path Parameters
tenantId
required
string

tenantId of the MSP creating an MSP Assignment.

Request Body schema: application/json

operationsRequest

bulkOperationRequest
Array of objects (AssignmentOperation)

Object providing a list of requested assignment operations.

Responses

Request samples

Content type
application/json
{
  • "bulkOperationRequest": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Assignment Summaries

Retrieve a summary by device type of all an MSP's Entitlement Assignments.

path Parameters
tenantId
required
string

tenantId of the MSP retrieving their MSP Assignments Summary.

Responses

Response samples

Content type
application/json
{
  • "deviceType": "MSP_WIFI",
  • "deviceSubType": "ICX71",
  • "quantity": 2000,
  • "courtesyMspEntitlementsUsed": false,
  • "remainingDevices": 1472,
  • "trial": true
}

Replace Assignment

Replace an entitlement assignment.

path Parameters
assignmentId
required
string

Id of the assignment to replace.

tenantId
required
string

tenantId of the MSP replacing this assignment.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "newQuantity": 10
}

Response samples

Content type
application/json
"string"

Revoke Assignment

Revoke an entitlement assignment.

path Parameters
assignmentId
required
string

Id of the assignment to revoke.

tenantId
required
string

tenantId of the MSP revoking this assignment.

Responses

Get MSP Entitlements

Retrieve all the MSP's MSP (Bulk) entitlements.

path Parameters
tenantId
required
string

tenantId of the MSP retrieving their MSP Entitlements.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Refresh MSP Entitlements

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

path Parameters
tenantId
required
string

tenantId of the MSP refreshing their MSP Entitlements.

Responses

Response samples

Content type
application/json
{
  • "mspEntitlementBanners": [
    ],
  • "mspEntitlementSummaries": [
    ],
  • "mspEntitlements": [
    ]
}

Get Banners

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.

path Parameters
tenantId
required
string

tenantId of the MSP retrieving their MSP Entitlement Banners.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get MSP Entitlement Summaries

Retrieve a summary of all an MSP's MSP (Bulk) Entitlements by device type.

path Parameters
tenantId
required
string

tenantId of the MSP retrieving their MSP Entitlements Summaries.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Get request list

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 details

path Parameters
requestId
required
string

requestId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "body": "string",
  • "method": "string",
  • "url": "string"
}

View

View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Get Admins

Get the list of admins.

path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

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)

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "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 Delegations

Get the list of customer delegations.

path Parameters
tenant_id
required
string

Tenant ID

Request Body schema: application/json

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)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "crtTime": "string",
  • "delegatedToEmail": "string",
  • "delegatedToId": "string",
  • "delegatedToName": "string",
  • "delegationType": "string",
  • "entitlements": [
    ],
  • "id": "string",
  • "lastUpdTime": "string",
  • "status": "string",
  • "tenantEmail": "string",
  • "tenantId": "string",
  • "tenantName": "string",
  • "type": "string"
}

Get MSP-ECs

Get the list of your MSP-ECs.

path Parameters
tenant_id
required
string

Tenant ID

query Parameters
delegation
string

delegation

Request Body schema: application/json

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)

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "filters": {
    },
  • "matchFields": [
    ],
  • "multiSortFields": [
    ],
  • "mustNotMatchField": [
    ],
  • "page": 0,
  • "pageByDate": {
    },
  • "pageSize": 0,
  • "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
}