Get a document count

POST also GET /_cat/count/{index}
POST also GET /_cat/count

Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

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 count API.

Note

Starting in Elasticsearch 9.3.0, this endpoint also supports the POST method. This is primarily intended for project routing in serverless environments.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST /_cat/count/my-index-000001?v=true&format=json

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.cat.count(
    index="my-index-000001",
    v=True,
    format="json",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_cat/count/my-index-000001?v=true&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().count(c -> c
    .index("my-index-000001")
);

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

response = client.cat.count(
  index: "my-index-000001",
  v: "true",
  format: "json"
)

Response

A successful response from GET /_cat/count/my-index-000001?v=true&format=json. It retrieves the document count for the my-index-000001 data stream or index.

[
  {
    "epoch": "1475868259",
    "timestamp": "15:24:20",
    "count": "120"
  }
]

Get a document count

Required authorization

Authentication

Path parameters

Query parameters

Request body

Response