License (license)

Overview

Manages the current license file that activates the system.

Available in master domain only.

Requests

HTTP verb Endpoint Description

POST

/rest/v1/master/license

Uploading the license to the server

GET

/rest/v1/master/license

Obtaining license data

Uploading the license to the server

A JSON string with encrypted content is passed in the body of the request.

Request

Field Description: license

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

"6F09F106EBA493FF…​…​…​B2C42"

Response

Field Description: license

Response example
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
  }
}

Obtaining 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 the disk with which it was generated by the licensor.

  • false – returns the contents of the active license, i.e. the current state after all smart conditions have been applied. The active license may not be the same as the issued license.

Default false.

Request example
GET /rest/v1/master/license?file=false HTTP/1.1

Response

Field Description: license

Response example
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
  }
}

See also