Elastic

Elastic Cat API

The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, it's recommend to use a corresponding JSON API. All the cat commands accept a query string parameter `help` to see all the headers and info they provide, and the `/_cat` command alone lists all the available commands.

GitHub OpenAPI

Operations 47

GET /_cat/aliases Get aliases #
GET /_cat/aliases/{name} Get aliases #
GET /_cat/allocation Get shard allocation information #
GET /_cat/allocation/{node_id} Get shard allocation information #
GET /_cat/circuit_breaker Get circuit breakers statistics #
GET /_cat/circuit_breaker/{circuit_breaker_patterns} Get circuit breakers statistics #
GET /_cat/component_templates Get component templates #
GET /_cat/component_templates/{name} Get component templates #
GET /_cat/count Get a document count #
POST /_cat/count Get a document count #
GET /_cat/count/{index} Get a document count #
POST /_cat/count/{index} Get a document count #
GET /_cat/fielddata Get field data cache information #
GET /_cat/fielddata/{fields} Get field data cache information #
GET /_cat/health Get the cluster health status #
GET /_cat Get CAT help #
GET /_cat/indices Get index information #
GET /_cat/indices/{index} Get index information #
GET /_cat/master Get master node information #
GET /_cat/ml/data_frame/analytics Get data frame analytics jobs #
GET /_cat/ml/data_frame/analytics/{id} Get data frame analytics jobs #
GET /_cat/ml/datafeeds Get datafeeds #
GET /_cat/ml/datafeeds/{datafeed_id} Get datafeeds #
GET /_cat/ml/anomaly_detectors Get anomaly detection jobs #
GET /_cat/ml/anomaly_detectors/{job_id} Get anomaly detection jobs #
GET /_cat/ml/trained_models Get trained models #
GET /_cat/ml/trained_models/{model_id} Get trained models #
GET /_cat/nodeattrs Get node attribute information #
GET /_cat/nodes Get node information #
GET /_cat/pending_tasks Get pending task information #
GET /_cat/plugins Get plugin information #
GET /_cat/recovery Get shard recovery information #
GET /_cat/recovery/{index} Get shard recovery information #
GET /_cat/repositories Get snapshot repository information #
GET /_cat/segments Get segment information #
GET /_cat/segments/{index} Get segment information #
GET /_cat/shards Get shard information #
GET /_cat/shards/{index} Get shard information #
GET /_cat/snapshots Get snapshot information #
GET /_cat/snapshots/{repository} Get snapshot information #
GET /_cat/tasks Get task information #
GET /_cat/templates Get index template information #
GET /_cat/templates/{name} Get index template information #
GET /_cat/thread_pool Get thread pool statistics #
GET /_cat/thread_pool/{thread_pool_patterns} Get thread pool statistics #
GET /_cat/transforms Get transform information #
GET /_cat/transforms/{transform_id} Get transform information #

Documentation

📖
Documentation
https://www.elastic.co/docs/api/doc/elasticsearch
📖
Documentation
https://www.elastic.co/docs/api/doc/kibana
📖
Documentation
https://www.elastic.co/docs/api/doc/cloud

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-cat-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/json-schema/elastic-saved-object-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elastic-cat-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elastic-cat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elasticsearch Cat API
  description: 'Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.

    ## Documentation source and versions

    This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.

    This documentation contains work-in-progress information for future Elastic Stack releases.'
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
security:
- apiKeyAuth: []
- basicAuth: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (516 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-cat-api-openapi.yml