Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elasticsearch Cat API

The Cat API from Elasticsearch — 3 operation(s) for cat.

Elasticsearch Cat API is one of 5 APIs that Elasticsearch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cat. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 8.x.

Requests are made against a single base URL, https://{host}:{port}.

3 operations 3 paths 0 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
8.x
Base URL
https://localhost:9200
Authentication
HTTP Basic, API Key
Contact
Resource Areas
1

Authentication & Security 2

Elasticsearch Cat API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Cat 3
GET
/_cat/indices
Cat indices
catIndices 1 param → 200
GET
/_cat/nodes
Cat nodes
catNodes → 200
GET
/_cat/health
Cat health
catHealth → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elasticsearch-cat-api-openapi.yml Raw ↑

Other APIs Elasticsearch publishes across the network.

Elasticsearch Cluster API
Elasticsearch Document API
Elasticsearch Index API
Elasticsearch Search API