HTTP Interface for License Management

The License Management REST API allows you to view the current license status and update the license of your ArangoDB Enterprise Edition deployment.

Return information about the current license

Get license information

GET /_admin/license

View the license information and status of an Enterprise Edition instance. Can be called on single servers, Coordinators, and DB-Servers.

Responses

HTTP 200:

• features (object):

  • expires (number): The expires key lists the expiry date as Unix timestamp (seconds since January 1st, 1970 UTC).

• license (string): The encrypted license key in Base64 encoding.

• version (number): The license version number.

• status (string): The status key allows you to confirm the state of the installed license on a glance. The possible values are as follows:

  • good: The license is valid for more than 2 weeks.
  • expiring: The license is valid for less than 2 weeks.
  • expired: The license has expired. In this situation, no new Enterprise Edition features can be utilized.
  • read-only: The license is expired over 2 weeks. The instance is now restricted to read-only mode.

Examples

shell> curl --header 'accept: application/json' --dump - http://localhost:8529/_admin/license

HTTP/1.1 200 OK
content-type: application/json
connection: Keep-Alive
content-length: 162
server: ArangoDB
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "upgrading" : false, 
  "features" : { 
    "expires" : 1652880546 
  }, 
  "license" : "JD4EOXdnfgldOS9cW1RxUlVBZ1gBfSddAVRmTWRbDU59WTMdeCBVFC0VFnwydQBZ", 
  "version" : 1, 
  "status" : "expiring" 
}

shell> curl --header 'accept: application/json' --dump - http://localhost:8529/_admin/license

HTTP/1.1 200 OK
content-type: application/json
connection: Keep-Alive
content-length: 162
server: ArangoDB
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

Set a new license

Set a new license

PUT /_admin/license

Query Parameters

• force (boolean, optional): Set to true to change the license even if it expires sooner than the current one.

Request Body

(string, required)

The body has to contain the Base64 encoded string wrapped in double quotes.

Set a new license for an Enterprise Edition instance. Can be called on single servers, Coordinators, and DB-Servers.

Responses

HTTP 400: If the license expires earlier than the previously installed one.

HTTP 201: License successfully deployed.

Examples

shell> curl -XPUT http://localhost:8529/_admin/license -d '"<license-string>"'

Server response in case of success:

{
  "result": {
    "error": false,
    "code": 201
  }
}

Server response if the new license expires sooner than the current one (requires ?force=true to update the license anyway):

{
  "code": 400,
  "error": true,
  "errorMessage": "This license expires sooner than the existing. You may override this by specifying force=true with invocation.",
  "errorNum": 9007
}

In case of a different error related to an expired or invalid license, please contact ArangoDB sales.