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

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

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

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

Deprecated

Operations

Retrieve Brand Logo URLsDeprecated

Request

Retrieve download URLs for brand logo image files associated with the tenant. This method will be removed no sooner than 08/31/2026. The following URL GET /tenants/{tenantId} can be used for this content.

Path

customerIdstringrequired

MSP EC Tenant Id

No request payload

Responses

Bodyapplication/json

requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response

application/json

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

List Tenant AdministratorsDeprecated

Request

Retrieve a list of all administrators assigned to the tenant account. This method will be removed no sooner than 08/31/2026. The following URL GET /tenants/{tenantId}/admins can be used for this content.

Path

customerIdstringrequired

Tenant ID of the MSP-EC administrator list to be retrieved.

No request payload

Responses

Bodyapplication/json

requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response

application/json

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

Get Tenant Activation StatusDeprecated

Request

Check whether a tenant account is currently activated or deactivated. This method will be removed no sooner than 08/31/2026.

Path

customerIdstringrequired

Tenant ID of the tenant to get MSP data.

No request payload

Responses

Bodyapplication/json

idstring

createdDatestring(date-time)read-only

Timestamp when the entity was created.

updatedDatestring(date-time)read-only

Timestamp when the entity was last updated.

propertiesobject

Additional custom properties stored as key value pairs for the MSP customer account.

wifiActivatedboolean

Indicates whether WiFi services are activated for this MSP customer account.

switchActivatedboolean

Indicates whether switch services are activated for this MSP customer account.

tenantActivatedboolean

Indicates whether the tenant service is activated for this MSP customer account.

parentIdstringread-only

Identifier of the parent entity in the hierarchy.

Response

application/json

{
  "id": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": null,
    "property2": null
  },
  "wifiActivated": true,
  "switchActivated": true,
  "tenantActivated": true,
  "parentId": "string"
}