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

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

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

Retrieve Brand Details

Request

Retrieve MSP account branding, contact information, and portal settings.

No request payload

Responses

Body

msp_labelstring

Unique label identifying the MSP.

Example: "msp-label"

logo_uuidstring

The UUID of logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"

alarm_notification_logo_uuidstring

The UUID of alarm notification logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"

ping_notification_logo_uuidstring

The UUID of ping notification logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"

mlisa_logo_uuidstring

The UUID of RUCKUS one logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"

ping_login_logo_uuidstring

The UUID of ping login logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"

default_logo_uuidstring

The UUID of default logo file.

Example: "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg"

msp_fqdnstring

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"

contact_support_urlstring

The URL at which to obtain customer support from your MSP.

Example: "http://support.sampledomain.com/"

contact_support_behaviorstring

The contact support behavior of MSP tenant.

Example: "redirect"

open_case_urlstring

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"

open_case_behaviorstring

The open case behavior of MSP tenant.

Example: "redirect"

my_open_case_urlstring

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"

my_open_case_behaviorstring

The my open case behavior of MSP tenant.

Example: "redirect"

change_password_urlstring

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"

msp_phonestring

Your MSP's customer support phone number.

Example: "+6501234567"

msp_emailstring

Your MSP's customer support email address.

Example: "support@msp.com"

msp_websitestring

Website URL for your MSP.

Example: "http://wifi.sampledomain.com"

msp_external_idstring

The MSP external account ID.

Example: "0015B000015bJEfQAM"

msp_tenant_namestring

Your MSP's name.

Example: "sampledomain Inc."

mspLogoFileDataListArray of objects(MspLogoFileData)

List of logo file metadata associated with the MSP account for branding purposes.

preferredWisprProviderobject(PreferredWisprProvider)

Preferred WISPr provider configuration for external captive portal authentication services.

domain_suffixstring

Domain suffix for MSP tenant email addresses and portal URLs.

Response

{
  "msp_label": "msp-label",
  "logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
  "alarm_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
  "ping_notification_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
  "mlisa_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
  "ping_login_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
  "default_logo_uuid": "b183ae56-e081-11e9-8a34-2a2ae2dbcce4.jpg",
  "msp_fqdn": "wifi.sampledomain.com",
  "contact_support_url": "http://support.sampledomain.com/",
  "contact_support_behavior": "redirect",
  "open_case_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "+6501234567",
  "msp_email": "support@msp.com",
  "msp_website": "http://wifi.sampledomain.com",
  "msp_external_id": "0015B000015bJEfQAM",
  "msp_tenant_name": "sampledomain Inc.",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … },
    "parentId": "string"
  },
  "domain_suffix": "string"
}

Update Brand Details

Request

Update MSP account branding, contact information, and portal settings.

Body

required

msp_labelstring[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]required

Unique label identifying the MSP.

Example: "msp-label"

logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

alarm_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of alarm notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

mlisa_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of RUCKUS one logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_login_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

default_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

msp_fqdnstring[ 0 .. 255 ] characters^$|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"

contact_support_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to obtain customer support from your MSP.

Example: "https://support.sampledomain.com/"

contact_support_behaviorstring[ 0 .. 255 ] characters

The contact support behavior of MSP tenant.

Example: "redirect"

open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"

open_case_behaviorstring[ 0 .. 255 ] characters

The open case behavior of MSP tenant.

Example: "redirect"

my_open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"

my_open_case_behaviorstring[ 0 .. 255 ] characters

The my open case behavior of MSP tenant.

Example: "redirect"

change_password_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"

msp_phonestring[ 0 .. 255 ] characters

Your MSP's customer support phone number.

Example: "408-123-5678"

msp_emailstring[ 0 .. 255 ] characters

Your MSP's customer support email address.

Example: "joho.wang@sampledomain.com"

msp_websitestring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

Website URL for your MSP.

Example: "http://wifi.sampledomain.com/"

mspLogoFileDataListArray of objects(MspLogoFileData)

List of logo file metadata associated with the MSP account.

preferredWisprProviderobject(PreferredWisprProvider)

Preferred WISPr provider configuration for external captive portal authentication.

{
  "msp_label": "msp-label",
  "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "msp_fqdn": "wifi.sampledomain.com",
  "contact_support_url": "https://support.sampledomain.com/",
  "contact_support_behavior": "redirect",
  "open_case_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "408-123-5678",
  "msp_email": "joho.wang@sampledomain.com",
  "msp_website": "http://wifi.sampledomain.com/",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … }
  }
}

Responses

Accepted

Body

requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response

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

Create Brand Details

Request

Create MSP account branding, contact information, and portal settings.

Body

required

msp_labelstring[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]required

Unique label identifying the MSP.

Example: "msp-label"

logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

alarm_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of alarm notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

mlisa_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of RUCKUS one logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_login_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

default_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

msp_fqdnstring[ 0 .. 255 ] characters^$|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"

contact_support_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to obtain customer support from your MSP.

Example: "https://support.sampledomain.com/"

contact_support_behaviorstring[ 0 .. 255 ] characters

The contact support behavior of MSP tenant.

Example: "redirect"

open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"

open_case_behaviorstring[ 0 .. 255 ] characters

The open case behavior of MSP tenant.

Example: "redirect"

my_open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"

my_open_case_behaviorstring[ 0 .. 255 ] characters

The my open case behavior of MSP tenant.

Example: "redirect"

change_password_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"

msp_phonestring[ 0 .. 255 ] characters

Your MSP's customer support phone number.

Example: "408-123-5678"

msp_emailstring[ 0 .. 255 ] characters

Your MSP's customer support email address.

Example: "joho.wang@sampledomain.com"

msp_websitestring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

Website URL for your MSP.

Example: "http://wifi.sampledomain.com/"

mspLogoFileDataListArray of objects(MspLogoFileData)

List of logo file metadata associated with the MSP account.

preferredWisprProviderobject(PreferredWisprProvider)

Preferred WISPr provider configuration for external captive portal authentication.

{
  "msp_label": "msp-label",
  "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "msp_fqdn": "wifi.sampledomain.com",
  "contact_support_url": "https://support.sampledomain.com/",
  "contact_support_behavior": "redirect",
  "open_case_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "408-123-5678",
  "msp_email": "joho.wang@sampledomain.com",
  "msp_website": "http://wifi.sampledomain.com/",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … }
  }
}

Responses

Accepted

Body

requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response

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

Upload Brand Logos

Request

Upload custom logo image files for branding customization, supports JPEG, PNG, and SVG formats.

Body

required

msp_labelstring[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]required

Unique label identifying the MSP.

Example: "msp-label"

logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

alarm_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of alarm notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

mlisa_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of RUCKUS one logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_login_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

default_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

msp_fqdnstring[ 0 .. 255 ] characters^$|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"

contact_support_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to obtain customer support from your MSP.

Example: "https://support.sampledomain.com/"

contact_support_behaviorstring[ 0 .. 255 ] characters

The contact support behavior of MSP tenant.

Example: "redirect"

open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"

open_case_behaviorstring[ 0 .. 255 ] characters

The open case behavior of MSP tenant.

Example: "redirect"

my_open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"

my_open_case_behaviorstring[ 0 .. 255 ] characters

The my open case behavior of MSP tenant.

Example: "redirect"

change_password_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"

msp_phonestring[ 0 .. 255 ] characters

Your MSP's customer support phone number.

Example: "408-123-5678"

msp_emailstring[ 0 .. 255 ] characters

Your MSP's customer support email address.

Example: "joho.wang@sampledomain.com"

msp_websitestring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

Website URL for your MSP.

Example: "http://wifi.sampledomain.com/"

mspLogoFileDataListArray of objects(MspLogoFileData)

List of logo file metadata associated with the MSP account.

preferredWisprProviderobject(PreferredWisprProvider)

Preferred WISPr provider configuration for external captive portal authentication.

{
  "msp_label": "msp-label",
  "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "msp_fqdn": "wifi.sampledomain.com",
  "contact_support_url": "https://support.sampledomain.com/",
  "contact_support_behavior": "redirect",
  "open_case_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "408-123-5678",
  "msp_email": "joho.wang@sampledomain.com",
  "msp_website": "http://wifi.sampledomain.com/",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … }
  }
}

Responses

Body

requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response

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

Retrieve Brand Logo File

Request

Retrieve download URLs and metadata for uploaded brand logo image files by file identifier.

Path

fileIdstringrequired

Body

msp_labelstring[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]required

Unique label identifying the MSP.

Example: "msp-label"

logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

alarm_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of alarm notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_notification_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping notification logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

mlisa_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of RUCKUS one logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

ping_login_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of ping login logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

default_logo_uuidstring^$|[a-zA-Z0-9~\.+_-]+

The ID of default logo file.

Example: "b183ae56e08111e98a342a2ae2dbcce4-001.png"

msp_fqdnstring[ 0 .. 255 ] characters^$|[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9](\...

The FQDN of MSP portal.

Example: "wifi.sampledomain.com"

contact_support_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to obtain customer support from your MSP.

Example: "https://support.sampledomain.com/"

contact_support_behaviorstring[ 0 .. 255 ] characters

The contact support behavior of MSP tenant.

Example: "redirect"

open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL at which to open a customer support case with your MSP.

Example: "http://support.sampledomain.com/opencase"

open_case_behaviorstring[ 0 .. 255 ] characters

The open case behavior of MSP tenant.

Example: "redirect"

my_open_case_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The URL to view your open customer support cases.

Example: "http://support.sampledomain.com/myopencase"

my_open_case_behaviorstring[ 0 .. 255 ] characters

The my open case behavior of MSP tenant.

Example: "redirect"

change_password_urlstring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

The change password URL of MSP tenant.

Example: "http://wifi.sampledomain.com/password"

msp_phonestring[ 0 .. 255 ] characters

Your MSP's customer support phone number.

Example: "408-123-5678"

msp_emailstring[ 0 .. 255 ] characters

Your MSP's customer support email address.

Example: "joho.wang@sampledomain.com"

msp_websitestring[ 0 .. 255 ] characters^$|(http|https)://[a-zA-Z0-9][a-zA-Z0-9-]{0,6...

Website URL for your MSP.

Example: "http://wifi.sampledomain.com/"

mspLogoFileDataListArray of objects(MspLogoFileData)

List of logo file metadata associated with the MSP account.

preferredWisprProviderobject(PreferredWisprProvider)

Preferred WISPr provider configuration for external captive portal authentication.

{
  "msp_label": "msp-label",
  "logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "alarm_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_notification_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "mlisa_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "ping_login_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "default_logo_uuid": "b183ae56e08111e98a342a2ae2dbcce4-001.png",
  "msp_fqdn": "wifi.sampledomain.com",
  "contact_support_url": "https://support.sampledomain.com/",
  "contact_support_behavior": "redirect",
  "open_case_url": "http://support.sampledomain.com/opencase",
  "open_case_behavior": "redirect",
  "my_open_case_url": "http://support.sampledomain.com/myopencase",
  "my_open_case_behavior": "redirect",
  "change_password_url": "http://wifi.sampledomain.com/password",
  "msp_phone": "408-123-5678",
  "msp_email": "joho.wang@sampledomain.com",
  "msp_website": "http://wifi.sampledomain.com/",
  "mspLogoFileDataList": [
    { … }
  ],
  "preferredWisprProvider": {
    "id": "string",
    "providerName": "string",
    "apiKey": "string",
    "apiSecret": "string",
    "customExternalProvider": true,
    "auth": { … },
    "acct": { … }
  }
}

Responses

Body

requestIdstringrequired

Unique identifier for tracking the API request.

tenantIdstring

Tenant identifier associated with the request.

Response

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

MSP Services (V0.3.3)

Tenant Activation Management

View MSP

Firmware Upgrade Scheduling

Query Inventory Information

Query Delegation Information

Query MSP Customer Information

Tenant Delegation Management

Administrator Access Control

Tenant Account Management

Brand Customization

Retrieve Brand Details

Request

Responses

Update Brand Details

RequestExpand all

Responses

Create Brand Details

RequestExpand all

Responses

Upload Brand Logos

RequestExpand all

Responses

Retrieve Brand Logo File

RequestExpand all

Responses

Request

Request

Request

Request