IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Simulate pipeline API Licensing APIs »

› ›

Info API

edit

Info API

edit

Provides general information about the installed X-Pack features.

Request

edit

GET /_xpack

Description

edit

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 parameters

edit

categories: (Optional, list) A comma-separated list of the information categories to include in the response. For example, build,license,features.
human: (Optional, 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.

Examples

edit

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" : "trial",
      "mode" : "trial",
      "status" : "active",
      "expiry_date_in_millis" : 1542665112332
   },
   "features" : {
      "ccr" : {
        "available" : true,
        "enabled" : true
      },
      "data_frame" : {
          "available" : true,
          "enabled" : true
      },
      "analytics" : {
          "available" : true,
          "enabled" : true
      },
      "flattened" : {
         "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,
         "native_code_info" : {
           "version" : "7.0.0-alpha1-SNAPSHOT",
           "build_hash" : "99a07c016d5a73"
        }
      },
      "monitoring" : {
         "available" : true,
         "enabled" : true
      },
      "rollup": {
         "available": true,
         "enabled": true
      },
      "security" : {
         "available" : true,
         "enabled" : false
      },
      "spatial" : {
         "available" : true,
         "enabled" : true
      },
      "sql" : {
         "available" : true,
         "enabled" : true
      },
      "vectors" : {
         "available" : true,
         "enabled" : true
      },
      "voting_only" : {
         "available" : true,
         "enabled" : true
      },
      "watcher" : {
         "available" : true,
         "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

« Simulate pipeline API Licensing APIs »