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

Assignment

Operations

AvailabilityReport

Operations

Query License Mileage Report

Request

This endpoint allows you to query license mileage reports for entitlements.

Body
required
pageinteger(int32)

The page number to be returned, 1 based, default 1.

Example: 1
pageSizeinteger(int32)

The page number to be returned, default 20.

Example: 30
filtersobject(CalculatorFilterRequestDto)required

Filter criteria for the request

filters.​usageTypestringrequired

Type of usage

Enum"SELF""ASSIGNED""UNKNOWN"
Example: "ASSIGNED"
filters.​licenseTypestringrequired

Type of entitlement

Example: "APSW"
filters.​isTrialboolean

Flag indicating if looking for trial license availability.

Example: true
{
  "page": 1,
  "pageSize": 30,
  "filters": {
    "usageType": "ASSIGNED",
    "licenseType": "APSW",
    "isTrial": true
  }
}

Responses

Success

Body
statusstring

Status of the response.

Example: "success"
messagestring

Message providing additional details about the response.

Example: "Object created/updated successfully."
pageinteger(int32)
pageSizeinteger(int32)
totalCountinteger(int64)
dataArray of objects(MileageDataDto)

Data object containing license details.

Response
{
  "status": "success",
  "message": "Object created/updated successfully.",
  "page": 0,
  "pageSize": 0,
  "totalCount": 0,
  "data": [
    { … }
  ]
}

Query Availability Reports

Request

This endpoint allows you to query availability reports for entitlements.

Body
required
effectiveDatestring^\d{4}-\d{2}-\d{2}$required

Start date from which the license is valid.

Example: "2024-01-22"
expirationDatestring^\d{4}-\d{2}-\d{2}$

End date until which the license is valid. Required if operator max quantity is selected.

Example: "2025-02-21"
quantityinteger(int32)

Number of licenses available. Required if operator max period is selected.

Example: 5
operatorstringrequired

Operator to be used.

Enum"MAX_QUANTITY""MAX_PERIOD"
Example: "MAX_QUANTITY"
filtersobject(CalculatorFilterRequestDto)required

Filter criteria for the request

filters.​usageTypestringrequired

Type of usage

Enum"SELF""ASSIGNED""UNKNOWN"
Example: "ASSIGNED"
filters.​licenseTypestringrequired

Type of entitlement

Example: "APSW"
filters.​isTrialboolean

Flag indicating if looking for trial license availability.

Example: true
{
  "effectiveDate": "2024-01-22",
  "expirationDate": "2025-02-21",
  "quantity": 5,
  "operator": "MAX_QUANTITY",
  "filters": {
    "usageType": "ASSIGNED",
    "licenseType": "APSW",
    "isTrial": true
  }
}

Responses

Success

Body
statusstring

Status of the response.

Example: "success"
messagestring

Message providing additional details about the response.

Example: "Object created/updated successfully."
dataobject(CalculatorDataDto)required

Data object containing license details

data.​effectiveDatestringrequired

Effective date of the license.

Example: "2024-01-22"
data.​expirationDatestringrequired

Expiration date of the license.

Example: "2024-02-21"
data.​quantityinteger(int64)

Number of licenses

Example: 5
data.​licenseTypestring

Type of license

Example: "APSW"
data.​isTrialbooleanrequired

Indicates whether this is a trial license.

Example: false
Response
{
  "status": "success",
  "message": "Object created/updated successfully.",
  "data": {
    "effectiveDate": "2024-01-22",
    "expirationDate": "2024-02-21",
    "quantity": 5,
    "licenseType": "APSW",
    "isTrial": false
  }
}

Get Entitlement Usage Report

Request

Get the entitlement usage report.

Query
licenseTypestring

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

Enum"MSP_WIFI""MSP_WIFI_TEMP""MSP_ICX""MSP_ICX71L""MSP_ICX71""MSP_ICX75""MSP_ICX76""MSP_ICX78""MSP_ICX_ANY""MSP_EDGE"
startDatestring

The first date included in the usage report, for example, startDate=yyyy-mm-dd; if omitted, the startDate is set to last month's first date.

endDatestring

The end date included in the usage report, for example, endDate=yyyy-mm-dd; if omitted, the endDate is set to last month's last date.

monthstring

month=mm

yearstring

year=yyyy

mspEcTenantIdstring

Specific MSP EC tenant ID

deviceDetailsboolean

True to include device detail in the report. False to exclude device detail in the report.

Default false
pageinteger(int32)

Page number for the daily reports. If missing or value 0 means no pagination, all daily reports will be returned.

Default 0
pageSizeinteger(int32)

Page size for the daily reports, default is 5, valid only if page is given

Default 5
Headers
Content-Typestringrequired
No request payload

Responses

Success

Body
object
Response
{}

AttentionNote

Operations

UsageSetting

Operations