Start a basic license | Elasticsearch API (v8)

Start a basic license Added in 6.3.0

POST /_license/start_basic

Start an indefinite basic license, which gives access to all the basic features.

NOTE: In order to start a basic license, you must not currently have a basic license.

If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.

To check the status of your basic license, use the get basic license API.

Query parameters

acknowledge boolean

whether the user has acknowledged acknowledge messages (default: false)

Responses

200 application/json
Hide response attributes Show response attributes object
- acknowledged boolean Required
- basic_was_started boolean Required
- error_message string
- type string
  
  Values are missing, trial, basic, standard, dev, silver, gold, platinum, or enterprise.
- acknowledge object

POST /_license/start_basic

curl \
 -X POST http://api.example.com/_license/start_basic

Response examples (200)

{
  "acknowledged": true,
  "basic_was_started": true,
  "error_message": "string",
  "type": "missing",
  "acknowledge": {}
}