6 Licenses

6.1 Get

GET https://<HOST>:<PORT>/api/licenses/get?version=0

Returns a list of currently loaded licenses. For more information about the license status go to section 27.6,

Required Permissions

  • API

  • User Management Read/Write Access

Response Body Structure

The response body is strutured as an array. The array consists of License JSON objects. A description for its fields is at section 27.6.1. For the JSON schema refer to section 27.6.2.

Example

GET http://127.0.0.1:8111/api/licenses/get?dateFormat=XZWO&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "identifier": "c1b436f1-a81d-4f0a-8bdf-42cdb8bdb509",
  "name": "anynode 4 lines demo license",
  "validUntil": "UTC 2023-12-31 23:59:59",
  "validFrom": "UTC 2022-01-04 00:00:00",
  "id": "f416560b-9f9a-4021-bb49-07c4a9e3a1e7",
  "facilities": [
    {
      "name": "recSession = 2",
      "value": 2
    },
    {
      "name": "telrtSession = 4",
      "value": 4
    }
  ],
  "constraints": "[telrtDemo]",
  "products": "[anynode]",
  "status": "ACTIVE"
}]

6.2 Import LOD

PUT https://<HOST>:<PORT>/api/licenses/importLod?version=0

Requests a license using the LOD key.

Required Permissions

  • API

  • User Management Read/Write Access

Request Body Structure

The request body is structured as ImportLodData JSON object. A description for its fields is at section 27.7.1. For the JSON schema refer to section 27.7.2.

Response Body Structure

The response body is strutured as an array. The array consists of License JSON objects. A description for its fields is at section 27.6.1. For the JSON schema refer to section 27.6.2.

6.3 Get System IDs

GET https://<HOST>:<PORT>/api/licenses/systemIds/get?version=0

Returns a list of the available device IDs for licensing.

Required Permissions

  • API

  • User Management Read/Write Access

Response Body Structure

The response body is strutured as an array. The array consists of SystemId JSON objects. A description for its fields is at section 27.43.1. For the JSON schema refer to section 27.43.2.

6.4 Import

PUT https://<HOST>:<PORT>/api/licenses/importFile?version=0

Imports a xzlicense file.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • filepath

    The path to the file that will be imported.

Request Body Structure

The request expects the license file that should be imported.