Type to search.

Get information

  • GET /_xpack
Auth

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 privileges

Cluster privileges monitor

Query parameters

categories enum[]

A comma-separated list of the information categories to include in the response. For example, build,license,features.

Values: build features license
accept_enterprise boolean deprecated

If used, this otherwise ignored parameter must be set to true

human boolean · default: true

Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line.

Response

application/json
build object required
date union oneOf required
One of: string or number
hash string required
features object required
aggregate_metric object required
available boolean required
description string
enabled boolean required
analytics object required
available boolean required
description string
enabled boolean required
ccr object required
available boolean required
description string
enabled boolean required
data_streams object required
available boolean required
description string
enabled boolean required
data_tiers object required
available boolean required
description string
enabled boolean required
enrich object required
available boolean required
description string
enabled boolean required
available boolean required
description string
enabled boolean required
eql object required
available boolean required
description string
enabled boolean required
esql object required The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 8.14 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
available boolean required
description string
enabled boolean required
frozen_indices object required
available boolean required
description string
enabled boolean required
graph object required
available boolean required
description string
enabled boolean required
ilm object required
available boolean required
description string
enabled boolean required
logstash object required
available boolean required
description string
enabled boolean required
logsdb object required
available boolean required
description string
enabled boolean required
ml object required
available boolean required
description string
enabled boolean required
monitoring object required
available boolean required
description string
enabled boolean required
rollup object required
available boolean required
description string
enabled boolean required
searchable_snapshots object required
available boolean required
description string
enabled boolean required
security object required
available boolean required
description string
enabled boolean required
slm object required
available boolean required
description string
enabled boolean required
spatial object required
available boolean required
description string
enabled boolean required
sql object required
available boolean required
description string
enabled boolean required
transform object required
available boolean required
description string
enabled boolean required
universal_profiling object required The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 8.7 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
available boolean required
description string
enabled boolean required
voting_only object required
available boolean required
description string
enabled boolean required
watcher object required
available boolean required
description string
enabled boolean required
archive object required The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 8.2 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
available boolean required
description string
enabled boolean required
license object required
expiry_date_in_millis number required
mode enum required
Values: missing trial basic standard dev silver gold platinum enterprise
status enum required
Values: active valid invalid expired
type enum required
Values: missing trial basic standard dev silver gold platinum enterprise
uid string required
tagline string required