Get usage information Generally available

GET /_xpack/usage
Api key auth Basic auth Bearer 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

    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.

    Values are -1 or 0.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • aggregate_metric object Required
      Hide aggregate_metric attributes Show aggregate_metric attributes object
      • available boolean Required
      • enabled boolean Required
    • analytics object
      Hide analytics attributes Show analytics attributes object
      • available boolean Required
      • enabled boolean Required
      • stats object Required
        Hide stats attributes Show stats attributes object
        • 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
      Hide archive attributes Show archive attributes object
      • available boolean Required
      • enabled boolean Required
      • indices_count number Required
    • watcher object
      Hide watcher attributes Show watcher attributes object
      • available boolean Required
      • enabled boolean Required
      • execution object Required
        Hide execution attribute Show execution attribute object
        • actions object Required
      • watch object Required
        Hide watch attributes Show watch attributes object
        • input object Required
        • condition object
        • action object
      • count object Required Additional properties
        Hide count attributes Show count attributes object
        • active number Required
        • total number Required
    • ccr object
      Hide ccr attributes Show ccr attributes object
      • available boolean Required
      • enabled boolean Required
      • auto_follow_patterns_count number Required
      • follower_indices_count number Required
    • data_frame object
      Hide data_frame attributes Show data_frame attributes object
      • available boolean Required
      • enabled boolean Required
    • data_science object
      Hide data_science attributes Show data_science attributes object
      • available boolean Required
      • enabled boolean Required
    • data_streams object
      Hide data_streams attributes Show data_streams attributes object
      • available boolean Required
      • enabled boolean Required
      • data_streams number Required
      • indices_count number Required
    • data_tiers object
      Hide data_tiers attributes Show data_tiers attributes object
      • available boolean Required
      • enabled boolean Required
      • data_warm object Required
        Hide data_warm attributes Show data_warm attributes object
        • 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
        Hide data_frozen attributes Show data_frozen attributes object
        • 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_cold object Required
        Hide data_cold attributes Show data_cold attributes object
        • 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_content object Required
        Hide data_content attributes Show data_content attributes object
        • 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_hot object Required
        Hide data_hot attributes Show data_hot attributes object
        • 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
    • enrich object
      Hide enrich attributes Show enrich attributes object
      • available boolean Required
      • enabled boolean Required
    • eql object
      Hide eql attributes Show eql attributes object
      • available boolean Required
      • enabled boolean Required
      • features object Required
      • queries object Required
        Hide queries attribute Show queries attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • count number
          • failed number
          • paging number
          • total number
    • flattened object
      Hide flattened attributes Show flattened attributes object
      • available boolean Required
      • enabled boolean Required
      • field_count number Required
    • graph object Required
      Hide graph attributes Show graph attributes object
      • available boolean Required
      • enabled boolean Required
    • health_api object
      Hide health_api attributes Show health_api attributes object
      • available boolean Required
      • enabled boolean Required
      • invocations object Required
        Hide invocations attribute Show invocations attribute object
        • total number Required
    • ilm object Required
      Hide ilm attributes Show ilm attributes object
      • policy_count number Required
      • policy_stats array[object] Required
        Hide policy_stats attributes Show policy_stats attributes object
        • indices_managed number Required
        • phases object Required
    • logstash object Required
      Hide logstash attributes Show logstash attributes object
      • available boolean Required
      • enabled boolean Required
    • ml object
      Hide ml attributes Show ml attributes object
      • available boolean Required
      • enabled boolean Required
      • datafeeds object Required
        Hide datafeeds attribute Show datafeeds attribute object
        • * object Additional properties
          Hide * attribute Show * attribute object
          • count number Required
      • jobs object Required

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

        Hide jobs attribute Show jobs attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • count number Required
          • created_by object Required
      • node_count number Required
      • data_frame_analytics_jobs object Required
      • inference object Required
        Hide inference attribute Show inference attribute object
        • ingest_processors object Required
    • monitoring object
      Hide monitoring attributes Show monitoring attributes object
      • available boolean Required
      • enabled boolean Required
      • collection_enabled boolean Required
      • enabled_exporters object Required
        Hide enabled_exporters attribute Show enabled_exporters attribute object
        • * number Additional properties
    • rollup object Required
      Hide rollup attributes Show rollup attributes object
      • available boolean Required
      • enabled boolean Required
    • runtime_fields object
      Hide runtime_fields attributes Show runtime_fields attributes object
      • available boolean Required
      • enabled boolean Required
      • field_types array[object] Required
        Hide field_types attributes Show field_types attributes object
        • chars_max number Required
        • chars_total number Required
        • count number Required
        • doc_max number Required
        • doc_total number Required
        • index_count number Required
        • lang array[string] Required
        • lines_max number Required
        • lines_total number Required
        • name
        • scriptless_count number Required
        • shadowed_count number Required
        • source_max number Required
        • source_total number Required
    • spatial object Required
      Hide spatial attributes Show spatial attributes object
      • available boolean Required
      • enabled boolean Required
    • searchable_snapshots object
      Hide searchable_snapshots attributes Show searchable_snapshots attributes object
      • available boolean Required
      • enabled boolean Required
      • indices_count number Required
      • full_copy_indices_count number
      • shared_cache_indices_count number
    • security object
      Hide security attributes Show security attributes object
      • available boolean Required
      • enabled boolean Required
      • api_key_service object Required
        Hide api_key_service attribute Show api_key_service attribute object
        • enabled boolean Required
      • anonymous object Required
        Hide anonymous attribute Show anonymous attribute object
        • enabled boolean Required
      • fips_140 object Required
        Hide fips_140 attribute Show fips_140 attribute object
        • enabled boolean Required
      • ipfilter object Required
        Hide ipfilter attributes Show ipfilter attributes object
        • http boolean Required
        • transport boolean Required
      • realms object Required
      • role_mapping object Required
        Hide role_mapping attribute Show role_mapping attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • enabled number Required
          • size number Required
      • roles object Required
      • ssl object Required
      • system_key object
        Hide system_key attribute Show system_key attribute object
        • enabled boolean Required
      • token_service object Required
        Hide token_service attribute Show token_service attribute object
        • enabled boolean Required
      • operator_privileges object Required
        Hide operator_privileges attributes Show operator_privileges attributes object
        • available boolean Required
        • enabled boolean Required
    • slm object
      Hide slm attributes Show slm attributes object
      • available boolean Required
      • enabled boolean Required
      • policy_count number
      • policy_stats object
        Hide policy_stats attributes Show policy_stats attributes object
        • retention_failed number
        • retention_runs number
        • retention_timed_out number
        • total_snapshots_deleted number
        • total_snapshot_deletion_failures number
        • total_snapshots_failed number
        • total_snapshots_taken number
    • sql object
      Hide sql attributes Show sql attributes object
      • available boolean Required
      • enabled boolean Required
      • features object Required
        Hide features attribute Show features attribute object
        • * number Additional properties
      • queries object Required
        Hide queries attribute Show queries attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • count number
          • failed number
          • paging number
          • total number
    • transform object Required
      Hide transform attributes Show transform attributes object
      • available boolean Required
      • enabled boolean Required
    • vectors object
      Hide vectors attributes Show vectors attributes 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
    • voting_only object Required
      Hide voting_only attributes Show voting_only attributes object
      • available boolean Required
      • enabled boolean Required
GET /_xpack/usage 
GET /_xpack/usage

resp = client.xpack.usage()
const response = await client.xpack.usage();
response = client.xpack.usage
$resp = $client->xpack()->usage();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_xpack/usage"
client.xpack().usage(u -> u);
Response examples (200)
An abbreviated response from `GET /_xpack/usage`. 
{
  "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
  },
  "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
  }
}