Elasticsearch Cluster API

The Cluster API from Elasticsearch — 3 operation(s) for cluster.

OpenAPI Specification

elasticsearch-cluster-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Elasticsearch REST Cat Cluster API
  version: 8.x
  description: Elasticsearch REST API provides programmatic access to document indexing, searching, aggregations, index lifecycle, and cluster operations. Supports basic authentication and API keys.
  contact:
    name: Elastic
    url: https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html
servers:
- url: https://{host}:{port}
  description: Elasticsearch cluster
  variables:
    host:
      default: localhost
    port:
      default: '9200'
security:
- basicAuth: []
- apiKeyAuth: []
tags:
- name: Cluster
paths:
  /_cluster/health:
    get:
      summary: Cluster health
      operationId: clusterHealth
      tags:
      - Cluster
      responses:
        '200':
          description: Health
  /_cluster/state:
    get:
      summary: Cluster state
      operationId: clusterState
      tags:
      - Cluster
      responses:
        '200':
          description: State
  /_cluster/stats:
    get:
      summary: Cluster stats
      operationId: clusterStats
      tags:
      - Cluster
      responses:
        '200':
          description: Stats
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization