Skip to content

Manage Entitlements API (0.2.0)

The Manage Entitlements API provides endpoints to manage entitlements. You can use this API to retrieve detailed information about entitlements, usage statistics, available licenses, and expired licenses. This API helps you effectively manage your entitlements and make informed decisions about licensing. Assignments API manage entitlement assignments. You can retrieve a list of assignments, create new assignments, update existing ones, and delete individual assignments.

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
E-mail

TBD@ruckuswireless.com

Languages
Servers

https://api.devalto.ruckuswireless.com/

Entitlement

Endpoints for Managing Entitlements

Operations

Get Entitlements Utilization Summaries

Request

Retrieve entitlement usage details. Usage summaries provide information on the number of entitlements used and active devices.

v1.1: Trial license entry will not exist in the response if there are no active trial licenses and no used trial licenses for the MSP/VAR.

v1.0: Will be deprecated on 07/2025 and will be fully removed no earlier than 01/2026.

Headers
Content-Typestringrequired
Body
required
filtersobject(DynamicQueryPayloadFilterDto)

The query filters

{
  "filters": {
    "licenseType": [ … ],
    "isTrial": false,
    "status": [ … ],
    "isAssignedLicense": false,
    "usageType": "Self"
  }
}

Responses

success

Body
One of:
dataArray of objects
errorsArray of objects(ErrorDto)
Response
{
  "data": [
    {}
  ],
  "errors": [
    { … }
  ]
}

Get Entitlements

Request

Retrieve all purchased entitlements.

Query
excludeContentboolean
Body
required
defaultPageSizeinteger(int32)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageSizeinteger(int32)
fieldsArray of stringsunique
filtersobject(DynamicQueryPayloadFilterDto)

The query filters

{
  "defaultPageSize": 0,
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "filters": {
    "licenseType": [ … ],
    "isTrial": false,
    "status": [ … ],
    "isAssignedLicense": false,
    "usageType": "Self"
  }
}

Responses

success.

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
pageSizeinteger(int32)
objectIdstring
dataArray of objects
errorsArray of objects(ErrorDto)
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "objectId": "string",
  "data": [
    {}
  ],
  "errors": [
    { … }
  ],
  "subsequentQueries": [
    { … }
  ]
}

Get Compliance

Request

Retrieve entitlement compliance data.

Body
required
filtersobject(LicenseComplianceFilter)
{
  "filters": {
    "licenseType": [ … ],
    "complianceType": "SELF"
  }
}

Responses

success

Body
compliancesArray of objects(TenantLicenseCompliance)
Response
{
  "compliances": [
    { … }
  ]
}

Get Entitlements Banners

Request

Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired.

Body
required
filtersobject(Filters)
{
  "filters": {
    "licenseType": [ … ],
    "usageType": "string"
  }
}

Responses

success

Body
dataArray of objects(EntitlementBannerInfo)
Response
{
  "data": [
    { … }
  ]
}

Update Entitlements

Request

Sync entitlements.

Body
required
usageTypestring
statusstring
refreshTypestring
Enum"FULL""DELTA"
{
  "usageType": "string",
  "status": "string",
  "refreshType": "FULL"
}

Responses

Sync entitlements

Body
linkstring(uri)
descstring
requestIdstring
Response
{
  "link": "http://example.com",
  "desc": "string",
  "requestId": "string"
}

Assignment

Operations

AvailabilityReport

Operations

AttentionNote

Operations

UsageSetting

Operations