---
type: api
title: Get usage information
description: Get information about the features that are currently enabled and available under the current license.
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-xpack-usage
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-xpack-usage
products:
  - Elasticsearch
---

# Get usage information

## Paths

- `GET` `/_xpack/usage`

## Description

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

## Required authorization

- Cluster privileges: `monitor`

## Authentication

- Api key: `Authorization: <value>`
  Elasticsearch APIs support key-based authentication.
  You must create an API key and use the encoded value in the request header.
  For example:
  
  
  ```
  curl -X GET "${ES_URL}/_cat/indices?v=true" \
    -H "Authorization: ApiKey ${API_KEY}"
  ```
  
  To get API keys, use the `/_security/api_key` APIs.
- Basic: `Authorization: Basic <credentials>`
- Bearer: `Authorization: Bearer <token>`
  Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
  For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)

## Query string parameters

- `master_timeout` (string · default: 30s) — optional
  The 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.
To indicate that the request should never timeout, set it to `-1`.

## Response

`application/json`

- `aggregate_metric` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `analytics` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `stats` (object)
    - `boxplot_usage` (number)
    - `cumulative_cardinality_usage` (number)
    - `string_stats_usage` (number)
    - `top_metrics_usage` (number)
    - `t_test_usage` (number)
    - `moving_percentiles_usage` (number)
    - `normalize_usage` (number)
    - `rate_usage` (number)
    - `multi_terms_usage` (number)
- `archive` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `indices_count` (number)
- `watcher` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `execution` (object)
    - `actions` (map string to object)
      Map values (object)
      - `total` (string)
      - `total_time_in_ms` (number)
  - `watch` (object)
    - `input` (map string to object)
      Map values (object)
      - `active` (number)
      - `total` (number)
    - `condition` (map string to object)
      Map values (object)
      - `active` (number)
      - `total` (number)
    - `action` (map string to object)
      Map values (object)
      - `active` (number)
      - `total` (number)
    - `trigger` (object)
      - `schedule` (object)
        - `active` (number)
        - `total` (number)
        - `cron` (object)
          - `active` (number)
          - `total` (number)
        - `_all` (object)
          - `active` (number)
          - `total` (number)
      - `_all` (object)
        - `active` (number)
        - `total` (number)
  - `count` (object)
    - `active` (number)
    - `total` (number)
- `ccr` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `auto_follow_patterns_count` (number)
  - `follower_indices_count` (number)
- `data_frame` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `data_science` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `data_streams` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `data_streams` (number)
  - `indices_count` (number)
- `data_tiers` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `data_warm` (object)
    - `node_count` (number)
    - `index_count` (number)
    - `total_shard_count` (number)
    - `primary_shard_count` (number)
    - `doc_count` (number)
    - `total_size_bytes` (number)
    - `primary_size_bytes` (number)
    - `primary_shard_size_avg_bytes` (number)
    - `primary_shard_size_median_bytes` (number)
    - `primary_shard_size_mad_bytes` (number)
  - `data_frozen` (object)
    Same fields as `data_warm` in `data_tiers`
  - `data_cold` (object)
    Same fields as `data_warm` in `data_tiers`
  - `data_content` (object)
    Same fields as `data_warm` in `data_tiers`
  - `data_hot` (object)
    Same fields as `data_warm` in `data_tiers`
- `enrich` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `eql` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `features` (object)
    - `join` (number)
    - `joins` (object)
      - `join_queries_two` (number)
      - `join_queries_three` (number)
      - `join_until` (number)
      - `join_queries_five_or_more` (number)
      - `join_queries_four` (number)
    - `keys` (object)
      - `join_keys_two` (number)
      - `join_keys_one` (number)
      - `join_keys_three` (number)
      - `join_keys_five_or_more` (number)
      - `join_keys_four` (number)
    - `event` (number)
    - `pipes` (object)
      - `pipe_tail` (number)
      - `pipe_head` (number)
    - `sequence` (number)
    - `sequences` (object)
      - `sequence_queries_three` (number)
      - `sequence_queries_four` (number)
      - `sequence_queries_two` (number)
      - `sequence_until` (number)
      - `sequence_queries_five_or_more` (number)
      - `sequence_maxspan` (number)
  - `queries` (map string to object)
    Map values (object)
    - `count` (number)
    - `failed` (number)
    - `paging` (number)
    - `total` (number)
- `flattened` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `field_count` (number)
- `frozen_indices` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `indices_count` (number)
- `graph` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `health_api` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `invocations` (object)
    - `total` (number)
- `ilm` (object)
  - `policy_count` (number)
  - `policy_stats` (object[])
    - `indices_managed` (number)
    - `phases` (object)
      - `cold` (object)
        - `actions` (string[])
        - `min_age` (number)
      - `delete` (object)
        - `actions` (string[])
        - `min_age` (number)
      - `frozen` (object)
        - `actions` (string[])
        - `min_age` (number)
      - `hot` (object)
        - `actions` (string[])
        - `min_age` (number)
      - `warm` (object)
        - `actions` (string[])
        - `min_age` (number)
- `logstash` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `ml` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `datafeeds` (map string to object)
    Map values (object)
    - `count` (number)
  - `jobs` (map string to object)
    Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs.
    Map values (object)
    - `count` (number)
    - `created_by` (map string to number)
    - `detectors` (object)
      - `avg` (number)
      - `max` (number)
      - `min` (number)
      - `total` (number)
    - `forecasts` (object)
      - `total` (number)
      - `forecasted_jobs` (number)
    - `model_size` (object)
      - `avg` (number)
      - `max` (number)
      - `min` (number)
      - `total` (number)
  - `node_count` (number)
  - `data_frame_analytics_jobs` (object)
    - `memory_usage` (object)
      - `peak_usage_bytes` (object)
        - `avg` (number)
        - `max` (number)
        - `min` (number)
        - `total` (number)
    - `_all` (object)
      - `count` (number)
    - `analysis_counts` (object)
      - `classification` (number)
      - `outlier_detection` (number)
      - `regression` (number)
    - `stopped` (object)
      - `count` (number)
  - `inference` (object)
    - `ingest_processors` (map string to object)
      Map values (object)
      - `num_docs_processed` (object)
        - `max` (number)
        - `sum` (number)
        - `min` (number)
      - `pipelines` (object)
        - `count` (number)
      - `num_failures` (object)
        - `max` (number)
        - `sum` (number)
        - `min` (number)
      - `time_ms` (object)
        - `max` (number)
        - `sum` (number)
        - `min` (number)
    - `trained_models` (object)
      - `estimated_operations` (object)
        - `avg` (number)
        - `max` (number)
        - `min` (number)
        - `total` (number)
      - `estimated_heap_memory_usage_bytes` (object)
        - `avg` (number)
        - `max` (number)
        - `min` (number)
        - `total` (number)
      - `count` (object)
        - `total` (number)
        - `prepackaged` (number)
        - `other` (number)
        - `pass_through` (number)
        - `regression` (number)
        - `classification` (number)
        - `ner` (number)
        - `text_embedding` (number)
      - `_all` (object)
        - `count` (number)
      - `model_size_bytes` (object)
        - `avg` (number)
        - `max` (number)
        - `min` (number)
        - `total` (number)
    - `deployments` (object)
      - `count` (number)
      - `inference_counts` (object)
        - `avg` (number)
        - `max` (number)
        - `min` (number)
        - `total` (number)
      - `model_sizes_bytes` (object)
        - `avg` (number)
        - `max` (number)
        - `min` (number)
        - `total` (number)
      - `time_ms` (object)
        - `avg` (number)
- `monitoring` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `collection_enabled` (boolean)
  - `enabled_exporters` (map string to number)
- `rollup` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `runtime_fields` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `field_types` (object[])
    - `chars_max` (number)
    - `chars_total` (number)
    - `count` (number)
    - `doc_max` (number)
    - `doc_total` (number)
    - `index_count` (number)
    - `lang` (string[])
    - `lines_max` (number)
    - `lines_total` (number)
    - `name` (string)
    - `scriptless_count` (number)
    - `shadowed_count` (number)
    - `source_max` (number)
    - `source_total` (number)
- `spatial` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `searchable_snapshots` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `indices_count` (number)
  - `full_copy_indices_count` (number)
  - `shared_cache_indices_count` (number)
- `security` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `api_key_service` (object)
    - `enabled` (boolean)
  - `anonymous` (object)
    - `enabled` (boolean)
  - `audit` (object)
    - `enabled` (boolean)
    - `outputs` (string[])
  - `fips_140` (object)
    - `enabled` (boolean)
  - `ipfilter` (object)
    - `http` (boolean)
    - `transport` (boolean)
  - `realms` (map string to object)
    Map values (object)
    - `available` (boolean)
    - `enabled` (boolean)
    - `name` (string[])
    - `order` (number[])
    - `size` (number[])
    - `cache` (object[])
      - `size` (number)
    - `has_authorization_realms` (boolean[])
    - `has_default_username_pattern` (boolean[])
    - `has_truststore` (boolean[])
    - `is_authentication_delegated` (boolean[])
  - `role_mapping` (map string to object)
    Map values (object)
    - `enabled` (number)
    - `size` (number)
  - `roles` (object)
    - `native` (object)
      - `dls` (boolean)
      - `fls` (boolean)
      - `size` (number)
    - `dls` (object)
      - `bit_set_cache` (object)
        - `count` (number)
        - `memory` (number | string)
        - `memory_in_bytes` (number)
    - `file` (object)
      - `dls` (boolean)
      - `fls` (boolean)
      - `size` (number)
  - `ssl` (object)
    - `http` (object)
      - `enabled` (boolean)
    - `transport` (object)
      - `enabled` (boolean)
  - `system_key` (object)
    - `enabled` (boolean)
  - `token_service` (object)
    - `enabled` (boolean)
  - `operator_privileges` (object)
    - `available` (boolean)
    - `enabled` (boolean)
- `slm` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `policy_count` (number)
  - `policy_stats` (object)
    - `retention_deletion_time` (string)
    - `retention_deletion_time_millis` (number)
    - `retention_failed` (number)
    - `retention_runs` (number)
    - `retention_timed_out` (number)
    - `policy` (string)
    - `total_snapshots_deleted` (number)
    - `total_snapshot_deletion_failures` (number)
    - `total_snapshots_failed` (number)
    - `total_snapshots_taken` (number)
- `sql` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `features` (map string to number)
  - `queries` (map string to object)
    Map values (object)
    - `count` (number)
    - `failed` (number)
    - `paging` (number)
    - `total` (number)
- `transform` (object)
  - `available` (boolean)
  - `enabled` (boolean)
- `vectors` (object)
  - `available` (boolean)
  - `enabled` (boolean)
  - `dense_vector_dims_avg_count` (number)
  - `dense_vector_fields_count` (number)
  - `sparse_vector_fields_count` (number)
- `voting_only` (object)
  - `available` (boolean)
  - `enabled` (boolean)
## Code examples

#### Console

```console
GET /_xpack/usage
```

#### JavaScript

```javascript
const response = await client.xpack.usage();
```

#### Python

```python
resp = client.xpack.usage()
```

#### curl

```curl
curl -X GET "$ELASTICSEARCH_URL/_xpack/usage" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"
```

#### Java

```java
client.xpack().usage(u -> u);
```

#### C#

```c#
var response = await client.Xpack.UsageAsync();
```

#### PHP

```php
$resp = $client->xpack()->usage();
```

#### Ruby

```ruby
response = client.xpack.usage
```

## Response examples

#### XPack usage response example1

An abbreviated response from `GET /_xpack/usage`.

```json
{
  "security" : {
    "available" : true,
    "enabled" : true
  },
  "monitoring" : {
    "available" : true,
    "enabled" : true,
    "collection_enabled" : false,
    "enabled_exporters" : {
      "local" : 1
    }
  },
  "watcher" : {
      "available" : true,
      "enabled" : true,
      "execution" : {
        "actions" : {
          "_all" : {
            "total" : 0,
            "total_time_in_ms" : 0
          }
        }
      },
    "watch" : {
      "input" : {
        "_all" : {
          "total" : 0,
          "active" : 0
        }
      },
      "trigger" : {
        "_all" : {
          "total" : 0,
          "active" : 0
        }
      }
    },
    "count" : {
      "total" : 0,
      "active" : 0
    }
  },
  "graph" : {
    "available" : true,
    "enabled" : true
  },
  "ml" : {
    "available" : true,
    "enabled" : true,
    "jobs" : {
      "_all" : {
        "count" : 0,
        "detectors" : { },
        "created_by" : { },
        "model_size" : { },
        "forecasts" : {
          "total" : 0,
          "forecasted_jobs" : 0
        }
      }
    },
    "datafeeds" : {
      "_all" : {
        "count" : 0
      }
    },
    "data_frame_analytics_jobs" : {
      "_all" : {
        "count" : 0
      },
      "analysis_counts": { },
      "memory_usage": {
        "peak_usage_bytes": {
          "min": 0.0,
          "max": 0.0,
          "avg": 0.0,
          "total": 0.0
        }
      }
    },
    "inference" : {
      "ingest_processors" : {
        "_all" : {
          "num_docs_processed" : {
            "max" : 0,
            "sum" : 0,
            "min" : 0
          },
          "pipelines" : {
            "count" : 0
          },
          "num_failures" : {
            "max" : 0,
            "sum" : 0,
            "min" : 0
          },
          "time_ms" : {
            "max" : 0,
            "sum" : 0,
            "min" : 0
          }
        }
      },
      "trained_models" : {
        "_all" : {
          "count": 1
        },
        "count": {
          "total": 1,
          "prepackaged": 1,
          "other": 0
        },
        "model_size_bytes": {
          "min": 0.0,
          "max": 0.0,
          "avg": 0.0,
          "total": 0.0
        },
        "estimated_operations": {
          "min": 0.0,
          "max": 0.0,
          "avg": 0.0,
          "total": 0.0
        }
      },
      "deployments": {
        "count": 0,
        "inference_counts": {
          "total": 0.0,
          "min": 0.0,
          "avg": 0.0,
          "max": 0.0
        },
        "stats_by_model": [],
        "model_sizes_bytes": {
          "total": 0.0,
          "min": 0.0,
          "avg": 0.0,
          "max": 0.0
        },
        "time_ms": {
          "avg": 0.0
        }
      }
    },
    "node_count" : 1,
    "memory": {
      anomaly_detectors_memory_bytes: 0,
      data_frame_analytics_memory_bytes: 0,
      pytorch_inference_memory_bytes: 0,
      total_used_memory_bytes: 0
    }
  },
  "inference": {
    "available" : true,
    "enabled" : true,
    "models" : [ ]
  },
  "logstash" : {
    "available" : true,
    "enabled" : true
  },
  "eql" : {
    "available" : true,
    "enabled" : true
  },
  "esql" : {
    "available" : true,
    "enabled" : true,
    "features" : {
      "eval" : 0,
      "stats" : 0,
      "dissect": 0,
      "grok" : 0,
      "limit" : 0,
      "where" : 0,
      "sort" : 0,
      "drop" : 0,
      "show" : 0,
      "rename" : 0,
      "mv_expand" : 0,
      "keep" : 0,
      "enrich" : 0,
      "from" : 0,
      "row" : 0
    },
    "queries" : {
      "rest" : {
        "total" : 0,
        "failed" : 0
      },
      "kibana" : {
        "total" : 0,
        "failed" : 0
      },
      "_all" : {
        "total" : 0,
        "failed" : 0
    }
  }
  },
  "sql" : {
    "available" : true,
    "enabled" : true,
    "features" : {
      "having" : 0,
      "subselect" : 0,
      "limit" : 0,
      "orderby" : 0,
      "where" : 0,
      "join" : 0,
      "groupby" : 0,
      "command" : 0,
      "local" : 0
    },
    "queries" : {
      "rest" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "cli" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "canvas" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "odbc" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "jdbc" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "odbc32" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "odbc64" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "_all" : {
        "total" : 0,
        "paging" : 0,
        "failed" : 0
      },
      "translate" : {
        "count" : 0
      }
    }
  },
  "rollup" : {
    "available" : true,
    "enabled" : true
  },
  "ilm" : {
    "policy_count" : 3,
    "policy_stats" : [ ]
  },
  "slm" : {
    "available" : true,
    "enabled" : true
  },
  "ccr" : {
    "available" : true,
    "enabled" : true,
    "follower_indices_count" : 0,
    "auto_follow_patterns_count" : 0
  },
  "transform" : {
    "available" : true,
    "enabled" : true
  },
  "voting_only" : {
    "available" : true,
    "enabled" : true
  },
  "searchable_snapshots" : {
    "available" : true,
    "enabled" : true,
    "indices_count" : 0,
    "full_copy_indices_count" : 0,
    "shared_cache_indices_count" : 0
  },
  "frozen_indices" : {
    "available" : true,
    "enabled" : true,
    "indices_count" : 0
  },
  "spatial" : {
    "available" : true,
    "enabled" : true
  },
  "analytics" : {
    "available" : true,
    "enabled" : true,
    "stats": {
      "boxplot_usage" : 0,
      "top_metrics_usage" : 0,
      "normalize_usage" : 0,
      "cumulative_cardinality_usage" : 0,
      "t_test_usage" : 0,
      "rate_usage" : 0,
      "string_stats_usage" : 0,
      "moving_percentiles_usage" : 0,
      "multi_terms_usage" : 0
    }
  },
  "data_streams" : {
    "available" : true,
    "enabled" : true,
    "data_streams" : 0,
    "indices_count" : 0
  },
  "data_lifecycle" : {
    "available": true,
    "enabled": true,
    "count": 0,
    "default_rollover_used": true,
    "data_retention": {
      "configured_data_streams": 0
    },
    "effective_retention": {
      "retained_data_streams": 0
    },
    "global_retention": {
      "default": {
        "defined": false
      },
      "max": {
        "defined": false
      }
    }
  },
  "data_tiers" : {
    "available" : true,
    "enabled" : true,
    "data_warm" : {
      "node_count" : 0,
      "index_count" : 0,
      "total_shard_count" : 0,
      "primary_shard_count" : 0,
      "doc_count" : 0,
      "total_size_bytes" : 0,
      "primary_size_bytes" : 0,
      "primary_shard_size_avg_bytes" : 0,
      "primary_shard_size_median_bytes" : 0,
      "primary_shard_size_mad_bytes" : 0
    },
    "data_frozen" : {
      "node_count" : 1,
      "index_count" : 0,
      "total_shard_count" : 0,
      "primary_shard_count" : 0,
      "doc_count" : 0,
      "total_size_bytes" : 0,
      "primary_size_bytes" : 0,
      "primary_shard_size_avg_bytes" : 0,
      "primary_shard_size_median_bytes" : 0,
      "primary_shard_size_mad_bytes" : 0
    },
    "data_cold" : {
      "node_count" : 0,
      "index_count" : 0,
      "total_shard_count" : 0,
      "primary_shard_count" : 0,
      "doc_count" : 0,
      "total_size_bytes" : 0,
      "primary_size_bytes" : 0,
      "primary_shard_size_avg_bytes" : 0,
      "primary_shard_size_median_bytes" : 0,
      "primary_shard_size_mad_bytes" : 0
    },
    "data_content" : {
      "node_count" : 0,
      "index_count" : 0,
      "total_shard_count" : 0,
      "primary_shard_count" : 0,
      "doc_count" : 0,
      "total_size_bytes" : 0,
      "primary_size_bytes" : 0,
      "primary_shard_size_avg_bytes" : 0,
      "primary_shard_size_median_bytes" : 0,
      "primary_shard_size_mad_bytes" : 0
    },
    "data_hot" : {
      "node_count" : 0,
      "index_count" : 0,
      "total_shard_count" : 0,
      "primary_shard_count" : 0,
      "doc_count" : 0,
      "total_size_bytes" : 0,
      "primary_size_bytes" : 0,
      "primary_shard_size_avg_bytes" : 0,
      "primary_shard_size_median_bytes" : 0,
      "primary_shard_size_mad_bytes" : 0
    }
  },
  "aggregate_metric" : {
    "available" : true,
    "enabled" : true
  },
  "archive" : {
    "available" : true,
    "enabled" : true,
    "indices_count" : 0
  },
  "health_api" : {
    "available" : true,
    "enabled" : true,
    "invocations": {
      "total": 0
    }
  },
  "remote_clusters": {
    "size": 0,
    "mode": {
      "proxy": 0,
      "sniff": 0
    },
    "security": {
      "cert": 0,
      "api_key": 0
    }
  },
  "enterprise_search" : {
    "available": true,
    "enabled": true,
    "search_applications" : {
      "count": 0
    },
    "analytics_collections": {
      "count": 0
    },
    "query_rulesets": {
      "total_rule_count": 0,
      "total_count": 0,
      "min_rule_count": 0,
      "max_rule_count": 0
    }
  },
  "universal_profiling" : {
    "available" : true,
    "enabled" : true
  },
  "logsdb": {
    "available": true,
    "enabled": false,
    "indices_count": 0,
    "indices_with_synthetic_source": 0,
    "num_docs": 0,
    "size_in_bytes": 0,
    "has_custom_cutoff_date": false
  }
}
```