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 30.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 30.6.1. For the JSON schema refer to section 30.6.2.

Example

GET http://127.0.0.1:8888/api/licenses/get?dateFormat=XZWO&version=0
HTTP Response
HTTP/1.1 200 OK

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 30.7.1. For the JSON schema refer to section 30.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 30.6.1. For the JSON schema refer to section 30.6.2.

Example

PUT http://127.0.0.1:8888/api/licenses/importLod?version=0
HTTP Request Body
{
  "emailAddress": "example@te-systems.de",
  "licensingDevice": "6C:4B:90:D4:E0:DA",
  "companyName": "TE-Systems GmbH",
  "lodKey": "an-b4pp-pwsr-lxrk-l7g3"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "identifier": "4cac410d-9453-46c6-a5e1-e3360252965b",
  "requiredSystemIds": "[6C:4B:90:D4:E0:DA]",
  "name": "TE-SYSTEMS GmbH - 1 Session",
  "validUntil": "UTC 2024-05-27 12:00:00",
  "validFrom": "UTC 2024-03-28 00:00:00",
  "id": "bdb156cd-4407-4831-ab61-b41cb5488d43",
  "facilities": [
    {
      "name": "g722Decoder = 1",
      "value": 1
    },
    {
      "name": "g722Encoder = 1",
      "value": 1
    },
    {
      "name": "opusDecoder = 1",
      "value": 1
    },
    {
      "name": "opusEncoder = 1",
      "value": 1
    },
    {
      "name": "telrtSession = 1",
      "value": 1
    }
  ],
  "softwareUpdateServiceUntil": "UTC 2024-05-27 12:00:00",
  "products": "[anynode]",
  "status": "ACTIVE"
}

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 30.52.1. For the JSON schema refer to section 30.52.2.

Example

GET http://127.0.0.1:8888/api/licenses/systemIds/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "Intel(R) Ethernet Connection (7) I219-V",
    "id": "6C:4B:90:D4:E0:DA"
  },
  {
    "displayName": "Hyper-V Virtual Ethernet Adapter",
    "id": "00:15:5D:68:6D:CA"
  }
]

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

Request Body Structure

The request expects the license file that should be imported as "multipart/form-data".

Example

PUT http://127.0.0.1:8888/api/licenses/importFile?version=0
HTTP Request Headers
Content-type : "multipart/form-data"
Accept : "application/json"
HTTP Request Body
--9963c9a8-69c4-47be-b347-3cf0d8bd5079
Content-Disposition: form-data; name="file"; filename="license.xzlicense"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
...
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "identifier": "000916d0-a778-4969-8970-9d89febb6f47",
  "requiredSystemIds": "[94:C6:91:1E:20:BB]",
  "name": "TE-SYSTEMS GmbH - 10 Sessions, 10 Recording Session, 10 Microsoft Teams Local Media Optimization Sessions - 365 days",
  "validUntil": "UTC 2021-08-20 12:00:00",
  "validFrom": "UTC 2020-08-19 00:00:00",
  "id": "7c0494fe-6750-4d59-8631-424f07e90efe",
  "facilities": [
    {
      "name": "g722Decoder = 10",
      "value": 10
    },
    {
      "name": "g722Encoder = 10",
      "value": 10
    },
    {
      "name": "opusDecoder = 10",
      "value": 10
    },
    {
      "name": "opusEncoder = 10",
      "value": 10
    },
    {
      "name": "recSession = 10",
      "value": 10
    },
    {
      "name": "telrtSession = 10",
      "value": 10
    },
    {
      "name": "telteamsSiteSession = 10",
      "value": 10
    }
  ],
  "softwareUpdateServiceUntil": "UTC 2021-08-20 12:00:00",
  "products": "[anynode]",
  "status": "SYSTEM_ID"
}