Get the basic license status Generally available; Added in 6.3.0

GET /_license/basic_status
Api key auth Basic auth Bearer auth

Required authorization

  • Cluster privileges: monitor

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • eligible_to_start_basic boolean Required
GET /_license/basic_status 
GET /_license/basic_status

resp = client.license.get_basic_status()
const response = await client.license.getBasicStatus();
response = client.license.get_basic_status
$resp = $client->license()->getBasicStatus();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_license/basic_status"
Response examples (200)
A successful response from `GET /_license/basic_status`. 
{
  "eligible_to_start_basic": true
}