IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Info APIedit
The info API provides general information about the installed X-Pack features.
Requestedit
GET /_xpack
Descriptionedit
The information provided by this API includes:
- Build Information - including the build number and timestamp.
- License Information - basic information about the currently installed license.
- Features Information - The features that are currently enabled and available under the current license.
Path Parametersedit
-
categories
-
(list) A comma-separated list of the information categories to include in the
response. For example,
build,license,features
. -
human
-
(boolean) Defines whether additional human-readable information is included in
the response. In particular, it adds descriptions and a tag line. The
default value is
true
.
Examplesedit
The following example queries the info API:
GET /_xpack
Example response:
{ "build" : { "hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168", "date" : "2015-04-07T13:34:42Z" }, "license" : { "uid" : "893361dc-9749-4997-93cb-xxx", "type" : "basic", "mode" : "basic", "status" : "active" }, "features" : { "graph" : { "description" : "Graph Data Exploration for the Elastic Stack", "available" : false, "enabled" : true }, "logstash" : { "description" : "Logstash management component for X-Pack", "available" : false, "enabled" : true }, "ml" : { "description" : "Machine Learning for the Elastic Stack", "available" : false, "enabled" : true, "native_code_info" : { "version" : "6.3.0", "build_hash" : "54b5cf147d946c" } }, "monitoring" : { "description" : "Monitoring for the Elastic Stack", "available" : true, "enabled" : true }, "rollup": { "description": "Time series pre-aggregation and rollup", "available": true, "enabled": true }, "security" : { "description" : "Security for the Elastic Stack", "available" : false, "enabled" : true }, "watcher" : { "description" : "Alerting, Notification and Automation for the Elastic Stack", "available" : false, "enabled" : true } }, "tagline" : "You know, for X" }
The following example only returns the build and features information:
GET /_xpack?categories=build,features
The following example removes the descriptions from the response:
GET /_xpack?human=false