Elasticsearch API
Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.
This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.
This documentation contains work-in-progress information for future Elastic Stack releases.
Behavioral analytics 4
Cluster 20
- POST Explain the shard allocations
- POST Update voting configuration exclusions
- DELETE Clear cluster voting config exclusions
- GET Get cluster-wide settings
- PUT Update the cluster settings
- GET Get the cluster health status
- GET Get cluster info
- GET Get the pending cluster tasks
- GET Get remote cluster information
- POST Reroute the cluster
- GET Get the cluster state
- GET Get cluster statistics
- HEAD Ping the cluster
- DELETE Clear the archived repositories metering
- GET Get cluster repositories metering
- GET Get the hot threads for nodes
- GET Get node information
- POST Reload the keystore on nodes in the cluster
- GET Get node statistics
- GET Get feature usage information
Cluster - Health 1
Compact and aligned text (CAT) 27
- GET Get aliases
- GET Get shard allocation information
- GET Get circuit breakers statistics
- GET Get component templates
- POST 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
Connector 29
- PUT Check in a connector
- GET Get a connector
- PUT Create or update a connector
- DELETE Delete a connector
- GET Get all connectors
- POST Create a connector
- PUT Cancel a connector sync job
- PUT Check in a connector sync job
- PUT Claim a connector sync job
- GET Get a connector sync job
- DELETE Delete a connector sync job
- PUT Set a connector sync job error
- GET Get all connector sync jobs
- POST Create a connector sync job
- PUT 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
Cross-cluster replication 13
- GET Get auto-follow patterns
- PUT Create or update auto-follow patterns
- DELETE Delete auto-follow patterns
- PUT Create a follower
- GET Get follower information
- GET Get follower stats
- POST Forget a follower
- POST Pause an auto-follow pattern
- POST Pause a follower
- POST Resume an auto-follow pattern
- POST Resume a follower
- GET Get cross-cluster replication stats
- POST Unfollow an index
Data stream 19
- GET Get data streams
- PUT Create a data stream
- DELETE Delete data streams
- GET Get data stream stats
- GET Get data stream lifecycles
- PUT Update data stream lifecycles
- GET Get data stream options
- PUT Update data stream options
- DELETE Delete data stream options
- POST Downsample an index
- GET Get the status for a data stream lifecycle
- GET Get data stream lifecycle stats
- GET Get data stream mappings
- PUT Update data stream mappings
- GET Get data stream settings
- PUT Update data stream settings
- POST Convert an index alias to a data stream
- POST Update data streams
- POST Promote a data stream
Document 18
- POST Bulk index or delete documents
- POST Create a new document in the index
- GET Get a document by its ID
- POST Create or update a document in an index
- DELETE Delete a document
- HEAD Check a document
- POST Delete documents
- POST Throttle a delete by query operation
- GET Get a document's source
- HEAD Check for a document source
- POST Reindex documents
- POST Get multiple documents
- POST Get multiple term vectors
- POST Throttle a reindex operation
- POST Get term vector information
- POST Update a document
- POST Update documents
- POST Throttle an update by query operation
Enrich 5
EQL 4
ES|QL 16
- POST Run an async ES|QL query
- GET Get async ES|QL query results
- DELETE Delete an async ES|QL query
- POST Stop async ES|QL query
- GET Get ES|QL data sources
- PUT Create or update an ES|QL data source
- DELETE Delete ES|QL data sources
- GET Get ES|QL datasets
- PUT Create or update an ES|QL dataset
- DELETE Delete ES|QL datasets
- GET Get an ES|QL view
- PUT Create or update an ES|QL view
- DELETE Delete an ES|QL view
- GET Get a specific running ES|QL query information
- GET Get running ES|QL queries information
- POST Run an ES|QL query
Features 2
Fleet 3
Graph explore 1
Index 55
- GET Get component templates
- POST Create or update a component template
- DELETE Delete component templates
- HEAD Check component templates
- POST Import a dangling index
- DELETE Delete a dangling index
- GET Get the dangling indices
- PUT Add an index block
- DELETE Remove an index block
- POST Get tokens from text analysis
- POST Clear the cache
- POST Clone an index
- POST Close an index
- GET Get index information
- PUT Create an index
- DELETE Delete indices
- HEAD Check indices
- POST Create or update an alias
- DELETE Delete an alias
- DELETE Delete data stream lifecycles
- GET Get index templates
- POST Create or update an index template
- DELETE Delete an index template
- HEAD Check index templates
- GET Get legacy index templates
- POST Create or update a legacy index template
- DELETE Delete a legacy index template
- HEAD Check existence of index templates
- POST Analyze the index disk usage
- GET Get aliases
- HEAD Check aliases
- GET Get field usage stats
- POST Flush data streams or indices
- POST Force a merge
- GET Get mapping definitions
- GET Get mapping definitions
- POST Update field mappings
- GET Get index settings
- POST Open a closed index
- PUT Update index settings
- GET Get index recovery information
- POST Refresh an index
- POST Reload search analyzers
- GET Resolve the cluster
- POST Resolve indices
- POST Roll over to a new index
- GET Get index segments
- GET Get index shard stores
- POST Shrink an index
- POST Simulate an index
- POST Simulate an index template
- POST Split an index
- GET Get index statistics
- POST Create or update an alias
- POST Validate a query
Index lifecycle management 11
- GET Get lifecycle policies
- PUT Create or update a lifecycle policy
- DELETE Delete a lifecycle policy
- GET Explain the lifecycle state
- GET Get the ILM status
- POST 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
Inference 41
- POST Perform chat completion inference on the service
- POST Perform completion inference on the service
- GET Get an inference endpoint
- PUT Create an inference endpoint
- POST Perform inference on the service
- DELETE Delete an inference endpoint
- GET Get the inference region policy
- PUT Create or update the inference region policy
- DELETE Delete the inference region policy
- POST Perform dense embedding inference on the service
- PUT Create a AI21 inference endpoint
- PUT Create an AlibabaCloud AI Search inference endpoint
- PUT Create an Amazon Bedrock inference endpoint
- PUT Create an Amazon SageMaker 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 Contextual AI inference endpoint
- PUT Create a custom inference endpoint
- PUT Create a DeepSeek inference endpoint
- PUT Create an Elasticsearch inference endpoint
- PUT Create an ELSER inference endpoint
- PUT Create a Fireworks AI inference endpoint
- PUT Create an Google AI Studio inference endpoint
- PUT Create a Google Vertex AI inference endpoint
- PUT Create a Groq inference endpoint
- PUT Create a Hugging Face inference endpoint
- PUT Create an JinaAI inference endpoint
- PUT Create a Llama inference endpoint
- PUT Create a Mistral inference endpoint
- PUT Create an Nvidia inference endpoint
- PUT Create an OpenAI inference endpoint
- PUT Create an OpenShift AI inference endpoint
- PUT Create a VoyageAI inference endpoint
- PUT Create a Watsonx inference endpoint
- POST Perform reranking inference on the service
- POST Perform sparse embedding inference on the service
- POST Perform streaming completion inference on the service
- POST Perform text embedding inference on the service
- PUT Update an inference endpoint
Info 1
Ingest 13
- GET Get GeoIP database configurations
- PUT Create or update a GeoIP database configuration
- DELETE Delete GeoIP database configurations
- GET Get IP geolocation database configurations
- PUT Create or update an IP geolocation database configuration
- DELETE Delete IP geolocation database configurations
- GET Get pipelines
- PUT Create or update a pipeline
- DELETE Delete pipelines
- GET Get GeoIP statistics
- GET Run a grok processor
- POST Simulate a pipeline
- POST Simulate data ingestion
Licensing 7
Logstash 3
Machine learning 3
Machine learning anomaly detection 45
- POST Close anomaly detection jobs
- PUT Create a calendar
- POST Get calendar configuration info
- DELETE Delete a calendar
- DELETE Delete events from a calendar
- PUT Add anomaly detection job to calendar
- DELETE Delete anomaly jobs from a calendar
- GET Get datafeeds configuration info
- PUT Create a datafeed
- DELETE Delete a datafeed
- DELETE Delete expired ML data
- GET Get filters
- PUT Create a filter
- DELETE Delete a filter
- DELETE Delete forecasts from a job
- GET Get anomaly detection jobs configuration info
- PUT Create an anomaly detection job
- DELETE Delete an anomaly detection job
- POST Get model snapshots info
- DELETE Delete a model snapshot
- POST Estimate job model memory usage
- POST Force buffered data to be processed
- POST Predict future behavior of a time series
- POST Get anomaly detection job results for buckets
- GET Get info about events in calendars
- POST Add scheduled events to the calendar
- POST Get anomaly detection job results for categories
- GET Get datafeed stats
- POST Get anomaly detection job results for influencers
- GET Get anomaly detection job stats
- GET Get anomaly detection job model snapshot upgrade usage info
- POST Get overall bucket results
- POST 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
- 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
Machine learning data frame analytics 10
- GET Get data frame analytics job configuration info
- PUT Create a data frame analytics job
- DELETE Delete a data frame analytics job
- POST Evaluate data frame analytics
- POST Explain data frame analytics config
- GET Get data frame analytics job stats
- POST 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
Machine learning trained model 13
- POST Clear trained model deployment cache
- GET Get trained model configuration info
- PUT Create a trained model
- DELETE Delete an unreferenced trained model
- PUT Create or update a trained model alias
- DELETE Delete a trained model alias
- GET Get trained models usage info
- POST Evaluate a trained model
- PUT Create part of a trained model definition
- PUT Create a trained model vocabulary
- POST Start a trained model deployment
- POST Stop a trained model deployment
- POST Update a trained model deployment
Migration 7
Query rules 8
Reindex 3
Rollup 8
Script 6
Search 20
- GET Get async search results
- DELETE Delete an async search
- GET Get the async search status
- POST Run an async search
- POST Run a scrolling search
- DELETE Clear a scrolling search
- DELETE Close a point in time
- POST Count search results
- POST Explain a document match result
- POST Get the field capabilities
- POST Run multiple searches
- POST Run multiple templated searches
- POST Open a point in time
- POST Evaluate ranked search results
- POST Render a search template
- POST Run a search
- POST Search a vector tile
- POST Get the search shards
- POST Run a search with a search template
- POST Get terms in an index
Search application 6
Searchable snapshots 4
Security 68
- POST Reset the project encryption key
- POST Activate a user profile
- GET Authenticate a user
- POST Bulk create or update roles
- DELETE Bulk delete roles
- POST Bulk update API keys
- POST 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 Clone an API key
- GET Get API key information
- POST Create an API key
- DELETE Invalidate API keys
- POST Create a cross-cluster API key
- POST Create a service account token
- DELETE Delete service account tokens
- POST Delegate PKI authentication
- GET Get application privileges
- DELETE Delete application privileges
- GET Get roles
- POST Create or update roles
- DELETE Delete roles
- GET Get role mappings
- POST Create or update role mappings
- DELETE Delete role mappings
- GET Get users
- POST Create or update users
- DELETE Delete users
- POST Disable users
- POST Disable a user profile
- POST Enable users
- POST Enable a user profile
- GET Enroll Kibana
- GET Enroll a node
- GET Get builtin privileges
- GET Get service accounts
- GET Get service account credentials
- GET Get security index settings
- PUT Update security index settings
- GET Get security stats
- POST Get a token
- DELETE Invalidate a token
- GET Get user privileges
- GET Get a user profile
- POST Grant an API key
- POST Check user privileges
- POST Check user profile privileges
- POST Authenticate OpenID Connect
- POST Logout of OpenID Connect
- POST Prepare OpenID connect authentication
- POST Create or update application privileges
- POST Find API keys with a query
- POST Find roles with a query
- POST Find users with a query
- POST Authenticate SAML
- POST Logout of SAML completely
- POST Invalidate SAML
- POST Logout of SAML
- POST Prepare SAML authentication
- GET Create SAML service provider metadata
- POST Suggest a user profile
- PUT Update an API key
- PUT Update a cross-cluster API key
- POST Update user profile data
- GET Get SSL certificates
Snapshot and restore 13
- POST Clean up the snapshot repository
- PUT Clone a snapshot
- GET Get snapshot information
- POST Create a snapshot
- DELETE Delete snapshots
- GET Get snapshot repository information
- POST Create or update a snapshot repository
- DELETE Delete snapshot repositories
- POST Analyze a snapshot repository
- POST Verify the repository integrity
- POST Restore a snapshot
- GET Get the snapshot status
- POST Verify a snapshot repository
Snapshot lifecycle management 9
- GET Get policy information
- PUT Create or update a policy
- DELETE Delete a policy
- PUT Run a policy
- POST Run a retention policy
- GET Get snapshot lifecycle management statistics
- GET Get the snapshot lifecycle management status
- POST Start snapshot lifecycle management
- POST Stop snapshot lifecycle management
SQL 6
Streams 3
Synonyms 7
Task management 3
Text structure 4
Transform 13
- GET Get transforms
- PUT Create a transform
- DELETE Delete a transform
- GET Get node stats
- GET Get transform stats
- POST Preview a transform
- POST Reset a transform
- POST Schedule a transform to start now
- POST Set upgrade_mode for transform indices
- POST Start a transform
- POST Stop transforms
- POST Update a transform
- POST Upgrade all transforms
Usage 2
Watcher 13
- POST Acknowledge a watch
- POST Activate a watch
- POST Deactivate a watch
- GET Get a watch
- POST Create or update a watch
- DELETE Delete a watch
- POST Run a watch
- GET Get Watcher index settings
- PUT Update Watcher index settings
- POST Query watches
- POST Start the watch service
- GET Get Watcher statistics
- POST Stop the watch service