Get usage information

GET /_xpack/usage

Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.

Query parameters

  • Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

Responses

GET /_xpack/usage
curl \
 -X GET http://api.example.com/_xpack/usage
Response examples (200)
{
  "aggregate_metric": {
    "available": true,
    "enabled": true
  },
  "": {
    "available": true,
    "enabled": true,
    "dense_vector_dims_avg_count": 42.0,
    "dense_vector_fields_count": 42.0,
    "sparse_vector_fields_count": 42.0
  },
  "data_frame": {
    "available": true,
    "enabled": true
  },
  "data_science": {
    "available": true,
    "enabled": true
  },
  "enrich": {
    "available": true,
    "enabled": true
  },
  "graph": {
    "available": true,
    "enabled": true
  },
  "ilm": {
    "policy_count": 42.0,
    "policy_stats": [
      {
        "indices_managed": 42.0,
        "phases": {
          "cold": {
            "actions": {}
          },
          "delete": {
            "actions": {}
          },
          "frozen": {
            "actions": {}
          },
          "hot": {
            "actions": {}
          },
          "warm": {
            "actions": {}
          }
        }
      }
    ]
  },
  "logstash": {
    "available": true,
    "enabled": true
  },
  "rollup": {
    "available": true,
    "enabled": true
  },
  "spatial": {
    "available": true,
    "enabled": true
  },
  "transform": {
    "available": true,
    "enabled": true
  },
  "voting_only": {
    "available": true,
    "enabled": true
  }
}