Ping the cluster | Elasticsearch API

Toggle dark mode

Elastic APIs hub

Elastic Cloud API
Elastic Cloud Enterprise API
Elastic Cloud Serverless API
Elasticsearch API
Elasticsearch Serverless API
Kibana API
Kibana Serverless API
Observability Intake Serverless API

Back to hub page

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Feedback

Topics

Introduction

Endpoints

Autoscaling
Behavioral analytics
Compact and aligned text (CAT)
Cluster
Cluster - Health
- Returns the health of the cluster GET
- Returns the health of the cluster GET
Connector
Cross-cluster replication
Data stream
Document
Enrich
EQL
ES|QL
- Executes an ES|QL request POST
Features
- Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot GET
- Resets the internal state of features, usually by deleting system indices POST
Fleet
Graph explore
- Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index GET
- Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index POST
Index
Index lifecycle management
Inference
Info
- Get cluster info GET
Ingest
Licensing
Logstash
Machine learning
Machine learning anomaly detection
Machine learning data frame analytics
Machine learning trained model
Migration
Monitoring
Node lifecycle
Query rules
Rollup
Script
Search
Search application
Searchable snapshots
Security
Snapshot and restore
Snapshot lifecycle management
SQL
Synonyms
Task management
Text structure
Transform
Usage
- Provides general information about the installed X-Pack features GET
- This API provides information about which features are currently enabled and available under the current license and some usage statistics GET
Watcher

Powered by Bump.sh

Ping the cluster

HEAD /

Returns whether the cluster is running.

Responses

200 application/json

HEAD /

curl \
 -X HEAD http://api.example.com/