Start Basic APIedit

This API starts an indefinite basic license.

Requestedit

POST _xpack/license/start_basic

Descriptionedit

The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. 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 following API: Get Basic Status API.

For more information about the different types of licenses, see https://www.elastic.co/subscriptions.

Authorizationedit

You must have manage cluster privileges to use this API. For more information, see Security Privileges.

Examplesedit

The following example starts a basic license if you do not currently have a license:

POST _xpack/license/start_basic

Example response:

{
  "basic_was_started": true,
  "acknowledged": true
}

The following example starts a basic license if you currently have a license with more features than a basic license. As you are losing features, you must pass the acknowledge parameter:

POST _xpack/license/start_basic?acknowledge=true

Example response:

{
  "basic_was_started": true,
  "acknowledged": true
}