Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

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
Elasticsearch API logo Elasticsearch API logo dark
8x-unreleased
  • main default
  • 8x-unreleased
  • v8
  • v9

Topics

  • Introduction

Endpoints

  • Alias
    • Get aliases GET
    • Check aliases HEAD
    • Get aliases GET
    • Get aliases GET
  • Aliases
    • Create or update an alias POST
  • Analyze
    • Get tokens from text analysis GET
    • Get tokens from text analysis POST
    • Get tokens from text analysis GET
    • Get tokens from text analysis POST
  • Application
    • Get search application details GET
    • Create or update a search application PUT
    • Delete a search application DELETE
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection PUT
    • Delete a behavioral analytics collection DELETE
    • Get behavioral analytics collections GET
    • Get search applications GET
    • Create a behavioral analytics collection event POST
    • Render a search application query POST
    • Run a search application search GET
    • Run a search application search POST
  • Async 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
  • Autoscaling
    • Get an autoscaling policy GET
    • Create or update an autoscaling policy PUT
    • Delete an autoscaling policy DELETE
    • Get the autoscaling capacity GET
  • Bulk
    • Bulk index or delete documents PUT
    • Bulk index or delete documents POST
    • Bulk index or delete documents PUT
    • Bulk index or delete documents POST
  • Cache
    • Clear the cache POST
    • Clear the cache POST
  • 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
  • Ccr
    • 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
  • Close
    • Close an index POST
  • 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 the pending cluster tasks 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
  • Component template
    • 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
  • 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
  • Count
    • Count search results GET
    • Count search results POST
    • Count search results GET
    • Count search results POST
  • Create from
    • Create an index from a source index PUT
    • Create an index from a source index POST
  • Dangling
    • Import a dangling index POST
    • Delete a dangling index DELETE
    • Get the dangling indices GET
  • 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
    • Delete data stream lifecycles DELETE
    • Get data stream options GET
    • Update data stream options PUT
    • Delete data stream options DELETE
    • Get data streams GET
    • Get data stream settings GET
    • Update data stream settings PUT
    • Convert an index alias to a data stream POST
    • Update data streams POST
    • Promote a data stream POST
  • Delete by query
    • Delete documents POST
    • Throttle a delete by query operation POST
  • Disk usage
    • Analyze the index disk usage POST
  • Doc
    • Create or update a document in an index 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
  • Features
    • Get the features GET
    • Reset the features POST
  • Field caps
    • Get the field capabilities GET
    • Get the field capabilities POST
    • Get the field capabilities GET
    • Get the field capabilities POST
  • Field usage stats
    • Get field usage stats GET
  • 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
  • Flush
    • Flush data streams or indices GET
    • Flush data streams or indices POST
    • Flush data streams or indices GET
    • Flush data streams or indices POST
  • Forcemerge
    • Force a merge POST
    • Force a merge POST
  • Graph
    • Explore graph analytics GET
    • Explore graph analytics POST
  • Health report
    • Get the cluster health GET
    • Get the cluster health GET
  • Ilm
    • 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
  • Index template
    • 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 index templates GET
    • Simulate an index POST
    • Simulate an index template POST
    • Simulate an index template 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
  • License
    • 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
  • Lifecycle
    • Get the status for a data stream lifecycle GET
    • Get data stream lifecycle stats GET
  • Logstash
    • Get Logstash pipelines GET
    • Create or update a Logstash pipeline PUT
    • Delete a Logstash pipeline DELETE
    • Get Logstash pipelines GET
  • Mapping
    • Get mapping definitions GET
    • Get mapping definitions GET
    • Get mapping definitions GET
    • Update field mappings PUT
    • Update field mappings POST
  • Mget
    • Get multiple documents GET
    • Get multiple documents POST
    • Get multiple documents GET
    • Get multiple documents POST
  • Migration
    • Cancel a migration reindex operation 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
  • Ml
    • Clear trained model deployment cache POST
    • 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 data frame analytics job configuration info GET
    • Create a data frame analytics job PUT
    • Delete a data frame analytics job 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
    • 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
    • Estimate job model memory usage POST
    • 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
    • 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 data frame analytics job configuration info GET
    • Get data frame analytics job stats GET
    • Get data frame analytics job stats GET
    • 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 machine learning memory usage info GET
    • Get machine learning memory usage 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
    • Get trained model configuration info GET
    • Get trained models usage info GET
    • Get trained models usage info GET
    • Evaluate a trained model POST
    • Get machine learning information GET
    • Open anomaly detection jobs POST
    • Send data to an anomaly detection job for analysis POST
    • 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
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Preview a datafeed GET
    • Preview a datafeed POST
    • Create part of a trained model definition PUT
    • Create a trained model vocabulary PUT
    • Reset an anomaly detection job POST
    • Revert to a snapshot POST
    • Set upgrade_mode for ML indices POST
    • Start a data frame analytics job POST
    • Start datafeeds POST
    • Start a trained model deployment POST
    • Stop data frame analytics jobs POST
    • Stop datafeeds POST
    • Stop a trained model deployment POST
    • Update a data frame analytics job POST
    • Update a datafeed POST
    • Update a filter POST
    • Update an anomaly detection job POST
    • Update a snapshot POST
    • Update a trained model deployment POST
    • Upgrade a snapshot POST
  • Msearch
    • 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
  • Mtermvectors
    • Get multiple term vectors GET
    • Get multiple term vectors POST
    • Get multiple term vectors GET
    • Get multiple term vectors POST
  • Nodes
    • 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
    • Get the shutdown status GET
    • Prepare a node to be shut down PUT
    • Cancel node shutdown preparations DELETE
    • Get the shutdown status GET
  • Open
    • Open a closed index POST
  • Pit
    • Close a point in time DELETE
    • Open a point in time POST
  • Query
    • 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
  • 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
  • Rank eval
    • Evaluate ranked search results GET
    • Evaluate ranked search results POST
    • Evaluate ranked search results GET
    • Evaluate ranked search results POST
  • Recovery
    • Get index recovery information GET
    • Get index recovery information GET
  • Refresh
    • Refresh an index GET
    • Refresh an index POST
    • Refresh an index GET
    • Refresh an index POST
  • Reindex
    • Reindex documents POST
    • Throttle a reindex operation POST
  • Reload search analyzers
    • Reload search analyzers GET
    • Reload search analyzers POST
  • Remote
    • Get remote cluster information GET
  • Render
    • Render a search template GET
    • Render a search template POST
    • Render a search template GET
    • Render a search template POST
  • Resolve
    • Resolve the cluster GET
    • Resolve the cluster GET
    • Resolve indices GET
  • Rollover
    • Roll over to a new index 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
    • Start rollup jobs POST
    • Stop rollup jobs POST
  • Rollup search
    • Search rolled-up data GET
    • Search rolled-up data POST
  • Root
    • 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
    • Get a document's source GET
    • Check for a document source HEAD
    • Explain a document match result GET
    • Explain a document match result POST
    • Add an index block PUT
    • Clone an index PUT
    • Clone 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
    • Downsample an index POST
    • Get mapping definitions GET
    • Get index settings GET
    • Roll over to a new index POST
    • Shrink an index PUT
    • Shrink an index POST
    • Split an index PUT
    • Split an index POST
    • Get index statistics GET
    • Get cluster info GET
    • Ping the cluster HEAD
    • Search a vector tile GET
    • Search a vector tile POST
    • Get term vector information GET
    • Get term vector information POST
    • Update a document POST
  • Script context
    • Get script contexts GET
  • Script language
    • Get script languages GET
  • Scripts
    • 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
    • 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
    • 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
    • Run a search GET
    • Run a search POST
    • Run a search GET
    • Run a search 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
  • Search shards
    • Get the search shards GET
    • Get the search shards POST
    • Get the search shards GET
    • Get the search shards POST
  • Searchable snapshots
    • Get cache statistics GET
    • Get cache statistics GET
    • Clear the cache POST
    • Clear the cache 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
    • Get builtin privileges GET
    • Get application privileges GET
    • Create or update application privileges PUT
    • Create or update application privileges POST
    • Get application privileges GET
    • Get role mappings GET
    • Get service accounts GET
    • Get service accounts GET
    • Get service accounts GET
    • Get service account credentials GET
    • Get security index settings GET
    • Update security index settings PUT
    • Get a token POST
    • Invalidate a token DELETE
    • Get users GET
    • Get user privileges GET
    • Get a user profile GET
    • Grant an API key POST
    • Check user privileges GET
    • Check user privileges POST
    • Check user privileges GET
    • Check user privileges POST
    • Check user profile privileges GET
    • Check user profile privileges POST
    • Authenticate OpenID Connect POST
    • Logout of OpenID Connect POST
    • Prepare OpenID connect authentication POST
    • Find API keys with a query GET
    • Find API keys with a query POST
    • Find roles with a query GET
    • Find roles with a query POST
    • Find users with a query GET
    • Find users with a query POST
    • Authenticate SAML POST
    • Logout of SAML completely POST
    • Invalidate SAML POST
    • Logout of SAML POST
    • Prepare SAML authentication POST
    • Create SAML service provider metadata GET
    • Suggest a user profile GET
    • Suggest a user profile POST
    • Update an API key PUT
    • Update a cross-cluster API key PUT
    • Update user profile data PUT
    • Update user profile data POST
  • Segments
    • Get index segments GET
    • Get index segments GET
  • Settings
    • Get index settings GET
    • Update index settings PUT
    • Get index settings GET
    • Update index settings PUT
    • Get index settings GET
  • Shard stores
    • Get index shard stores GET
    • Get index shard stores GET
  • Slm
    • Get policy information GET
    • Create or update a policy PUT
    • Delete a policy DELETE
    • Run a policy PUT
    • Run a retention policy POST
    • Get policy information GET
    • Get snapshot lifecycle management statistics GET
    • Get the snapshot lifecycle management status GET
    • Start snapshot lifecycle management POST
    • Stop snapshot lifecycle management POST
  • Snapshot
    • Mount a snapshot POST
    • Clean up the snapshot repository POST
    • Clone a snapshot PUT
    • Get snapshot information GET
    • Create a snapshot PUT
    • Create a snapshot POST
    • Delete snapshots DELETE
    • Get snapshot repository information GET
    • Create or update a snapshot repository PUT
    • Create or update a snapshot repository POST
    • Delete snapshot repositories DELETE
    • Get snapshot repository information GET
    • Analyze a snapshot repository POST
    • Verify the repository integrity POST
    • Restore a snapshot POST
    • Get the snapshot status GET
    • Get the snapshot status GET
    • Get the snapshot status GET
    • Verify a snapshot repository POST
  • Sql
    • Clear an SQL search cursor POST
    • Delete an async SQL search DELETE
    • Get async SQL search results GET
    • Get the async SQL search status GET
    • Get SQL search results GET
    • Get SQL search results POST
    • Translate SQL into Elasticsearch queries GET
    • Translate SQL into Elasticsearch queries POST
  • Ssl
    • Get SSL certificates GET
  • Stats
    • Get index statistics GET
    • Get index statistics GET
    • Get index statistics GET
  • Synonyms
    • Get a synonym set GET
    • Create or update a synonym set PUT
    • Delete a synonym set DELETE
    • Get a synonym rule GET
    • Create or update a synonym rule PUT
    • Delete a synonym rule DELETE
    • Get all synonym sets GET
  • Tasks
    • Cancel a task POST
    • Cancel a task POST
    • Get task information GET
    • Get all tasks GET
  • Template
    • 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
    • Get legacy index templates GET
  • Terms enum
    • Get terms in an index GET
    • Get terms in an index POST
  • Termvectors
    • Get term vector information GET
    • Get term vector information POST
  • Text structure
    • Find the structure of a text field GET
    • Find the structure of text messages GET
    • Find the structure of text messages POST
    • Find the structure of a text file POST
    • Test a Grok pattern GET
    • Test a Grok pattern POST
  • Transform
    • Get transforms GET
    • Create a transform PUT
    • Delete a transform DELETE
    • Get transforms GET
    • Get transform stats GET
    • Preview a transform GET
    • Preview a transform POST
    • Preview a transform GET
    • Preview a transform POST
    • Reset a transform POST
    • Schedule a transform to start now POST
    • Start a transform POST
    • Stop transforms POST
    • Update a transform POST
    • Upgrade all transforms POST
  • Update by query
    • Update documents POST
    • Throttle an update by query operation POST
  • Validate
    • Validate a query GET
    • Validate a query POST
    • Validate a query GET
    • Validate a query POST
  • Watcher
    • Acknowledge a watch PUT
    • Acknowledge a watch POST
    • Acknowledge a watch PUT
    • Acknowledge a watch POST
    • Activate a watch PUT
    • Activate a watch POST
    • Deactivate a watch PUT
    • Deactivate a watch POST
    • Get a watch GET
    • Create or update a watch PUT
    • Create or update a watch POST
    • Delete a watch DELETE
    • Run a watch PUT
    • Run a watch POST
    • Run a watch PUT
    • Run a watch POST
    • Get Watcher index settings GET
    • Update Watcher index settings PUT
    • Query watches GET
    • Query watches POST
    • Start the watch service POST
    • Get Watcher statistics GET
    • Get Watcher statistics GET
    • Stop the watch service POST
  • Xpack
    • Get information GET
    • Get usage information GET
Powered by Bump.sh
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
Elasticsearch API logo Elasticsearch API logo dark

Ingest

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown
Operations quick access
GET /_ingest/geoip/database/{id} PUT /_ingest/geoip/database/{id} DELETE /_ingest/geoip/database/{id} GET /_ingest/ip_location/database/{id} PUT /_ingest/ip_location/database/{id} DELETE /_ingest/ip_location/database/{id} GET /_ingest/pipeline/{id} PUT /_ingest/pipeline/{id} DELETE /_ingest/pipeline/{id} GET /_ingest/geoip/stats GET /_ingest/geoip/database GET /_ingest/ip_location/database GET /_ingest/pipeline GET /_ingest/processor/grok GET /_ingest/pipeline/_simulate POST /_ingest/pipeline/_simulate GET /_ingest/pipeline/{id}/_simulate POST /_ingest/pipeline/{id}/_simulate GET /_ingest/_simulate POST /_ingest/_simulate GET /_ingest/{index}/_simulate POST /_ingest/{index}/_simulate

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation