Elasticsearch Serverless API
This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.
Behavioral analytics 3
Cluster 2
Compact and aligned text (CAT) 10
Connector 24
- 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
- GET Get a connector sync job
- DELETE Delete a connector sync job
- GET Get all connector sync jobs
- POST Create a connector sync job
- 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 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
Data stream 14
- GET Get data streams
- PUT Create a data stream
- DELETE Delete data streams
- GET Get the status for a data stream lifecycle
- GET Get data stream lifecycles
- PUT Update data stream lifecycles
- GET Get data stream mappings
- PUT Update data stream mappings
- GET Get data stream options
- PUT Update data stream options
- GET Get data stream settings
- PUT Update data stream settings
- POST Convert an index alias to a data stream
- POST Update data streams
Document 16
- 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
- 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
Enrich 4
EQL 4
ES|QL 12
- 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
Index 30
- GET Get component templates
- POST Create or update a component template
- DELETE Delete component templates
- HEAD Check component templates
- PUT Add an index block
- DELETE Remove an index block
- POST Get tokens from text analysis
- GET Get index information
- PUT Create an index
- DELETE Delete indices
- HEAD Check indices
- POST Create or update an alias
- DELETE Delete an alias
- GET Get index templates
- POST Create or update an index template
- DELETE Delete an index template
- HEAD Check index templates
- GET Get aliases
- HEAD Check aliases
- GET Get mapping definitions
- POST Update field mappings
- GET Get index settings
- PUT Update index settings
- POST Refresh an index
- POST Resolve indices
- POST Roll over to a new index
- POST Simulate an index
- POST Simulate an index template
- POST Create or update an alias
- POST Validate a query
Inference 42
- POST Perform streaming 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
- POST Perform non-streaming chat completion 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 5
Licensing 1
Logstash 3
Machine learning anomaly detection 32
- 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
- GET Get filters
- PUT Create a filter
- DELETE Delete a filter
- GET Get anomaly detection jobs configuration info
- PUT Create an anomaly detection job
- DELETE Delete an anomaly detection job
- POST Estimate job model memory usage
- POST Force buffered data to be processed
- POST Predict future behavior of a time series
- GET Get info about events in calendars
- POST Add scheduled events to the calendar
- GET Get datafeed stats
- GET Get anomaly detection job stats
- POST Get overall bucket results
- POST Open anomaly detection jobs
- POST 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
Machine learning data frame analytics 9
- 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
- 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 12
- 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 3
Project 6
Query rules 8
Reindex 3
Script 4
Search 19
- 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 Run a search with a search template
- POST Get terms in an index
Search application 5
Security 14
- GET Authenticate a user
- GET Get API key information
- POST Create an API key
- DELETE Invalidate API keys
- POST Create a service account token
- DELETE Delete service account tokens
- GET Get roles
- POST Create or update roles
- DELETE Delete roles
- GET Get builtin privileges
- POST Check user privileges
- POST Find API keys with a query
- POST Find roles with a query
- PUT Update an API key