Activities (v 0.0.4)


What’s New


GET /pendingDevices/aps/models

Get Access Point Device Models

POST /pendingDevices/aps/query

Query Access Point Device Assets

PATCH /pendingDevices/aps

Update Pending AP Device State

POST /pendingDevices/aps/csvFile

Import APs to the Pending Assets from CSV

GET /pendingDevices/aps/statusReports

Get AP Refresh Status

PATCH /pendingDevices/aps/statusReports

Refresh Access Points

POST /pendingDevices/customers/{customerId}/venues/{venueId}/apGroups/{apGroupId}/aps

Claim AP Asset to Associated MSP-EC Tenant

GET /pendingDevices/settings

Get Pending Assets Settings

PUT /pendingDevices/settings

Update Pending Assets Settings

POST /templates/directoryServerProfiles

Create Directory Server Profile Template

GET /templates/directoryServerProfiles/{directoryServerProfileTemplateId}

Get Directory Server Profile Template

PUT /templates/directoryServerProfiles/{directoryServerProfileTemplateId}

Update Directory Server Profile Template

DELETE /templates/directoryServerProfiles/{directoryServerProfileTemplateId}

Delete Directory Server Profile Template

POST /migrations/radiusAttributeGroups
POST /policies
POST /policies/query
GET /policies/rules/responses
GET /policies/rules/sources
GET /policies/{policyId}
DELETE /policies/{policyId}
PATCH /policies/{policyId}
POST /policies/{policyId}/assignments/query
GET /policies/{policyId}/assignments/{assignmentId}
GET /policies/{policyId}/rules
POST /policies/{policyId}/rules
GET /policies/{policyId}/rules/{ruleId}
DELETE /policies/{policyId}/rules/{ruleId}
PATCH /policies/{policyId}/rules/{ruleId}
GET /policies/{policyId}/rules/{ruleId}/responses
PATCH /policies/{policyId}/rules/{ruleId}/responses
GET /policies/{policyId}/rules/{ruleId}/sources
PATCH /policies/{policyId}/rules/{ruleId}/sources
PUT /templates/wifiNetworks/{wifiNetworkTemplateId}/directoryServerProfiles/{directoryServerProfileTemplateId}

Activate Directory Server Profile template On Wi-Fi Network template

PATCH /venues/{venueId}/apGroups/{apGroupId}/firmwares

Upgrade firmware on an AP group

PATCH /venues/{venueId}/aps/{serialNumber}/firmwares

Upgrade firmware on a single AP

PUT /venues/{venueId}/dhcpConfigServiceProfiles/{dhcpConfigServiceProfileId}/ethernetPortProfiles/{ethernetPortProfileId}

Activate Ethernet Port Profile On DHCP Service Profile of Venue

PATCH /venues/{venueId}/firmwares

Upgrade firmware on a venue or AP models

What’s Deprecated


GET /deviceProvisions/aps/models

Get Access Point Device Models

PATCH /deviceProvisions/aps

Update Access Points Status

GET /deviceProvisions/aps/statusReports

Get AP Refresh Status

PATCH /deviceProvisions/aps/statusReports

Refresh Access Points

POST /deviceProvisions/aps/query

Query Access Point Device Assets

DELETE /tenants/notificationRecipients

Delete Notification Recipients

What’s Changed


GET /banners
Parameters:

Changed: type in query > Filter by device type (Optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

GET /files/{fileId}
POST /templates/{templateId}/tenants/{tenantId}
Request:

Changed content type : application/json

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

GET /deviceProvisions/aps/models
PATCH /deviceProvisions/aps
GET /deviceProvisions/aps/statusReports
PATCH /deviceProvisions/aps/statusReports
POST /edgeDhcpServices
Request:

Changed content type : application/json

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

GET /edgeDhcpServices/{dhcpId}
Return Type:

Changed response : 200 OK > OK

PATCH /edgeDhcpServices/{dhcpId}
Request:

Changed content type : application/json

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

GET /entitlements/summaries
Parameters:

Changed: type in query > Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

GET /mspEntitlements/summaries
Return Type:

Changed response : 200 OK > Success

POST /files/uploadurls
GET /files/{fileId}/urls
GET /guestUsers
POST /guestUsers
DELETE /guestUsers
GET /portalServiceProfiles/networks
GET /portalServiceProfiles/tags
POST /identityGroups/{groupId}/identities/csvFile
POST /identityGroups/{groupId}/identities/{id}/devices
DELETE /identityGroups/{groupId}/identities/{id}/devices/{macAddress}
DELETE /identityGroups/{groupId}/identities/{id}/ethernetPorts/{macAddress}/{portIndex}
POST /admins/query

Query administrators

Parameters:

Added: withDelegatedECs in query > Include delegated EC tenant IDs per admin (default true)

Added: includeDelegatedAdmins in query > Minimal delegated-admin rows; body mspEcTenantIds scopes the list

Added: includeSelectedAdmins in query > MSP-EC selection mode with includeSystemRoles or includePrivilegeGroups (body mspEcTenantIds)

Added: includeSystemRoles in query > With includeSelectedAdmins: would be returning system admins only

Added: includePrivilegeGroups in query > With includePrivilegeGroups: would be returning privilege groups and associated admins

Changed: withExternalId in query > Include external (SWU) ID in each row

Request:

Changed content type : application/json

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

Return Type:

Changed response : 200 OK > OK — page type depends on query flags (default: full admin rows).

POST /switches/deviceRequests
Operation ID:

Changed: SyncVenueAdminPasswordMultipleDeviceRequests_1 to SyncVenueAdminPasswordMultipleDeviceRequests

Request:

Changed content type : application/json

Request:

Changed content type : application/json

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK > OK

PUT /lbsServerProfiles/{lbsServerProfileId}
Request:

Changed content type : application/json

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

POST /deviceProvisions/aps/query
Request:

Changed content type : application/json

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

POST /deviceProvisions/switches/query
Request:

Changed content type : application/json

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

GET /dpskServices
Parameters:

Added: type in query > Optional filter by DPSK pool type. When omitted, type is not used for filtering.

POST /dpskServices
Request:

Changed content type : application/json

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

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

POST /dpskServices/query
Request:

Changed content type : application/json

Request:

Changed content type : application/json

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

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

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

PATCH /dpskServices/{poolId}
Request:

Changed content type : application/json

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

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

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

GET /dpskServices/{poolId}
Return Type:

Changed response : 200 OK > DPSK pool

POST /identityGroups/{identityGroupId}/dpskServices
Request:

Changed content type : application/json

POST /templates/dpskServices
Request:

Changed content type : application/json

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

POST /templates/dpskServices/query
Request:

Changed content type : application/json

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

PUT /templates/dpskServices/{poolTemplateId}
Request:

Changed content type : application/json

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

PATCH /templates/dpskServices/{poolTemplateId}
Request:

Changed content type : application/json

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

GET /templates/dpskServices/{poolTemplateId}
Return Type:

Changed response : 200 OK > DPSK pool template

POST /templates/identityGroups/{identityGroupId}/dpskServices
Request:

Changed content type : application/json

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

GET /templates/wifiNetworks/{networkTemplateId}/dpskServices
Parameters:

Added: type in query > Optional filter by DPSK pool type. When omitted, type is not used for filtering.

Return Type:

Changed response : 200 OK > DPSK pool template

GET /wifiNetworks/{networkId}/dpskServices
Parameters:

Added: type in query > Optional filter by DPSK pool type. When omitted, type is not used for filtering.

POST /venues/{venueId}/edgeClusters
Request:

Changed content type : application/json

GET /venues/{venueId}/edgeClusters/{clusterId}
Return Type:

Changed response : 200 OK > OK

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

Changed content type : application/json

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

GET /entitlements
Parameters:

Changed: type in query > Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

PATCH /entitlements
Request:

New content type : application/json

POST /entitlements/availabilityReports/query
Request:

New content type : application/json

POST /entitlements/banners/query
Request:

New content type : application/json

Return Type:

Changed response : 200 OK > success

Changed response : 500 Internal Server Error > Internal Server Error

POST /entitlements/compliances/query
Request:

New content type : application/json

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

Return Type:

Changed response : 200 OK > success

Changed response : 500 Internal Server Error > Internal Server Error

GET /entitlements/licenseUsageReports
Parameters:

Deleted: licenseType in query > Specific license type if the tenant is an ALM tenant, valid value: MSP_APSW (default), MSP_URLF, MSP_EDGE_SECS, MSP_EDGE_SECL

POST /alarms/metas/query
Return Type:

Changed response : 200 OK > successful operation

POST /alarms/query
Return Type:

Changed response : 200 OK > successful operation

POST /networks/{networkId}/guestUsers
GET /brandings/profiles/{profileId}/assignments
POST /identities/csvFile
GET /venues/propertyConfigs
GET /tenants/delegations
Parameters:

Changed: type in query

POST /tenants/delegations
Return Type:

Changed response : 202 Accepted > Accepted

Return Type:

Changed response : 200 OK > OK

Return Type:

Changed response : 202 Accepted > Accepted

Delete Notification Recipients

Operation ID:

Changed: deleteNotificationRecipients to deleteNotificationRecipientsV2

Request:

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

Return Type:

Changed response : 202 Accepted > Accepted

Changed response : 400 Bad Request > Indicates that a bad request was made.

Changed response : 500 Internal Server Error > Internal Server Error

POST /tenants/notificationRecipients
Request:

Changed content type : application/json

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

Return Type:

Changed response : 202 Accepted > Accepted

Changed response : 400 Bad Request > Bad/Malformed Request

Changed response : 500 Internal Server Error > Internal Server Error

PUT /tenants/self
Request:

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

Changed content type : application/json

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

Return Type:

Changed response : 200 OK > OK

GET /tenants/self
Return Type:

Changed response : 200 OK > OK

POST /tenants/supportDelegations
Return Type:

Changed response : 202 Accepted > Accepted

Request:

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

PUT /templates/venues/{venueId}/aaaServers/{aaaServerId}
Request:

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

POST /venues/{venueId}/aaaServers
Request:

Changed content type : application/json

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

PUT /venues/{venueId}/aaaServers/{aaaServerId}
Request:

Changed content type : application/json

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

POST /venues/{venueId}/deviceRequests
Operation ID:

Changed: SyncVenueAdminPasswordMultipleDeviceRequests to MultipleDeviceRequests

Request:

Changed content type : application/json

Request:

Changed content type : application/json

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

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

POST /venues/{venueId}/switchFirmwares/schedules
Request:

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

POST /venues/{venueId}/switches/{switchId}/deviceRequests
Request:

Changed content type : application/json

Request:

Changed content type : application/json

GET /ethernetPortProfiles/{ethernetPortProfileId}
Return Type:

Changed response : 200 OK > OK

PUT /ethernetPortProfiles/{ethernetPortProfileId}
Request:

Changed content type : application/json

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

POST /lbsServerProfiles
Request:

Changed content type : application/json

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

POST /templates/ethernetPortProfiles
Request:

Changed content type : application/json

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

GET /templates/ethernetPortProfiles/{ethernetPortProfileTemplateId}
Return Type:

Changed response : 200 OK > OK

PUT /templates/ethernetPortProfiles/{ethernetPortProfileTemplateId}
Request:

Changed content type : application/json

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

POST /entitlements/query
Request:

New content type : application/json

POST /entitlements/utilizations/query
Request:

New content type : application/json

Return Type:

Changed response : 500 Internal Server Error > Internal Server Error

DELETE /guestUsers/{guestUserId}
GET /guestUsers/{guestUserId}
PATCH /guestUsers/{guestUserId}
POST /templates/portalServiceProfiles
Request:

Changed content type : application/json

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

GET /templates/portalServiceProfiles/{portalServiceProfileId}
Return Type:

Changed response : 200 OK > OK

PUT /templates/portalServiceProfiles/{portalServiceProfileId}
Request:

Changed content type : application/json

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

DELETE /brandings/profiles
Return Type:

New response : 404 Not Found > Not Found

New response : 409 Conflict > Conflict

POST /brandings/profiles/query
POST /identityGroups
DELETE /identityGroups/{groupId}/identities
POST /identityGroups/{groupId}/identities
DELETE /identityGroups/{groupId}/identities/{id}
PATCH /identityGroups/{groupId}/identities/{id}
DELETE /identityGroups/{id}
PATCH /identityGroups/{id}
POST /policySetEvaluations
GET /policySets
GET /policyTemplates
GET /policyTemplates/policies
DELETE /residentPortals
GET /residentPortals
DELETE /venues/{venueId}/units
GET /tenants/userProfiles
Return Type:

Changed response : 200 OK > OK

PUT /tenants/userProfiles
Return Type:

Changed response : 200 OK > Accepted

Changed response : 500 Internal Server Error > Internal Server Error

GET /venues
DELETE /venues
DELETE /portalServiceProfiles
GET /portalServiceProfiles
POST /portalServiceProfiles
Request:

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

GET /portalServiceProfiles/{portalServiceProfileId}
Return Type:

Changed response : 200 OK > OK

PUT /portalServiceProfiles/{portalServiceProfileId}
Request:

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

GET /venues/{venueId}/wifiSettings
Return Type:

Changed response : 200 OK > OK

Result


API changes broke backward compatibility