- X-Pack Reference for 6.0-6.2 and 5.x:
- Introduction
- Installing X-Pack
- Migrating to X-Pack
- Breaking Changes
- Securing Elasticsearch and Kibana
- Monitoring the Elastic Stack
- Alerting on Cluster and Index Events
- Reporting from Kibana
- Graphing Connections in Your Data
- Profiling your Queries and Aggregations
- Machine Learning in the Elastic Stack
- X-Pack Settings
- X-Pack APIs
- Info API
- Security APIs
- Watcher APIs
- Graph APIs
- Machine Learning APIs
- Close Jobs
- Create Datafeeds
- Create Jobs
- Delete Datafeeds
- Delete Jobs
- Delete Model Snapshots
- Flush Jobs
- Get Buckets
- Get Categories
- Get Datafeeds
- Get Datafeed Statistics
- Get Influencers
- Get Jobs
- Get Job Statistics
- Get Model Snapshots
- Get Records
- Open Jobs
- Post Data to Jobs
- Preview Datafeeds
- Revert Model Snapshots
- Start Datafeeds
- Stop Datafeeds
- Update Datafeeds
- Update Jobs
- Update Model Snapshots
- Validate Detectors
- Validate Jobs
- Definitions
- Troubleshooting
- Limitations
- License Management
- Release Notes
WARNING: Version 5.4 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Info API
editInfo API
editThe info API provides general information on the installed X-Pack. This information 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.
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-802e3dofh7aa", "type" : "trial", "mode" : "trial", "status" : "active", "expiry_date_in_millis" : 1914278399999 }, "features" : { "graph" : { "description" : "Graph Data Exploration for the Elastic Stack", "available" : true, "enabled" : true }, "ml" : { "description" : "Machine Learning for the Elastic Stack", "available" : true, "enabled" : true, "native_code_info" : { "version" : "6.0.0-alpha1-SNAPSHOT", "build_hash" : "d081461967d61a" } }, "monitoring" : { "description" : "Monitoring for the Elastic Stack", "available" : true, "enabled" : true }, "security" : { "description" : "Security for the Elastic Stack", "available" : true, "enabled" : true }, "watcher" : { "description" : "Alerting, Notification and Automation for the Elastic Stack", "available" : true, "enabled" : true } }, "tagline" : "You know, for X" }
You can also control what information is returned using the categories and
human parameters.
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
Was this helpful?
Thank you for your feedback.