Get the basic license status

Auth

Required privileges

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_license/basic_status

JavaScript Elasticsearch JavaScript Client

const response = await client.license.getBasicStatus();

Python Elasticsearch Python Client

resp = client.license.get_basic_status()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_license/basic_status" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.license().getBasicStatus();

C# Elasticsearch .NET Client

var response = await client.LicenseManagement.GetBasicStatusAsync();

PHP Elasticsearch PHP Client

$resp = $client->license()->getBasicStatus();

Ruby Elasticsearch Ruby Client

response = client.license.get_basic_status

Response

A successful response from GET /_license/basic_status.

{
  "eligible_to_start_basic": true
}