Get information

GET /_xpack

The information provided by the API includes:

Build information including the build number and timestamp.
License information about the currently installed license.
Feature information for the features that are currently enabled and available under the current license.

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

Query parameters

Response

application/json

build object required
features object required
license object required
tagline string required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_xpack

JavaScript Elasticsearch JavaScript Client

const response = await client.xpack.info();

Python Elasticsearch Python Client

resp = client.xpack.info()

curl Shell

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

Java Elasticsearch Java Client

client.xpack().info(i -> i);

C# Elasticsearch .NET Client

var response = await client.Xpack.InfoAsync();

PHP Elasticsearch PHP Client

$resp = $client->xpack()->info();

Ruby Elasticsearch Ruby Client

response = client.xpack.info

Response

A successful response from GET /_xpack.

{
  "build" : {
      "hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",
      "date" : "2015-04-07T13:34:42Z"
  },
  "license" : {
      "uid" : "893361dc-9749-4997-93cb-xxx",
      "type" : "trial",
      "mode" : "trial",
      "status" : "active",
      "expiry_date_in_millis" : 1542665112332
  },
  "features" : {
      "ccr" : {
        "available" : true,
        "enabled" : true
      },
    "aggregate_metric" : {
          "available" : true,
          "enabled" : true
      },
      "analytics" : {
          "available" : true,
          "enabled" : true
      },
      "archive" : {
          "available" : true,
          "enabled" : true
      },
      "enrich" : {
          "available" : true,
          "enabled" : true
      },
      "frozen_indices" : {
        "available" : true,
        "enabled" : true
      },
      "graph" : {
        "available" : true,
        "enabled" : true
      },
      "ilm" : {
        "available" : true,
        "enabled" : true
      },
      "logstash" : {
        "available" : true,
        "enabled" : true
      },
      "ml" : {
        "available" : true,
        "enabled" : true
      },
      "esql" : {
        "available" : true,
        "enabled" : true
      },
      "monitoring" : {
        "available" : true,
        "enabled" : true
      },
      "rollup": {
        "available": true,
        "enabled": true
      },
      "searchable_snapshots" : {
        "available" : true,
        "enabled" : true
      },
      "security" : {
        "available" : true,
        "enabled" : true
      },
      "slm" : {
        "available" : true,
        "enabled" : true
      },
      "spatial" : {
        "available" : true,
        "enabled" : true
      },
      "eql" : {
        "available" : true,
        "enabled" : true
      },
      "sql" : {
        "available" : true,
        "enabled" : true
      },
      "transform" : {
        "available" : true,
        "enabled" : true
      },
      "voting_only" : {
        "available" : true,
        "enabled" : true
      },
      "watcher" : {
        "available" : true,
        "enabled" : true
      },
      "data_streams" : {
        "available" : true,
        "enabled" : true
      },
      "data_tiers" : {
        "available" : true,
        "enabled" : true
      },
      "enterprise_search": {
        "available": true,
        "enabled": true
      },
      "universal_profiling": {
        "available": true,
        "enabled": true
      },
      "logsdb": {
        "available": true,
        "enabled": false
      }
  },
  "tagline" : "You know, for X"
}