RUCKUS Cloud - MSP & VAR APIs and Model Documentation (v22.07.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.

RUCKUS Cloud API Documents

This document, MSP & VAR APIs and Model Documentation, is one of four documents describing the RUCKUS Cloud public API. Different API endpoints are described in each of the four documents, which are arranged according to the resources managed. Corresponding to each of the 4 HTML documents is an Open API v3 JSON document, which can be used to generate code for API clients.

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

Cloud Hosts

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

Introduction to MSP & VAR Concepts

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 are 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 (cf. Platform APIs and Model Documentation).

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 can use API endpoints to manage their own networks, if permitted by their MSP.

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.

Delegation

Manage delegations between VARs and RECs.

Get Delegations

Get delegation list.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant ID

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

type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invite VAR

Send invitation to VAR (aka delegate) to manage my account.

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

Get Delegation

Get delegation by ID.

Authorizations:
Token
path Parameters
delegationId
required
string

delegationId

tenantId
required
string

Tenant ID

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,
  • "status": "INVITED",
  • "type": "VAR",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Respond to Delegation

A VAR uses this endpoint to respond to a delegation invitation; the response is either accept or reject.

Authorizations:
Token
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

Revoke VAR delegation by ID.

Authorizations:
Token
path Parameters
delegationId
required
string

delegationId

tenantId
required
string

tenantId

Responses

Response samples

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

MSP: Services & Branding

Manage MSP services & branding.

Get Base URL

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

Authorizations:
Token

Responses

Response samples

Content type
application/json
"string"

Check MSP Label

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

Authorizations:
Token
path Parameters
mspLabel
required
string

MSP Label

Responses

Response samples

Content type
application/json
"string"

Get Authorized Admins

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

Authorizations:
Token
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.

Authorizations:
Token
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 Customization Data

Get the MSP's customization data. Note: customization data provides MSP branding data including URLs from which MSP-ECs can request technical assistance.

Authorizations:
Token
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.sampledomain.com",
  • "contact_support_url": "http://support.sampledomain.com/",
  • "contact_support_behavior": "redirect",
  • "open_case_behavior": "redirect",
  • "my_open_case_behavior": "redirect",
  • "change_password_url": "http://wifi.sampledomain.com/password",
  • "msp_phone": "+6501234567",
  • "msp_email": "[email protected]",
  • "msp_external_id": "0015B000015bJEfQAM",
  • "msp_tenant_name": "Sampledomain Inc."
}

Update MSP Data

Update data for MSP.

Authorizations:
Token
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 alarm notification logo file.

ping_notification_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

mlisa_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of Ruckus Analytics logo file.

ping_login_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

default_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo 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 URL at which to obtain customer support from your MSP.

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 URL at which to open a customer support case with your MSP.

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 URL to view your open customer support cases.

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

Your MSP's customer-support phone number.

msp_email
string [ 0 .. 255 ] characters

Your MSP's customer-support email address.

msp_website
string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[...

Your MSP's website.

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.sampledomain.com",
  • "contact_support_url": "https://support.sampledomain.com/",
  • "contact_support_behavior": "redirect",
  • "open_case_behavior": "redirect",
  • "my_open_case_behavior": "redirect",
  • "change_password_url": "http://wifi.sampledomain.com/password",
  • "msp_phone": "408-123-5678",
  • "msp_email": "[email protected]",
}

Response samples

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

Create MSP Label

Create a new DNS label for this MSP. Note: the label is part of the DNS domain name used by MSP-ECs for account login.

Authorizations:
Token
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 alarm notification logo file.

ping_notification_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

mlisa_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of Ruckus Analytics logo file.

ping_login_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

default_logo_uuid
string^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo 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 URL at which to obtain customer support from your MSP.

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 URL at which to open a customer support case with your MSP.

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 URL to view your open customer support cases.

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

Your MSP's customer-support phone number.

msp_email
string [ 0 .. 255 ] characters

Your MSP's customer-support email address.

msp_website
string [ 0 .. 255 ] characters ^$|(http|https)://[a-zA-Z][a-zA-Z0-9-]{0,61}[...

Your MSP's website.

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.sampledomain.com",
  • "contact_support_url": "https://support.sampledomain.com/",
  • "contact_support_behavior": "redirect",
  • "open_case_behavior": "redirect",
  • "my_open_case_behavior": "redirect",
  • "change_password_url": "http://wifi.sampledomain.com/password",
  • "msp_phone": "408-123-5678",
  • "msp_email": "[email protected]",
}

Response samples

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

MSP: Manage MSP-ECs

Manage MSP-EC accounts.

Get MSP-EC

Get MSP-EC account details.

Authorizations:
Token
path Parameters
mspEcTenantId
required
string

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

Responses

Response samples

Content type
application/json
{
  • "msp_label": "msp-label",
  • "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-08-24T14:15:22Z",
  • "service_expiration_date": "2019-08-24T14:15:22Z",
  • "is_active": "true",
  • "tenant_id": "6173ca160495421c95be47b42b349067",
  • "parent_tenant_id": "6173ca160495421c95be47b42b349067",
  • "account_id": "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS"
}

Update MSP-EC

Update MSP-EC account.

Authorizations:
Token
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 the MSP-EC account.

street_address
string [ 0 .. 255 ] characters

The street address of the MSP-EC account.

state
string [ 0 .. 255 ] characters

The state of the MSP-EC account.

country
string [ 0 .. 255 ] characters

The country of the MSP-EC account.

postal_code
string [ 0 .. 255 ] characters

The postal code of the MSP-EC account.

phone_number
string [ 0 .. 255 ] characters

The phone number of the MSP-EC account.

fax_number
string [ 0 .. 255 ] characters

The fax number of the MSP-EC account.

city
string [ 0 .. 255 ] characters

The city of the MSP-EC account.

mapping_url
string [ 0 .. 255 ] characters

The map URL of the MSP-EC account.

service_effective_date
string <date-time>

The effective date of the MSP-EC account.

service_expiration_date
string <date-time>

The expiration date of the MSP-EC account.

Responses

Request samples

Content type
application/json
{
  • "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-08-24T14:15:22Z",
  • "service_expiration_date": "2019-08-24T14:15:22Z"
}

Response samples

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

Delete MSP-EC

Delete MSP-EC account.

Authorizations:
Token
path Parameters
mspEcTenantId
required
string

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

Responses

Response samples

Content type
application/json
{ }

Get MSP-EC Status

Get activation status for this MSP-EC.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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 the MSP-EC administrator.

user_name
string [ 0 .. 255 ] characters

The user name of the MSP-EC administrator.

full_name
string [ 0 .. 255 ] characters

The full name of the MSP-EC administrator.

first_name
string [ 0 .. 64 ] characters

The first name of the MSP-EC administrator.

last_name
string [ 0 .. 64 ] characters

The last name of the 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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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 MSP-EC Support Status

Get the status of the MSP-EC's delegation to RUCKUS Support.

Authorizations:
Token
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 to access this MSP-EC's account and networks.

Authorizations:
Token
path Parameters
mspEcTenantId
required
string

MSP-EC Tenant Id

Responses

Response samples

Content type
application/json
"string"

Revoke MSP-EC Support Access

Revoke RUCKUS Support access from this MSP-EC.

Authorizations:
Token
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 their account.

Authorizations:
Token
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 MSP-EC administrator.

resend
boolean

Indicate if this is to resend in case of email got lost.

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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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 MSP-EC mailing address' street name and number.

state
string [ 0 .. 255 ] characters

The MSP-EC mailing address' geographical state.

country
string [ 0 .. 255 ] characters

The MSP-EC mailing address' country.

postal_code
string [ 0 .. 255 ] characters

The MSP-EC mailing address' postal code.

phone_number
string [ 0 .. 255 ] characters

The MSP-EC's phone number.

fax_number
string [ 0 .. 255 ] characters

The MSP-EC's fax number.

city
string [ 0 .. 255 ] characters

The MSP-EC mailing address' city.

mapping_url
string [ 0 .. 255 ] characters

The map URL corresponding to the MSP-EC's mailing address.

service_effective_date
string <date-time>

The date when the MSP-EC's service started.

service_expiration_date
string <date-time>

The date when the MSP-EC's service terminates/terminated.

admin_email
string [ 0 .. 255 ] characters

The email address of the first MSP-EC administrator added to the account by the MSP.

admin_firstname
string [ 0 .. 64 ] characters

The first name of the first MSP-EC administrator added to the account by the MSP.

admin_lastname
string [ 0 .. 64 ] characters

The last name of the first MSP-EC administrator added to the account by the MSP.

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": "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-08-24T14:15:22Z",
  • "service_expiration_date": "2019-08-24T14:15:22Z",
  • "admin_email": "[email protected]",
  • "admin_firstname": "John",
  • "admin_lastname": "Wang",
  • "admin_role": "PRIME_ADMIN,ADMIN,READ_ONLY"
}

Response samples

Content type
application/json
"string"

MSP Entitlement

Manage MSP entitlements (bulk licenses).

Get Usage Report

The purpose of this usage report is to provide accounting data related to MSP-ECs’ use of networking assets. Usage is measured in two ways. The first is number of license assignments to MSP-ECs and the second is the actual number of devices installed in the MSP-ECs' networks. For the purposes of a usage report, a networking device is considered “installed” when it was created by invoking an API endpoint, not when it was physically installed or when it first connected to the RUCKUS cloud.

This API endpoint provides query parameters so an API client can select any start and end date as well as other query parameters to customize the report. The usage report is comprised of daily reports over the requested date interval plus cumulative sums showing overall usage. Each daily report provides the number of assignments and installed devices for each device type for each and every MSP-EC.

The following are definitions of parameters used in the API response.
  • assignment-day means that an assignment of quantity 1 was in effect for 1 day or any fraction thereof. For example, if a Wi-Fi assignment for a quantity 10 APs was in effect for 30 days, this calculates to 300 assignment-days.
  • device-day means that 1 networking device was installed for 1 day or any fraction thereof. For example, if 16 APs were installed on every day in May, this calculates to 496 device-days.
Authorizations:
Token
path Parameters
mspTenantId
required
string

tenantId of the MSP creating an MSP assignment.

query Parameters
deviceDetails
boolean
Default: false

True to include device detail in the report. False to exclude device detail in the report.

endDate
string

The end date included in the usage report, for example, endDate=yyyy-mm-dd; if omitted, the endDate is set to last month's last date.

month
string

month=mm

mspEcTenantId
string

Specific MSP EC tenant ID

startDate
string

The first date included in the usage report, for example, startDate=yyyy-mm-dd; if omitted, the startDate is set to last month's first date.

year
string

year=yyyy

header Parameters
Content-Type
required
string

Content-Type

Responses

Response samples

Content type
application/json
{
  • "dailyReport": [
    ],
  • "grandTotalAssignmentDays": 0,
  • "grandTotalDeviceDays": 0,
  • "mspName": "string",
  • "reportEndDate": "2019-08-24",
  • "reportStartDate": "2019-08-24",
  • "requestEndDate": "2019-08-24",
  • "requestStartDate": "2019-08-24",
  • "totalAssignmentDaysByDevice": [
    ],
  • "totalDaysInReport": 0,
  • "totalDeviceDaysByDevice": [
    ]
}

Retrieve all the assignments (created and revoked).

Retrieve all the assignments (created and revoked).

Authorizations:
Token
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.

Authorizations:
Token
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 entitlement assignments.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
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.

Authorizations:
Token
path Parameters
tenantId
required
string

tenantId of the MSP retrieving their MSP Entitlements Summaries.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

View

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

Get Delegations

Get the list of customer delegations.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

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

Responses

Request samples

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

Response samples

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

Get EC Inventory

View the list of networking devices installed in our end customers venues.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant ID

Request Body schema: application/json

payload

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

Responses

Request samples

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

Response samples

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

Export EC Inventory

Export the list of networking devices installed in our end customers venues.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant Id of the MSP.

Request Body schema: application/json

payload

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

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Get MSP-ECs

Get the list of your MSP-ECs.

Authorizations:
Token
path Parameters
tenantId
required
string

Tenant ID

query Parameters
delegation
string

delegation

Request Body schema: application/json

payload

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

Responses

Request samples

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

Response samples

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