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

Servers

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

Entitlement

Endpoints for Managing Entitlements

Operations

Get EntitlementsDeprecated

Request

Get the list of device entitlements.Please note that this API will be retired on 04/2024 and will be fully removed no earlier than 10/2024. For updated functionality, refer to '/entitlements/query'

Query

typestring

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

Enum"UNASSIGNED_DEVICE_TYPE""WIFI""LTE""SWITCH""ANALYTICS""RWG""EDGE""VIRTUAL_EDGE""APSW""EDGE_SECS"

licenseTypestring

Filter by license type (optional)

Enum"UNKNOWN""APSW""URLF""EDGE_SECS""EDGE_SECL""SLTN_TOKEN"

No request payload

Responses

Returns the entitlements.

Bodyapplication/jsonArray [

idstring

createdDatestring(date-time)

updatedDatestring(date-time)

externalIdstring

deviceTypestring

Enum"UNASSIGNED_DEVICE_TYPE""WIFI""LTE""SWITCH""ANALYTICS""RWG""EDGE""VIRTUAL_EDGE""APSW""EDGE_SECS"

effectiveDatestring(date-time)

expirationDatestring(date-time)

quantityinteger(int64)

skustring

licenseNamestring

licenseDescstring

emailStagestring

deviceSubTypestring

almboolean

almLicenseTypestring

Enum"UNKNOWN""APSW""URLF""EDGE_SECS""EDGE_SECL""SLTN_TOKEN"

almActivationIdstring

almSoEntQuantityinteger(int64)

almUsedQuantityinteger(int64)

extendedLicensesAssignmentboolean

r1Skuboolean

tempLicenseboolean

assignedLicenseboolean

historicalboolean

graceEndDatestring(date-time)

parentIdstring

]

Response

application/json

[
  {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "externalId": "string",
    "deviceType": "UNASSIGNED_DEVICE_TYPE",
    "effectiveDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "quantity": 0,
    "sku": "string",
    "licenseName": "string",
    "licenseDesc": "string",
    "emailStage": "string",
    "deviceSubType": "string",
    "alm": true,
    "almLicenseType": "UNKNOWN",
    "almActivationId": "string",
    "almSoEntQuantity": 0,
    "almUsedQuantity": 0,
    "extendedLicensesAssignment": true,
    "r1Sku": true,
    "tempLicense": true,
    "assignedLicense": true,
    "historical": true,
    "graceEndDate": "2019-08-24T14:15:22Z",
    "parentId": "string"
  }
]

Get Entitlement SummariesDeprecated

Request

Get summaries of the device entitlements.Please note that this API will be retired on 4/2024 and will be fully removed no earlier than 10/2024. For updated functionality, refer to '/entitlements/utilizations/query'.

Query

refreshboolean

typestring

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

Enum"UNASSIGNED_DEVICE_TYPE""WIFI""LTE""SWITCH""ANALYTICS""RWG""EDGE""VIRTUAL_EDGE""APSW""EDGE_SECS"

licenseTypestring

Filter by license type (optional)

Enum"UNKNOWN""APSW""URLF""EDGE_SECS""EDGE_SECL""SLTN_TOKEN"

No request payload

Responses

Returns the entitlement summary. The response is actual in case when the refresh request parameter value is false

Bodyapplication/json

entitlementsArray of objects(Entitlement)

summaryArray of objects(EntitlementOperationInfo)

bannersArray of objects(LicenseBannerDto)

Response

application/json

{
  "entitlements": [
    { … }
  ],
  "summary": [
    { … }
  ],
  "banners": [
    { … }
  ]
}

Get BannersDeprecated

Request

Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired.Please note that this API will be retired on 4/2024 and will be fully removed no earlier than 10/2024. For updated functionality, refer to '/entitlements/banners/query'.

Query

typestring

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

Enum"UNASSIGNED_DEVICE_TYPE""WIFI""LTE""SWITCH""ANALYTICS""RWG""EDGE""VIRTUAL_EDGE""APSW""EDGE_SECS"

licenseTypestring

Filter by license type (optional)

Enum"UNKNOWN""APSW""URLF""EDGE_SECS""EDGE_SECL""SLTN_TOKEN"

No request payload

Responses

Bodyapplication/jsonArray [

typestring

Enum"INITIAL""CLOSE_TO_EXPIRATION""GRACE_PERIOD""AFTER_GRACE_PERIOD""RA_BELOW_90_PERCENT_OF_DEVICES""RA_BELOW_50_PERCENT_OF_DEVICES""RA_ONBOARD_ONLY"

almboolean

almExtraInfoobject(AlmExtraEntitlementInfoDto)

multipleLicenseboolean

effectDatestring(date-time)

effectDaysinteger(int64)

deviceCountinteger(int64)

deviceTypestring

Enum"UNASSIGNED_DEVICE_TYPE""WIFI""LTE""SWITCH""ANALYTICS""RWG""EDGE""VIRTUAL_EDGE""APSW""EDGE_SECS"

licenseTypestring

Enum"UNKNOWN""APSW""URLF""EDGE_SECS""EDGE_SECL""SLTN_TOKEN"

deviceSubTypestring

totalRALicenseinteger(int64)

totalActiveDevicesinteger(int64)

]

Response

application/json

[
  {
    "type": "INITIAL",
    "alm": true,
    "almExtraInfo": { … },
    "multipleLicense": true,
    "effectDate": "2019-08-24T14:15:22Z",
    "effectDays": 0,
    "deviceCount": 0,
    "deviceType": "UNASSIGNED_DEVICE_TYPE",
    "licenseType": "UNKNOWN",
    "deviceSubType": "string",
    "totalRALicense": 0,
    "totalActiveDevices": 0
  }
]