Skip to content

MSP Services (V0.3.3)

Documentation for Dashboard API

Ruckus Network Technical Documents

Download OpenAPI description

Overview

URL

http://support.ruckuswireless.com

Support Team

support@ruckuswireless.com

License

RUCKUS Cloud Privacy Policy

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

Deprecated

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

DeprecatedDeprecated

Request

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

Path

customerIdstringrequired

Tenant Id of the MSP EC account to be retrieved.

No request payload

Responses

Ok

Bodyapplication/json

msp_labelstring

The MSP label.

Example: "msp-label"

namestring

The name of MSP-EC account.

Example: "Acme Sales"

street_addressstring or null

The street address of MSP-EC account.

Example: "350 West Java st"

statestring or null

The state of MSP-EC account.

Example: "CA"

countrystring or null

The country of MSP-EC account.

Example: "US"

postal_codestring or null

The postal code of MSP-EC account.

Example: "95089"

phone_numberstring or null

The phone number of MSP-EC account.

Example: "650-123-4567"

fax_numberstring or null

The fax number of MSP-EC account.

Example: "650-123-9999"

citystring or null

The city of MSP-EC account.

Example: "Sunnyvale"

mapping_urlstring or null

The map URL of MSP-EC account.

Example: "https//map.gogle.com/zsdweews"

service_effective_datestring

The effective date of MSP-EC account.

Example: "2019-09-14 01:12:51Z"

service_expiration_datestring

The expiration date of MSP-EC account.

Example: "2020-09-14 01:12:51Z"

is_activestring or null

Active state of MSP-EC account.

Example: "true"

tenant_idstring

Tenant ID.

Example: "6173ca160495421c95be47b42b349067"

parent_tenant_idstring

Parent tenant ID.

Example: "6173ca160495421c95be47b42b349067"

tenant_typestring

The tenant type of the MSP EC administrator.

Example: "MSP, MSP_INTEGRATOR, MSP_INSTALLER"

account_idstring

Account ID.

Example: "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS"

tierstring

Account ID.

Example: "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS"

logo_urlstring

privacyFeaturesArray of objects(PrivacyFeatureResponse)unique

Privacy features

Response

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-09-14 01:12:51Z",
  "service_expiration_date": "2020-09-14 01:12:51Z",
  "is_active": "true",
  "tenant_id": "6173ca160495421c95be47b42b349067",
  "parent_tenant_id": "6173ca160495421c95be47b42b349067",
  "tenant_type": "MSP, MSP_INTEGRATOR, MSP_INSTALLER",
  "account_id": "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS",
  "tier": "_53997fe0-dffb-4bac-bcc1-e21c689a320f_kodzLWdS",
  "logo_url": "string",
  "privacyFeatures": [
    { … }
  ]
}

DeprecatedDeprecated

Request

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

Path

customerIdstringrequired

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

Bodyapplication/jsonrequired

namestring[ 0 .. 255 ] charactersrequired

The name of the MSP-EC account.

Example: "Acme Sales"

street_addressstring or null[ 0 .. 255 ] characters

The street address of the MSP-EC account.

Example: "350 West Java st"

statestring or null[ 0 .. 255 ] characters

The state of the MSP-EC account.

Example: "CA"

countrystring or null[ 0 .. 255 ] characters

The country of the MSP-EC account.

Example: "US"

postal_codestring or null[ 0 .. 255 ] characters

The postal code of the MSP-EC account.

Example: "95089"

phone_numberstring or null[ 0 .. 255 ] characters

The phone number of the MSP-EC account.

Example: "650-123-4567"

fax_numberstring or null[ 0 .. 255 ] characters

The fax number of the MSP-EC account.

Example: "650-123-9999"

citystring or null[ 0 .. 255 ] characters

The city of the MSP-EC account.

Example: "Sunnyvale"

mapping_urlstring or null[ 0 .. 255 ] characters

The map URL of the MSP-EC account.

Example: "https//map.gogle.com/zsdweews"

service_effective_datestringrequired

The effective date of the MSP-EC account.

Example: "2019-09-14 01:12:51.805Z"

service_expiration_datestringrequired

The expiration date of the MSP-EC account.

Example: "2020-09-14 01:12:51.805Z"

licensesobject(License)

license information

tierstring

MSP-EC tier info

Example: "GOLD, PLATINUM"

privacyFeaturesArray of objects(PrivacyFeatureRequest)[ 0 .. 1 ] itemsunique

Privacy features

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-09-14 01:12:51.805Z",
  "service_expiration_date": "2020-09-14 01:12:51.805Z",
  "licenses": {
    "trialAction": "ACTIVATE",
    "assignments": [ … ],
    "subscription_start_date": "string",
    "subscription_end_date": "string"
  },
  "tier": "GOLD, PLATINUM",
  "privacyFeatures": [
    { … }
  ]
}

Responses

Accepted

Bodyapplication/json

requestIdstringrequired

tenantIdstring

Response

application/json

{
  "requestId": "string",
  "tenantId": "string"
}

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