Skip to content
/
Deprecated

MSP Services (V0.3.3)

Documentation for Dashboard API

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
URL

http://support.ruckuswireless.com

Support Team

support@ruckuswireless.com

License

RUCKUS Cloud Privacy Policy

Languages
Servers
RUCKUS One API host for North American region.

https://api.ruckus.cloud/

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud/

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud/

Managed-Tenant Operations

Managed-Tenant Operations

Operations

Managed Brand Operations

Managed Brand Operations

Operations

Brand Settings

Operations

Retrieve Brand SettingsDeprecated

Request

The following method will be removed no sooner than 09/08/2025. The following URL GET /brandings can be used for this content.

No request payload

Responses

Ok

Bodyapplication/json
msp_labelstring

The MSP label.

Example: "msp-label"
logo_uuidstring or null

The UUID of logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"
alarm_notification_logo_uuidstring or null

The UUID of alarm notification logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"
ping_notification_logo_uuidstring or null

The UUID of ping notification logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"
mlisa_logo_uuidstring or null

The UUID of Ruckus Analytics logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"
ping_login_logo_uuidstring or null

The UUID of ping login logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"
default_logo_uuidstring or null

The UUID of default logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"
msp_fqdnstring or null

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"
contact_support_urlstring or null

The URL at which to obtain customer support from your MSP.

Example: "http://support.sampledomain.com/"
contact_support_behaviorstring or null

The contact support behavior of MSP tenant.

Example: "redirect"
open_case_urlstring or null

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"
open_case_behaviorstring or null

The open case behavior of MSP tenant.

Example: "redirect"
my_open_case_urlstring or null

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"
my_open_case_behaviorstring or null

The my open case behavior of MSP tenant.

Example: "redirect"
change_password_urlstring or null

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"
msp_phonestring or null

Your MSP's customer-support phone number.

Example: "+6501234567"
msp_emailstring or null

Your MSP's customer-support email address.

Example: "support@msp.com"
msp_websitestring or null

Your MSP's website.

Example: "http://wifi.sampledomain.com"
msp_external_idstring or null

The MSP external account ID.

Example: "0015B000015bJEfQAM"
msp_tenant_namestring or null

Your MSP's name.

Example: "sampledomain Inc."
mspLogoFileDataListArray of objects(MspLogoFileData)
preferredWisprProviderobject(PreferredWisprProvider)
domain_suffixstring
Response
application/json
{
  "msp_label": "msp-label",
  "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_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "+6501234567",
  "msp_email": "support@msp.com",
  "msp_website": "http://wifi.sampledomain.com",
  "msp_external_id": "0015B000015bJEfQAM",
  "msp_tenant_name": "sampledomain Inc.",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … },
    "parentId": "string"
  },
  "domain_suffix": "string"
}

Update Brand SettingsDeprecated

Request

The following method will be removed no sooner than 09/08/2025. The following URL PUT /brandings can be used for this content.

Bodyapplication/jsonrequired
msp_labelstring[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]required

The MSP label.

Example: "msp-label"
logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
alarm_notification_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of alarm notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
ping_notification_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
mlisa_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of Ruckus Analytics logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
ping_login_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
default_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
msp_fqdnstring or null[ 0 .. 255 ] characters^$|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"
contact_support_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to obtain customer support from your MSP.

Example: "https://support.sampledomain.com/"
contact_support_behaviorstring or null[ 0 .. 255 ] characters

The contact support behavior of MSP tenant.

Example: "redirect"
open_case_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"
open_case_behaviorstring or null[ 0 .. 255 ] characters

The open case behavior of MSP tenant.

Example: "redirect"
my_open_case_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"
my_open_case_behaviorstring or null[ 0 .. 255 ] characters

The my open case behavior of MSP tenant.

Example: "redirect"
change_password_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"
msp_phonestring or null[ 0 .. 255 ] characters

Your MSP's customer-support phone number.

Example: "408-123-5678"
msp_emailstring or null[ 0 .. 255 ] characters

Your MSP's customer-support email address.

Example: "joho.wang@sampledomain.com"
msp_websitestring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

Your MSP's website.

Example: "http://wifi.sampledomain.com/"
mspLogoFileDataListArray of objects(MspLogoFileData)
preferredWisprProviderobject(PreferredWisprProvider)
application/json
{
  "msp_label": "msp-label",
  "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_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "408-123-5678",
  "msp_email": "joho.wang@sampledomain.com",
  "msp_website": "http://wifi.sampledomain.com/",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … }
  }
}

Responses

Accepted

Bodyapplication/json
requestIdstringrequired
tenantIdstring
Response
application/json
{
  "requestId": "string",
  "tenantId": "string"
}

Add Brand SettingsDeprecated

Request

The following method will be removed no sooner than 09/08/2025. The following URL POST /brandings can be used for this content.

Bodyapplication/jsonrequired
msp_labelstring[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]required

The MSP label.

Example: "msp-label"
logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
alarm_notification_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of alarm notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
ping_notification_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
mlisa_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of Ruckus Analytics logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
ping_login_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
default_logo_uuidstring or null^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"
msp_fqdnstring or null[ 0 .. 255 ] characters^$|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"
contact_support_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to obtain customer support from your MSP.

Example: "https://support.sampledomain.com/"
contact_support_behaviorstring or null[ 0 .. 255 ] characters

The contact support behavior of MSP tenant.

Example: "redirect"
open_case_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"
open_case_behaviorstring or null[ 0 .. 255 ] characters

The open case behavior of MSP tenant.

Example: "redirect"
my_open_case_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"
my_open_case_behaviorstring or null[ 0 .. 255 ] characters

The my open case behavior of MSP tenant.

Example: "redirect"
change_password_urlstring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"
msp_phonestring or null[ 0 .. 255 ] characters

Your MSP's customer-support phone number.

Example: "408-123-5678"
msp_emailstring or null[ 0 .. 255 ] characters

Your MSP's customer-support email address.

Example: "joho.wang@sampledomain.com"
msp_websitestring or null[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

Your MSP's website.

Example: "http://wifi.sampledomain.com/"
mspLogoFileDataListArray of objects(MspLogoFileData)
preferredWisprProviderobject(PreferredWisprProvider)
application/json
{
  "msp_label": "msp-label",
  "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_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "408-123-5678",
  "msp_email": "joho.wang@sampledomain.com",
  "msp_website": "http://wifi.sampledomain.com/",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … }
  }
}

Responses

Accepted

Bodyapplication/json
requestIdstringrequired
tenantIdstring
Response
application/json
{
  "requestId": "string",
  "tenantId": "string"
}

DeprecatedDeprecated

Request

The following method will be removed no sooner than 09/08/2025.

No request payload

Responses

Ok

Bodyapplication/json
string
Response
application/json
"string"

Deprecated

Operations

Admin Delegation Management

Operations

Resend email Invitation

Operations

Support Team assistance

Operations

Enable Support Team assistance

Operations

Disable Support Team assistance

Operations

Manage Firmware Upgrade Schedules

Operations

Tenant Delegation Management

Operations

Reactivation and Deactivation

Operations