License API

The license API allows managing the Canvus server license. You must authenticate as an administrator to use this endpoint.

Get License Info

Gets the current license status.

GET /license

Attribute Type Required Description

subscribe (query) boolean no See api_streaming

curl -H "Private-Token: <access token>" https://canvus.example.com/api/v1/license

Example response:

{
  "edition": "",
  "has_expired": false,
  "is_valid": true,
  "max_clients": -1,
  "type": "",
  "valid_until": "2021-08-17"
}

Performs online activation of a new license using an activation key.

POST /license/activate

Attribute Type Required Description

key string yes License key

curl -X POST -H "Private-Token: <access token>" -d '{"key":"AAAA-BBBB-CCCC-DDDD"}' https://canvus.example.com/api/v1/license/activate

Generates an offline activation request.

GET /license/request

Attribute Type Required Description

key (query) string yes License key

curl -H "Private-Token: <access token>" https://canvus.example.com/api/v1/license/request?key=AAAA-BBBB-CCCC-DDDD

Installs a new license obtained from offline activation.

POST /license

Attribute Type Required Description

license string yes License data

curl -X POST -H "Private-Token: <access token>" -d '{"license":"..."}' https://canvus.example.com/api/v1/license