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.
Document Name | Resources Managed |
msp-ns-220711.html | MSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks. |
platform-ns-220711.html | Platform 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.html | ICX switch related resources. This document describes API endpoints related to managing your switches and wired networks. |
wifi-ns-220711.html | Wi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks. |
Region | Domain |
Asia | https://asia.ruckus.cloud |
Europe | https://eu.ruckus.cloud |
North America | https://ruckus.cloud |
Abbreviation | Description |
REC | RUCKUS end customer. RUCKUS end customers use API endpoints to manage their own account and networks. |
VAR | Value-added reseller. VARs can manage the account (including networks) of specific RECs. In order for a VAR to manage an REC’s account, the REC must first invite the VAR to manage their account and the VAR must accept the invitation. A successful invitation and acceptance process is modeled by a delegation resource. API endpoints in the ”Delegation” API group are used to manage these delegations. In order for a VAR to manage (configure and monitor) an REC’s account using API endpoints, the VAR’s API client must obtain an API token for that REC; an endpoint in the “API Client Authentication” group is used for this purpose. When a VAR is managing an REC’s network, the VAR may need to install devices in that network on behalf of the REC. Entitlements which the REC has purchased and activated 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-EC | MSP's end customer. MSP-ECs can use API endpoints to manage their own networks, if permitted by their MSP. |
Get delegation list.
tenantId required | string Tenant ID |
type | string Enum: "REC" "MSP" "MSP_EC" type |
[- {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
]
Send invitation to VAR (aka delegate) to manage my account.
tenantId required | string tenantId |
inviteVARPayload
username | string |
{- "username": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
Get delegation by ID.
delegationId required | string delegationId |
tenantId required | string Tenant ID |
{- "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"
}
A VAR uses this endpoint to respond to a delegation invitation; the response is either accept or reject.
delegationId required | string delegationId |
tenantId required | string tenantId |
payload
accept | boolean |
fromTenantId | string |
{- "accept": true,
- "fromTenantId": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2019-08-24T14:15:22Z"
}
}
Get the list of MSP administrators authorized to manage an MSP-EC.
mspEcTenantId required | string MSP-EC Tenant ID |
[- {
- "msp_admin_id": "4c2b196a205d11ea978f-2e728ce88125",
- "msp_admin_role": "PRIME_ADMIN"
}
]
Update the list of MSP administrators authorized to manage an MSP-EC.
mspEcTenantId required | string MSP-EC Tenant Id |
mspAdminRoleList
msp_admin_id | string The admin ID of MSP tenant. |
msp_admin_role | string [ 0 .. 255 ] characters The admin role of the first MSP administrator. |
[- {
- "msp_admin_id": "4c2b196a205d11ea978f-2e728ce88125",
- "msp_admin_role": "PRIME_ADMIN"
}
]
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Get the MSP's customization data. Note: customization data provides MSP branding data including URLs from which MSP-ECs can request technical assistance.
mspTenantId required | string Tenant Id of the tenant to get MSP data. |
{- "mspLogoFileDataList": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "logo_fileuuid": "mockLogoFileUUID",
- "logo_file_name": "mockLogoFileName"
}
], - "preferredWisprProvider": {
- "acct": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "apiKey": "string",
- "apiSecret": "string",
- "auth": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "createdDate": "2019-08-24T14:15:22Z",
- "customExternalProvider": true,
- "id": "string",
- "parentId": "string",
- "providerName": "string",
- "updatedDate": "2019-08-24T14:15:22Z"
}, - "msp_label": "acme-sales",
- "logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "alarm_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "ping_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "mlisa_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "ping_login_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "default_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
- "msp_fqdn": "wifi.sampledomain.com",
- "contact_support_behavior": "redirect",
- "open_case_behavior": "redirect",
- "my_open_case_behavior": "redirect",
- "msp_phone": "+6501234567",
- "msp_external_id": "0015B000015bJEfQAM",
- "msp_tenant_name": "Sampledomain Inc."
}
Update data for MSP.
mspTenantId required | string Tenant Id of the tenant to update MSP data. |
updateMspRequest
Array of objects (MspLogoFileData) | |
object (PreferredWisprProvider) | |
msp_label | string[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9] The MSP label. |
logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of logo file. |
alarm_notification_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of 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. |
{- "mspLogoFileDataList": [
- {
- "id": "string",
- "logo_fileuuid": "mockLogoFileUUID",
- "logo_file_name": "mockLogoFileName"
}
], - "preferredWisprProvider": {
- "acct": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "apiKey": "string",
- "apiSecret": "string",
- "auth": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "customExternalProvider": true,
- "id": "string",
- "providerName": "string"
}, - "msp_label": "acme-sales",
- "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "msp_fqdn": "wifi.sampledomain.com",
- "contact_support_behavior": "redirect",
- "open_case_behavior": "redirect",
- "my_open_case_behavior": "redirect",
- "msp_phone": "408-123-5678",
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
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.
mspTenantId required | string Tenant Id of the tenant to add MSP Label. |
updateMspRequest
Array of objects (MspLogoFileData) | |
object (PreferredWisprProvider) | |
msp_label | string[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9] The MSP label. |
logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of logo file. |
alarm_notification_logo_uuid | string^$|[a-zA-Z0-9~\.+_-]+ The ID of 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. |
{- "mspLogoFileDataList": [
- {
- "id": "string",
- "logo_fileuuid": "mockLogoFileUUID",
- "logo_file_name": "mockLogoFileName"
}
], - "preferredWisprProvider": {
- "acct": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "apiKey": "string",
- "apiSecret": "string",
- "auth": {
- "primary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}, - "secondary": {
- "ip": "string",
- "port": 1,
- "sharedSecret": "string"
}
}, - "customExternalProvider": true,
- "id": "string",
- "providerName": "string"
}, - "msp_label": "acme-sales",
- "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
- "msp_fqdn": "wifi.sampledomain.com",
- "contact_support_behavior": "redirect",
- "open_case_behavior": "redirect",
- "my_open_case_behavior": "redirect",
- "msp_phone": "408-123-5678",
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Get MSP-EC account details.
mspEcTenantId required | string Tenant Id of the MSP-EC account to be retrieved. |
{- "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 account.
mspEcTenantId required | string Tenant ID of the MSP-EC account to be updated. |
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. |
{- "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"
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Get activation status for this MSP-EC.
mspEcTenantId required | string Tenant ID of the tenant to get MSP data. |
{- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "properties": { },
- "switchActivated": true,
- "tenantActivated": true,
- "updatedDate": "2019-08-24T14:15:22Z",
- "wifiActivated": true
}
Get MSP-EC administrator data.
mspEcAdminId required | string Admin Id of the MSP-EC administrator to be retrieved. |
mspEcTenantId required | string Tenant ID of the MSP-EC administrator to be retrieved. |
{- "full_name": "John Wang",
- "first_name": "John",
- "last_name": "Wang"
}
Update MSP-EC administrator data.
mspEcAdminId required | string Admin Id of the MSP-EC administrator to be updated. |
mspEcTenantId required | string Tenant Id of the MSP-EC administrator to be updated. |
updateMspEcAdminRequest
string [ 0 .. 255 ] characters The email address of 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. |
{- "full_name": "John Wang",
- "first_name": "John",
- "last_name": "Wang"
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Delete MSP-EC administrator.
mspEcAdminId required | string Admin Id of the MSP-EC administrator to be deleted. |
mspEcTenantId required | string Tenant ID of the MSP-EC administrator to be deleted. |
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Deactivate the MSP-EC account.
mspEcTenantId required | string Tenant Id of the MSP-EC account to be deactivated. |
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "properties": { },
- "switchActivated": true,
- "tenantActivated": true,
- "updatedDate": "2019-08-24T14:15:22Z",
- "wifiActivated": true
}
}
Email an MSP-EC administrator an invitation to join their account.
mspEcTenantId required | string Tenant Id of the MSP-EC account |
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. |
{- "resend": false
}
{- "downloadUrl": "string",
- "errors": [
- {
- "code": "string",
- "message": "string",
- "object": "string",
- "value": { }
}
], - "requestId": "string"
}
Reactivate the MSP-EC account.
mspEcTenantId required | string Tenant Id of the MSP-EC account to be reactivated. |
{- "requestId": "string",
- "response": {
- "createdDate": "2019-08-24T14:15:22Z",
- "id": "string",
- "parentId": "string",
- "properties": { },
- "switchActivated": true,
- "tenantActivated": true,
- "updatedDate": "2019-08-24T14:15:22Z",
- "wifiActivated": true
}
}
Get the list of MSP-EC accounts.
mspTenantId required | string Tenant Id of the tenant to add MSP Label. |
[- {
- "msp_label": "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"
}
]
Create an MSP-EC account.
mspTenantId required | string Tenant ID of the tenant to create MSP-EC account. |
addMspEcRequest
name | string The name of MSP-EC account. |
street_address | string [ 0 .. 255 ] characters The 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. |
{- "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_firstname": "John",
- "admin_lastname": "Wang",
- "admin_role": "PRIME_ADMIN,ADMIN,READ_ONLY"
}
"string"
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.mspTenantId required | string tenantId of the MSP creating an MSP assignment. |
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 |
Content-Type required | string Content-Type |
{- "dailyReport": [
- {
- "date": "2019-08-24",
- "mspEcs": [
- {
- "assignments": [
- {
- "assignmentCount": 0,
- "deviceSubType": "string",
- "deviceType": "MSP_WIFI"
}
], - "installedDevices": [
- {
- "createdDate": "2019-08-24T14:15:22Z",
- "deviceModel": "string",
- "deviceType": "string",
- "historyCreatedDate": "2019-08-24",
- "mspEcTenantId": "string",
- "serialNumber": "string"
}
], - "mspEcName": "string"
}
], - "numberOfEcs": 0,
- "totalAssignmentDaysByDevice": [
- {
- "assignmentDays": 0,
- "deviceSubType": "string",
- "deviceType": "MSP_WIFI"
}
], - "totalDeviceDaysByDevice": [
- {
- "deviceDays": 0,
- "deviceSubType": "string",
- "deviceType": "string"
}
]
}
], - "grandTotalAssignmentDays": 0,
- "grandTotalDeviceDays": 0,
- "mspName": "string",
- "reportEndDate": "2019-08-24",
- "reportStartDate": "2019-08-24",
- "requestEndDate": "2019-08-24",
- "requestStartDate": "2019-08-24",
- "totalAssignmentDaysByDevice": [
- {
- "assignmentDays": 0,
- "deviceSubType": "string",
- "deviceType": "MSP_WIFI"
}
], - "totalDaysInReport": 0,
- "totalDeviceDaysByDevice": [
- {
- "deviceDays": 0,
- "deviceSubType": "string",
- "deviceType": "string"
}
]
}
Retrieve all the assignments (created and revoked).
tenantId required | string tenantId of the MSP retrieving their MSP Assignments. |
[- {
- "status": "FUTURE",
- "id": 231,
- "mspEcTenantId": "d7c104ba608c41eb864279be2fc0d2e8",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 15,
- "dateEffective": "2019-08-24T14:15:22Z",
- "dateExpires": "2019-08-24T14:15:22Z",
- "trialAssignment": false,
- "dateAssignmentCreated": "2019-08-24T14:15:22Z",
- "dateAssignmentRevoked": "2019-08-24T14:15:22Z",
- "mspTenantId": "15bebe3c3e7c40499d65b5b7f63f80ea",
- "revokedBy": "null"
}
]
Create a new entitlement assignment.
tenantId required | string tenantId of the MSP creating an MSP Assignment. |
assign
mspEcTenantId | string MSP-EC's tenantId. |
deviceType | string Enum: "MSP_WIFI" "MSP_SWITCH" MSP (Bulk) Entitlement device type. |
deviceSubType | string MSP (Bulk) Entitlement device sub-type; in this version of the API, this parameter is only used when deviceType is SWITCH. Valid string values for device sub-type are "ICX71L", "ICX71", "ICX75", "ICX76", "ICX78" and "ICX_ANY". |
quantity | integer <int64> Quantity of devices permitted by this assignment. |
useTemporaryMspEntitlement | boolean Trial (aka Temporary) MSP Entitlement to be used for this assignment (if this parameter is not supplied in the request, it defaults to false). |
{- "mspEcTenantId": "d7c104ba608c41eb864279be2fc0d2e8",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 15,
- "useTemporaryMspEntitlement": false
}
"string"
Bulk operations request to create, replace or revoke multiple entitlement assignments.
tenantId required | string tenantId of the MSP creating an MSP Assignment. |
operationsRequest
bulkOperationRequest | Array of objects (AssignmentOperation) Object providing a list of requested assignment operations. |
{- "bulkOperationRequest": [
- { }
]
}
[- {
- "success": true,
- "assignmentId": 15,
- "code": "201",
- "status": "CREATED",
- "errors": {
- "code": "string",
- "errors": { },
- "internalMessage": "string",
- "message": "string",
- "method": "string",
- "path": "string",
- "requestId": "string",
- "service": "string",
- "status": "string",
- "timestamp": "string",
- "validationError": {
- "expected": "string",
- "object": "string",
- "objectName": "string",
- "value": "string"
}
}
}
]
Retrieve a summary by device type of all an MSP's Entitlement Assignments.
tenantId required | string tenantId of the MSP retrieving their MSP Assignments Summary. |
{- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 2000,
- "courtesyMspEntitlementsUsed": false,
- "remainingDevices": 1472,
- "trial": true
}
Replace an entitlement assignment.
assignmentId required | string Id of the assignment to replace. |
tenantId required | string tenantId of the MSP replacing this assignment. |
replacementAssignment
newQuantity | integer <int64> Quantity of devices permitted by this replacement assignment; the replacement assignment will be for the same MSP-EC and have the same deviceType, deviceSubType and isTrial values as the assignment being revoked. |
{- "newQuantity": 10
}
"string"
Retrieve all the MSP's MSP (Bulk) entitlements.
tenantId required | string tenantId of the MSP retrieving their MSP Entitlements. |
[- {
- "isTrial": true,
- "lastNotificationDate": "2019-08-24T14:15:22Z",
- "status": "FUTURE",
- "id": "5fb69a6e157d494f96e419d6eb541904",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "sku": "CLD-MW00-3001",
- "quantity": 2000,
- "effectiveDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}
]
Refresh MSP entitlements. Note: this endpoint can be used to retrieve recently activated licenses.
tenantId required | string tenantId of the MSP refreshing their MSP Entitlements. |
{- "mspEntitlementBanners": [
- {
- "type": "INITIAL",
- "deviceType": "MSP_WIFI",
- "multipleLicense": true,
- "effectDate": "2019-08-24T14:15:22Z",
- "effectDays": 35,
- "deviceCount": 100,
- "affectedDeviceCount": 22
}
], - "mspEntitlementSummaries": [
- {
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 2000,
- "courtesyQuantity": 100,
- "remainingDays": 86,
- "effectiveDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "trial": true
}
], - "mspEntitlements": [
- {
- "isTrial": true,
- "lastNotificationDate": "2019-08-24T14:15:22Z",
- "status": "FUTURE",
- "id": "5fb69a6e157d494f96e419d6eb541904",
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "sku": "CLD-MW00-3001",
- "quantity": 2000,
- "effectiveDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z"
}
]
}
Retrieve banner data for the MSP's MSP (Bulk) entitlements. Banners provide information about MSP (Bulk) Entitlements that are either near their expiry or have expired.
tenantId required | string tenantId of the MSP retrieving their MSP Entitlement Banners. |
[- {
- "type": "INITIAL",
- "deviceType": "MSP_WIFI",
- "multipleLicense": true,
- "effectDate": "2019-08-24T14:15:22Z",
- "effectDays": 35,
- "deviceCount": 100,
- "affectedDeviceCount": 22
}
]
Retrieve a summary of all an MSP's MSP (Bulk) Entitlements by device type.
tenantId required | string tenantId of the MSP retrieving their MSP Entitlements Summaries. |
[- {
- "deviceType": "MSP_WIFI",
- "deviceSubType": "ICX71",
- "quantity": 2000,
- "courtesyQuantity": 100,
- "remainingDays": 86,
- "effectiveDate": "2019-08-24T14:15:22Z",
- "expirationDate": "2019-08-24T14:15:22Z",
- "trial": true
}
]
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 the list of customer delegations.
tenantId required | string Tenant ID |
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) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "alarmCount": 0,
- "crtTime": "string",
- "delegatedToEmail": "string",
- "delegatedToId": "string",
- "delegatedToName": "string",
- "delegationType": "string",
- "earlyExpirationDate": "string",
- "entitlements": [
- {
- "consumed": "string",
- "entitlementDeviceSubType": "string",
- "entitlementDeviceType": "string",
- "expirationDate": "string",
- "expirationDateTs": "string",
- "quantity": "string",
- "tenantId": "string",
- "toBeRemovedQuantity": 0,
- "type": "string"
}
], - "id": "string",
- "lastUpdTime": "string",
- "priorityIncidents": {
- "p1": "string",
- "p2": "string",
- "p3": "string",
- "p4": "string"
}, - "status": "string",
- "switchLicenses": 0,
- "tenantEmail": "string",
- "tenantId": "string",
- "tenantName": "string",
- "type": "string",
- "wifiLicenses": 0
}
View the list of networking devices installed in our end customers venues.
tenantId required | string Tenant ID |
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) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "customerName": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "deviceType": "string",
- "downlink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downMac": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "latitude": "string",
- "longitude": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "uplink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": null,
- "band": null,
- "channel": null,
- "operativeChannelBandwidth": null,
- "radioId": null,
- "txPower": null
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "latitude": "string",
- "longitude": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "upMac": "string",
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "managedAs": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "serialNumber": "string",
- "switchMac": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "tenantId": "string",
- "uplink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": 0,
- "band": "string",
- "channel": 0,
- "operativeChannelBandwidth": "string",
- "radioId": 0,
- "txPower": "string"
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downlink": [
- {
- "IP": "string",
- "apGroupId": "string",
- "apGroupName": "string",
- "apMac": "string",
- "apStatusData": {
- "APRadio": [
- {
- "Rssi": null,
- "band": null,
- "channel": null,
- "operativeChannelBandwidth": null,
- "radioId": null,
- "txPower": null
}
], - "APSystem": {
- "uptime": 0
}, - "cellularInfo": {
- "cellular3G4GChannel": 0,
- "cellularActiveSim": "string",
- "cellularBand": "string",
- "cellularCardRemovalCountSIM0": "string",
- "cellularCardRemovalCountSIM1": "string",
- "cellularConnectionStatus": "string",
- "cellularCountry": "string",
- "cellularDHCPTimeoutCountSIM0": "string",
- "cellularDHCPTimeoutCountSIM1": "string",
- "cellularDefaultGateway": "string",
- "cellularDownlinkBandwidth": "string",
- "cellularECIO": 0,
- "cellularICCIDSIM0": "string",
- "cellularICCIDSIM1": "string",
- "cellularIMEI": "string",
- "cellularIMSISIM0": "string",
- "cellularIMSISIM1": "string",
- "cellularIPaddress": "string",
- "cellularIsSIM0Present": "string",
- "cellularIsSIM1Present": "string",
- "cellularLTEFirmware": "string",
- "cellularNWLostCountSIM0": "string",
- "cellularNWLostCountSIM1": "string",
- "cellularOperator": "string",
- "cellularRSCP": 0,
- "cellularRSRP": 0,
- "cellularRSRQ": 0,
- "cellularRadioUptime": 0,
- "cellularRoamingStatus": "string",
- "cellularRxBytesSIM0": "string",
- "cellularRxBytesSIM1": "string",
- "cellularSINR": 0,
- "cellularSignalStrength": "string",
- "cellularSubnetMask": "string",
- "cellularSwitchCountSIM0": "string",
- "cellularSwitchCountSIM1": "string",
- "cellularTxBytesSIM0": "string",
- "cellularTxBytesSIM1": "string",
- "cellularUplinkBandwidth": "string",
- "cellularWanInterface": "string"
}
}, - "clients": 0,
- "configStatus": "string",
- "connectionStatus": "string",
- "crtTime": "string",
- "description": "string",
- "deviceGroupId": "string",
- "deviceGroupName": "string",
- "deviceModelType": "string",
- "deviceStatus": "string",
- "deviceStatusSeverity": "string",
- "downMac": "string",
- "downlink": [
- { }
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "latitude": "string",
- "longitude": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "downlink.downMac": [
- "string"
], - "downlink.rssi": [
- 0
], - "downlink.type": [
- 0
], - "extIp": "string",
- "externalPort": "string",
- "floorplanId": "string",
- "fwVersion": "string",
- "hops": 0,
- "isMeshEnable": true,
- "lastSeenTime": "string",
- "lastUpdTime": "string",
- "latitude": "string",
- "longitude": "string",
- "meshRole": "string",
- "model": "string",
- "name": "string",
- "rogueCategory": {
- "property1": 0,
- "property2": 0
}, - "rssi": 0,
- "rxBytes": "string",
- "rxFrames": "string",
- "serialNumber": "string",
- "switchName": "string",
- "switchSerialNumber": "string",
- "tags": "string",
- "txBytes": "string",
- "txFrames": "string",
- "type": 0,
- "upMac": "string",
- "uplink": [
- { }
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "wlanGroups": [
- {
- "radioId": 0,
- "wlanGroupId": "string",
- "wlanGroupName": "string"
}
], - "xPercent": 0,
- "yPercent": 0
}
], - "uplink.rssi": 0,
- "uplink.upMac": "string",
- "venueId": "string",
- "venueName": "string",
- "wlanGroup24GId": "string",
- "wlanGroup5GId": "string",
- "xPercent": 0,
- "yPercent": 0
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Export the list of networking devices installed in our end customers venues.
tenantId required | string Tenant Id of the MSP. |
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) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{ }
Get the list of your MSP-ECs.
tenantId required | string Tenant ID |
delegation | string delegation |
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) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeDateFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lt": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "assignedMspEcList": [
- "string"
], - "city": "string",
- "country": "string",
- "creationDate": "string",
- "delegatedTo": "string",
- "delegationExpiryDate": 0,
- "entitlements": [
- {
- "consumed": "string",
- "entitlementDeviceSubType": "string",
- "entitlementDeviceType": "string",
- "expirationDate": "string",
- "expirationDateTs": "string",
- "quantity": "string",
- "tenantId": "string",
- "toBeRemovedQuantity": 0,
- "type": "string"
}
], - "id": "string",
- "installer": "string",
- "integrator": "string",
- "lastUpdTime": "string",
- "mspAdminCount": 0,
- "mspAdmins": [
- "string"
], - "mspEcAdminCount": 0,
- "mspInstallerAdminCount": 0,
- "mspInstallerAdmins": [
- "string"
], - "mspIntegratorAdminCount": 0,
- "mspIntegratorAdmins": [
- "string"
], - "mspLabel": "string",
- "mspName": "string",
- "mspTenantId": "string",
- "name": "string",
- "postalCode": "string",
- "priorityIncidents": {
- "p1": "string",
- "p2": "string",
- "p3": "string",
- "p4": "string"
}, - "state": "string",
- "status": "string",
- "streetAddress": "string",
- "switchLicenses": 0,
- "tenantType": "string",
- "wifiLicenses": 0
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}