Skip to content
MSP Services/
/
Remove Managed Tenant

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

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

Update Managed TenantDeprecated

Request

Update configuration settings for an existing managed tenant account. This method will be removed no sooner than 08/31/2026. 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[ 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.

application/json
{
  "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

Bodyapplication/json
requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response
application/json
{
  "requestId": "string",
  "tenantId": "string"
}

Remove Managed TenantDeprecated

Request

Delete a managed tenant account and all associated data. This method will be removed no sooner than 08/31/2026. 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

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response
application/json
{
  "requestId": "string",
  "tenantId": "string"
}

Retrieve Admin DelegationsDeprecated

Request

Retrieve active relationships between designated administrators and their assigned tenants. This method will be removed no sooner than 08/31/2026. The following URL GET /tenants/{tenantId}/adminDelegations can be used for this content.

Path
customerIdstringrequired

MSP-EC Tenant ID

No request payload

Responses

Ok

Bodyapplication/jsonArray [
msp_admin_idstringrequired

The admin ID of MSP tenant.

Example: "4c2b196a205d11ea978f-2e728ce88125"
msp_admin_rolestring[ 0 .. 255 ] charactersrequired

The admin role of the first MSP administrator.

Example: "PRIME_ADMIN"
]
Response
application/json
[
  {
    "msp_admin_id": "4c2b196a205d11ea978f-2e728ce88125",
    "msp_admin_role": "PRIME_ADMIN"
  }
]