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

Elastic Stack (ELK Stack) Cluster API

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

Elastic Stack (ELK Stack) Cluster API is one of 8 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: http://localhost:9200, https://{host}:{port}.

4 operations 4 paths 0 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Elastic Stack (ELK Stack) Cluster 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.

  • apiKeyAuth — ApiKey

Paths & Operations 4

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

Cluster 4
GET
/
Cluster info
getRoot → 200
GET
/_info
Cluster information
getInfo → 200
GET
/_cluster/health
Cluster health
getClusterHealth → 200
GET
/_cluster/state
Cluster state
getClusterState → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-cluster-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Kibana API
Elastic Stack (ELK Stack) Cat API
Elastic Stack (ELK Stack) Document API
Elastic Stack (ELK Stack) Index API
Elastic Stack (ELK Stack) Ingest API
Elastic Stack (ELK Stack) Search API
Elastic Stack (ELK Stack) Snapshot API