Get usage information
Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.
Query parameters
-
master_timeout string
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
-
200 application/json
Hide response attributes Show response attributes object
-
Additional properties are allowed.
-
analytics object
Additional properties are allowed.
Hide analytics attributes Show analytics attributes object
-
Additional properties are allowed.
Hide stats attributes Show stats attributes object
-
multi_terms_usage number
-
archive object
Additional properties are allowed.
Hide archive attributes Show archive attributes object
-
watcher object
Additional properties are allowed.
Hide watcher attributes Show watcher attributes object
-
Additional properties are allowed.
Hide execution attribute Show execution attribute object
-
Hide actions attribute Show actions attribute object
-
Additional properties are allowed.
Hide * attributes Show * attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
-
-
-
Additional properties are allowed.
Hide watch attributes Show watch attributes object
-
Additional properties are allowed.
-
ccr object
Additional properties are allowed.
Hide ccr attributes Show ccr attributes object
-
data_frame object
Additional properties are allowed.
-
data_science object
Additional properties are allowed.
-
data_streams object
Additional properties are allowed.
Hide data_streams attributes Show data_streams attributes object
-
data_tiers object
Additional properties are allowed.
Hide data_tiers attributes Show data_tiers attributes object
-
Additional properties are allowed.
Hide data_warm attributes Show data_warm attributes object
-
data_frozen object
Additional properties are allowed.
Hide data_frozen attributes Show data_frozen attributes object
-
Additional properties are allowed.
Hide data_cold attributes Show data_cold attributes object
-
Additional properties are allowed.
Hide data_content attributes Show data_content attributes object
-
Additional properties are allowed.
Hide data_hot attributes Show data_hot attributes object
-
enrich object
Additional properties are allowed.
-
eql object
Additional properties are allowed.
Hide eql attributes Show eql attributes object
-
Additional properties are allowed.
Hide features attributes Show features attributes object
-
Additional properties are allowed.
Hide joins attributes Show joins attributes object
-
Additional properties are allowed.
Hide keys attributes Show keys attributes object
-
Additional properties are allowed.
-
Additional properties are allowed.
Hide sequences attributes Show sequences attributes object
-
flattened object
Additional properties are allowed.
Hide flattened attributes Show flattened attributes object
-
frozen_indices object
Additional properties are allowed.
Hide frozen_indices attributes Show frozen_indices attributes object
-
Additional properties are allowed.
-
health_api object
Additional properties are allowed.
Hide health_api attributes Show health_api attributes object
-
Additional properties are allowed.
Hide invocations attribute Show invocations attribute object
-
Additional properties are allowed.
Hide ilm attributes Show ilm attributes object
-
Hide policy_stats attributes Show policy_stats attributes object
-
Additional properties are allowed.
Hide phases attributes Show phases attributes object
-
Additional properties are allowed.
-
ml object
Additional properties are allowed.
Hide ml attributes Show ml attributes object
-
Job usage statistics. The
_all
entry is always present and gathers statistics for all jobs.Hide jobs attribute Show jobs attribute object
-
Additional properties are allowed.
Hide * attributes Show * attributes object
-
Hide created_by attribute Show created_by attribute object
-
Additional properties are allowed.
-
Additional properties are allowed.
Hide forecasts attributes Show forecasts attributes object
-
Additional properties are allowed.
-
-
Additional properties are allowed.
Hide data_frame_analytics_jobs attributes Show data_frame_analytics_jobs attributes object
-
memory_usage object
Additional properties are allowed.
Hide memory_usage attribute Show memory_usage attribute object
-
Additional properties are allowed.
-
-
Additional properties are allowed.
Hide _all attribute Show _all attribute object
-
analysis_counts object
Additional properties are allowed.
Hide analysis_counts attributes Show analysis_counts attributes object
-
classification number
-
outlier_detection number
-
regression number
-
-
stopped object
Additional properties are allowed.
Hide stopped attribute Show stopped attribute object
-
-
Additional properties are allowed.
Hide inference attributes Show inference attributes object
-
Hide ingest_processors attribute Show ingest_processors attribute object
-
Additional properties are allowed.
Hide * attributes Show * attributes object
-
Additional properties are allowed.
-
Additional properties are allowed.
-
Additional properties are allowed.
-
Additional properties are allowed.
-
-
-
Additional properties are allowed.
Hide trained_models attributes Show trained_models attributes object
-
estimated_operations object
Additional properties are allowed.
-
Additional properties are allowed.
-
count object
Additional properties are allowed.
Hide count attributes Show count attributes object
-
pass_through number
-
regression number
-
classification number
-
ner number
-
text_embedding number
-
Additional properties are allowed.
Hide _all attribute Show _all attribute object
-
model_size_bytes object
Additional properties are allowed.
-
-
deployments object
Additional properties are allowed.
Hide deployments attributes Show deployments attributes object
-
Additional properties are allowed.
-
Additional properties are allowed.
-
Additional properties are allowed.
Hide time_ms attribute Show time_ms attribute object
-
-
monitoring object
Additional properties are allowed.
Hide monitoring attributes Show monitoring attributes object
-
Hide enabled_exporters attribute Show enabled_exporters attribute object
-
Additional properties are allowed.
-
runtime_fields object
Additional properties are allowed.
Hide runtime_fields attributes Show runtime_fields attributes object
-
Hide field_types attributes Show field_types attributes object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
Additional properties are allowed.
-
searchable_snapshots object
Additional properties are allowed.
Hide searchable_snapshots attributes Show searchable_snapshots attributes object
-
full_copy_indices_count number
-
shared_cache_indices_count number
-
security object
Additional properties are allowed.
Hide security attributes Show security attributes object
-
Additional properties are allowed.
Hide api_key_service attribute Show api_key_service attribute object
-
Additional properties are allowed.
Hide anonymous attribute Show anonymous attribute object
-
audit object
Additional properties are allowed.
-
Additional properties are allowed.
Hide fips_140 attribute Show fips_140 attribute object
-
Additional properties are allowed.
-
Additional properties are allowed.
Hide roles attributes Show roles attributes object
-
Additional properties are allowed.
-
Additional properties are allowed.
Hide dls attribute Show dls attribute object
-
Additional properties are allowed.
Hide bit_set_cache attributes Show bit_set_cache attributes object
-
-
Additional properties are allowed.
-
-
Additional properties are allowed.
Hide ssl attributes Show ssl attributes object
-
system_key object
Additional properties are allowed.
Hide system_key attribute Show system_key attribute object
-
Additional properties are allowed.
Hide token_service attribute Show token_service attribute object
-
Additional properties are allowed.
-
slm object
Additional properties are allowed.
Hide slm attributes Show slm attributes object
-
policy_count number
-
policy_stats object
Additional properties are allowed.
Hide policy_stats attributes Show policy_stats attributes object
-
retention_deletion_time string
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
Time unit for milliseconds
-
retention_failed number
-
retention_runs number
-
retention_timed_out number
-
policy string
-
total_snapshots_deleted number
-
total_snapshots_failed number
-
total_snapshots_taken number
-
-
sql object
Additional properties are allowed.
Hide sql attributes Show sql attributes object
-
Hide features attribute Show features attribute object
-
Additional properties are allowed.
-
vectors object
Additional properties are allowed.
Hide vectors attributes Show vectors attributes object
-
sparse_vector_fields_count number
-
Additional properties are allowed.
-
curl \
-X GET http://api.example.com/_xpack/usage
{
"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
}
}