What’s New


GET /portalServiceProfiles/{portalServiceProfileId}

Get Portal Service Profile

PUT /portalServiceProfiles/{portalServiceProfileId}

Update Portal Service Profile

DELETE /portalServiceProfiles/{portalServiceProfileId}

Delete Portal Service Profile

PUT /portalServiceProfiles/{portalServiceProfileId}/poweredImages

Update Portal Service Profile Powered Image

PUT /portalServiceProfiles/{portalServiceProfileId}/photos

Update Portal Service Profile Photo

PUT /portalServiceProfiles/{portalServiceProfileId}/logos

Update Portal Service Profile Logo

PUT /portalServiceProfiles/{portalServiceProfileId}/backgroundImages

Update Portal Service Profile Background Image

POST /wifiNetworks/{wifiNetworkId}/guestUsers

Add Guest User

PATCH /wifiNetworks/{wifiNetworkId}/guestUsers

Guest User Action

GET /portalServiceProfiles

Get Portal Service Profiles

POST /portalServiceProfiles

Add Portal Service Profile

DELETE /portalServiceProfiles

Delete Portal Service Profile

POST /networks/{networkId}/guestUsers

Import Guest Users by Network ID

GET /guestUsers

Get Guest Users

POST /guestUsers

Add Guest Users

DELETE /guestUsers

Delete Guest Users

GET /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

Get Guest User by ID

DELETE /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

Delete Guest User by ID

PATCH /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}

Update Guest User

GET /guestUsers/{guestUserId}

Get Guest User by ID

DELETE /guestUsers/{guestUserId}

Delete Guest User by ID

PATCH /guestUsers/{guestUserId}

Update Guest User

GET /portalServiceProfiles/tags

Get Tags Filter of Portal Service Profiles

GET /portalServiceProfiles/networks

Get Network Filter of Portal Service Profiles

GET /tenants/{tenantId}

Retrieve Managed Tenant

PUT /tenants/{tenantId}

Update Managed Tenant

DELETE /tenants/{tenantId}

Remove Managed Tenant

GET /tenants/{tenantId}/tenantDelegations

Retrieve Active Relationships Between Designated Accounts and Their Managed Tenant

PUT /tenants/{tenantId}/tenantDelegations

Update Active Relationships Between Designated Accounts and Their Managed Tenant

PUT /tenants/{tenantId}/invitations

Resend Email Invitation

GET /tenants/{tenantId}/admins/{adminId}

Retrieve Administrator

PUT /tenants/{tenantId}/admins/{adminId}

Assign Administrator

DELETE /tenants/{tenantId}/admins/{adminId}

Revoke Administrator

GET /tenants/{tenantId}/adminDelegations

Retrieve Active Relationships Between Designated Administrators and Their Assigned Tenants

PUT /tenants/{tenantId}/adminDelegations

Update Active Relationships Between Designated Administrators and Their Managed Tenant

PUT /tenantActivations/{tenantId}

Reactivate

DELETE /tenantActivations/{tenantId}

Deactivate

GET /tenantActivations/supportStatus/{tenantId}

Retrieve Support Team Assistance Status

PUT /tenantActivations/supportStatus/{tenantId}

Enable Support Team Assistance

DELETE /tenantActivations/supportStatus/{tenantId}

Disable Support Team Assistance

GET /brandings

Retrieve Brand Settings

PUT /brandings

Update Brand Settings

POST /brandings

Add Brand Settings

POST /tenants

Add Managed Tenants

POST /logoFiles

Update Brand Logos

POST /firmwareUpgradeSchedules

Update Firmware Upgrade Schedules

PATCH /tenantDelegations

Add Designated Accounts to Manage Tenants

PATCH /adminDelegations

Assign Administrators

GET /tenants/{tenantId}/admins

Retrieve Administrators

GET /logoFiles/{fileId}

Retrieve Brand Logos

What’s Deleted


POST /tenants/query

Query Customer Or Tech Partner Data

POST /tenants/inventories/query

Query Customer Device Inventory Data

POST /tenants/inventories/query/csv

Export Customer Device Inventory Data

POST /delegations/query

Query Customer Delegation Data

PATCH /mspCustomers/{customerId}

Partial Update of the MSP-EC

What’s Changed


GET /mspCustomers/{customerId}/mspadmins

Deprecated

PUT /mspCustomers/{customerId}/mspadmins

Deprecated

GET /mspCustomers/{customerId}/admins/{adminId}

Deprecated

PUT /mspCustomers/{customerId}/admins/{adminId}

Deprecated

DELETE /mspCustomers/{customerId}/admins/{adminId}

Deprecated

POST /mspCustomers/{customerId}/invitations

Deprecated

GET /mspCustomers/{customerId}/delegations

Deprecated

POST /mspCustomers/{customerId}/delegations

Deprecated

DELETE /mspCustomers/{customerId}/delegations

Deprecated

GET /mspIntegrators/{integratorId}

Deprecated

PATCH /mspIntegrators/{integratorId}

Deprecated

Request:

Changed content type : application/json

GET /mspLabels/{mspLabel}
GET /mspLabels/baseUrls

Deprecated

GET /mspCustomers/{customerId}/logoUrls

Deprecated

GET /mspCustomers/{customerId}/admins

Deprecated

GET /mspCustomers/{customerId}/activationStatus

Deprecated

GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}
Return Type:

Changed response : 200 OK > OK

PUT /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

POST /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces
Return Type:

Changed response : 200 OK > OK

POST /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces
Request:

Changed content type : application/json

GET /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}
Return Type:

Changed response : 200 OK > OK

PATCH /venues/{venueId}/edgeClusters/{edgeClusterId}/edges/{serialNumber}/lags/{lagId}/subInterfaces/{subInterfaceId}
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/ports/{portId}/subInterfaces/{subInterfaceId}
Request:

Changed content type : application/vnd.ruckus.v1+json

GET /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs
Return Type:

Changed response : 200 OK > OK

PATCH /venues/{venueId}/edgeClusters/{clusterId}/edges/{serialNumber}/portConfigs
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

POST /events/csvFiles
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

PUT /mspCustomers/{customerId}/delegatorAdmins

Deprecated

Request:

Changed content type : application/json

PATCH /mspCustomers/delegations

Deprecated

Request:

Changed content type : application/json

GET /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}
Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

GET /tunnelServiceProfiles/{tunnelServiceProfileId}
Return Type:

Changed response : 200 OK > OK

PUT /tunnelServiceProfiles/{tunnelServiceProfileId}
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

PATCH /tunnelServiceProfiles/{tunnelServiceProfileId}
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

DELETE /mspCustomers/{customerId}

Deprecated

GET /mspCustomers/{customerId}

Deprecated

Return Type:

Changed response : 200 OK > Ok

PUT /mspCustomers/{customerId}

Deprecated

Request:

Changed content type : application/json

GET /mspCustomers

Deprecated

Return Type:

Changed response : 200 OK > Ok

POST /mspCustomers

Deprecated

Request:

New content type : application/vnd.ruckus.v1.2+json

New content type : application/vnd.ruckus.v1.1+json

Deleted content type : application/vnd.ruckus.v3+json

Deleted content type : application/vnd.ruckus.v2+json

Changed content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Return Type:

Changed response : 202 Accepted > Accepted

Changed response : 400 Bad Request > Bad Request

Changed response : 500 Internal Server Error > Server Error

POST /mspCustomers/firmwareUpgradeSchedules

Deprecated

PATCH /mspCustomers/mspAdmins/associations

Deprecated

Request:

Changed content type : application/json

GET /venues/{venueId}/switches/{switchId}/vlans/{vlanId}
Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed items (object):

Changed items (object):

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 201 Created > Created

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed items (object):

Changed items (object):

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 200 OK > OK

PATCH /venues/{venueId}/edgeClusters/{clusterId}/networkSettings
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

GET /mspLabels

Retrieve Brand Settings

PUT /mspLabels

Update Brand Settings

POST /mspLabels

Add Brand Settings

GET /switchProfiles/{switchProfileId}/vlans
Return Type:

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Changed response : 200 OK > OK

Request:

Changed content type : application/json

Updated Wi-Fi_API_and_Model_Documentation_GuestNetwork : * Changed property guestPortal (object) > Network configuration of guest access including captive portal settings and authentication settings.

* Changed property `externalPortalUrl` (string)

* Changed property `redirectUrl` (string)

* Changed property `wisprPage` (object)
    > Configuration for WISPr network


    * Changed property `captivePortalUrl` (string)
POST /wifiNetworks
Request:

Changed content type : application/json

Updated Wi-Fi_API_and_Model_Documentation_GuestWifiNetwork : * Changed property guestPortal (object) > Network configuration of guest access including captive portal settings and authentication settings.

* Changed property `externalPortalUrl` (string)

* Changed property `redirectUrl` (string)

* Changed property `wisprPage` (object)
    > Configuration for WISPr network


    * Changed property `captivePortalUrl` (string)

Changed content type : application/vnd.ruckus.v1+json

Updated Wi-Fi_API_and_Model_Documentation_GuestWifiNetwork : * Changed property guestPortal (object) > Network configuration of guest access including captive portal settings and authentication settings.

* Changed property `externalPortalUrl` (string)

* Changed property `redirectUrl` (string)

* Changed property `wisprPage` (object)
    > Configuration for WISPr network


    * Changed property `captivePortalUrl` (string)
PUT /wifiNetworks/{wifiNetworkId}
Request:

Changed content type : application/json

Updated Wi-Fi_API_and_Model_Documentation_GuestWifiNetwork : * Changed property guestPortal (object) > Network configuration of guest access including captive portal settings and authentication settings.

* Changed property `externalPortalUrl` (string)

* Changed property `redirectUrl` (string)

* Changed property `wisprPage` (object)
    > Configuration for WISPr network


    * Changed property `captivePortalUrl` (string)

Changed content type : application/vnd.ruckus.v1+json

Updated Wi-Fi_API_and_Model_Documentation_GuestWifiNetwork : * Changed property guestPortal (object) > Network configuration of guest access including captive portal settings and authentication settings.

* Changed property `externalPortalUrl` (string)

* Changed property `redirectUrl` (string)

* Changed property `wisprPage` (object)
    > Configuration for WISPr network


    * Changed property `captivePortalUrl` (string)
PUT /switches/{switchId}
Request:

Changed content type : application/json

PUT /switches/{switchId}/portSettings
Request:

Changed content type : application/json

Changed content type : application/vnd.ruckus.v1+json

POST /venues/switchFirmwares/switches/schedules/query
Return Type:

Changed response : 200 OK > OK

POST /venues/switchFirmwares/schedules/query
Return Type:

Changed response : 200 OK > OK

POST /switches
Request:

Changed content type : application/json

Changed items (object):

Changed content type : application/vnd.ruckus.v1+json

Changed items (object):

POST /networks
Request:

Changed content type : application/json

Updated Wi-Fi_API_and_Model_Documentation_GuestNetwork : * Changed property guestPortal (object) > Network configuration of guest access including captive portal settings and authentication settings.

* Changed property `externalPortalUrl` (string)

* Changed property `redirectUrl` (string)

* Changed property `wisprPage` (object)
    > Configuration for WISPr network


    * Changed property `captivePortalUrl` (string)
Return Type:

Changed response : 202 Accepted > Accepted