Method Path Description
GET /v1/license Get license details
PUT /v1/license Update the license

Get license

GET /v1/license

Returns the license details, including license string, expiration, and supported features.

Required permissions

Permission name
view_license

Request

Example HTTP request

GET /license 

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Response

Returns a JSON object that contains the license details.

Example JSON body

{
    "license": "----- LICENSE START -----\ndi+iK...KniI9\n----- LICENSE END -----\n",
    "expired": true,
    "activation_date":"2018-12-31T00:00:00Z",
    "expiration_date":"2019-12-31T00:00:00Z",
    "shards_limit": 300,
    "features": ["bigstore"]
}

Status codes

Code Description
200 OK License is returned in the response body.
404 Not Found No license is installed.

Update license

PUT /v1/license

Validate and install a new license string.

Required permissions

Permission name
install_new_license

Request

The request must be a JSON object with a single key named “license”.

Example HTTP request

PUT /license 

Example JSON body

{
    "license": "----- LICENSE START -----\ndi+iK...KniI9\n----- LICENSE END -----\n"
}

Request headers

Key Value Description
Accept application/json Accepted media type

Request body

Include a JSON object that contains the new license string in the request body.

Response

Returns an error if the new license is not valid.

Status codes

Code Description
200 OK License installed successfully.
400 Bad Request Invalid request, either bad JSON object or corrupted license was supplied.
406 Not Acceptable License violation. A response body provides more details on the specific cause.