Get information Generally available

GET /_xpack
Api key auth Basic auth Bearer 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 array[string]

    A comma-separated list of the information categories to include in the response. For example, build,license,features.

    Values are build, features, or license.

  • accept_enterprise boolean

    If this param is used it must be set to true

  • human boolean

    Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • build object Required
      Hide build attributes Show build attributes object

      • date string | number Required

        A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

        One of:
        string-1 string UnitMillis number

        Time unit for milliseconds

      • hash string Required
    • features object Required
      Hide features attributes Show features attributes object
      • aggregate_metric object Required
        Hide aggregate_metric attributes Show aggregate_metric attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • analytics object Required
        Hide analytics attributes Show analytics attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • ccr object Required
        Hide ccr attributes Show ccr attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • data_streams object Required
        Hide data_streams attributes Show data_streams attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • data_tiers object Required
        Hide data_tiers attributes Show data_tiers attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • enrich object Required
        Hide enrich attributes Show enrich attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • enterprise_search object Required
        Hide enterprise_search attributes Show enterprise_search attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • eql object Required
        Hide eql attributes Show eql attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • esql object Required
        Hide esql attributes Show esql attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • frozen_indices object Required
        Hide frozen_indices attributes Show frozen_indices attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • graph object Required
        Hide graph attributes Show graph attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • ilm object Required
        Hide ilm attributes Show ilm attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • logstash object Required
        Hide logstash attributes Show logstash attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • logsdb object Required
        Hide logsdb attributes Show logsdb attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • ml object Required
        Hide ml attributes Show ml attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • monitoring object Required
        Hide monitoring attributes Show monitoring attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • rollup object Required
        Hide rollup attributes Show rollup attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • runtime_fields object
        Hide runtime_fields attributes Show runtime_fields attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • searchable_snapshots object Required
        Hide searchable_snapshots attributes Show searchable_snapshots attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • security object Required
        Hide security attributes Show security attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • slm object Required
        Hide slm attributes Show slm attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • spatial object Required
        Hide spatial attributes Show spatial attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • sql object Required
        Hide sql attributes Show sql attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • transform object Required
        Hide transform attributes Show transform attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • universal_profiling object Required
        Hide universal_profiling attributes Show universal_profiling attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • voting_only object Required
        Hide voting_only attributes Show voting_only attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • watcher object Required
        Hide watcher attributes Show watcher attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
      • archive object Required
        Hide archive attributes Show archive attributes object
        • available boolean Required
        • description string
        • enabled boolean Required
        • native_code_info object
          Hide native_code_info attributes Show native_code_info attributes object
          • build_hash string Required
          • version string Required
    • license object Required
      Hide license attributes Show license attributes object
      • expiry_date_in_millis number

        Time unit for milliseconds

      • mode string Required

        Values are missing, trial, basic, standard, dev, silver, gold, platinum, or enterprise.

      • status string Required

        Values are active, valid, invalid, or expired.

      • type string Required

        Values are missing, trial, basic, standard, dev, silver, gold, platinum, or enterprise.

      • uid string Required
    • tagline string Required
GET /_xpack 
GET /_xpack

resp = client.xpack.info()
const response = await client.xpack.info();
response = client.xpack.info
$resp = $client->xpack()->info();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_xpack"
Response examples (200)
A successful response from `GET /_xpack`. 
{
  "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
      },
    "aggregate_metric" : {
          "available" : true,
          "enabled" : true
      },
      "analytics" : {
          "available" : true,
          "enabled" : true
      },
      "archive" : {
          "available" : true,
          "enabled" : true
      },
      "enrich" : {
          "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
      },
      "esql" : {
        "available" : true,
        "enabled" : true
      },
      "monitoring" : {
        "available" : true,
        "enabled" : true
      },
      "rollup": {
        "available": true,
        "enabled": true
      },
      "searchable_snapshots" : {
        "available" : true,
        "enabled" : true
      },
      "security" : {
        "available" : true,
        "enabled" : true
      },
      "slm" : {
        "available" : true,
        "enabled" : true
      },
      "spatial" : {
        "available" : true,
        "enabled" : true
      },
      "eql" : {
        "available" : true,
        "enabled" : true
      },
      "sql" : {
        "available" : true,
        "enabled" : true
      },
      "transform" : {
        "available" : true,
        "enabled" : true
      },
      "voting_only" : {
        "available" : true,
        "enabled" : true
      },
      "watcher" : {
        "available" : true,
        "enabled" : true
      },
      "data_streams" : {
        "available" : true,
        "enabled" : true
      },
      "data_tiers" : {
        "available" : true,
        "enabled" : true
      },
      "enterprise_search": {
        "available": true,
        "enabled": true
      },
      "universal_profiling": {
        "available": true,
        "enabled": true
      },
      "logsdb": {
        "available": true,
        "enabled": false
      }
  },
  "tagline" : "You know, for X"
}