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

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

DeprecatedDeprecated

Request

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

Path
customerIdstringrequired

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

No request payload

Responses

Ok

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/jsonArray [
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 POST /tenants can be used for this content.

Body
required
account_idstring[ 0 .. 255 ] characters
namestring[ 2 .. 255 ] characters

The name of MSP-EC account.

Example: "Acme Sales"
street_addressstring or null[ 0 .. 255 ] characters

The MSP-EC mailing address' street name and number.

Example: "350 West Java st"
statestring or null[ 0 .. 255 ] characters

The MSP-EC mailing address' geographical state.

Example: "CA"
countrystring or null[ 0 .. 255 ] characters

The MSP-EC mailing address' country.

Example: "US"
postal_codestring or null[ 0 .. 255 ] characters

The MSP-EC mailing address' postal code.

Example: "95089"
phone_numberstring or null[ 0 .. 255 ] characters

The MSP-EC's phone number.

Example: "650-123-4567"
fax_numberstring or null[ 0 .. 255 ] characters

The MSP-EC's fax number.

Example: "650-123-9999"
citystring or null[ 0 .. 255 ] characters

The MSP-EC mailing address' city.

Example: "Sunnyvale"
mapping_urlstring or null[ 0 .. 255 ] characters

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

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

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

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

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

Example: "2020-09-14 01:12:51Z"
admin_emailstring[ 0 .. 255 ] characters

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

Example: "john.wang@sampledomain.com"
admin_firstnamestring or null[ 0 .. 64 ] characters

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

Example: "John"
admin_lastnamestring or null[ 0 .. 64 ] characters

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

Example: "Wang"
admin_rolestring[ 0 .. 255 ] characters

The admin role of the first MSP-EC administrator.

Example: "PRIME_ADMIN,ADMIN,READ_ONLY"
tenant_typestring[ 0 .. 25 ] characters

The tenant type of the MSP EC administrator.

Example: "MSP, MSP_INTEGRATOR, MSP_INSTALLER"
licensesobject(License)

license information

delegationsArray of objects(EcDelegation)unique

Grant or revoke access to tenants to manage the customer.

admin_delegationsArray of objects(MspAdminRole)unique

Grant or revoke access to admins to manage the customer.

tierstring

MSP-EC tier info

Example: "GOLD, PLATINUM"
{
  "account_id": "string",
  "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",
  "admin_email": "john.wang@sampledomain.com",
  "admin_firstname": "John",
  "admin_lastname": "Wang",
  "admin_role": "PRIME_ADMIN,ADMIN,READ_ONLY",
  "tenant_type": "MSP, MSP_INTEGRATOR, MSP_INSTALLER",
  "licenses": {
    "trialAction": "ACTIVATE",
    "assignments": [ … ],
    "subscription_start_date": "string",
    "subscription_end_date": "string"
  },
  "delegations": [
    { … }
  ],
  "admin_delegations": [
    { … }
  ],
  "tier": "GOLD, PLATINUM"
}

Responses

Accepted

Body
string
Response
"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

MSP EC Tenant Id

No request payload

Responses

Ok

Bodyapplication/json
string
Response
application/json
"string"

Managed Brand Operations

Managed Brand Operations

Operations

Brand Settings

Operations

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