Get node statistics | Elasticsearch API documentation (v8)

Get behavioral analytics collections Technical preview; Added in 8.8.0

GET /_application/analytics/{name}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_application/analytics

GET /_application/analytics/{name}

Path parameters

name array[string] Required

A list of analytics collections to limit the returned information

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attribute Show * attribute object
  
  event_data_stream object Required
  
  Data stream for the collection.
  
  Hide event_data_stream attribute Show event_data_stream attribute object
  
  name string Required

GET /_application/analytics/{name}

GET _application/analytics/my*

resp = client.search_application.get_behavioral_analytics(
    name="my*",
)

const response = await client.searchApplication.getBehavioralAnalytics({
  name: "my*",
});

response = client.search_application.get_behavioral_analytics(
  name: "my*"
)

$resp = $client->searchApplication()->getBehavioralAnalytics([
    "name" => "my*",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_application/analytics/my*"

client.searchApplication().getBehavioralAnalytics(g -> g
    .name("my*")
);

Response examples (200)

A successful response from `GET _application/analytics/my*`

{
  "my_analytics_collection": {
      "event_data_stream": {
          "name": "behavioral_analytics-events-my_analytics_collection"
      }
  },
  "my_analytics_collection2": {
      "event_data_stream": {
          "name": "behavioral_analytics-events-my_analytics_collection2"
      }
  }
}

Create a behavioral analytics collection Technical preview; Added in 8.8.0

PUT /_application/analytics/{name}

Api key auth Basic auth Bearer auth

Path parameters

name string Required

The name of the analytics collection to be created or updated.

Responses

200 application/json
Hide response attributes Show response attributes object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.
- name string Required
  
  The name of the analytics collection created or updated

PUT /_application/analytics/{name}

PUT _application/analytics/my_analytics_collection

resp = client.search_application.put_behavioral_analytics(
    name="my_analytics_collection",
)

const response = await client.searchApplication.putBehavioralAnalytics({
  name: "my_analytics_collection",
});

response = client.search_application.put_behavioral_analytics(
  name: "my_analytics_collection"
)

$resp = $client->searchApplication()->putBehavioralAnalytics([
    "name" => "my_analytics_collection",
]);

curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_application/analytics/my_analytics_collection"

client.searchApplication().putBehavioralAnalytics(p -> p
    .name("my_analytics_collection")
);

Delete a behavioral analytics collection Technical preview; Added in 8.8.0

DELETE /_application/analytics/{name}

Api key auth Basic auth Bearer auth

The associated data stream is also deleted.

Path parameters

name string Required

The name of the analytics collection to be deleted

Responses

200 application/json
Hide response attribute Show response attribute object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.

DELETE /_application/analytics/{name}

DELETE _application/analytics/my_analytics_collection/

resp = client.search_application.delete_behavioral_analytics(
    name="my_analytics_collection",
)

const response = await client.searchApplication.deleteBehavioralAnalytics({
  name: "my_analytics_collection",
});

response = client.search_application.delete_behavioral_analytics(
  name: "my_analytics_collection"
)

$resp = $client->searchApplication()->deleteBehavioralAnalytics([
    "name" => "my_analytics_collection",
]);

curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_application/analytics/my_analytics_collection/"

client.searchApplication().deleteBehavioralAnalytics(d -> d
    .name("my_analytics_collection")
);

Create a behavioral analytics collection event Technical preview

POST /_application/analytics/{collection_name}/event/{event_type}

Api key auth Basic auth Bearer auth

External documentation

Path parameters

collection_name string Required

The name of the behavioral analytics collection.
event_type string

The analytics event type.

Values are page_view, search, or search_click.

Query parameters

debug boolean

Whether the response type has to include more details

application/json

Body Required

object

Responses

200 application/json
Hide response attributes Show response attributes object
- accepted boolean Required
- event object

POST /_application/analytics/{collection_name}/event/{event_type}

POST _application/analytics/my_analytics_collection/event/search_click
{
  "session": {
    "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
  },
  "user": {
    "id": "5f26f01a-bbee-4202-9298-81261067abbd"
  },
  "search":{
    "query": "search term",
    "results": {
      "items": [
        {
          "document": {
            "id": "123",
            "index": "products"
          }
        }
      ],
      "total_results": 10
    },
    "sort": {
      "name": "relevance"
    },
    "search_application": "website"
  },
  "document":{
    "id": "123",
    "index": "products"
  }
}

resp = client.search_application.post_behavioral_analytics_event(
    collection_name="my_analytics_collection",
    event_type="search_click",
    payload={
        "session": {
            "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
        },
        "user": {
            "id": "5f26f01a-bbee-4202-9298-81261067abbd"
        },
        "search": {
            "query": "search term",
            "results": {
                "items": [
                    {
                        "document": {
                            "id": "123",
                            "index": "products"
                        }
                    }
                ],
                "total_results": 10
            },
            "sort": {
                "name": "relevance"
            },
            "search_application": "website"
        },
        "document": {
            "id": "123",
            "index": "products"
        }
    },
)

const response = await client.searchApplication.postBehavioralAnalyticsEvent({
  collection_name: "my_analytics_collection",
  event_type: "search_click",
  payload: {
    session: {
      id: "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9",
    },
    user: {
      id: "5f26f01a-bbee-4202-9298-81261067abbd",
    },
    search: {
      query: "search term",
      results: {
        items: [
          {
            document: {
              id: "123",
              index: "products",
            },
          },
        ],
        total_results: 10,
      },
      sort: {
        name: "relevance",
      },
      search_application: "website",
    },
    document: {
      id: "123",
      index: "products",
    },
  },
});

response = client.search_application.post_behavioral_analytics_event(
  collection_name: "my_analytics_collection",
  event_type: "search_click",
  body: {
    "session": {
      "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
    },
    "user": {
      "id": "5f26f01a-bbee-4202-9298-81261067abbd"
    },
    "search": {
      "query": "search term",
      "results": {
        "items": [
          {
            "document": {
              "id": "123",
              "index": "products"
            }
          }
        ],
        "total_results": 10
      },
      "sort": {
        "name": "relevance"
      },
      "search_application": "website"
    },
    "document": {
      "id": "123",
      "index": "products"
    }
  }
)

$resp = $client->searchApplication()->postBehavioralAnalyticsEvent([
    "collection_name" => "my_analytics_collection",
    "event_type" => "search_click",
    "body" => [
        "session" => [
            "id" => "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9",
        ],
        "user" => [
            "id" => "5f26f01a-bbee-4202-9298-81261067abbd",
        ],
        "search" => [
            "query" => "search term",
            "results" => [
                "items" => array(
                    [
                        "document" => [
                            "id" => "123",
                            "index" => "products",
                        ],
                    ],
                ),
                "total_results" => 10,
            ],
            "sort" => [
                "name" => "relevance",
            ],
            "search_application" => "website",
        ],
        "document" => [
            "id" => "123",
            "index" => "products",
        ],
    ],
]);

curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"session":{"id":"1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"},"user":{"id":"5f26f01a-bbee-4202-9298-81261067abbd"},"search":{"query":"search term","results":{"items":[{"document":{"id":"123","index":"products"}}],"total_results":10},"sort":{"name":"relevance"},"search_application":"website"},"document":{"id":"123","index":"products"}}' "$ELASTICSEARCH_URL/_application/analytics/my_analytics_collection/event/search_click"

client.searchApplication().postBehavioralAnalyticsEvent(p -> p
    .collectionName("my_analytics_collection")
    .eventType(EventType.SearchClick)
    .payload(JsonData.fromJson("{\"session\":{\"id\":\"1797ca95-91c9-4e2e-b1bd-9c38e6f386a9\"},\"user\":{\"id\":\"5f26f01a-bbee-4202-9298-81261067abbd\"},\"search\":{\"query\":\"search term\",\"results\":{\"items\":[{\"document\":{\"id\":\"123\",\"index\":\"products\"}}],\"total_results\":10},\"sort\":{\"name\":\"relevance\"},\"search_application\":\"website\"},\"document\":{\"id\":\"123\",\"index\":\"products\"}}"))
);

Request example

Run `POST _application/analytics/my_analytics_collection/event/search_click` to send a `search_click` event to an analytics collection called `my_analytics_collection`.

{
  "session": {
    "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
  },
  "user": {
    "id": "5f26f01a-bbee-4202-9298-81261067abbd"
  },
  "search":{
    "query": "search term",
    "results": {
      "items": [
        {
          "document": {
            "id": "123",
            "index": "products"
          }
        }
      ],
      "total_results": 10
    },
    "sort": {
      "name": "relevance"
    },
    "search_application": "website"
  },
  "document":{
    "id": "123",
    "index": "products"
  }
}

Get aliases Generally available

GET /_cat/aliases/{name}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/aliases

GET /_cat/aliases/{name}

Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

Required authorization

Index privileges: view_index_metadata

Path parameters

name string | array[string]

A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

Query parameters

h string | array[string]
A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:
- alias (or a): The name of the alias.
- index (or i, idx): The name of the index the alias points to.
- filter (or f, fi): The filter applied to the alias.
- routing.index (or ri, routingIndex): Index routing value for the alias.
- routing.search (or rs, routingSearch): Search routing value for the alias.
- is_write_index (or w, isWriteIndex): Indicates if the index is the write index for the alias.
Values are alias, a, index, i, idx, filter, f, fi, routing.index, ri, routingIndex, routing.search, rs, routingSearch, is_write_index, w, or isWriteIndex.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
expand_wildcards string | array[string]
The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
Values are all, open, closed, hidden, or none.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

Responses

200 application/json
Hide response attributes Show response attributes object
- alias string
  
  alias name
- index string
  
  index alias points to
- filter string
  
  filter
- routing.index string
  
  index routing
- routing.search string
  
  search routing
- is_write_index string
  
  write index

GET /_cat/aliases/{name}

GET _cat/aliases?format=json&v=true

resp = client.cat.aliases(
    format="json",
    v=True,
)

const response = await client.cat.aliases({
  format: "json",
  v: "true",
});

response = client.cat.aliases(
  format: "json",
  v: "true"
)

$resp = $client->cat()->aliases([
    "format" => "json",
    "v" => "true",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/aliases?format=json&v=true"

client.cat().aliases();

Response examples (200)

A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.

[
  {
    "alias": "alias1",
    "index": "test1",
    "filter": "-",
    "routing.index": "-",
    "routing.search": "-",
    "is_write_index": "true"
  },
  {
    "alias": "alias1",
    "index": "test1",
    "filter": "*",
    "routing.index": "-",
    "routing.search": "-",
    "is_write_index": "true"
  },
  {
    "alias": "alias3",
    "index": "test1",
    "filter": "-",
    "routing.index": "1",
    "routing.search": "1",
    "is_write_index": "true"
  },
  {
    "alias": "alias4",
    "index": "test1",
    "filter": "-",
    "routing.index": "2",
    "routing.search": "1,2",
    "is_write_index": "true"
  }
]

Get component templates Generally available; Added in 5.1.0

GET /_cat/component_templates/{name}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/component_templates

GET /_cat/component_templates/{name}

Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

Required authorization

Cluster privileges: monitor

Path parameters

name string Required

The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

Query parameters

h string | array[string]
A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:
- name (or n): The name of the component template.
- version (or v): The version number of the component template.
- alias_count (or a): The number of aliases in the component template.
- mapping_count (or m): The number of mappings in the component template.
- settings_count (or s): The number of settings in the component template.
- metadata_count (or me): The number of metadata entries in the component template.
- included_in (or i): The index templates that include this component template.
Values are name, n, version, v, alias_count, a, mapping_count, m, settings_count, s, metadata_count, me, included_in, or i.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

The period to wait for a connection to the master node.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- name string Required
- version string | null Required
  
  One of:
  string-1 string string-2 string | null
- alias_count string Required
- mapping_count string Required
- settings_count string Required
- metadata_count string Required
- included_in string Required

GET /_cat/component_templates/{name}

GET _cat/component_templates/my-template-*?v=true&s=name&format=json

resp = client.cat.component_templates(
    name="my-template-*",
    v=True,
    s="name",
    format="json",
)

const response = await client.cat.componentTemplates({
  name: "my-template-*",
  v: "true",
  s: "name",
  format: "json",
});

response = client.cat.component_templates(
  name: "my-template-*",
  v: "true",
  s: "name",
  format: "json"
)

$resp = $client->cat()->componentTemplates([
    "name" => "my-template-*",
    "v" => "true",
    "s" => "name",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/component_templates/my-template-*?v=true&s=name&format=json"

client.cat().componentTemplates();

Response examples (200)

A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.

[
  {
    "name": "my-template-1",
    "version": "null",
    "alias_count": "0",
    "mapping_count": "0",
    "settings_count": "1",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  },
    {
    "name": "my-template-2",
    "version": null,
    "alias_count": "0",
    "mapping_count": "3",
    "settings_count": "0",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  }
]

Get index information Generally available

GET /_cat/indices/{index}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/indices

GET /_cat/indices/{index}

Get high-level information about indices in a cluster, including backing indices for data streams.

Use this request to get the following information for each index in a cluster:

shard count
document count
deleted document count
primary store size
total store size of all shards, including shard replicas

These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.

CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.

Required authorization

Index privileges: monitor
Cluster privileges: monitor

Path parameters

index string | array[string] Required

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
expand_wildcards string | array[string]
The type of index that wildcard patterns can match.

Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
Values are all, open, closed, hidden, or none.
health string
The health status used to limit returned indices. By default, the response includes indices of any health status.

Supported values include:
- green (or GREEN): All shards are assigned.
- yellow (or YELLOW): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.
- red (or RED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.
- unknown
- unavailable
Values are green, GREEN, yellow, YELLOW, red, RED, unknown, or unavailable.
include_unloaded_segments boolean

If true, the response includes information from segments that are not loaded into memory.
pri boolean

If true, the response only includes information from primary shards.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

Responses

200 application/json
Hide response attributes Show response attributes object
- health string
  
  current health status
- status string
  
  open/close status
- index string
  
  index name
- uuid string
  
  index uuid
- pri string
  
  number of primary shards
- rep string
  
  number of replica shards
- docs.count string | null
  
  available docs
  
  One of:
  string-1 string string-2 string | null
- docs.deleted string | null
  
  deleted docs
  
  One of:
  string-1 string string-2 string | null
- creation.date string
  
  index creation date (millisecond value)
- creation.date.string string
  
  index creation date (as string)
- store.size string | null
  
  store size of primaries & replicas
  
  One of:
  string-1 string string-2 string | null
- pri.store.size string | null
  
  store size of primaries
  
  One of:
  string-1 string string-2 string | null
- dataset.size string | null
  
  total size of dataset (including the cache for partially mounted indices)
  
  One of:
  string-1 string string-2 string | null
- completion.size string
  
  size of completion
- pri.completion.size string
  
  size of completion
- fielddata.memory_size string
  
  used fielddata cache
- pri.fielddata.memory_size string
  
  used fielddata cache
- fielddata.evictions string
  
  fielddata evictions
- pri.fielddata.evictions string
  
  fielddata evictions
- query_cache.memory_size string
  
  used query cache
- pri.query_cache.memory_size string
  
  used query cache
- query_cache.evictions string
  
  query cache evictions
- pri.query_cache.evictions string
  
  query cache evictions
- request_cache.memory_size string
  
  used request cache
- pri.request_cache.memory_size string
  
  used request cache
- request_cache.evictions string
  
  request cache evictions
- pri.request_cache.evictions string
  
  request cache evictions
- request_cache.hit_count string
  
  request cache hit count
- pri.request_cache.hit_count string
  
  request cache hit count
- request_cache.miss_count string
  
  request cache miss count
- pri.request_cache.miss_count string
  
  request cache miss count
- flush.total string
  
  number of flushes
- pri.flush.total string
  
  number of flushes
- flush.total_time string
  
  time spent in flush
- pri.flush.total_time string
  
  time spent in flush
- get.current string
  
  number of current get ops
- pri.get.current string
  
  number of current get ops
- get.time string
  
  time spent in get
- pri.get.time string
  
  time spent in get
- get.total string
  
  number of get ops
- pri.get.total string
  
  number of get ops
- get.exists_time string
  
  time spent in successful gets
- pri.get.exists_time string
  
  time spent in successful gets
- get.exists_total string
  
  number of successful gets
- pri.get.exists_total string
  
  number of successful gets
- get.missing_time string
  
  time spent in failed gets
- pri.get.missing_time string
  
  time spent in failed gets
- get.missing_total string
  
  number of failed gets
- pri.get.missing_total string
  
  number of failed gets
- indexing.delete_current string
  
  number of current deletions
- pri.indexing.delete_current string
  
  number of current deletions
- indexing.delete_time string
  
  time spent in deletions
- pri.indexing.delete_time string
  
  time spent in deletions
- indexing.delete_total string
  
  number of delete ops
- pri.indexing.delete_total string
  
  number of delete ops
- indexing.index_current string
  
  number of current indexing ops
- pri.indexing.index_current string
  
  number of current indexing ops
- indexing.index_time string
  
  time spent in indexing
- pri.indexing.index_time string
  
  time spent in indexing
- indexing.index_total string
  
  number of indexing ops
- pri.indexing.index_total string
  
  number of indexing ops
- indexing.index_failed string
  
  number of failed indexing ops
- pri.indexing.index_failed string
  
  number of failed indexing ops
- merges.current string
  
  number of current merges
- pri.merges.current string
  
  number of current merges
- merges.current_docs string
  
  number of current merging docs
- pri.merges.current_docs string
  
  number of current merging docs
- merges.current_size string
  
  size of current merges
- pri.merges.current_size string
  
  size of current merges
- merges.total string
  
  number of completed merge ops
- pri.merges.total string
  
  number of completed merge ops
- merges.total_docs string
  
  docs merged
- pri.merges.total_docs string
  
  docs merged
- merges.total_size string
  
  size merged
- pri.merges.total_size string
  
  size merged
- merges.total_time string
  
  time spent in merges
- pri.merges.total_time string
  
  time spent in merges
- refresh.total string
  
  total refreshes
- pri.refresh.total string
  
  total refreshes
- refresh.time string
  
  time spent in refreshes
- pri.refresh.time string
  
  time spent in refreshes
- refresh.external_total string
  
  total external refreshes
- pri.refresh.external_total string
  
  total external refreshes
- refresh.external_time string
  
  time spent in external refreshes
- pri.refresh.external_time string
  
  time spent in external refreshes
- refresh.listeners string
  
  number of pending refresh listeners
- pri.refresh.listeners string
  
  number of pending refresh listeners
- search.fetch_current string
  
  current fetch phase ops
- pri.search.fetch_current string
  
  current fetch phase ops
- search.fetch_time string
  
  time spent in fetch phase
- pri.search.fetch_time string
  
  time spent in fetch phase
- search.fetch_total string
  
  total fetch ops
- pri.search.fetch_total string
  
  total fetch ops
- search.open_contexts string
  
  open search contexts
- pri.search.open_contexts string
  
  open search contexts
- search.query_current string
  
  current query phase ops
- pri.search.query_current string
  
  current query phase ops
- search.query_time string
  
  time spent in query phase
- pri.search.query_time string
  
  time spent in query phase
- search.query_total string
  
  total query phase ops
- pri.search.query_total string
  
  total query phase ops
- search.scroll_current string
  
  open scroll contexts
- pri.search.scroll_current string
  
  open scroll contexts
- search.scroll_time string
  
  time scroll contexts held open
- pri.search.scroll_time string
  
  time scroll contexts held open
- search.scroll_total string
  
  completed scroll contexts
- pri.search.scroll_total string
  
  completed scroll contexts
- segments.count string
  
  number of segments
- pri.segments.count string
  
  number of segments
- segments.memory string
  
  memory used by segments
- pri.segments.memory string
  
  memory used by segments
- segments.index_writer_memory string
  
  memory used by index writer
- pri.segments.index_writer_memory string
  
  memory used by index writer
- segments.version_map_memory string
  
  memory used by version map
- pri.segments.version_map_memory string
  
  memory used by version map
- segments.fixed_bitset_memory string
  
  memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields
- pri.segments.fixed_bitset_memory string
  
  memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields
- warmer.current string
  
  current warmer ops
- pri.warmer.current string
  
  current warmer ops
- warmer.total string
  
  total warmer ops
- pri.warmer.total string
  
  total warmer ops
- warmer.total_time string
  
  time spent in warmers
- pri.warmer.total_time string
  
  time spent in warmers
- suggest.current string
  
  number of current suggest ops
- pri.suggest.current string
  
  number of current suggest ops
- suggest.time string
  
  time spend in suggest
- pri.suggest.time string
  
  time spend in suggest
- suggest.total string
  
  number of suggest ops
- pri.suggest.total string
  
  number of suggest ops
- memory.total string
  
  total used memory
- pri.memory.total string
  
  total user memory
- search.throttled string
  
  indicates if the index is search throttled
- bulk.total_operations string
  
  number of bulk shard ops
- pri.bulk.total_operations string
  
  number of bulk shard ops
- bulk.total_time string
  
  time spend in shard bulk
- pri.bulk.total_time string
  
  time spend in shard bulk
- bulk.total_size_in_bytes string
  
  total size in bytes of shard bulk
- pri.bulk.total_size_in_bytes string
  
  total size in bytes of shard bulk
- bulk.avg_time string
  
  average time spend in shard bulk
- pri.bulk.avg_time string
  
  average time spend in shard bulk
- bulk.avg_size_in_bytes string
  
  average size in bytes of shard bulk
- pri.bulk.avg_size_in_bytes string
  
  average size in bytes of shard bulk

GET /_cat/indices/{index}

GET /_cat/indices/my-index-*?v=true&s=index&format=json

resp = client.cat.indices(
    index="my-index-*",
    v=True,
    s="index",
    format="json",
)

const response = await client.cat.indices({
  index: "my-index-*",
  v: "true",
  s: "index",
  format: "json",
});

response = client.cat.indices(
  index: "my-index-*",
  v: "true",
  s: "index",
  format: "json"
)

$resp = $client->cat()->indices([
    "index" => "my-index-*",
    "v" => "true",
    "s" => "index",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/indices/my-index-*?v=true&s=index&format=json"

client.cat().indices();

Response examples (200)

A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.

[
  {
    "health": "yellow",
    "status": "open",
    "index": "my-index-000001",
    "uuid": "u8FNjxh8Rfy_awN11oDKYQ",
    "pri": "1",
    "rep": "1",
    "docs.count": "1200",
    "docs.deleted": "0",
    "store.size": "88.1kb",
    "pri.store.size": "88.1kb",
    "dataset.size": "88.1kb"
  },
  {
    "health": "green",
    "status": "open",
    "index": "my-index-000002",
    "uuid": "nYFWZEO7TUiOjLQXBaYJpA ",
    "pri": "1",
    "rep": "0",
    "docs.count": "0",
    "docs.deleted": "0",
    "store.size": "260b",
    "pri.store.size": "260b",
    "dataset.size": "260b"
  }
]

Get node attribute information Generally available

GET /_cat/nodeattrs

Api key auth Basic auth Bearer auth

Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Required authorization

Cluster privileges: monitor

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- node string
  
  The node name.
- id string
  
  The unique node identifier.
- pid string
  
  The process identifier.
- host string
  
  The host name.
- ip string
  
  The IP address.
- port string
  
  The bound transport port.
- attr string
  
  The attribute name.
- value string
  
  The attribute value.

GET /_cat/nodeattrs

GET /_cat/nodeattrs?v=true&format=json

resp = client.cat.nodeattrs(
    v=True,
    format="json",
)

const response = await client.cat.nodeattrs({
  v: "true",
  format: "json",
});

response = client.cat.nodeattrs(
  v: "true",
  format: "json"
)

$resp = $client->cat()->nodeattrs([
    "v" => "true",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/nodeattrs?v=true&format=json"

client.cat().nodeattrs();

Response examples (200)

A successful response from `GET /_cat/nodeattrs?v=true&format=json`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line.

[
  {
    "node": "node-0",
    "host": "127.0.0.1",
    "ip": "127.0.0.1",
    "attr": "testattr",
    "value": "test"
  }
]

A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`. It returns the `name`, `pid`, `attr`, and `value` columns.

[
  {
    "name": "node-0",
    "pid": "19566",
    "attr": "testattr",
    "value": "test"
  }
]

Get node information Generally available

GET /_cat/nodes

Api key auth Basic auth Bearer auth

Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Required authorization

Cluster privileges: monitor

Query parameters

bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
full_id boolean | string

If true, return the full node ID. If false, return the shortened node ID.
include_unloaded_segments boolean

If true, the response includes information from segments that are not loaded into memory.
h string | array[string]
A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:
- build (or b): The Elasticsearch build hash. For example: 5c03844.
- completion.size (or cs, completionSize): The size of completion. For example: 0b.
- cpu: The percentage of recent system CPU used.
- disk.avail (or d, disk, diskAvail): The available disk space. For example: 198.4gb.
- disk.total (or dt, diskTotal): The total disk space. For example: 458.3gb.
- disk.used (or du, diskUsed): The used disk space. For example: 259.8gb.
- disk.used_percent (or dup, diskUsedPercent): The percentage of disk space used.
- fielddata.evictions (or fe, fielddataEvictions): The number of fielddata cache evictions.
- fielddata.memory_size (or fm, fielddataMemory): The fielddata cache memory used. For example: 0b.
- file_desc.current (or fdc, fileDescriptorCurrent): The number of file descriptors used.
- file_desc.max (or fdm, fileDescriptorMax): The maximum number of file descriptors.
- file_desc.percent (or fdp, fileDescriptorPercent): The percentage of file descriptors used.
- flush.total (or ft, flushTotal): The number of flushes.
- flush.total_time (or ftt, flushTotalTime): The amount of time spent in flush.
- get.current (or gc, getCurrent): The number of current get operations.
- get.exists_time (or geti, getExistsTime): The time spent in successful get operations. For example: 14ms.
- get.exists_total (or geto, getExistsTotal): The number of successful get operations.
- get.missing_time (or gmti, getMissingTime): The time spent in failed get operations. For example: 0s.
- get.missing_total (or gmto, getMissingTotal): The number of failed get operations.
- get.time (or gti, getTime): The amount of time spent in get operations. For example: 14ms.
- get.total (or gto, getTotal): The number of get operations.
- heap.current (or hc, heapCurrent): The used heap size. For example: 311.2mb.
- heap.max (or hm, heapMax): The total heap size. For example: 4gb.
- heap.percent (or hp, heapPercent): The used percentage of total allocated Elasticsearch JVM heap. This value reflects only the Elasticsearch process running within the operating system and is the most direct indicator of its JVM, heap, or memory resource performance.
- http_address (or http): The bound HTTP address.
- id (or nodeId): The identifier for the node.
- indexing.delete_current (or idc, indexingDeleteCurrent): The number of current deletion operations.
- indexing.delete_time (or idti, indexingDeleteTime): The time spent in deletion operations. For example: 2ms.
- indexing.delete_total (or idto, indexingDeleteTotal): The number of deletion operations.
- indexing.index_current (or iic, indexingIndexCurrent): The number of current indexing operations.
- indexing.index_failed (or iif, indexingIndexFailed): The number of failed indexing operations.
- indexing.index_failed_due_to_version_conflict (or iifvc, indexingIndexFailedDueToVersionConflict): The number of indexing operations that failed due to version conflict.
- indexing.index_time (or iiti, indexingIndexTime): The time spent in indexing operations. For example: 134ms.
- indexing.index_total (or iito, indexingIndexTotal): The number of indexing operations.
- ip (or i): The IP address.
- jdk (or j): The Java version. For example: 1.8.0.
- load_1m (or l): The most recent load average. For example: 0.22.
- load_5m (or l): The load average for the last five minutes. For example: 0.78.
- load_15m (or l): The load average for the last fifteen minutes. For example: 1.24.
- mappings.total_count (or mtc, mappingsTotalCount): The number of mappings, including runtime and object fields.
- mappings.total_estimated_overhead_in_bytes (or mteo, mappingsTotalEstimatedOverheadInBytes): The estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.
- master (or m): Indicates whether the node is the elected master node. Returned values include * (elected master) and - (not elected master).
- merges.current (or mc, mergesCurrent): The number of current merge operations.
- merges.current_docs (or mcd, mergesCurrentDocs): The number of current merging documents.
- merges.current_size (or mcs, mergesCurrentSize): The size of current merges. For example: 0b.
- merges.total (or mt, mergesTotal): The number of completed merge operations.
- merges.total_docs (or mtd, mergesTotalDocs): The number of merged documents.
- merges.total_size (or mts, mergesTotalSize): The total size of merges. For example: 0b.
- merges.total_time (or mtt, mergesTotalTime): The time spent merging documents. For example: 0s.
- name (or n): The node name.
- node.role (or r, role, nodeRole): The roles of the node. Returned values include c (cold node), d (data node), f (frozen node), h (hot node), i (ingest node), l (machine learning node), m (master-eligible node), r (remote cluster client node), s (content node), t (transform node), v (voting-only node), w (warm node), and - (coordinating node only). For example, dim indicates a master-eligible data and ingest node.
- pid (or p): The process identifier.
- port (or po): The bound transport port number.
- query_cache.memory_size (or qcm, queryCacheMemory): The used query cache memory. For example: 0b.
- query_cache.evictions (or qce, queryCacheEvictions): The number of query cache evictions.
- query_cache.hit_count (or qchc, queryCacheHitCount): The query cache hit count.
- query_cache.miss_count (or qcmc, queryCacheMissCount): The query cache miss count.
- ram.current (or rc, ramCurrent): The used total memory. For example: 513.4mb.
- ram.max (or rm, ramMax): The total memory. For example: 2.9gb.
- ram.percent (or rp, ramPercent): The used percentage of the total operating system memory. This reflects all processes running on the operating system instead of only Elasticsearch and is not guaranteed to correlate to its performance.
- refresh.total (or rto, refreshTotal): The number of refresh operations.
- refresh.time (or rti, refreshTime): The time spent in refresh operations. For example: 91ms.
- request_cache.memory_size (or rcm, requestCacheMemory): The used request cache memory. For example: 0b.
- request_cache.evictions (or rce, requestCacheEvictions): The number of request cache evictions.
- request_cache.hit_count (or rchc, requestCacheHitCount): The request cache hit count.
- request_cache.miss_count (or rcmc, requestCacheMissCount): The request cache miss count.
- script.compilations (or scrcc, scriptCompilations): The number of total script compilations.
- script.cache_evictions (or scrce, scriptCacheEvictions): The number of total compiled scripts evicted from cache.
- search.fetch_current (or sfc, searchFetchCurrent): The number of current fetch phase operations.
- search.fetch_time (or sfti, searchFetchTime): The time spent in fetch phase. For example: 37ms.
- search.fetch_total (or sfto, searchFetchTotal): The number of fetch operations.
- search.open_contexts (or so, searchOpenContexts): The number of open search contexts.
- search.query_current (or sqc, searchQueryCurrent): The number of current query phase operations.
- search.query_time (or sqti, searchQueryTime): The time spent in query phase. For example: 43ms.
- search.query_total (or sqto, searchQueryTotal): The number of query operations.
- search.scroll_current (or scc, searchScrollCurrent): The number of open scroll contexts.
- search.scroll_time (or scti, searchScrollTime): The amount of time scroll contexts were held open. For example: 2m.
- search.scroll_total (or scto, searchScrollTotal): The number of completed scroll contexts.
- segments.count (or sc, segmentsCount): The number of segments.
- segments.fixed_bitset_memory (or sfbm, fixedBitsetMemory): The memory used by fixed bit sets for nested object field types and type filters for types referred in join fields. For example: 1.0kb.
- segments.index_writer_memory (or siwm, segmentsIndexWriterMemory): The memory used by the index writer. For example: 18mb.
- segments.memory (or sm, segmentsMemory): The memory used by segments. For example: 1.4kb.
- segments.version_map_memory (or svmm, segmentsVersionMapMemory): The memory used by the version map. For example: 1.0kb.
- shard_stats.total_count (or sstc, shards, shardStatsTotalCount): The number of shards assigned.
- suggest.current (or suc, suggestCurrent): The number of current suggest operations.
- suggest.time (or suti, suggestTime): The time spent in suggest operations.
- suggest.total (or suto, suggestTotal): The number of suggest operations.
- uptime (or u): The amount of node uptime. For example: 17.3m.
- version (or v): The Elasticsearch version. For example: 9.0.0.
s string | array[string]

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
master_timeout string

The period to wait for a connection to the master node.

Values are -1 or 0.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The unique node identifier.
- pid string
  
  The process identifier.
- ip string
  
  The IP address.
- port string
  
  The bound transport port.
- http_address string
  
  The bound HTTP address.
- version string
  
  The Elasticsearch version.
- flavor string
  
  The Elasticsearch distribution flavor.
- type string
  
  The Elasticsearch distribution type.
- build string
  
  The Elasticsearch build hash.
- jdk string
  
  The Java version.
- disk.total number | string
  
  The total disk space.
  
  One of:
  number-1 number string-2 string
  
  The total disk space.
- disk.used number | string
  
  The used disk space.
  
  One of:
  number-1 number string-2 string
  
  The used disk space.
- disk.avail number | string
  
  The available disk space.
  
  One of:
  number-1 number string-2 string
  
  The available disk space.
- disk.used_percent string | number
  
  The used disk space percentage.
  
  One of:
  string-1 string number-2 number
  
  The used disk space percentage.
- heap.current string
  
  The used heap.
- heap.percent string | number
  
  The used heap ratio.
  
  One of:
  string-1 string number-2 number
  
  The used heap ratio.
- heap.max string
  
  The maximum configured heap.
- ram.current string
  
  The used machine memory.
- ram.percent string | number
  
  The used machine memory ratio.
  
  One of:
  string-1 string number-2 number
  
  The used machine memory ratio.
- ram.max string
  
  The total machine memory.
- file_desc.current string
  
  The used file descriptors.
- file_desc.percent string | number
  
  The used file descriptor ratio.
  
  One of:
  string-1 string number-2 number
  
  The used file descriptor ratio.
- file_desc.max string
  
  The maximum number of file descriptors.
- cpu string
  
  The recent system CPU usage as a percentage.
- load_1m string
  
  The load average for the most recent minute.
- load_5m string
  
  The load average for the last five minutes.
- load_15m string
  
  The load average for the last fifteen minutes.
- uptime string
  
  The node uptime.
- node.role string
  
  The roles of the node. Returned values include c(cold node), d(data node), f(frozen node), h(hot node), i(ingest node), l(machine learning node), m (master eligible node), r(remote cluster client node), s(content node), t(transform node), v(voting-only node), w(warm node),and -(coordinating node only).
- master string
  
  Indicates whether the node is the elected master node. Returned values include *(elected master) and -(not elected master).
- name string
  
  The node name.
- completion.size string
  
  The size of completion.
- fielddata.memory_size string
  
  The used fielddata cache.
- fielddata.evictions string
  
  The fielddata evictions.
- query_cache.memory_size string
  
  The used query cache.
- query_cache.evictions string
  
  The query cache evictions.
- query_cache.hit_count string
  
  The query cache hit counts.
- query_cache.miss_count string
  
  The query cache miss counts.
- request_cache.memory_size string
  
  The used request cache.
- request_cache.evictions string
  
  The request cache evictions.
- request_cache.hit_count string
  
  The request cache hit counts.
- request_cache.miss_count string
  
  The request cache miss counts.
- flush.total string
  
  The number of flushes.
- flush.total_time string
  
  The time spent in flush.
- get.current string
  
  The number of current get ops.
- get.time string
  
  The time spent in get.
- get.total string
  
  The number of get ops.
- get.exists_time string
  
  The time spent in successful gets.
- get.exists_total string
  
  The number of successful get operations.
- get.missing_time string
  
  The time spent in failed gets.
- get.missing_total string
  
  The number of failed gets.
- indexing.delete_current string
  
  The number of current deletions.
- indexing.delete_time string
  
  The time spent in deletions.
- indexing.delete_total string
  
  The number of delete operations.
- indexing.index_current string
  
  The number of current indexing operations.
- indexing.index_time string
  
  The time spent in indexing.
- indexing.index_total string
  
  The number of indexing operations.
- indexing.index_failed string
  
  The number of failed indexing operations.
- merges.current string
  
  The number of current merges.
- merges.current_docs string
  
  The number of current merging docs.
- merges.current_size string
  
  The size of current merges.
- merges.total string
  
  The number of completed merge operations.
- merges.total_docs string
  
  The docs merged.
- merges.total_size string
  
  The size merged.
- merges.total_time string
  
  The time spent in merges.
- refresh.total string
  
  The total refreshes.
- refresh.time string
  
  The time spent in refreshes.
- refresh.external_total string
  
  The total external refreshes.
- refresh.external_time string
  
  The time spent in external refreshes.
- refresh.listeners string
  
  The number of pending refresh listeners.
- script.compilations string
  
  The total script compilations.
- script.cache_evictions string
  
  The total compiled scripts evicted from the cache.
- script.compilation_limit_triggered string
  
  The script cache compilation limit triggered.
- search.fetch_current string
  
  The current fetch phase operations.
- search.fetch_time string
  
  The time spent in fetch phase.
- search.fetch_total string
  
  The total fetch operations.
- search.open_contexts string
  
  The open search contexts.
- search.query_current string
  
  The current query phase operations.
- search.query_time string
  
  The time spent in query phase.
- search.query_total string
  
  The total query phase operations.
- search.scroll_current string
  
  The open scroll contexts.
- search.scroll_time string
  
  The time scroll contexts held open.
- search.scroll_total string
  
  The completed scroll contexts.
- segments.count string
  
  The number of segments.
- segments.memory string
  
  The memory used by segments.
- segments.index_writer_memory string
  
  The memory used by the index writer.
- segments.version_map_memory string
  
  The memory used by the version map.
- segments.fixed_bitset_memory string
  
  The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.
- suggest.current string
  
  The number of current suggest operations.
- suggest.time string
  
  The time spend in suggest.
- suggest.total string
  
  The number of suggest operations.
- bulk.total_operations string
  
  The number of bulk shard operations.
- bulk.total_time string
  
  The time spend in shard bulk.
- bulk.total_size_in_bytes string
  
  The total size in bytes of shard bulk.
- bulk.avg_time string
  
  The average time spend in shard bulk.
- bulk.avg_size_in_bytes string
  
  The average size in bytes of shard bulk.

GET /_cat/nodes

GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json

resp = client.cat.nodes(
    v=True,
    h="id,ip,port,v,m",
    format="json",
)

const response = await client.cat.nodes({
  v: "true",
  h: "id,ip,port,v,m",
  format: "json",
});

response = client.cat.nodes(
  v: "true",
  h: "id,ip,port,v,m",
  format: "json"
)

$resp = $client->cat()->nodes([
    "v" => "true",
    "h" => "id,ip,port,v,m",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/nodes?v=true&h=id,ip,port,v,m&format=json"

client.cat().nodes();

Response examples (200)

A successful response from `GET /_cat/nodes?v=true&format=json`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones.

[
  {
    "ip": "127.0.0.1",
    "heap.percent": "65",
    "ram.percent": "99",
    "cpu": "42",
    "load_1m": "3.07",
    "load_5m": null,
    "load_15m": null,
    "node.role": "cdfhilmrstw",
    "master": "*",
    "name": "mJw06l1"
  }
]

A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.

[
  {
    "id": "veJR",
    "ip": "127.0.0.1",
    "port": "59938",
    "v": "9.0.0",
    "m": "*"
  }
]

Get plugin information Generally available

GET /_cat/plugins

Api key auth Basic auth Bearer auth

Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Required authorization

Cluster privileges: monitor

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
include_bootstrap boolean

Include bootstrap plugins in the response
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The unique node identifier.
- name string
  
  The node name.
- component string
  
  The component name.
- version string
  
  The component version.
- description string
  
  The plugin details.
- type string
  
  The plugin type.

GET /_cat/plugins

GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json

resp = client.cat.plugins(
    v=True,
    s="component",
    h="name,component,version,description",
    format="json",
)

const response = await client.cat.plugins({
  v: "true",
  s: "component",
  h: "name,component,version,description",
  format: "json",
});

response = client.cat.plugins(
  v: "true",
  s: "component",
  h: "name,component,version,description",
  format: "json"
)

$resp = $client->cat()->plugins([
    "v" => "true",
    "s" => "component",
    "h" => "name,component,version,description",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/plugins?v=true&s=component&h=name,component,version,description&format=json"

client.cat().plugins();

Response examples (200)

A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`.

[
  { "name": "U7321H6", "component": "analysis-icu", "version": "8.17.0", "description": "The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components."},
  {"name": "U7321H6", "component": "analysis-kuromoji",   "verison":  "8.17.0", description: "The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch."},
  {"name" "U7321H6", "component": "analysis-nori", "version":         "8.17.0", "description": "The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch."},
  {"name": "U7321H6", "component": "analysis-phonetic",   "verison":  "8.17.0", "description": "The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch."},
  {"name": "U7321H6", "component": "analysis-smartcn",   "verison":  "8.17.0", "description": "Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch."},
  {"name": "U7321H6", "component": "analysis-stempel",   "verison":  "8.17.0", "description": "The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch."},
  {"name": "U7321H6", "component": "analysis-ukrainian",   "verison":  "8.17.0", "description": "The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch."},
  {"name": "U7321H6", "component": "discovery-azure-classic",   "verison":  "8.17.0", "description": "The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism"},
  {"name": "U7321H6", "component": "discovery-ec2",   "verison":  "8.17.0", "description": "The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism."},
  {"name": "U7321H6", "component": "discovery-gce",   "verison":  "8.17.0", "description": "The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism."},
  {"name": "U7321H6", "component": "mapper-annotated-text",   "verison":  "8.17.0", "description": "The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index."},
  {"name": "U7321H6", "component": "mapper-murmur3",   "verison":  "8.17.0", "description": "The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index."},
  {"name": "U7321H6", "component": "mapper-size",   "verison":  "8.17.0", "description": "The Mapper Size plugin allows document to record their uncompressed size at index time."},
  {"name": "U7321H6", "component": "store-smb",   "verison":  "8.17.0", "description": "The Store SMB plugin adds support for SMB stores."}
]

Get shard recovery information Generally available

GET /_cat/recovery/{index}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/recovery

GET /_cat/recovery/{index}

Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

Required authorization

Index privileges: monitor
Cluster privileges: monitor

Path parameters

index string | array[string] Required

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

active_only boolean

If true, the response only includes ongoing shard recoveries.
bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
detailed boolean

If true, the response includes detailed information about shard recoveries.
index string | array[string]

Comma-separated list or wildcard expression of index names to limit the returned information
h string | array[string]
A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:
- index (or i, idx): The name of the index.
- shard (or s, sh): The name of the shard.
- time (or t, ti, primaryOrReplica): The recovery time elasped.
- type: The type of recovery, from a peer or a snapshot.
- stage (or st): The stage of the recovery. Returned values are: INIT, INDEX: recovery of lucene files, either reusing local ones are copying new ones, VERIFY_INDEX: potentially running check index, TRANSLOG: starting up the engine, replaying the translog, FINALIZE: performing final task after all translog ops have been done, DONE
- source_host (or shost): The host address the index is moving from.
- source_node (or snode): The node name the index is moving from.
- target_host (or thost): The host address the index is moving to.
- target_node (or tnode): The node name the index is moving to.
- repository (or tnode): The name of the repository being used. if not relevant 'n/a'.
- snapshot (or snap): The name of the snapshot being used. if not relevant 'n/a'.
- files (or f): The total number of files to recover.
- files_recovered (or fr): The number of files currently recovered.
- files_percent (or fp): The percentage of files currently recovered.
- files_total (or tf): The total number of files.
- bytes (or b): The total number of bytes to recover.
- bytes_recovered (or br): Total number of bytes currently recovered.
- bytes_percent (or bp): The percentage of bytes currently recovered.
- bytes_total (or tb): The total number of bytes.
- translog_ops (or to): The total number of translog ops to recover.
- translog_ops_recovered (or tor): The total number of translog ops currently recovered.
- translog_ops_percent (or top): The percentage of translog ops currently recovered.
- start_time (or start): The start time of the recovery operation.
- start_time_millis (or start_millis): The start time of the recovery operation in eopch milliseconds.
- stop_time (or stop): The end time of the recovery operation. If ongoing '1970-01-01T00:00:00.000Z'
- stop_time_millis (or stop_millis): The end time of the recovery operation in eopch milliseconds. If ongoing '0'
Values are index, i, idx, shard, s, sh, time, t, ti, primaryOrReplica, type, stage, st, source_host, shost, source_node, snode, target_host, thost, target_node, tnode, repository, snapshot, snap, files, f, files_recovered, fr, files_percent, fp, files_total, tf, bytes, b, bytes_recovered, br, bytes_percent, bp, bytes_total, tb, translog_ops, to, translog_ops_recovered, tor, translog_ops_percent, top, start_time, start, start_time_millis, start_millis, stop_time, stop, stop_time_millis, or stop_millis.
s string | array[string]

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- index string
  
  The index name.
- shard string
  
  The shard name.
- start_time string | number
  
  The recovery start time.
  
  One of:
  string-1 string UnitMillis number
  
  The recovery start time.
- start_time_millis number
  
  Time unit for milliseconds
- stop_time string | number
  
  The recovery stop time.
  
  One of:
  string-1 string UnitMillis number
  
  The recovery stop time.
- stop_time_millis number
  
  Time unit for milliseconds
- time string
  
  The recovery time.
- type string
  
  The recovery type.
- stage string
  
  The recovery stage.
- source_host string
  
  The source host.
- source_node string
  
  The source node name.
- target_host string
  
  The target host.
- target_node string
  
  The target node name.
- repository string
  
  The repository name.
- snapshot string
  
  The snapshot name.
- files string
  
  The number of files to recover.
- files_recovered string
  
  The files recovered.
- files_percent string | number
  
  The ratio of files recovered.
  
  One of:
  string-1 string number-2 number
  
  The ratio of files recovered.
- files_total string
  
  The total number of files.
- bytes string
  
  The number of bytes to recover.
- bytes_recovered string
  
  The bytes recovered.
- bytes_percent string | number
  
  The ratio of bytes recovered.
  
  One of:
  string-1 string number-2 number
  
  The ratio of bytes recovered.
- bytes_total string
  
  The total number of bytes.
- translog_ops string
  
  The number of translog operations to recover.
- translog_ops_recovered string
  
  The translog operations recovered.
- translog_ops_percent string | number
  
  The ratio of translog operations recovered.
  
  One of:
  string-1 string number-2 number
  
  The ratio of translog operations recovered.

GET /_cat/recovery/{index}

GET _cat/recovery?v=true&format=json

resp = client.cat.recovery(
    v=True,
    format="json",
)

const response = await client.cat.recovery({
  v: "true",
  format: "json",
});

response = client.cat.recovery(
  v: "true",
  format: "json"
)

$resp = $client->cat()->recovery([
    "v" => "true",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/recovery?v=true&format=json"

client.cat().recovery();

Response examples (200)

A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.

[
  {
    "index": "my-index-000001 ",
    "shard": "0",
    "time": "13ms",
    "type": "store",
    "stage": "done",
    "source_host": "n/a",
    "source_node": "n/a",
    "target_host": "127.0.0.1",
    "target_node": "node-0",
    "repository": "n/a",
    "snapshot": "n/a",
    "files": "0",
    "files_recovered": "0",
    "files_percent": "100.0%",
    "files_total": "13",
    "bytes": "0b",
    "bytes_recovered": "0b",
    "bytes_percent": "100.0%",
    "bytes_total": "9928b",
    "translog_ops": "0",
    "translog_ops_recovered": "0",
    "translog_ops_percent": "100.0%"
  }
]

A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements.

[
  {
    "i": "my-index-000001",
    "s": "0",
    "t": "1252ms",
    "ty": "peer",
    "st": "done",
    "shost": "192.168.1.1",
    "thost": "192.168.1.1",
    "f": "0",
    "fp": "100.0%",
    "b": "0b",
    "bp": "100.0%",
  }
]

A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery.

[
  {
    "i": "my-index-000001",
    "s": "0",
    "t": "1978ms",
    "ty": "snapshot",
    "st": "done",
    "rep": "my-repo",
    "snap": "snap-1",
    "f": "79",
    "fp": "8.0%",
    "b": "12086",
    "bp": "9.0%"
  }
]

Get shard information Generally available

GET /_cat/shards/{index}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/shards

GET /_cat/shards/{index}

Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Required authorization

Index privileges: monitor
Cluster privileges: monitor

Path parameters

index string | array[string] Required

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
h string | array[string]
List of columns to appear in the response. Supports simple wildcards.

Supported values include:
- completion.size (or cs, completionSize): Size of completion. For example: 0b.
- dataset.size: Disk space used by the shard’s dataset, which may or may not be the size on disk, but includes space used by the shard on object storage. Reported as a size value for example: 5kb.
- dense_vector.value_count (or dvc, denseVectorCount): Number of indexed dense vectors.
- docs (or d, dc): Number of documents in shard, for example: 25.
- fielddata.evictions (or fe, fielddataEvictions): Fielddata cache evictions, for example: 0.
- fielddata.memory_size (or fm, fielddataMemory): Used fielddata cache memory, for example: 0b.
- flush.total (or ft, flushTotal): Number of flushes, for example: 1.
- flush.total_time (or ftt, flushTotalTime): Time spent in flush, for example: 1.
- get.current (or gc, getCurrent): Number of current get operations, for example: 0.
- get.exists_time (or geti, getExistsTime): Time spent in successful gets, for example: 14ms.
- get.exists_total (or geto, getExistsTotal): Number of successful get operations, for example: 2.
- get.missing_time (or gmti, getMissingTime): Time spent in failed gets, for example: 0s.
- get.missing_total (or gmto, getMissingTotal): Number of failed get operations, for example: 1.
- get.time (or gti, getTime): Time spent in get, for example: 14ms.
- get.total (or gto, getTotal): Number of get operations, for example: 2.
- id: ID of the node, for example: k0zy.
- index (or i, idx): Name of the index.
- indexing.delete_current (or idc, indexingDeleteCurrent): Number of current deletion operations, for example: 0.
- indexing.delete_time (or idti, indexingDeleteTime): Time spent in deletions, for example: 2ms.
- indexing.delete_total (or idto, indexingDeleteTotal): Number of deletion operations, for example: 2.
- indexing.index_current (or iic, indexingIndexCurrent): Number of current indexing operations, for example: 0.
- indexing.index_failed_due_to_version_conflict (or iifvc, indexingIndexFailedDueToVersionConflict): Number of failed indexing operations due to version conflict, for example: 0.
- indexing.index_failed (or iif, indexingIndexFailed): Number of failed indexing operations, for example: 0.
- indexing.index_time (or iiti, indexingIndexTime): Time spent in indexing, such as for example: 134ms.
- indexing.index_total (or iito, indexingIndexTotal): Number of indexing operations, for example: 1.
- ip: IP address of the node, for example: 127.0.1.1.
- merges.current (or mc, mergesCurrent): Number of current merge operations, for example: 0.
- merges.current_docs (or mcd, mergesCurrentDocs): Number of current merging documents, for example: 0.
- merges.current_size (or mcs, mergesCurrentSize): Size of current merges, for example: 0b.
- merges.total (or mt, mergesTotal): Number of completed merge operations, for example: 0.
- merges.total_docs (or mtd, mergesTotalDocs): Number of merged documents, for example: 0.
- merges.total_size (or mts, mergesTotalSize): Size of current merges, for example: 0b.
- merges.total_time (or mtt, mergesTotalTime): Time spent merging documents, for example: 0s.
- node (or n): Node name, for example: I8hydUG.
- prirep (or p, pr, primaryOrReplica): Shard type. Returned values are primary or replica.
- query_cache.evictions (or qce, queryCacheEvictions): Query cache evictions, for example: 0.
- query_cache.memory_size (or qcm, queryCacheMemory): Used query cache memory, for example: 0b.
- recoverysource.type (or rs): Type of recovery source.
- refresh.time (or rti, refreshTime): Time spent in refreshes, for example: 91ms.
- refresh.total (or rto, refreshTotal): Number of refreshes, for example: 16.
- search.fetch_current (or sfc, searchFetchCurrent): Current fetch phase operations, for example: 0.
- search.fetch_time (or sfti, searchFetchTime): Time spent in fetch phase, for example: 37ms.
- search.fetch_total (or sfto, searchFetchTotal): Number of fetch operations, for example: 7.
- search.open_contexts (or so, searchOpenContexts): Open search contexts, for example: 0.
- search.query_current (or sqc, searchQueryCurrent): Current query phase operations, for example: 0.
- search.query_time (or sqti, searchQueryTime): Time spent in query phase, for example: 43ms.
- search.query_total (or sqto, searchQueryTotal): Number of query operations, for example: 9.
- search.scroll_current (or scc, searchScrollCurrent): Open scroll contexts, for example: 2.
- search.scroll_time (or scti, searchScrollTime): Time scroll contexts held open, for example: 2m.
- search.scroll_total (or scto, searchScrollTotal): Completed scroll contexts, for example: 1.
- segments.count (or sc, segmentsCount): Number of segments, for example: 4.
- segments.fixed_bitset_memory (or sfbm, fixedBitsetMemory): Memory used by fixed bit sets for nested object field types and type filters for types referred in join fields, for example: 1.0kb.
- segments.index_writer_memory (or siwm, segmentsIndexWriterMemory): Memory used by index writer, for example: 18mb.
- segments.memory (or sm, segmentsMemory): Memory used by segments, for example: 1.4kb.
- segments.version_map_memory (or svmm, segmentsVersionMapMemory): Memory used by version map, for example: 1.0kb.
- seq_no.global_checkpoint (or sqg, globalCheckpoint): Global checkpoint.
- seq_no.local_checkpoint (or sql, localCheckpoint): Local checkpoint.
- seq_no.max (or sqm, maxSeqNo): Maximum sequence number.
- shard (or s, sh): Name of the shard.
- dsparse_vector.value_count (or svc, sparseVectorCount): Number of indexed sparse vectors.
- state (or st): State of the shard. Returned values are:
  - INITIALIZING: The shard is recovering from a peer shard or gateway.
  - RELOCATING: The shard is relocating.
  - STARTED: The shard has started.
  - UNASSIGNED: The shard is not assigned to any node.
- store (or sto): Disk space used by the shard, for example: 5kb.
- suggest.current (or suc, suggestCurrent): Number of current suggest operations, for example: 0.
- suggest.time (or suti, suggestTime): Time spent in suggest, for example: 0.
- suggest.total (or suto, suggestTotal): Number of suggest operations, for example: 0.
- sync_id: Sync ID of the shard.
- unassigned.at (or ua): Time at which the shard became unassigned in Coordinated Universal Time (UTC).
- unassigned.details (or ud): Details about why the shard became unassigned. This does not explain why the shard is currently unassigned. To understand why a shard is not assigned, use the Cluster allocation explain API.
- unassigned.for (or uf): Time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).
- unassigned.reason (or ur): Indicates the reason for the last change to the state of this unassigned shard. This does not explain why the shard is currently unassigned. To understand why a shard is not assigned, use the Cluster allocation explain API. Returned values include:
  - ALLOCATION_FAILED: Unassigned as a result of a failed allocation of the shard.
  - CLUSTER_RECOVERED: Unassigned as a result of a full cluster recovery.
  - DANGLING_INDEX_IMPORTED: Unassigned as a result of importing a dangling index.
  - EXISTING_INDEX_RESTORED: Unassigned as a result of restoring into a closed index.
  - FORCED_EMPTY_PRIMARY: The shard’s allocation was last modified by forcing an empty primary using the Cluster reroute API.
  - INDEX_CLOSED: Unassigned because the index was closed.
  - INDEX_CREATED: Unassigned as a result of an API creation of an index.
  - INDEX_REOPENED: Unassigned as a result of opening a closed index.
  - MANUAL_ALLOCATION: The shard’s allocation was last modified by the Cluster reroute API.
  - NEW_INDEX_RESTORED: Unassigned as a result of restoring into a new index.
  - NODE_LEFT: Unassigned as a result of the node hosting it leaving the cluster.
  - NODE_RESTARTING: Similar to NODE_LEFT, except that the node was registered as restarting using the Node shutdown API.
  - PRIMARY_FAILED: The shard was initializing as a replica, but the primary shard failed before the initialization completed.
  - REALLOCATED_REPLICA: A better replica location is identified and causes the existing replica allocation to be cancelled.
  - REINITIALIZED: When a shard moves from started back to initializing.
  - REPLICA_ADDED: Unassigned as a result of explicit addition of a replica.
  - REROUTE_CANCELLED: Unassigned as a result of explicit cancel reroute command.
Values are completion.size, cs, completionSize, dataset.size, dense_vector.value_count, dvc, denseVectorCount, docs, d, dc, fielddata.evictions, fe, fielddataEvictions, fielddata.memory_size, fm, fielddataMemory, flush.total, ft, flushTotal, flush.total_time, ftt, flushTotalTime, get.current, gc, getCurrent, get.exists_time, geti, getExistsTime, get.exists_total, geto, getExistsTotal, get.missing_time, gmti, getMissingTime, get.missing_total, gmto, getMissingTotal, get.time, gti, getTime, get.total, gto, getTotal, id, index, i, idx, indexing.delete_current, idc, indexingDeleteCurrent, indexing.delete_time, idti, indexingDeleteTime, indexing.delete_total, idto, indexingDeleteTotal, indexing.index_current, iic, indexingIndexCurrent, indexing.index_failed_due_to_version_conflict, iifvc, indexingIndexFailedDueToVersionConflict, indexing.index_failed, iif, indexingIndexFailed, indexing.index_time, iiti, indexingIndexTime, indexing.index_total, iito, indexingIndexTotal, ip, merges.current, mc, mergesCurrent, merges.current_docs, mcd, mergesCurrentDocs, merges.current_size, mcs, mergesCurrentSize, merges.total, mt, mergesTotal, merges.total_docs, mtd, mergesTotalDocs, merges.total_size, mts, mergesTotalSize, merges.total_time, mtt, mergesTotalTime, node, n, prirep, p, pr, primaryOrReplica, query_cache.evictions, qce, queryCacheEvictions, query_cache.memory_size, qcm, queryCacheMemory, recoverysource.type, rs, refresh.time, rti, refreshTime, refresh.total, rto, refreshTotal, search.fetch_current, sfc, searchFetchCurrent, search.fetch_time, sfti, searchFetchTime, search.fetch_total, sfto, searchFetchTotal, search.open_contexts, so, searchOpenContexts, search.query_current, sqc, searchQueryCurrent, search.query_time, sqti, searchQueryTime, search.query_total, sqto, searchQueryTotal, search.scroll_current, scc, searchScrollCurrent, search.scroll_time, scti, searchScrollTime, search.scroll_total, scto, searchScrollTotal, segments.count, sc, segmentsCount, segments.fixed_bitset_memory, sfbm, fixedBitsetMemory, segments.index_writer_memory, siwm, segmentsIndexWriterMemory, segments.memory, sm, segmentsMemory, segments.version_map_memory, svmm, segmentsVersionMapMemory, seq_no.global_checkpoint, sqg, globalCheckpoint, seq_no.local_checkpoint, sql, localCheckpoint, seq_no.max, sqm, maxSeqNo, shard, s, sh, dsparse_vector.value_count, svc, sparseVectorCount, state, st, store, sto, suggest.current, suc, suggestCurrent, suggest.time, suti, suggestTime, suggest.total, suto, suggestTotal, sync_id, unassigned.at, ua, unassigned.details, ud, unassigned.for, uf, unassigned.reason, or ur.
s string | array[string]

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
master_timeout string

The period to wait for a connection to the master node.

Values are -1 or 0.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- index string
  
  The index name.
- shard string
  
  The shard name.
- prirep string
  
  The shard type: primary or replica.
- state string
  
  The shard state. Returned values include: INITIALIZING: The shard is recovering from a peer shard or gateway. RELOCATING: The shard is relocating. STARTED: The shard has started. UNASSIGNED: The shard is not assigned to any node.
- docs string | null
  
  The number of documents in the shard.
  
  One of:
  string-1 string string-2 string | null
- store string | null
  
  The disk space used by the shard.
  
  One of:
  string-1 string string-2 string | null
- dataset string | null
  
  total size of dataset (including the cache for partially mounted indices)
  
  One of:
  string-1 string string-2 string | null
- ip string | null
  
  The IP address of the node.
  
  One of:
  string-1 string string-2 string | null
- id string
  
  The unique identifier for the node.
- node string | null
  
  The name of node.
  
  One of:
  string-1 string string-2 string | null
- sync_id string
  
  The sync identifier.
- unassigned.reason string
  
  The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include: ALLOCATION_FAILED: Unassigned as a result of a failed allocation of the shard. CLUSTER_RECOVERED: Unassigned as a result of a full cluster recovery. DANGLING_INDEX_IMPORTED: Unassigned as a result of importing a dangling index. EXISTING_INDEX_RESTORED: Unassigned as a result of restoring into a closed index. FORCED_EMPTY_PRIMARY: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. INDEX_CLOSED: Unassigned because the index was closed. INDEX_CREATED: Unassigned as a result of an API creation of an index. INDEX_REOPENED: Unassigned as a result of opening a closed index. MANUAL_ALLOCATION: The shard’s allocation was last modified by the cluster reroute API. NEW_INDEX_RESTORED: Unassigned as a result of restoring into a new index. NODE_LEFT: Unassigned as a result of the node hosting it leaving the cluster. NODE_RESTARTING: Similar to NODE_LEFT, except that the node was registered as restarting using the node shutdown API. PRIMARY_FAILED: The shard was initializing as a replica, but the primary shard failed before the initialization completed. REALLOCATED_REPLICA: A better replica location is identified and causes the existing replica allocation to be cancelled. REINITIALIZED: When a shard moves from started back to initializing. REPLICA_ADDED: Unassigned as a result of explicit addition of a replica. REROUTE_CANCELLED: Unassigned as a result of explicit cancel reroute command.
- unassigned.at string
  
  The time at which the shard became unassigned in Coordinated Universal Time (UTC).
- unassigned.for string
  
  The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).
- unassigned.details string
  
  Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information.
- recoverysource.type string
  
  The type of recovery source.
- completion.size string
  
  The size of completion.
- fielddata.memory_size string
  
  The used fielddata cache memory.
- fielddata.evictions string
  
  The fielddata cache evictions.
- query_cache.memory_size string
  
  The used query cache memory.
- query_cache.evictions string
  
  The query cache evictions.
- flush.total string
  
  The number of flushes.
- flush.total_time string
  
  The time spent in flush.
- get.current string
  
  The number of current get operations.
- get.time string
  
  The time spent in get operations.
- get.total string
  
  The number of get operations.
- get.exists_time string
  
  The time spent in successful get operations.
- get.exists_total string
  
  The number of successful get operations.
- get.missing_time string
  
  The time spent in failed get operations.
- get.missing_total string
  
  The number of failed get operations.
- indexing.delete_current string
  
  The number of current deletion operations.
- indexing.delete_time string
  
  The time spent in deletion operations.
- indexing.delete_total string
  
  The number of delete operations.
- indexing.index_current string
  
  The number of current indexing operations.
- indexing.index_time string
  
  The time spent in indexing operations.
- indexing.index_total string
  
  The number of indexing operations.
- indexing.index_failed string
  
  The number of failed indexing operations.
- merges.current string
  
  The number of current merge operations.
- merges.current_docs string
  
  The number of current merging documents.
- merges.current_size string
  
  The size of current merge operations.
- merges.total string
  
  The number of completed merge operations.
- merges.total_docs string
  
  The nuber of merged documents.
- merges.total_size string
  
  The size of current merges.
- merges.total_time string
  
  The time spent merging documents.
- refresh.total string
  
  The total number of refreshes.
- refresh.time string
  
  The time spent in refreshes.
- refresh.external_total string
  
  The total nunber of external refreshes.
- refresh.external_time string
  
  The time spent in external refreshes.
- refresh.listeners string
  
  The number of pending refresh listeners.
- search.fetch_current string
  
  The current fetch phase operations.
- search.fetch_time string
  
  The time spent in fetch phase.
- search.fetch_total string
  
  The total number of fetch operations.
- search.open_contexts string
  
  The number of open search contexts.
- search.query_current string
  
  The current query phase operations.
- search.query_time string
  
  The time spent in query phase.
- search.query_total string
  
  The total number of query phase operations.
- search.scroll_current string
  
  The open scroll contexts.
- search.scroll_time string
  
  The time scroll contexts were held open.
- search.scroll_total string
  
  The number of completed scroll contexts.
- segments.count string
  
  The number of segments.
- segments.memory string
  
  The memory used by segments.
- segments.index_writer_memory string
  
  The memory used by the index writer.
- segments.version_map_memory string
  
  The memory used by the version map.
- segments.fixed_bitset_memory string
  
  The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.
- seq_no.max string
  
  The maximum sequence number.
- seq_no.local_checkpoint string
  
  The local checkpoint.
- seq_no.global_checkpoint string
  
  The global checkpoint.
- warmer.current string
  
  The number of current warmer operations.
- warmer.total string
  
  The total number of warmer operations.
- warmer.total_time string
  
  The time spent in warmer operations.
- path.data string
  
  The shard data path.
- path.state string
  
  The shard state path.
- bulk.total_operations string
  
  The number of bulk shard operations.
- bulk.total_time string
  
  The time spent in shard bulk operations.
- bulk.total_size_in_bytes string
  
  The total size in bytes of shard bulk operations.
- bulk.avg_time string
  
  The average time spent in shard bulk operations.
- bulk.avg_size_in_bytes string
  
  The average size in bytes of shard bulk operations.

GET /_cat/shards/{index}

GET _cat/shards?format=json

resp = client.cat.shards(
    format="json",
)

const response = await client.cat.shards({
  format: "json",
});

response = client.cat.shards(
  format: "json"
)

$resp = $client->cat()->shards([
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/shards?format=json"

client.cat().shards();

Response examples (200)

A successful response from `GET _cat/shards?format=json`.

[
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "p",
    "state": "STARTED",
    "docs": "3014",
    "store": "31.1mb",
    "dataset": "249b",
    "ip": "192.168.56.10",
    "node": "H5dfFeA"
  }
]

A successful response from `GET _cat/shards/my-index-*?format=json`. It returns information for any data streams or indices beginning with `my-index-`.

[
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "p",
    "state": "STARTED",
    "docs": "3014",
    "store": "31.1mb",
    "dataset": "249b",
    "ip": "192.168.56.10",
    "node": "H5dfFeA"
  }
]

A successful response from `GET _cat/shards?format=json`. The `RELOCATING` value in the `state` column indicates the index shard is relocating.

[
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "p",
    "state": "RELOCATING",
    "docs": "3014",
    "store": "31.1mb",
    "dataset": "249b",
    "ip": "192.168.56.10",
    "node": "H5dfFeA -> -> 192.168.56.30 bGG90GE"
  }
]

A successful response from `GET _cat/shards?format=json`. Before a shard is available for use, it goes through an `INITIALIZING` state. You can use the cat shards API to see which shards are initializing.

[
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "p",
    "state": "STARTED",
    "docs": "3014",
    "store": "31.1mb",
    "dataset": "249b",
    "ip": "192.168.56.10",
    "node": "H5dfFeA"
  },
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "r",
    "state": "INITIALIZING",
    "docs": "0",
    "store": "14.3mb",
    "dataset": "249b",
    "ip": "192.168.56.30",
    "node": "bGG90GE"
  }
]

A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json`. It includes the `unassigned.reason` column, which indicates why a shard is unassigned.

[
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "p",
    "state": "STARTED",
    "unassigned.reason": "3014 31.1mb 192.168.56.10 H5dfFeA"
  },
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "r",
    "state": "STARTED",
    "unassigned.reason": "3014 31.1mb 192.168.56.30 bGG90GE"
  },
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "r",
    "state": "STARTED",
    "unassigned.reason": "3014 31.1mb 192.168.56.20 I8hydUG"
  },
  {
    "index": "my-index-000001",
    "shard": "0",
    "prirep": "r",
    "state": "UNASSIGNED",
    "unassigned.reason": "ALLOCATION_FAILED"
  }
]

Get snapshot information Generally available; Added in 2.1.0

GET /_cat/snapshots/{repository}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/snapshots

GET /_cat/snapshots/{repository}

Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

Required authorization

Cluster privileges: monitor_snapshot

Path parameters

repository string | array[string] Required

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

Query parameters

ignore_unavailable boolean

If true, the response does not include information from unavailable snapshots.
h string | array[string]
A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:
- id (or snapshot): The ID of the snapshot, such as 'snap1'.
- repository (or re, repo): The name of the repository, such as 'repo1'.
- status (or s): State of the snapshot process. Returned values are: 'FAILED': The snapshot process failed. 'INCOMPATIBLE': The snapshot process is incompatible with the current cluster version. 'IN_PROGRESS': The snapshot process started but has not completed. 'PARTIAL': The snapshot process completed with a partial success. 'SUCCESS': The snapshot process completed with a full success.
- start_epoch (or ste, startEpoch): The unix epoch time at which the snapshot process started.
- start_time (or sti, startTime): 'HH:MM:SS' time at which the snapshot process started.
- end_epoch (or ete, endEpoch): The unix epoch time at which the snapshot process ended.
- end_time (or eti, endTime): 'HH:MM:SS' time at which the snapshot process ended.
- duration (or dur): The time it took the snapshot process to complete in time units.
- indices (or i): The number of indices in the snapshot.
- successful_shards (or ss): The number of successful shards in the snapshot.
- failed_shards (or fs): The number of failed shards in the snapshot.
- total_shards (or ts): The total number of shards in the snapshot.
- reason (or r): The reason for any snapshot failures.
Values are id, snapshot, repository, re, repo, status, s, start_epoch, ste, startEpoch, start_time, sti, startTime, end_epoch, ete, endEpoch, end_time, eti, endTime, duration, dur, indices, i, successful_shards, ss, failed_shards, fs, total_shards, ts, reason, or r.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.
time string

Unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the snapshot.
- repository string
  
  The repository name.
- status string
  
  The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.
- start_epoch number | string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.
  
  One of:
  UnitSeconds number string-2 string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.
- start_time string | object
  
  The time (HH:MM:SS) at which the snapshot process started.
  
  One of:
  string-1 string HourAndMinute object
  
  The time (HH:MM:SS) at which the snapshot process started.
- end_epoch number | string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.
  
  One of:
  UnitSeconds number string-2 string
  
  The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.
- end_time string
  
  The time (HH:MM:SS) at which the snapshot process ended.
- duration string
  
  The time it took the snapshot process to complete, in time units.
- indices string
  
  The number of indices in the snapshot.
- successful_shards string
  
  The number of successful shards in the snapshot.
- failed_shards string
  
  The number of failed shards in the snapshot.
- total_shards string
  
  The total number of shards in the snapshot.
- reason string
  
  The reason for any snapshot failures.

GET /_cat/snapshots/{repository}

GET /_cat/snapshots/repo1?v=true&s=id&format=json

resp = client.cat.snapshots(
    repository="repo1",
    v=True,
    s="id",
    format="json",
)

const response = await client.cat.snapshots({
  repository: "repo1",
  v: "true",
  s: "id",
  format: "json",
});

response = client.cat.snapshots(
  repository: "repo1",
  v: "true",
  s: "id",
  format: "json"
)

$resp = $client->cat()->snapshots([
    "repository" => "repo1",
    "v" => "true",
    "s" => "id",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/snapshots/repo1?v=true&s=id&format=json"

client.cat().snapshots();

Response examples (200)

A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`.

[
  {
    "id": "snap1",
    "repository": "repo1",
    "status": "FAILED",
    "start_epoch": "1445616705",
    "start_time": "18:11:45",
    "end_epoch": "1445616978",
    "end_time": "18:16:18",
    "duration": "4.6m",
    "indices": "1",
    "successful_shards": "4",
    "failed_shards": "1",
    "total_shards": "5"
  },
  {
    "id": "snap2",
    "repository": "repo1",
    "status": "SUCCESS",
    "start_epoch": "1445634298",
    "start_time": "23:04:58",
    "end_epoch": "1445634672",
    "end_time": "23:11:12",
    "duration": "6.2m",
    "indices": "2",
    "successful_shards": "10",
    "failed_shards": "0",
    "total_shards": "10"
  }
]

Get task information Technical preview; Added in 5.0.0

GET /_cat/tasks

Api key auth Basic auth Bearer auth

Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

Required authorization

Cluster privileges: monitor

Query parameters

actions array[string]

The task action names, which are used to limit the response.
detailed boolean

If true, the response includes detailed information about shard recoveries.
nodes array[string]

Unique node identifiers, which are used to limit the response.
parent_task_id string

The parent task identifier, which is used to limit the response.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
time string

Unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
timeout string

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

Values are -1 or 0.
wait_for_completion boolean

If true, the request blocks until the task has completed.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The identifier of the task with the node.
- action string
  
  The task action.
- task_id string
  
  The unique task identifier.
- parent_task_id string
  
  The parent task identifier.
- type string
  
  The task type.
- start_time string
  
  The start time in milliseconds.
- timestamp string
  
  The start time in HH:MM:SS format.
- running_time_ns string
  
  The running time in nanoseconds.
- running_time string
  
  The running time.
- node_id string
  
  The unique node identifier.
- ip string
  
  The IP address for the node.
- port string
  
  The bound transport port for the node.
- node string
  
  The node name.
- version string
  
  The Elasticsearch version.
- x_opaque_id string
  
  The X-Opaque-ID header.
- description string
  
  The task action description.

GET /_cat/tasks

GET _cat/tasks?v=true&format=json

resp = client.cat.tasks(
    v=True,
    format="json",
)

const response = await client.cat.tasks({
  v: "true",
  format: "json",
});

response = client.cat.tasks(
  v: "true",
  format: "json"
)

$resp = $client->cat()->tasks([
    "v" => "true",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/tasks?v=true&format=json"

client.cat().tasks();

Response examples (200)

A successful response from `GET _cat/tasks?v=true&format=json`.

[
  {
    "action": "cluster:monitor/tasks/lists[n]",
    "task_id": "oTUltX4IQMOUUVeiohTt8A:124",
    "parent_task_id": "oTUltX4IQMOUUVeiohTt8A:123",
    "type": "direct",
    "start_time": "1458585884904",
    "timestamp": "01:48:24",
    "running_time": "44.1micros",
    "ip": "127.0.0.1:9300",
    "node": "oTUltX4IQMOUUVeiohTt8A"
  },
  {
    "action": "cluster:monitor/tasks/lists",
    "task_id": "oTUltX4IQMOUUVeiohTt8A:123",
    "parent_task_id": "-",
    "type": "transport",
    "start_time": "1458585884904",
    "timestamp": "01:48:24",
    "running_time": "186.2micros",
    "ip": "127.0.0.1:9300",
    "node": "oTUltX4IQMOUUVeiohTt8A"
  }
]

Get thread pool statistics Generally available

GET /_cat/thread_pool/{thread_pool_patterns}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_cat/thread_pool

GET /_cat/thread_pool/{thread_pool_patterns}

Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Required authorization

Cluster privileges: monitor

Path parameters

thread_pool_patterns string | array[string] Required

A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

Query parameters

h string | array[string]
List of columns to appear in the response. Supports simple wildcards.

Supported values include:
- active (or a): Number of active threads in the current thread pool.
- completed (or c): Number of tasks completed by the thread pool executor.
- core (or cr): Configured core number of active threads allowed in the current thread pool.
- ephemeral_id (or eid): Ephemeral node ID.
- host (or h): Hostname for the current node.
- ip (or i): IP address for the current node.
- keep_alive (or k): Configured keep alive time for threads.
- largest (or l): Highest number of active threads in the current thread pool.
- max (or mx): Configured maximum number of active threads allowed in the current thread pool.
- name: Name of the thread pool, such as analyze or generic.
- node_id (or id): ID of the node, such as k0zy.
- node_name: Node name, such as I8hydUG.
- pid (or p): Process ID of the running node.
- pool_size (or psz): Number of threads in the current thread pool.
- port (or po): Bound transport port for the current node.
- queue (or q): Number of tasks in the queue for the current thread pool.
- queue_size (or qs): Maximum number of tasks permitted in the queue for the current thread pool.
- rejected (or r): Number of tasks rejected by the thread pool executor.
- size (or sz): Configured fixed number of active threads allowed in the current thread pool.
- type (or t): Type of thread pool. Returned values are fixed, fixed_auto_queue_size, direct, or scaling.
Values are active, a, completed, c, core, cr, ephemeral_id, eid, host, h, ip, i, keep_alive, k, largest, l, max, mx, name, node_id, id, node_name, pid, p, pool_size, psz, port, po, queue, q, queue_size, qs, rejected, r, size, sz, type, or t.
s string | array[string]

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

The period to wait for a connection to the master node.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- node_name string
  
  The node name.
- node_id string
  
  The persistent node identifier.
- ephemeral_node_id string
  
  The ephemeral node identifier.
- pid string
  
  The process identifier.
- host string
  
  The host name for the current node.
- ip string
  
  The IP address for the current node.
- port string
  
  The bound transport port for the current node.
- name string
  
  The thread pool name.
- type string
  
  The thread pool type. Returned values include fixed, fixed_auto_queue_size, direct, and scaling.
- active string
  
  The number of active threads in the current thread pool.
- pool_size string
  
  The number of threads in the current thread pool.
- queue string
  
  The number of tasks currently in queue.
- queue_size string
  
  The maximum number of tasks permitted in the queue.
- rejected string
  
  The number of rejected tasks.
- largest string
  
  The highest number of active threads in the current thread pool.
- completed string
  
  The number of completed tasks.
- core string | null
  
  The core number of active threads allowed in a scaling thread pool.
  
  One of:
  string-1 string string-2 string | null
- max string | null
  
  The maximum number of active threads allowed in a scaling thread pool.
  
  One of:
  string-1 string string-2 string | null
- size string | null
  
  The number of active threads allowed in a fixed thread pool.
  
  One of:
  string-1 string string-2 string | null
- keep_alive string | null
  
  The thread keep alive time.
  
  One of:
  string-1 string string-2 string | null

GET /_cat/thread_pool/{thread_pool_patterns}

GET /_cat/thread_pool?format=json

resp = client.cat.thread_pool(
    format="json",
)

const response = await client.cat.threadPool({
  format: "json",
});

response = client.cat.thread_pool(
  format: "json"
)

$resp = $client->cat()->threadPool([
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/thread_pool?format=json"

client.cat().threadPool();

Response examples (200)

A successful response from `GET /_cat/thread_pool?format=json`.

[
  {
    "node_name": "node-0",
    "name": "analyze",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "fetch_shard_started",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "fetch_shard_store",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "flush",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "write",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  }
]

A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool.

[
  {
    "id": "0EWUhXeBQtaVGlexUeVwMg",
    "name": "generic",
    "active": "0",
    "rejected": "0",
    "completed": "70"
  }
]

Update voting configuration exclusions Generally available; Added in 7.0.0

POST /_cluster/voting_config_exclusions

Api key auth Basic auth Bearer auth

Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.

Clusters should have no voting configuration exclusions in normal operation. Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. This API waits for the nodes to be fully removed from the cluster before it returns. If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.

A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. In that case, you may safely retry the call.

NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.

External documentation

Query parameters

node_names string | array[string]

A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids.
node_ids string | array[string]

A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names.
master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.
timeout string

When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error.

Values are -1 or 0.

Responses

200 application/json

POST /_cluster/voting_config_exclusions

curl \
 --request POST 'http://api.example.com/_cluster/voting_config_exclusions' \
 --header "Authorization: $API_KEY"

Get cluster-wide settings Generally available

GET /_cluster/settings

Api key auth Basic auth Bearer auth

By default, it returns only settings that have been explicitly defined.

Required authorization

Cluster privileges: monitor

External documentation

Query parameters

flat_settings boolean

If true, returns settings in flat format.
include_defaults boolean

If true, also returns default values for all other cluster settings, reflecting the values in the elasticsearch.yml file of one of the nodes in the cluster. If the nodes in your cluster do not all have the same values in their elasticsearch.yml config files then the values returned by this API may vary from invocation to invocation and may not reflect the values that Elasticsearch uses in all situations. Use the GET _nodes/settings API to fetch the settings for each individual node in your cluster.
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.

Values are -1 or 0.
timeout string

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

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- persistent object Required
  
  The settings that persist after the cluster restarts.
  
  Hide persistent attribute Show persistent attribute object
  
  * object Additional properties
- transient object Required
  
  The settings that do not persist after the cluster restarts.
  
  Hide transient attribute Show transient attribute object
  
  * object Additional properties
- defaults object
  
  The default setting values.
  
  Hide defaults attribute Show defaults attribute object
  
  * object Additional properties

GET /_cluster/settings

GET /_cluster/settings?filter_path=persistent.cluster.remote

resp = client.cluster.get_settings(
    filter_path="persistent.cluster.remote",
)

const response = await client.cluster.getSettings({
  filter_path: "persistent.cluster.remote",
});

response = client.cluster.get_settings(
  filter_path: "persistent.cluster.remote"
)

$resp = $client->cluster()->getSettings([
    "filter_path" => "persistent.cluster.remote",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cluster/settings?filter_path=persistent.cluster.remote"

Ping the cluster Generally available

HEAD /

Api key auth Basic auth Bearer auth

Get information about whether the cluster is running.

Responses

200 application/json

HEAD /

curl \
 --request HEAD 'http://api.example.com/' \
 --header "Authorization: $API_KEY"

Get the hot threads for nodes Generally available

GET /_nodes/{node_id}/hot_threads

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_nodes/hot_threads

GET /_nodes/{node_id}/hot_threads

Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

Required authorization

Cluster privileges: monitor,manage

Path parameters

node_id string | array[string] Required

List of node IDs or names used to limit returned information.

Query parameters

ignore_idle_threads boolean

If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out.
interval string

The interval to do the second sampling of threads.

Values are -1 or 0.
snapshots number

Number of samples of thread stacktrace.
threads number

Specifies the number of hot threads to provide information for.
timeout string

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

Values are -1 or 0.
type string

The type to sample.

Values are cpu, wait, block, gpu, or mem.
sort string

The sort order for 'cpu' type (default: total)

Values are cpu, wait, block, gpu, or mem.

Responses

200 application/json

GET /_nodes/{node_id}/hot_threads

GET /_nodes/hot_threads

resp = client.nodes.hot_threads()

const response = await client.nodes.hotThreads();

response = client.nodes.hot_threads

$resp = $client->nodes()->hotThreads();

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_nodes/hot_threads"

client.nodes().hotThreads(h -> h);

Get node statistics Generally available

GET /_nodes/{node_id}/stats/{metric}/{index_metric}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_nodes/stats

GET /_nodes/stats/{metric}

GET /_nodes/{node_id}/stats

GET /_nodes/{node_id}/stats/{metric}

GET /_nodes/stats/{metric}/{index_metric}

GET /_nodes/{node_id}/stats/{metric}/{index_metric}

Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.

Required authorization

Cluster privileges: monitor,manage

Path parameters

node_id string | array[string] Required

Comma-separated list of node IDs or names used to limit returned information.
metric string | array[string] Required

Limit the information returned to the specified metrics
index_metric string | array[string] Required

Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.

Query parameters

completion_fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
fielddata_fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in the statistics.
groups boolean

Comma-separated list of search groups to include in the search statistics.
include_segment_file_sizes boolean

If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
level string

Indicates whether statistics are aggregated at the cluster, index, or shard level.

Values are cluster, indices, or shards.
timeout string

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

Values are -1 or 0.
types array[string]

A comma-separated list of document types for the indexing index metric.
include_unloaded_segments boolean

If true, the response includes information from segments that are not loaded into memory.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request’s node filters.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by
  
  root_cause array[object]
  
  suppressed array[object]
  
  total number Required
  
  Total number of nodes selected by the request.
  
  successful number Required
  
  Number of nodes that responded successfully to the request.
  
  failed number Required
  
  Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
- cluster_name string
- nodes object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  adaptive_selection object
  
  Statistics about adaptive replica selection.
  
  Hide adaptive_selection attribute Show adaptive_selection attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  avg_queue_size number
  
  The exponentially weighted moving average queue size of search requests on the keyed node.
  
  avg_response_time_ns number
  
  The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.
  
  avg_service_time_ns number
  
  The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.
  
  outgoing_searches number
  
  The number of outstanding search requests to the keyed node from the node these stats are for.
  
  rank string
  
  The rank of this node; used for shard selection when routing search requests.
  
  breakers object
  
  Statistics about the field data circuit breaker.
  
  Hide breakers attribute Show breakers attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  estimated_size string
  
  Estimated memory used for the operation.
  
  estimated_size_in_bytes number
  
  Estimated memory used, in bytes, for the operation.
  
  limit_size string
  
  Memory limit for the circuit breaker.
  
  limit_size_in_bytes number
  
  Memory limit, in bytes, for the circuit breaker.
  
  overhead number
  
  A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.
  
  tripped number
  
  Total number of times the circuit breaker has been triggered and prevented an out of memory error.
  
  fs object
  
  File system information, data path, free disk space, read/write stats.
  
  Hide fs attributes Show fs attributes object
  
  data array[object]
  
  List of all file stores.
  
  timestamp number
  
  Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch.
  
  host string
  
  Network host for the node, based on the network host setting.
  
  http object
  
  HTTP connection information.
  
  Hide http attributes Show http attributes object
  
  current_open number
  
  Current number of open HTTP connections for the node.
  
  total_opened number
  
  Total number of HTTP connections opened for the node.
  
  clients array[object]
  
  Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here.
  
  routes object Required Generally available; Added in 8.12.0
  
  Detailed HTTP stats broken down by route
  
  ingest object
  
  Statistics about ingest preprocessing.
  
  Hide ingest attribute Show ingest attribute object
  
  pipelines object
  
  Contains statistics about ingest pipelines for the node.
  
  ip string | array[string]
  
  IP address and port for the node.
  
  One of:
  Ip string array-2 array[string]
  
  jvm object
  
  JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.
  
  Hide jvm attributes Show jvm attributes object
  
  buffer_pools object
  
  Contains statistics about JVM buffer pools for the node.
  
  timestamp number
  
  Last time JVM statistics were refreshed.
  
  uptime string
  
  Human-readable JVM uptime. Only returned if the human query parameter is true.
  
  uptime_in_millis number
  
  JVM uptime in milliseconds.
  
  name string
  
  Human-readable identifier for the node. Based on the node name setting.
  
  os object
  
  Operating system stats, load average, mem, swap.
  
  Hide os attribute Show os attribute object
  
  timestamp number
  
  process object
  
  Process statistics, memory consumption, cpu usage, open file descriptors.
  
  Hide process attributes Show process attributes object
  
  open_file_descriptors number
  
  Number of opened file descriptors associated with the current or -1 if not supported.
  
  max_file_descriptors number
  
  Maximum number of file descriptors allowed on the system, or -1 if not supported.
  
  timestamp number
  
  Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch.
  
  roles array[string]
  
  Roles assigned to the node.
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  script object
  
  Contains script statistics for the node.
  
  Hide script attributes Show script attributes object
  
  cache_evictions number
  
  Total number of times the script cache has evicted old data.
  
  compilations number
  
  Total number of inline script compilations performed by the node.
  
  compilations_history object
  
  Contains this recent history of script compilations.
  
  compilation_limit_triggered number
  
  Total number of times the script compilation circuit breaker has limited inline script compilations.
  
  contexts array[object]
  
  script_cache object
  
  thread_pool object
  
  Statistics about each thread pool, including current size, queue and rejected tasks.
  
  Hide thread_pool attribute Show thread_pool attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  active number
  
  Number of active threads in the thread pool.
  
  completed number
  
  Number of tasks completed by the thread pool executor.
  
  largest number
  
  Highest number of active threads in the thread pool.
  
  queue number
  
  Number of tasks in queue for the thread pool.
  
  rejected number
  
  Number of tasks rejected by the thread pool executor.
  
  threads number
  
  Number of threads in the thread pool.
  
  timestamp number
  
  transport object
  
  Transport statistics about sent and received bytes in cluster communication.
  
  Hide transport attributes Show transport attributes object
  
  inbound_handling_time_histogram array[object]
  
  The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.
  
  outbound_handling_time_histogram array[object]
  
  The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.
  
  rx_count number
  
  Total number of RX (receive) packets received by the node during internal cluster communication.
  
  rx_size string
  
  Size of RX packets received by the node during internal cluster communication.
  
  rx_size_in_bytes number
  
  Size, in bytes, of RX packets received by the node during internal cluster communication.
  
  server_open number
  
  Current number of inbound TCP connections used for internal communication between nodes.
  
  tx_count number
  
  Total number of TX (transmit) packets sent by the node during internal cluster communication.
  
  tx_size string
  
  Size of TX packets sent by the node during internal cluster communication.
  
  tx_size_in_bytes number
  
  Size, in bytes, of TX packets sent by the node during internal cluster communication.
  
  total_outbound_connections number
  
  The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster.
  
  transport_address string
  
  Host and port for the transport layer, used for internal communication between nodes in a cluster.
  
  attributes object
  
  Contains a list of attributes for the node.
  
  Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  discovery object
  
  Contains node discovery statistics for the node.
  
  Hide discovery attribute Show discovery attribute object
  
  cluster_state_update object
  
  Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. Omitted if the node is not master-eligible. Every field whose name ends in _time within this object is also represented as a raw number of milliseconds in a field whose name ends in _time_millis. The human-readable fields with a _time suffix are only returned if requested with the ?human=true query parameter.
  
  indexing_pressure object
  
  Contains indexing pressure statistics for the node.
  
  indices object
  
  Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.
  
  Hide indices attribute Show indices attribute object
  
  shards object Generally available; Added in 7.15.0

GET /_nodes/{node_id}/stats/{metric}/{index_metric}

GET _nodes/stats/process?filter_path=**.max_file_descriptors

resp = client.nodes.stats(
    metric="process",
    filter_path="**.max_file_descriptors",
)

const response = await client.nodes.stats({
  metric: "process",
  filter_path: "**.max_file_descriptors",
});

response = client.nodes.stats(
  metric: "process",
  filter_path: "**.max_file_descriptors"
)

$resp = $client->nodes()->stats([
    "metric" => "process",
    "filter_path" => "**.max_file_descriptors",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_nodes/stats/process?filter_path=**.max_file_descriptors"

Elasticsearch API

Documentation source and versions

Behavioral analytics

Get behavioral analytics collections Technical preview; Added in 8.8.0

Path parameters

Responses

Create a behavioral analytics collection Technical preview; Added in 8.8.0

Path parameters

Responses

Delete a behavioral analytics collection Technical preview; Added in 8.8.0

Path parameters

Responses

Create a behavioral analytics collection event Technical preview

Path parameters

Query parameters

Body Required

Responses

Get aliases Generally available

Required authorization

Path parameters

Query parameters

Responses

Get component templates Generally available; Added in 5.1.0

Required authorization

Path parameters

Query parameters

Responses

version string | null Required

Get index information Generally available

Required authorization

Path parameters

Query parameters

Responses

docs.count string | null

docs.deleted string | null

store.size string | null

pri.store.size string | null

dataset.size string | null

Get node attribute information Generally available

Required authorization

Query parameters

Responses

Get node information Generally available

Required authorization

Query parameters

Responses

disk.total number | string

disk.used number | string

disk.avail number | string

disk.used_percent string | number

heap.percent string | number

ram.percent string | number

file_desc.percent string | number

Get plugin information Generally available

Required authorization

Query parameters

Responses

Get shard recovery information Generally available

Required authorization

Path parameters

Query parameters

Responses

start_time string | number

stop_time string | number

files_percent string | number

bytes_percent string | number

translog_ops_percent string | number

Get shard information Generally available

Required authorization

Path parameters

Query parameters

Responses

docs string | null

store string | null

dataset string | null

ip string | null

node string | null

Get snapshot information Generally available; Added in 2.1.0

Required authorization

Path parameters