Elastic APIs hub
  • Elastic Cloud API
  • Elastic Cloud Billing API
  • Elastic Cloud Enterprise API
  • Elastic Cloud Serverless API
  • Elasticsearch API
  • Elasticsearch Serverless API
  • Kibana API
  • Kibana Serverless API
  • Logstash API
  • Observability Intake Serverless API
Back to hub page
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Feedback
Elasticsearch API logo
v8
  • main default
  • v8
  • v9

Topics

  • Introduction
  • Authentication

Endpoints

  • Behavioral analytics
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection PUT
    • Delete a behavioral analytics collection DELETE
    • Create a behavioral analytics collection event POST
  • Compact and aligned text (CAT)
    • Get aliases GET
    • Get shard allocation information GET
    • Get component templates GET
    • Get a document count GET
    • Get field data cache information GET
    • Get the cluster health status GET
    • Get CAT help GET
    • Get index information GET
    • Get master node information GET
    • Get data frame analytics jobs GET
    • Get datafeeds GET
    • Get anomaly detection jobs GET
    • Get trained models GET
    • Get node attribute information GET
    • Get node information GET
    • Get pending task information GET
    • Get plugin information GET
    • Get shard recovery information GET
    • Get snapshot repository information GET
    • Get segment information GET
    • Get shard information GET
    • Get snapshot information GET
    • Get task information GET
    • Get index template information GET
    • Get thread pool statistics GET
    • Get transform information GET
  • Cluster
    • Explain the shard allocations POST
    • Update voting configuration exclusions POST
    • Clear cluster voting config exclusions DELETE
    • Get cluster-wide settings GET
    • Update the cluster settings PUT
    • Get the cluster health status GET
    • Get cluster info GET
    • Get the pending cluster tasks GET
    • Get remote cluster information GET
    • Reroute the cluster POST
    • Get the cluster state GET
    • Get cluster statistics GET
    • Ping the cluster HEAD
    • Clear the archived repositories metering DELETE
    • Get cluster repositories metering GET
    • Get the hot threads for nodes GET
    • Get node information GET
    • Reload the keystore on nodes in the cluster POST
    • Get node statistics GET
    • Get feature usage information GET
  • Cluster - Health
    • Get the cluster health GET
  • Connector
    • Check in a connector PUT
    • Get a connector GET
    • Create or update a connector PUT
    • Delete a connector DELETE
    • Get all connectors GET
    • Create a connector POST
    • Cancel a connector sync job PUT
    • Check in a connector sync job PUT
    • Claim a connector sync job PUT
    • Get a connector sync job GET
    • Delete a connector sync job DELETE
    • Set a connector sync job error PUT
    • Get all connector sync jobs GET
    • Create a connector sync job POST
    • Set the connector sync job stats PUT
    • Activate the connector draft filter PUT
    • Update the connector API key ID PUT
    • Update the connector configuration PUT
    • Update the connector error field PUT
    • Update the connector features PUT
    • Update the connector filtering PUT
    • Update the connector draft filtering validation PUT
    • Update the connector index name PUT
    • Update the connector name and description PUT
    • Update the connector is_native flag PUT
    • Update the connector pipeline PUT
    • Update the connector scheduling PUT
    • Update the connector service type PUT
    • Update the connector status PUT
  • Cross-cluster replication
    • Get auto-follow patterns GET
    • Create or update auto-follow patterns PUT
    • Delete auto-follow patterns DELETE
    • Create a follower PUT
    • Get follower information GET
    • Get follower stats GET
    • Forget a follower POST
    • Pause an auto-follow pattern POST
    • Pause a follower POST
    • Resume an auto-follow pattern POST
    • Resume a follower POST
    • Get cross-cluster replication stats GET
    • Unfollow an index POST
  • Data stream
    • Get data streams GET
    • Create a data stream PUT
    • Delete data streams DELETE
    • Get data stream stats GET
    • Get data stream lifecycles GET