Skip to content
/
Query Entitlement Setting...

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

AttentionNote

Operations

UsageSetting

Operations

Query Entitlement Settings

Request

Query entitlement settings.

No request payload

Responses

Success

Body
Array [
featureTypestringrequired

Type of the feature.

Example: "SLTN_PI_NET"
featureNamestringrequired

Name of the feature.

Example: "Personal Identity Network"
maxQuantityinteger(int32)required

Maximum license quantity for the feature.

Example: 100
enabledbooleanrequired

Indicates whether the feature is enabled or not.

Example: true
cappedbooleanrequired

Indicates whether the license usage of the feature is capped by max quantity or not.

Example: true
licenseTokeninteger(int32)required

Indicates the token

Example: 1
featureCostUnitstringrequired

Indicates the feature-cost unit

Example: "per Tunnel"
featureUnitstringrequired

Indicates the feature unit

Example: "Tunnel"
]
Response
[
  {
    "featureType": "SLTN_PI_NET",
    "featureName": "Personal Identity Network",
    "maxQuantity": 100,
    "enabled": true,
    "capped": true,
    "licenseToken": 1,
    "featureCostUnit": "per Tunnel",
    "featureUnit": "Tunnel"
  }
]

Update Entitlement Settings

Request

Update entitlement settings.

Body
requiredArray [
featureTypestring
maxQuantityinteger(int32)
enabledboolean
cappedboolean
]
[
  {
    "featureType": "string",
    "maxQuantity": 0,
    "enabled": true,
    "capped": true
  }
]

Responses

Success

Body
Array [
featureTypestringrequired

Type of the feature.

Example: "SLTN_PI_NET"
featureNamestringrequired

Name of the feature.

Example: "Personal Identity Network"
maxQuantityinteger(int32)required

Maximum license quantity for the feature.

Example: 100
enabledbooleanrequired

Indicates whether the feature is enabled or not.

Example: true
cappedbooleanrequired

Indicates whether the license usage of the feature is capped by max quantity or not.

Example: true
licenseTokeninteger(int32)required

Indicates the token

Example: 1
featureCostUnitstringrequired

Indicates the feature-cost unit

Example: "per Tunnel"
featureUnitstringrequired

Indicates the feature unit

Example: "Tunnel"
]
Response
[
  {
    "featureType": "SLTN_PI_NET",
    "featureName": "Personal Identity Network",
    "maxQuantity": 100,
    "enabled": true,
    "capped": true,
    "licenseToken": 1,
    "featureCostUnit": "per Tunnel",
    "featureUnit": "Tunnel"
  }
]