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
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Feedback
Elasticsearch API logo
main
  • main default
  • v8
  • v9

Topics

  • Introduction
  • Authentication

Endpoints

  • Autoscaling
    • Get an autoscaling policy GET
    • Create or update an autoscaling policy PUT
    • Delete an autoscaling policy DELETE
    • Get the autoscaling capacity GET
  • Behavioral analytics
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection PUT
    • Delete a behavioral analytics collection DELETE
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection event POST
  • Compact and aligned text (CAT)
    • Get aliases GET
    • Get aliases GET
    • Get shard allocation information GET
    • Get shard allocation information GET
    • Get component templates GET
    • Get component templates GET
    • Get a document count GET
    • Get a document count GET
    • Get field data cache information GET
    • Get field data cache information GET
    • Get the cluster health status GET
    • Get CAT help GET
    • Get index information GET
    • Get index information GET
    • Get master node information GET
    • Get data frame analytics jobs GET
    • Get data frame analytics jobs GET
    • Get datafeeds GET
    • Get datafeeds GET
    • Get anomaly detection jobs GET
    • Get anomaly detection jobs GET
    • Get trained models 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 shard recovery information GET
    • Get snapshot repository information GET
    • Get segment information GET
    • Get segment information GET
    • Get shard information GET
    • Get shard information GET
    • Get snapshot information GET
    • Get snapshot information GET
    • Get task information GET
    • Get index template information GET
    • Get index template information GET
    • Get thread pool statistics GET
    • Get thread pool statistics GET
    • Get transform information GET
    • Get transform information GET
  • Cluster
    • Explain the shard allocations GET
    • 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 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 the cluster state GET
    • Get the cluster state GET
    • Get cluster statistics 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 the hot threads for nodes GET
    • Get node information GET
    • Get node information GET
    • Get node information GET
    • Get node information GET
    • Reload the keystore on nodes in the cluster POST
    • Reload the keystore on nodes in the cluster POST
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get node statistics GET
    • Get feature usage information GET
    • Get feature usage information GET
    • Get feature usage information GET
    • Get feature usage information GET
  • Cluster - Health
    • Get the cluster health GET
    • 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 or update a connector PUT
    • 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
    • Get auto-follow patterns GET
    • 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 stats GET
    • Get data stream lifecycles GET
    • Update data stream lifecycles PUT
    • Downsample an index POST
    • Get the status for a data stream lifecycle GET
    • Get data stream lifecycle stats GET
    • Get data streams GET
    • Convert an index alias to a data stream POST
    • Update data streams POST
    • Promote a data stream POST
  • Document
    • Bulk index or delete documents PUT
    • Bulk index or delete documents POST
    • Bulk index or delete documents PUT
    • Bulk index or delete documents POST
    • Create a new document in the index PUT
    • Create a new document in the index POST
    • Get a document by its ID GET
    • Create or update a document in an index PUT
    • Create or update a document in an index POST
    • Delete a document DELETE
    • Check a document HEAD
    • Delete documents POST
    • Throttle a delete by query operation POST
    • Get a document's source GET
    • Check for a document source HEAD
    • Create or update a document in an index POST
    • Get multiple documents GET
    • Get multiple documents POST
    • Get multiple documents GET
    • Get multiple documents POST
    • Get multiple term vectors GET
    • Get multiple term vectors POST
    • Get multiple term vectors GET
    • Get multiple term vectors POST
    • Reindex documents POST
    • Throttle a reindex operation POST
    • Get term vector information GET
    • Get term vector information POST
    • Get term vector information GET
    • Get term vector information POST
    • Update a document POST
    • Update documents POST
    • Throttle an update by query operation POST
  • Enrich
    • Get an enrich policy GET
    • Create an enrich policy PUT
    • Delete an enrich policy DELETE
    • Run an enrich policy PUT
    • Get an enrich policy GET
    • Get enrich stats GET
  • EQL
    • Get async EQL search results GET
    • Delete an async EQL search DELETE
    • Get the async EQL status GET
    • Get EQL search results GET
    • Get EQL search results POST
  • ES|QL
    • Run an async ES|QL query POST
    • Get async ES|QL query results GET
    • Delete an async ES|QL query DELETE
    • Stop async ES|QL query POST
    • Get a specific running ES|QL query information GET
    • Get running ES|QL queries information GET
    • Run an ES|QL query POST
  • Features
    • Get the features GET
    • Reset the features POST
  • Fleet
    • Get global checkpoints GET
    • Run multiple Fleet searches GET
    • Run multiple Fleet searches POST
    • Run multiple Fleet searches GET
    • Run multiple Fleet searches POST
    • Run a Fleet search GET
    • Run a Fleet search POST
  • Graph explore
    • Explore graph analytics GET
    • Explore graph analytics POST
  • Index
    • Get component templates GET
    • Create or update a component template PUT
    • Create or update a component template POST
    • Delete component templates DELETE
    • Check component templates HEAD
    • Get component templates GET
    • Import a dangling index POST
    • Delete a dangling index DELETE
    • Get the dangling indices GET
    • Add an index block PUT
    • Get tokens from text analysis GET
    • Get tokens from text analysis POST
    • Get tokens from text analysis GET
    • Get tokens from text analysis POST
    • Clear the cache POST
    • Clear the cache POST
    • Clone an index PUT
    • Clone an index POST
    • Close an index POST
    • Get index information GET
    • Create an index PUT
    • Delete indices DELETE
    • Check indices HEAD
    • Get aliases GET
    • Create or update an alias PUT
    • Create or update an alias POST
    • Delete an alias DELETE
    • Check aliases HEAD
    • Create or update an alias PUT
    • Create or update an alias POST
    • Delete an alias DELETE
    • Delete data stream lifecycles DELETE
    • Get index templates GET
    • Create or update an index template PUT
    • Create or update an index template POST
    • Delete an index template DELETE
    • Check index templates HEAD
    • Get legacy index templates GET
    • Create or update a legacy index template PUT
    • Create or update a legacy index template POST
    • Delete a legacy index template DELETE
    • Check existence of index templates HEAD
    • Analyze the index disk usage POST
    • Get aliases GET
    • Check aliases HEAD
    • Get field usage stats GET
    • Flush data streams or indices GET
    • Flush data streams or indices POST
    • Flush data streams or indices GET
    • Flush data streams or indices POST
    • Force a merge POST
    • Force a merge POST
    • Get aliases GET
    • Get aliases GET
    • Get mapping definitions GET
    • Get mapping definitions GET
    • Get index templates GET
    • Get mapping definitions GET
    • Get mapping definitions GET
    • Update field mappings PUT
    • Update field mappings POST
    • Get index settings GET
    • Update index settings PUT
    • Get index settings GET
    • Update index settings PUT
    • Get index settings GET
    • Get index settings GET
    • Get legacy index templates GET
    • Open a closed index POST
    • Get index recovery information GET
    • Get index recovery information GET
    • Refresh an index GET
    • Refresh an index POST
    • Refresh an index GET
    • Refresh an index POST
    • Reload search analyzers GET
    • Reload search analyzers POST
    • Resolve the cluster GET
    • Resolve the cluster GET
    • Resolve indices GET
    • Roll over to a new index POST
    • Roll over to a new index POST
    • Get index segments GET
    • Get index segments GET
    • Get index shard stores GET
    • Get index shard stores GET
    • Shrink an index PUT
    • Shrink an index POST
    • Simulate an index POST
    • Simulate an index template POST
    • Simulate an index template POST
    • Split an index PUT
    • Split an index POST
    • Get index statistics GET
    • Get index statistics GET
    • Get index statistics GET
    • Get index statistics GET
    • Create or update an alias POST
    • Validate a query GET
    • Validate a query POST
    • Validate a query GET
    • Validate a query POST
  • Index lifecycle management
    • Get lifecycle policies GET
    • Create or update a lifecycle policy PUT
    • Delete a lifecycle policy DELETE
    • Explain the lifecycle state GET
    • Get lifecycle policies GET
    • Get the ILM status GET
    • Migrate to data tiers routing POST
    • Move to a lifecycle step POST
    • Remove policies from an index POST
    • Retry a policy POST
    • Start the ILM plugin POST
    • Stop the ILM plugin POST
  • Inference
    • Perform chat completion inference POST
    • Perform completion inference on the service POST
    • Get an inference endpoint GET
    • Create an inference endpoint PUT
    • Perform inference on the service POST
    • Delete an inference endpoint DELETE
    • Get an inference endpoint GET
    • Create an inference endpoint PUT
    • Perform inference on the service POST
    • Delete an inference endpoint DELETE
    • Get an inference endpoint GET
    • Create an AlibabaCloud AI Search inference endpoint PUT
    • Create an Amazon Bedrock inference endpoint PUT
    • Create an Anthropic inference endpoint PUT
    • Create an Azure AI studio inference endpoint PUT
    • Create an Azure OpenAI inference endpoint PUT
    • Create a Cohere inference endpoint PUT
    • Create an Elasticsearch inference endpoint PUT
    • Create an ELSER inference endpoint PUT
    • Create an Google AI Studio inference endpoint PUT
    • Create a Google Vertex AI inference endpoint PUT
    • Create a Hugging Face inference endpoint PUT
    • Create an JinaAI inference endpoint PUT
    • Create a Mistral inference endpoint PUT
    • Create an OpenAI inference endpoint PUT
    • Create a VoyageAI inference endpoint PUT
    • Create a Watsonx inference endpoint PUT
    • Perform rereanking inference on the service POST
    • Perform sparse embedding inference on the service POST
    • Perform streaming inference POST
    • Perform text embedding inference on the service POST
    • Update an inference endpoint PUT
    • Update an inference endpoint PUT
  • Info
    • Get cluster info GET
  • Ingest
    • Get GeoIP database configurations GET
    • Create or update a GeoIP database configuration PUT
    • Delete GeoIP database configurations DELETE
    • Get IP geolocation database configurations GET
    • Create or update an IP geolocation database configuration PUT
    • Delete IP geolocation database configurations DELETE
    • Get pipelines GET
    • Create or update a pipeline PUT
    • Delete pipelines DELETE
    • Get GeoIP statistics GET
    • Get GeoIP database configurations GET
    • Get IP geolocation database configurations GET
    • Get pipelines GET
    • Run a grok processor GET
    • Simulate a pipeline GET
    • Simulate a pipeline POST
    • Simulate a pipeline GET
    • Simulate a pipeline POST
    • Simulate data ingestion GET
    • Simulate data ingestion POST
    • Simulate data ingestion GET
    • Simulate data ingestion POST
  • Licensing
    • Get license information GET
    • Update the license PUT
    • Update the license POST
    • Delete the license DELETE
    • Get the basic license status GET
    • Get the trial status GET
    • Start a basic license POST
    • Start a trial POST
  • Logstash
    • Get Logstash pipelines GET
    • Create or update a Logstash pipeline PUT
    • Delete a Logstash pipeline DELETE
    • Get Logstash pipelines GET
  • Machine learning
    • Get machine learning memory usage info GET
    • Get machine learning memory usage info GET
    • Get machine learning information GET
    • Set upgrade_mode for ML indices POST
  • Machine learning anomaly detection
    • Close anomaly detection jobs POST
    • Get calendar configuration info GET
    • Create a calendar PUT
    • Get calendar configuration info POST
    • Delete a calendar DELETE
    • Delete events from a calendar DELETE
    • Add anomaly detection job to calendar PUT
    • Delete anomaly jobs from a calendar DELETE
    • Get datafeeds configuration info GET
    • Create a datafeed PUT
    • Delete a datafeed DELETE
    • Delete expired ML data DELETE
    • Delete expired ML data DELETE
    • Get filters GET
    • Create a filter PUT
    • Delete a filter DELETE
    • Predict future behavior of a time series POST
    • Delete forecasts from a job DELETE
    • Delete forecasts from a job DELETE
    • Get anomaly detection jobs configuration info GET
    • Create an anomaly detection job PUT
    • Delete an anomaly detection job DELETE
    • Get model snapshots info GET
    • Get model snapshots info POST
    • Delete a model snapshot DELETE
    • Estimate job model memory usage POST
    • Force buffered data to be processed POST
    • Get anomaly detection job results for buckets GET
    • Get anomaly detection job results for buckets POST
    • Get anomaly detection job results for buckets GET
    • Get anomaly detection job results for buckets POST
    • Get info about events in calendars GET
    • Add scheduled events to the calendar POST
    • Get calendar configuration info GET
    • Get calendar configuration info POST
    • Get anomaly detection job results for categories GET
    • Get anomaly detection job results for categories POST
    • Get anomaly detection job results for categories GET
    • Get anomaly detection job results for categories POST
    • Get datafeed stats GET
    • Get datafeed stats GET
    • Get datafeeds configuration info GET
    • Get filters GET
    • Get anomaly detection job results for influencers GET
    • Get anomaly detection job results for influencers POST
    • Get anomaly detection job stats GET
    • Get anomaly detection job stats GET
    • Get anomaly detection jobs configuration info GET
    • Get anomaly detection job model snapshot upgrade usage info GET
    • Get model snapshots info GET
    • Get model snapshots info POST
    • Get overall bucket results GET
    • Get overall bucket results POST
    • Get anomaly records for an anomaly detection job GET
    • Get anomaly records for an anomaly detection job POST
    • Open anomaly detection jobs POST
    • Send data to an anomaly detection job for analysis POST
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Reset an anomaly detection job POST
    • Revert to a snapshot POST
    • Start datafeeds POST
    • Stop datafeeds POST
    • Update a datafeed POST
    • Update a filter POST
    • Update an anomaly detection job POST
    • Update a snapshot POST
    • Upgrade a snapshot POST
  • Machine learning data frame analytics
    • Get data frame analytics job configuration info GET
    • Create a data frame analytics job PUT
    • Delete a data frame analytics job DELETE
    • Evaluate data frame analytics POST
    • Explain data frame analytics config GET
    • Explain data frame analytics config POST
    • Explain data frame analytics config GET
    • Explain data frame analytics config POST
    • Get data frame analytics job configuration info GET
    • Get data frame analytics job stats GET
    • Get data frame analytics job stats GET
    • Preview features used by data frame analytics GET
    • Preview features used by data frame analytics POST
    • Preview features used by data frame analytics GET
    • Preview features used by data frame analytics POST
    • Start a data frame analytics job POST
    • Stop data frame analytics jobs POST
    • Update a data frame analytics job POST
  • Machine learning trained model
    • Clear trained model deployment cache POST
    • Get trained model configuration info GET
    • Create a trained model PUT
    • Delete an unreferenced trained model DELETE
    • Create or update a trained model alias PUT
    • Delete a trained model alias DELETE
    • Get trained model configuration info GET
    • Get trained models usage info GET
    • Get trained models usage info GET
    • Evaluate a trained model POST
    • Create part of a trained model definition PUT
    • Create a trained model vocabulary PUT
    • Start a trained model deployment POST
    • Stop a trained model deployment POST
    • Update a trained model deployment POST
  • Migration
    • Cancel a migration reindex operation POST
    • Create an index from a source index PUT
    • Create an index from a source index POST
    • Get the migration reindexing status GET
    • Reindex legacy backing indices POST
    • Get deprecation information GET
    • Get deprecation information GET
    • Get feature migration information GET
    • Start the feature migration POST
  • Node lifecycle
    • Get the shutdown status GET
    • Prepare a node to be shut down PUT
    • Cancel node shutdown preparations DELETE
    • Get the shutdown status GET
  • Query rules
    • Get a query rule GET
    • Create or update a query rule PUT
    • Delete a query rule DELETE
    • Get a query ruleset GET
    • Create or update a query ruleset PUT
    • Delete a query ruleset DELETE
    • Get all query rulesets GET
    • Test a query ruleset POST
  • Rollup
    • Get rollup job information GET
    • Create a rollup job PUT
    • Delete a rollup job DELETE
    • Get rollup job information GET
    • Get the rollup job capabilities GET
    • Get the rollup job capabilities GET
    • Get the rollup index capabilities GET
    • Search rolled-up data GET
    • Search rolled-up data POST
    • Start rollup jobs POST
    • Stop rollup jobs POST
  • Script
    • Get a script or search template GET
    • Create or update a script or search template PUT
    • Create or update a script or search template POST
    • Delete a script or search template DELETE
    • Get script contexts GET
    • Get script languages GET
    • Create or update a script or search template PUT
    • Create or update a script or search template POST
    • Run a script GET
    • Run a script POST
  • Search
    • Get async search results GET
    • Delete an async search DELETE
    • Get the async search status GET
    • Run an async search POST
    • Run an async search POST
    • Run a scrolling search GET
    • Run a scrolling search POST
    • Clear a scrolling search DELETE
    • Run a scrolling search GET
    • Run a scrolling search POST
    • Clear a scrolling search DELETE
    • Close a point in time DELETE
    • Count search results GET
    • Count search results POST
    • Count search results GET
    • Count search results POST
    • Explain a document match result GET
    • Explain a document match result POST
    • Get the field capabilities GET
    • Get the field capabilities POST
    • Get the field capabilities GET
    • Get the field capabilities POST
    • Run multiple searches GET
    • Run multiple searches POST
    • Run multiple searches GET
    • Run multiple searches POST
    • Run multiple templated searches GET
    • Run multiple templated searches POST
    • Run multiple templated searches GET
    • Run multiple templated searches POST
    • Open a point in time POST
    • Evaluate ranked search results GET
    • Evaluate ranked search results POST
    • Evaluate ranked search results GET
    • Evaluate ranked search results POST
    • Render a search template GET
    • Render a search template POST
    • Render a search template GET
    • Render a search template POST
    • Run a search GET
    • Run a search POST
    • Run a search GET
    • Run a search POST
    • Search a vector tile GET
    • Search a vector tile POST
    • Get the search shards GET
    • Get the search shards POST
    • Get the search shards GET
    • Get the search shards POST
    • Run a search with a search template GET
    • Run a search with a search template POST
    • Run a search with a search template GET
    • Run a search with a search template POST
    • Get terms in an index GET
    • Get terms in an index POST
  • Search application
    • Get search application details GET
    • Create or update a search application PUT
    • Delete a search application DELETE
    • Get search applications GET
    • Render a search application query POST
    • Run a search application search GET
    • Run a search application search POST
  • Searchable snapshots
    • Get cache statistics GET
    • Get cache statistics GET
    • Clear the cache POST
    • Clear the cache POST
    • Mount a snapshot POST
    • Get searchable snapshot statistics GET
    • Get searchable snapshot statistics GET
  • Security
    • Activate a user profile POST
    • Authenticate a user GET
    • Get roles GET
    • Bulk create or update roles POST
    • Bulk delete roles DELETE
    • Bulk update API keys POST
    • Change passwords PUT
    • Change passwords POST
    • Change passwords PUT
    • Change passwords POST
    • Clear the API key cache POST
    • Clear the privileges cache POST
    • Clear the user cache POST
    • Clear the roles cache POST
    • Clear service account token caches POST
    • Get API key information GET
    • Create an API key PUT
    • Create an API key POST
    • Invalidate API keys DELETE
    • Create a cross-cluster API key POST
    • Create a service account token PUT
    • Create a service account token POST
    • Delete service account tokens DELETE
    • Create a service account token POST
    • Delegate PKI authentication POST
    • Get application privileges GET
    • Delete application privileges DELETE
    • Get roles GET
    • Create or update roles PUT
    • Create or update roles POST
    • Delete roles DELETE
    • Get role mappings GET
    • Create or update role mappings PUT
    • Create or update role mappings POST
    • Delete role mappings DELETE
    • Get users GET
    • Create or update users PUT
    • Create or update users POST
    • Delete users DELETE
    • Disable users PUT
    • Disable users POST
    • Disable a user profile PUT
    • Disable a user profile POST
    • Enable users PUT
    • Enable users POST
    • Enable a user profile PUT
    • Enable a user profile POST
    • Enroll Kibana GET
    • Enroll a node GET