List licenses

GET

/license

Last modified:2026-10-08 21:37:20

OperationId:ListLicenseEntries

Lists the license records of every core server in the cluster as one list, with each license's product, expiry, authorized endpoints and sessions, and authorization keys.

Requires Super User or Super User Read Only scope. The authorization keys are masked unless a Super User sends include-secret=yes.

Each server answers for its own records. A server that does not answer within 3 seconds is left out of the list, without an error. Filters, sort, limit, and start apply on each server, so one page can hold up to limit records from every server. To page through one server, use GET /license/{hostname}.

Send only the filters listed here. A query-builder key such as OR or joins, or a filter name that is not a plain field name, returns 400.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

License records from every server that answered. An empty array when none match.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/license?license-element-id=undefined&license-mac-address=undefined&license-product=undefined&license-status=undefined&license-update-status=undefined&limit=undefined&start=undefined&sort=license-expiration-date%20desc&include-secret=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - One license, keys masked

[
    {
        "license-element-id": "{{element_id}}",
        "license-mac-address": "00:00:5E:00:53:01",
        "license-product": "NMS",
        "license-expiration-date": "2027-12-31",
        "license-remaining-days": 452,
        "license-authorized-endpoints": 1000,
        "license-authorized-sessions": 500,
        "license-authorization-key": "AB****************YZ",
        "license-authorization-data": "{{authorization_data}}",
        "license-pending-key": "",
        "license-pending-data": "",
        "license-status": "active",
        "license-update-status": "idle"
    }
]

Modified at 2026-10-08 21:37:20

Get translation descriptions for a locale

List licenses for a server