Get usage information

  • GET /_xpack/usage
Auth

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

Query parameters

master_timeout string · default: 30s

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 required
available boolean required
enabled boolean required
analytics object required
available boolean required
enabled boolean required
stats object required
boxplot_usage number required
cumulative_cardinality_usage number required
string_stats_usage number required
top_metrics_usage number required
t_test_usage number required
moving_percentiles_usage number required
normalize_usage number required
rate_usage number required
multi_terms_usage number
archive object required
available boolean required
enabled boolean required
indices_count number required
watcher object required
available boolean required
enabled boolean required
execution object required
actions map string to object required
<string> object
total string required
total_time_in_ms number required
watch object required
input map string to object required
<string> object
active number required
total number required
condition map string to object
<string> object
active number required
total number required
action map string to object
<string> object
active number required
total number required
trigger object required
schedule object
active number required
total number required
cron object required
active number required
total number required
_all object required
active number required
total number required
_all object required
active number required
total number required
count object required
active number required
total number required
ccr object required
available boolean required
enabled boolean required
auto_follow_patterns_count number required
follower_indices_count number required
columnar object

Usage of the indices with index.mode set to columnar.

available boolean required
enabled boolean required
indices_count number required

The number of indices in this index mode.

indices_with_synthetic_source number required

The number of indices in this index mode that use synthetic _source.

num_docs number required

The number of documents in the indices in this index mode.

size_in_bytes number required

The size of the indices in this index mode, in bytes.

data_streams_count number required

The number of data streams in this index mode.

data_streams_managed_by_ilm number required

The number of data streams in this index mode that are managed by index lifecycle management.

data_streams_managed_by_dlm number required

The number of data streams in this index mode that are managed by data stream lifecycle.

data_frame object
available boolean required
enabled boolean required
data_science object
available boolean required
enabled boolean required
data_lifecycle object
available boolean required
enabled boolean required
count number

The number of data streams that have a lifecycle configured.

default_rollover_used boolean

Whether the default rollover configuration is used by at least one data stream.

data_retention object

Statistics about the explicitly configured data retention across data streams.

minimum_millis number

The smallest configured value in milliseconds.

maximum_millis number

The largest configured value in milliseconds.

average_millis number

The average configured value in milliseconds.

configured_data_streams number required

The number of data streams for which this value is configured.

effective_retention object

Statistics about the effective retention (configured or derived from global retention) across data streams.

minimum_millis number

The smallest configured value in milliseconds.

maximum_millis number

The largest configured value in milliseconds.

average_millis number

The average configured value in milliseconds.

retained_data_streams number required

The number of data streams for which an effective retention applies.

frozen_after object

Statistics about the configured frozen_after (searchable snapshot) tier threshold across data streams.

minimum_millis number

The smallest configured value in milliseconds.

maximum_millis number

The largest configured value in milliseconds.

average_millis number

The average configured value in milliseconds.

configured_data_streams number required

The number of data streams for which this value is configured.

global_retention object

Statistics about the cluster's global default and maximum retention settings.

default object required

Statistics about the cluster's default global retention.

defined boolean required

Whether this global retention is defined for the cluster.

affected_data_streams number

The number of data streams affected by this global retention.

retention_millis number

The global retention period in milliseconds.

max object required

Statistics about the cluster's maximum global retention.

defined boolean required

Whether this global retention is defined for the cluster.

affected_data_streams number

The number of data streams affected by this global retention.

retention_millis number

The global retention period in milliseconds.

data_streams object
available boolean required
enabled boolean required
data_streams number required
indices_count number required
data_tiers object required
available boolean required
enabled boolean required
data_warm object required
node_count number required
index_count number required
total_shard_count number required
primary_shard_count number required
doc_count number required
total_size_bytes number required
primary_size_bytes number required
primary_shard_size_avg_bytes number required
primary_shard_size_median_bytes number required
primary_shard_size_mad_bytes number required
data_frozen object
Same fields as data_warm in data_tiers
data_cold object required
Same fields as data_warm in data_tiers
data_content object required
Same fields as data_warm in data_tiers
data_hot object required
Same fields as data_warm in data_tiers
enrich object
available boolean required
enabled boolean required
eql object required
available boolean required
enabled boolean required
features object required
join number required
joins object required
join_queries_two number required
join_queries_three number required
join_until number required
join_queries_five_or_more number required
join_queries_four number required
keys object required
join_keys_two number required
join_keys_one number required
join_keys_three number required
join_keys_five_or_more number required
join_keys_four number required
event number required
pipes object required
pipe_tail number required
pipe_head number required
sequence number required
sequences object required
sequence_queries_three number required
sequence_queries_four number required
sequence_queries_two number required
sequence_until number required
sequence_queries_five_or_more number required
sequence_maxspan number required
queries map string to object required
<string> object
count number
failed number
paging number
total number
flattened object
available boolean required
enabled boolean required
field_count number required
graph object required
available boolean required
enabled boolean required
gpu_vector_indexing object
available boolean required
enabled boolean required
index_build_count number required

Total GPU index builds across the cluster.

nodes_with_gpu number required

Count of data nodes with GPU support.

nodes object[] required

Per-node GPU details including type, memory, enabled status, and build count.

type string required

GPU device type (e.g., "NVIDIA L4", "NVIDIA A100").

memory_in_bytes number required

GPU memory in bytes.

enabled boolean required

Whether GPU vector indexing is enabled on this node.

index_build_count number required

Number of GPU index builds performed on this node.

health_api object
available boolean required
enabled boolean required
invocations object required
total number required
ilm object required
policy_count number required
policy_stats object[] required
indices_managed number required
phases object required
cold object
actions string[] required
min_age number required
delete object
actions string[] required
min_age number required
frozen object
actions string[] required
min_age number required
hot object
actions string[] required
min_age number required
warm object
actions string[] required
min_age number required
logging object
querylog object required

Search query log configuration.

enabled boolean required

Whether query logging is enabled.

user boolean required

Whether user information is included in the query log.

system boolean required

Whether system queries are included in the query log.

threshold string

The configured logging threshold, if any.

esql object required

ES|QL query log configuration.

enabled boolean required

Whether ES|QL query logging is enabled.

user boolean required

Whether user information is included in the ES|QL query log.

thresholds map string to string

The configured logging thresholds, keyed by threshold name, if any.

logsdb_columnar object

Usage of the indices with index.mode set to logsdb_columnar.

available boolean required
enabled boolean required
indices_count number required

The number of indices in this index mode.

indices_with_synthetic_source number required

The number of indices in this index mode that use synthetic _source.

num_docs number required

The number of documents in the indices in this index mode.

size_in_bytes number required

The size of the indices in this index mode, in bytes.

data_streams_count number required

The number of data streams in this index mode.

data_streams_managed_by_ilm number required

The number of data streams in this index mode that are managed by index lifecycle management.

data_streams_managed_by_dlm number required

The number of data streams in this index mode that are managed by data stream lifecycle.

logstash object required
available boolean required
enabled boolean required
ml object required
available boolean required
enabled boolean required
datafeeds map string to object required
<string> object
count number required
jobs map string to object required

Job usage statistics. The _all entry is always present and gathers statistics for all jobs.

<string> object
count number required
created_by map string to number required
detectors object required
avg number required
max number required
min number required
total number required
forecasts object required
total number required
forecasted_jobs number required
model_size object required
avg number required
max number required
min number required
total number required
node_count number required
data_frame_analytics_jobs object required
memory_usage object
peak_usage_bytes object required
avg number required
max number required
min number required
total number required
_all object required
count number required
analysis_counts object
classification number
outlier_detection number
regression number
stopped object
count number required
inference object required
ingest_processors map string to object required
<string> object
num_docs_processed object required
max number required
sum number required
min number required
pipelines object required
count number required
num_failures object required
max number required
sum number required
min number required
time_ms object required
max number required
sum number required
min number required
trained_models object required
estimated_operations object
avg number required
max number required
min number required
total number required
estimated_heap_memory_usage_bytes object
avg number required
max number required
min number required
total number required
count object
total number required
prepackaged number required
other number required
pass_through number
regression number
classification number
ner number
text_embedding number
_all object required
count number required
model_size_bytes object
avg number required
max number required
min number required
total number required
deployments object
count number required
inference_counts object required
avg number required
max number required
min number required
total number required
model_sizes_bytes object required
avg number required
max number required
min number required
total number required
time_ms object required
avg number required
monitoring object required
available boolean required
enabled boolean required
collection_enabled boolean required
enabled_exporters map string to number required
rollup object required
available boolean required
enabled boolean required
runtime_fields object
available boolean required
enabled boolean required
field_types object[] required
chars_max number required
chars_total number required
count number required
doc_max number required
doc_total number required
index_count number required
lang string[] required
lines_max number required
lines_total number required
name string required
scriptless_count number required
shadowed_count number required
source_max number required
source_total number required
spatial object required
available boolean required
enabled boolean required
searchable_snapshots object required
available boolean required
enabled boolean required
indices_count number required
full_copy_indices_count number
shared_cache_indices_count number
security object required
available boolean required
enabled boolean required
api_key_service object required
enabled boolean required
anonymous object required
enabled boolean required
audit object required
enabled boolean required
outputs string[]
fips_140 object required
enabled boolean required
ipfilter object required
http boolean required
transport boolean required
realms map string to object required
<string> object
available boolean required
enabled boolean required
name string[]
order number[]
size number[]
cache object[]
size number required
has_authorization_realms boolean[]
has_default_username_pattern boolean[]
has_truststore boolean[]
is_authentication_delegated boolean[]
role_mapping map string to object required
<string> object
enabled number required
size number required
roles object required
native object required
dls boolean required
fls boolean required
size number required
dls object required
bit_set_cache object required
count number required

Number of entries in the cache.

memory number | string

Human-readable amount of memory taken up by the cache.

memory_in_bytes number required

Memory taken up by the cache in bytes.

hits number required

Total number of cache hits.

misses number required

Total number of cache misses.

evictions number required

Total number of cache evictions.

hits_time_in_millis number required

Total combined time spent in cache for hits in milliseconds.

misses_time_in_millis number required

Total combined time spent in cache for misses in milliseconds.

file object required
dls boolean required
fls boolean required
size number required
ssl object required
http object required
enabled boolean required
transport object required
enabled boolean required
system_key object
enabled boolean required
token_service object required
enabled boolean required
operator_privileges object required
available boolean required
enabled boolean required
slm object required
available boolean required
enabled boolean required
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 required
available boolean required
enabled boolean required
features map string to number required
queries map string to object required
<string> object
count number
failed number
paging number
total number
transform object required
available boolean required
enabled boolean required
vectors object
available boolean required
enabled boolean required
dense_vector_dims_avg_count number required
dense_vector_fields_count number required
sparse_vector_fields_count number
vectordb_document object
available boolean required
enabled boolean required
indices_count number required

The number of indices using the vectordb_document index mode.

num_docs number required

The total number of documents held across all vectordb_document indices.

vectordb_columnar object

The vectordb_columnar index mode is behind a feature flag. Without the flag, this section is still returned, disabled and with zero counts.

available boolean required
enabled boolean required
indices_count number required

The number of indices using the vectordb_columnar index mode.

num_docs number required

The total number of documents held across all vectordb_columnar indices.

voting_only object required
available boolean required
enabled boolean required