This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Get basic status API
editGet basic status API
editThis API enables you to check the status of your basic license.
Request
editGET /_license/basic_status
Description
editIn 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.
Authorization
editYou must have monitor cluster privileges to use this API.
For more information, see Security privileges.
Examples
editThe following example checks whether you are eligible to start a basic:
resp = client.license.get_basic_status() print(resp)
response = client.license.get_basic_status puts response
const response = await client.license.getBasicStatus(); console.log(response);
GET /_license/basic_status
Example response:
{
"eligible_to_start_basic": true
}