Show Menu
Search…
Ctrl+K
ESC
Example searches: “version”, “total”, “Reindex documents”, “throttled_millis”, “timed_out”
Toggle dark mode
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
Observability Intake Serverless API
Back to hub page
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Feedback
Topics
Introduction
Authentication
Endpoints
Behavioral analytics
Get behavioral analytics collections
GET
Create a behavioral analytics collection
PUT
Delete a behavioral analytics collection
DELETE
Get behavioral analytics collections
GET
Compact and aligned text (CAT)
Get aliases
GET
Get aliases
GET
Get component templates
GET
Get component templates
GET
Get a document count
GET
Get a document count
GET
Get CAT help
GET
Get index information
GET
Get index 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 transform information
GET
Get transform information
GET
Cluster
Get cluster info
GET
Ping the cluster
HEAD
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
Get a connector sync job
GET
Delete a connector sync job
DELETE
Get all connector sync jobs
GET
Create a connector sync job
POST
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 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
Data stream
Get data streams
GET
Create a data stream
PUT
Delete data streams
DELETE
Get the status for a data stream lifecycle
GET
Get data stream lifecycles
GET
Update data stream lifecycles
PUT
Get data streams
GET
Convert an index alias to a data stream
POST
Update data streams
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
Index a document
PUT
Index a document
POST
Get a document by its ID
GET
Index a document
PUT
Index a document
POST
Delete a document
DELETE
Check a document
HEAD
Delete documents
POST
Get a document's source
GET
Check for a document source
HEAD
Index a document
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
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
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
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 ES|QL query
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
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
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
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 aliases
GET
Check aliases
HEAD
Get aliases
GET
Get aliases
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
Refresh an index
GET
Refresh an index
POST
Refresh an index
GET
Refresh an index
POST
Resolve indices
GET
Roll over to a new index
POST
Roll over to a new index
POST
Simulate an index
POST
Simulate an index template
POST
Simulate an index template
POST
Create or update an alias
POST
Validate a query
GET
Validate a query
POST
Validate a query
GET
Validate a query
POST
Inference
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
Info
Get cluster info
GET
Ingest
Get pipelines
GET
Create or update a pipeline
PUT
Delete pipelines
DELETE
Get pipelines
GET
Run a grok processor
GET
Simulate a pipeline
GET
Simulate a pipeline
POST
Simulate a pipeline
GET
Simulate a pipeline
POST
Licensing
Get license information
GET
Logstash
Get Logstash pipelines
GET
Create or update a Logstash pipeline
PUT
Delete a Logstash pipeline
DELETE
Get Logstash pipelines
GET
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
Get filters
GET
Create a filter
PUT
Delete a filter
DELETE
Get anomaly detection jobs configuration info
GET
Create an anomaly detection job
PUT
Delete an anomaly detection job
DELETE
Estimate job model memory usage
POST
Force buffered data to be processed
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 datafeeds usage info
GET
Get datafeeds usage info
GET
Get datafeeds configuration info
GET
Get filters
GET
Get anomaly detection jobs usage info
GET
Get anomaly detection jobs usage info
GET
Get anomaly detection jobs configuration info
GET
Get overall bucket results
GET
Get overall bucket results
POST
Open anomaly detection jobs
POST
Preview a datafeed
GET
Preview a datafeed
POST
Preview a datafeed
GET
Preview a datafeed
POST
Reset an anomaly detection job
POST
Start datafeeds
POST
Stop datafeeds
POST
Update a datafeed
POST
Update a filter
POST
Update an anomaly detection job
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
Get data frame analytics job configuration info
GET
Get data frame analytics jobs usage info
GET
Get data frame analytics jobs usage info
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
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
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
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
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
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
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
Returns the existing search applications
GET
Run a search application search
GET
Run a search application search
POST
Security
Authenticate a user
GET
Get API key information
GET
Create an API key
PUT
Create an API key
POST
Invalidate API keys
DELETE
Get roles
GET
Create or update roles
PUT
Create or update roles
POST
Delete roles
DELETE
Get builtin privileges
GET
Get roles
GET
Check user privileges
GET
Check user privileges
POST
Check user privileges
GET
Check user privileges
POST
Find API keys with a query
GET
Find API keys with a query
POST
Update an API key
PUT
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
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
Task management
Get task information
GET
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
Dismiss highlight
Show more
Document
Learn more about reading and writing documents