› › ›

Get basic status API

This API enables you to check the status of your basic license.

GET /_license/basic_status

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://elastic.ac.cn/subscriptions.

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

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
}