License (license)

Overview

Manages the current license file that activates the system.

Available only in the master domain.

Requests

HTTP verb Endpoint Description

POST

/rest/v1/master/license

Uploading a license to the server

GET

/rest/v1/master/license

Getting license data

Uploading a license to the server

The request body contains a JSON string with encrypted content.

Request

Field description: license

Example request
POST /rest/v1/master/license HTTP/1.1
Content-Type: application/json; charset=utf-8

"6F09F106EBA493FF…​…​…​B2C42"

Response

Field description: license

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "products": "incoplax",
  "topleveldnpolicy": 1,
  "dql": {
    "domains": 100,
    "sol_pbx": 100,
    "devices": 15000,
    "siptrunks": 3000,
    "ivrscripts": 100,
    "svcscripts": 20,
    "webservice_public": 300,
    "webservice_subscr": 100
  },
  "sqf": {
    "rec": true,
    "cdr": true,
    "sel": false
  }
}

Getting license data

Returns the contents of the current license used by the server in unencrypted form.

Request

Table 1. Request parameters
Name Type Description

file

bool

Contents of the returned license.

  • true – returns the contents of the issued license from disk, as formed by the licensor.

  • false – returns the contents of the active license, that is, the current state after applying all smart conditions. The active license may differ from the issued license.

Default is false.

Example request
GET /rest/v1/master/license?file=false HTTP/1.1

Response

Field description: license

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "lbdate": "2025-04-14",
  "ledate": "2028-01-14",
  "cdate": "2026-03-24 01:45:22",
  "adate": "2026-03-24 03:45:22",
  "tdate": "2026-05-23",
  "alarm_notify_date": "2026-04-24",
  "from_dt": "2026-03-23T13:45:22Z",
  "sync_dt": "2026-04-23T01:45:22Z",
  "stop_dt": "2026-05-23T01:45:22Z",
  "products": "incoplax",
  "info": "<b>Test License</b>",
  "maxproductversion": "1.12",
  "max_server_count": 2,
  "topleveldnpolicy": 0,
  "dql": {
    "callcenter_operator": 10000,
    "callcenter_supervisor": 10000,
    "devices": 10000,
    "domains": 100,
    "siptrunks": 10000
  },
  "sqf": []
}

See also