Info API

Provides general information about the installed X-Pack features.

Request

GET /_xpack

Description

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

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

The following example queries the info API:

  1. GET /_xpack

Example response:

  1. {
  2.    "build" : {
  3.       "hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",
  4.       "date" : "2015-04-07T13:34:42Z"
  5.    },
  6.    "license" : {
  7.       "uid" : "893361dc-9749-4997-93cb-xxx",
  8.       "type" : "trial",
  9.       "mode" : "trial",
  10.       "status" : "active",
  11.       "expiry_date_in_millis" : 1542665112332
  12.    },
  13.    "features" : {
  14.       "ccr" : {
  15.         "available" : true,
  16.         "enabled" : true
  17.       },
  18.       "analytics" : {
  19.           "available" : true,
  20.           "enabled" : true
  21.       },
  22.       "enrich" : {
  23.           "available" : true,
  24.           "enabled" : true
  25.       },
  26.       "flattened" : {
  27.          "available" : true,
  28.          "enabled" : true
  29.       },
  30.       "frozen_indices" : {
  31.          "available" : true,
  32.          "enabled" : true
  33.       },
  34.       "graph" : {
  35.          "available" : true,
  36.          "enabled" : true
  37.       },
  38.       "ilm" : {
  39.          "available" : true,
  40.          "enabled" : true
  41.       },
  42.       "logstash" : {
  43.          "available" : true,
  44.          "enabled" : true
  45.       },
  46.       "ml" : {
  47.          "available" : true,
  48.          "enabled" : true,
  49.          "native_code_info" : {
  50.            "version" : "7.0.0-alpha1-SNAPSHOT",
  51.            "build_hash" : "99a07c016d5a73"
  52.         }
  53.       },
  54.       "monitoring" : {
  55.          "available" : true,
  56.          "enabled" : true
  57.       },
  58.       "rollup": {
  59.          "available": true,
  60.          "enabled": true
  61.       },
  62.       "searchable_snapshots" : {
  63.          "available" : true,
  64.          "enabled" : true
  65.       },
  66.       "security" : {
  67.          "available" : true,
  68.          "enabled" : false
  69.       },
  70.       "slm" : {
  71.          "available" : true,
  72.          "enabled" : true
  73.       },
  74.       "spatial" : {
  75.          "available" : true,
  76.          "enabled" : true
  77.       },
  78.       "eql" : {
  79.          "available" : true,
  80.          "enabled" : true
  81.       },
  82.       "sql" : {
  83.          "available" : true,
  84.          "enabled" : true
  85.       },
  86.       "transform" : {
  87.          "available" : true,
  88.          "enabled" : true
  89.       },
  90.       "vectors" : {
  91.          "available" : true,
  92.          "enabled" : true
  93.       },
  94.       "voting_only" : {
  95.          "available" : true,
  96.          "enabled" : true
  97.       },
  98.       "watcher" : {
  99.          "available" : true,
  100.          "enabled" : true
  101.       },
  102.       "data_streams" : {
  103.          "available" : true,
  104.          "enabled" : true,
  105.       }
  106.    },
  107.    "tagline" : "You know, for X"
  108. }

The following example only returns the build and features information:

  1. GET /_xpack?categories=build,features

The following example removes the descriptions from the response:

  1. GET /_xpack?human=false