NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Get basic status APIedit
This API enables you to check the status of your basic license.
Requestedit
GET _xpack/license/basic_status
Descriptionedit
In order to initiate a basic license, you must not currently have a basic license.
For more information about the different types of licenses, see https://www.elastic.co/subscriptions.
Authorizationedit
You must have monitor
cluster privileges to use this API.
For more information, see Security privileges.
Examplesedit
The following example checks whether you are eligible to start a basic:
GET _xpack/license/basic_status
Example response:
{ "eligible_to_start_basic": true }