Skip to content

MSP Services (V0.3.3)

Documentation for Dashboard API

Download OpenAPI description
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

Deprecated

Operations

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.

Bodyrequired
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 PUT /tenants/{tenantId}/invitations can be used for this content.

Path
customerIdstringrequired

Tenant Id of the MSP EC account

Bodyapplication/jsonrequired
admin_emailstring[ 0 .. 255 ] charactersrequired

The email of the MSP-EC administrator.

Example: "john.wang@sampledomain.com"
resendboolean

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

Example: false
application/json
{ "admin_email": "john.wang@sampledomain.com", "resend": false }

Responses

OK

Response
No content

DeprecatedDeprecated

Request

The following method will be removed no sooner than 09/08/2025. The following URL GET /tenantActivations/supportStatus/{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"

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