Get a document count Beta

GET /_cat/count/{index}

Provides 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.

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.

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.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
GET /_cat/count/{index}
curl \
 -X GET http://api.example.com/_cat/count/{index}