Get basic status API
This API enables you to check the status of your basic license.
Request
GET /_license/basic_status
Description
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.
Authorization
You must have monitor cluster privileges to use this API. For more information, see Security privileges.
Examples
The 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
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-basic-status.html
