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 authorization

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
native_code_info object
build_hash string required
version string required
analytics object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
ccr object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
data_streams object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
data_tiers object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
enrich object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
eql object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
esql object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
frozen_indices object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
graph object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
ilm object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
logstash object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
logsdb object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
ml object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
monitoring object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
rollup object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
runtime_fields object
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
searchable_snapshots object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
security object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
slm object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
spatial object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
sql object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
transform object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
universal_profiling object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
voting_only object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
watcher object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string required
archive object required
available boolean required
description string
enabled boolean required
native_code_info object
build_hash string required
version string 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