List licenses for a server

GET

/license/{hostname}

Last modified:2026-10-05 17:52:39

OperationId:listLicenseByHostname

Lists the license records of one server in the cluster.

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

hostname must be the server answering the request or a core server in the cluster; any other name returns 400. For another server the request is passed on over HTTPS, which must answer within 6 seconds, or 15 seconds when limit is over 2,000. A server that cannot be reached, or does not answer in time, returns an empty array rather than an error, so an empty array does not prove the server has no licenses.

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 ********************

Path Params

Query Params

Responses

🟢200OK

application/json

License records from the server. An empty array when none match or the server did not answer.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/license/core1.example.com?license-product=undefined&license-status=undefined&license-update-status=undefined&limit=undefined&start=undefined&sort=license-expiration-date%20desc&license-element-id=undefined&license-mac-address=undefined&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-05 17:52:39

List licenses

List rejected SIP requests