Get the basic license status

GET /_license/basic_status

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Response

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
}