Skip to content
/Tenant Account Management

MSP Services (V0.3.3)

Overview

The MSP API provides comprehensive management capabilities for managing multiple MSP managed tenant accounts. This API enables you to manage tenant accounts, control administrator access, customize branding, and schedule firmware upgrades.

The API is designed for managed service providers that manage multiple customer tenant accounts and need to control access delegation, branding customization, and device management operations.

What This API Does

  • MSP Tenant Management: Create, retrieve, update, and delete MSP managed tenant accounts and configuration settings
  • MSP Tenant Queries: Query and retrieve MSP customer or tech partner data
  • MSP Administrator Access Control: Grant or revoke MSP administrator access with role based permissions, delegation capabilities, and cross tenant access control
  • MSP Tenant Activation Management: Control MSP tenant status including activation, deactivation, and temporary support team access for troubleshooting
  • MSP Branding Customization: Configure custom branding for MSP tenants including logo uploads and brand settings
  • MSP Firmware Upgrade Scheduling: Schedule and manage firmware upgrades across managed devices
  • MSP Tenant Delegations: Establish and manage delegation relationships between MSP accounts, technology partners, and customer tenants
  • MSP Administrator Delegations: Manage administrator assignments and access permissions for MSP tenant accounts
  • MSP Administrator Invitations: Send email invitations to MSP administrators for tenant access and onboarding

Key Capabilities

  • Multi Tenant Operations: Manage multiple isolated MSP tenant accounts with independent configurations and administrator assignments
  • MSP Delegation Support: Support delegation between MSP accounts, integrators, installers, and tenant administrators
  • Role Based Access: Assign MSP administrators with specific roles and privilege groups for granular access control
  • MSP Tenant Management: Complete MSP tenant management from creation through deactivation and deletion
  • Support Access Control: Enable or disable temporary support team access to MSP tenants for assistance
  • Custom Branding: Upload and manage custom logos and branding configurations for MSP service delivery
  • Scheduled Upgrades: Configure firmware upgrade schedules with recurring or one time scheduling options for MSP managed devices
  • Query Capabilities: Retrieve MSP tenant data

Authentication & Authorization

This API uses bearer token authentication with role based access control. MSP administrators must have appropriate permissions to perform operations on tenant accounts and delegation relationships.

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

Tenant Activation Management

Supports the activation and deactivation of a managed tenant. Control support team access for managed tenants.

Operations

View MSP

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.

Operations

Firmware Upgrade Scheduling

Manages firmware upgrade schedules for access points and switches. Supports recurring automated upgrades and one time manual scheduling options.

Operations

Query Inventory Information

Retrieves inventory information. These endpoints are specifically designed for viewing operational data and do not facilitate configuration management.

Operations

Query Delegation Information

Retrieves delegation information. These endpoints are specifically designed for viewing operational data and do not facilitate configuration management.

Operations

Query MSP Customer Information

Retrieves customer information. These endpoints are specifically designed for viewing operational data and do not facilitate configuration management.

Operations

Tenant Delegation Management

Manages delegation relationships between service provider accounts, technology partners, installers, and tenant accounts. Supports assigning tenant accounts to technology partners and controlling organizational access permissions.

Operations

Administrator Access Control

Manages administrator assignments and access control for MSP tenant accounts. Supports assigning or removing administrators, configuring role based permissions and privilege groups, and managing cross tenant administrator access.

Operations

Tenant Account Management

Manages tenant accounts including creation, retrieval, updates, and deletion. Supports sending email invitations to tenant administrators and managing account configurations.

Operations

Retrieve Managed Tenant

Request

Retrieve detailed information for a specific managed tenant account.

Path
tenantIdstringrequired
No request payload

Responses

Ok

Body
msp_labelstring

Label identifying the parent MSP.

Example: "msp-label"
namestring

The name of MSP-EC account.

Example: "Acme Sales"
street_addressstring

The street address of MSP-EC account.

Example: 350
statestring

The state of MSP-EC account.

Example: "CA"
countrystring

The country of MSP-EC account.

Example: "US"
postal_codestring

The postal code of MSP-EC account.

Example: 95089
phone_numberstring

The phone number of MSP-EC account.

Example: "650-123-4567"
fax_numberstring

The fax number of MSP-EC account.

Example: "650-123-9999"
citystring

The city of MSP-EC account.

Example: "Sunnyvale"
mapping_urlstring

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

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

Service tier of the account.

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

URL to access the MSP customer account's logo file.

privacyFeaturesArray of objects(PrivacyFeatureResponse)unique

Privacy features for the account.

Response
{
  "msp_label": "msp-label",
  "name": "Acme Sales",
  "street_address": 350,
  "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": [
    { … }
  ]
}

Update Managed Tenant

Request

Update configuration settings for an existing managed tenant account.

Path
tenantIdstringrequired
Body
required
namestring[ 0 .. 255 ] charactersrequired

The name of the MSP-EC account.

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

The street address of the MSP-EC account.

Example: 350
statestring[ 0 .. 255 ] characters

The state of the MSP-EC account.

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

The country of the MSP-EC account.

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

The postal code of the MSP-EC account.

Example: 95089
phone_numberstring[ 0 .. 255 ] characters

The phone number of the MSP-EC account.

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

The fax number of the MSP-EC account.

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

The city of the MSP-EC account.

Example: "Sunnyvale"
mapping_urlstring[ 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 for the account.

tierstring

Service tier information for MSP-EC.

Example: "GOLD, PLATINUM"
privacyFeaturesArray of objects(PrivacyFeatureRequest)[ 0 .. 1 ] itemsunique

Privacy features for the account.

{
  "name": "Acme Sales",
  "street_address": 350,
  "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

Body
requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

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

Remove Managed Tenant

Request

Delete a managed tenant account and all associated data.

Path
tenantIdstringrequired
No request payload

Responses

Ok

Body
requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

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

Send Administrator Invitation

Request

Send or resend an email invitation to an administrator, granting them access credentials and login instructions for the tenant account.

Path
tenantIdstringrequired
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: true
application/json
{
  "admin_email": "john.wang@sampledomain.com",
  "resend": true
}

Responses

No Content

Body
Response
null

Create Managed Tenant

Request

Create a new managed tenant account with specified configuration settings.

Body
required
dataArray of objects(AddMspEcRequestV1_4)[ 1 .. 100 ] itemsunique
{
  "data": [
    { … }
  ]
}

Responses

Accepted

Body
dataArray of objects(ResponseBo)required
data[].​requestIdstringrequired

Unique identifier for tracking the API request.

data[].​tenantIdstring

Tenant identifier associated with the request.

Response
{
  "data": [
    { … }
  ]
}

Get Consolidated API Download URL

Request

Get signed URL for downloading the consolidated API zip file.

No request payload

Responses

Ok

Body
consolidatedApiUrlstring

Signed URL for downloading the consolidated API zip file

Example: "https://storage.example.com/api/consolidatedApi.zip?signature=..."
Response
{
  "consolidatedApiUrl": "https://storage.example.com/api/consolidatedApi.zip?signature=..."
}

Brand Customization

Manages branding customization for managed service provider accounts. Supports uploading logo images, configuring contact information and portal settings such as custom domain names and support URLs.

Operations