Elastic Stack (ELK Stack) Cluster API

The Cluster API from Elastic Stack (ELK Stack) — 4 operation(s) for cluster.

OpenAPI Specification

elk-stack-cluster-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Elasticsearch REST Cat Cluster API
  description: 'The Elasticsearch REST API exposes the core operations of the distributed search and analytics engine at the heart of the Elastic Stack. It allows clients to manage indices, ingest and retrieve documents, run search and aggregation queries, inspect cluster and node health, and operate snapshots and ingest pipelines.

    '
  version: 1.0.0
  contact:
    name: Elastic
    url: https://www.elastic.co
servers:
- url: http://localhost:9200
  description: Default local Elasticsearch endpoint
- url: https://{host}:{port}
  description: Self-hosted or Elastic Cloud cluster endpoint
  variables:
    host:
      default: localhost
    port:
      default: '9200'
security:
- basicAuth: []
- apiKeyAuth: []
tags:
- name: Cluster
paths:
  /:
    get:
      summary: Cluster info
      description: Returns basic information about the cluster.
      operationId: getRoot
      tags:
      - Cluster
      responses:
        '200':
          description: Cluster info
  /_info:
    get:
      summary: Cluster information
      operationId: getInfo
      tags:
      - Cluster
      responses:
        '200':
          description: Cluster information
  /_cluster/health:
    get:
      summary: Cluster health
      operationId: getClusterHealth
      tags:
      - Cluster
      responses:
        '200':
          description: Cluster health status
  /_cluster/state:
    get:
      summary: Cluster state
      operationId: getClusterState
      tags:
      - Cluster
      responses:
        '200':
          description: Current cluster state
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: ApiKey <base64-encoded-id:api_key>