Licensing

Get

get

Retrieve the current license setting.

Query parameters

UseCachebooleanOptional

Specifies whether to retrieve the number of current licensed users from cache or calculate it on demand.

Responses

200

Success

application/json; api-version=1.0

RAS License

licenseTypestring · nullableOptional

License Type (Permanent, PrePaid, PostPaid, ExtTrial, LegacyTrial, or NormalTrial)

licenseKeystring · nullableOptional

License Key

expiryDatestring · nullableOptional

Expiry date of License

installedUsersstring · nullableOptional

Maximum number of licensed users

usersPeakstring · nullableOptional

Maximum amount of connected users since the product was installed (calculated together with the Usage Today).

usersLicenseInfostring · nullableOptional

Amount of users currently connected

gracePeriodStatestring · nullableOptional

State of Grace period

gracePeriodDaysLeftstring · nullableOptional

Days left for Grace period

typestring · enumOptional

License Type

Possible values:

needsAttentionbooleanOptional

RAS licensing requires attention.

statusMessagestring · nullableOptional

The current status message of the RAS License.

alertMessagestring · nullableOptional

The alert message a RAS Administrator should be notificed about.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/License

HTTPcURLJavaScriptPython

GET /api/License HTTP/1.1
Accept: */*

{
  "licenseType": "text",
  "licenseKey": "text",
  "expiryDate": "text",
  "installedUsers": "text",
  "usersPeak": "text",
  "usersLicenseInfo": "text",
  "gracePeriodState": "text",
  "gracePeriodDaysLeft": "text",
  "type": [
    "1 = Perpetual",
    "2 = Subscription",
    "3 = SPLA",
    "4 = ExtTrial",
    "5 = Beta",
    "6 = Trial"
  ],
  "needsAttention": true,
  "statusMessage": "text",
  "alertMessage": "text"
}