Elasticsearch Serverless API

Behavioral analytics 4

• POST Create a behavioral analytics collection event /_application/analytics/{collection_name}/event/{event_type}
• GET Get behavioral analytics collections /_application/analytics/{name}
• PUT Create a behavioral analytics collection /_application/analytics/{name}
• DELETE Delete a behavioral analytics collection /_application/analytics/{name}

Cluster 2

• HEAD Ping the cluster /
• GET Get cluster subsystem info /_info/{target}

Compact and aligned text (CAT) 10

• GET Get CAT help /_cat
• GET Get a compact list of aliases /_cat/aliases/{name}
• GET Get a compact list of component templates /_cat/component_templates/{name}
• POST Get a document count /_cat/count/{index}
• GET Get a compact list of indices /_cat/indices/{index}
• GET Get anomaly detection jobs /_cat/ml/anomaly_detectors/{job_id}
• GET Get data frame analytics jobs /_cat/ml/data_frame/analytics/{id}
• GET Get datafeeds /_cat/ml/datafeeds/{datafeed_id}
• GET Get trained models /_cat/ml/trained_models/{model_id}
• GET Get transform information /_cat/transforms/{transform_id}

Connector 29

• GET Get all connectors /_connector
• POST Create a connector /_connector
• GET Get all connector sync jobs /_connector/_sync_job
• POST Create a connector sync job /_connector/_sync_job
• GET Get a connector sync job /_connector/_sync_job/{connector_sync_job_id}
• DELETE Delete a connector sync job /_connector/_sync_job/{connector_sync_job_id}
• PUT Cancel a connector sync job /_connector/_sync_job/{connector_sync_job_id}/_cancel
• PUT Check in a connector sync job /_connector/_sync_job/{connector_sync_job_id}/_check_in
• PUT Claim a connector sync job /_connector/_sync_job/{connector_sync_job_id}/_claim
• PUT Set a connector sync job error /_connector/_sync_job/{connector_sync_job_id}/_error
• PUT Set the connector sync job stats /_connector/_sync_job/{connector_sync_job_id}/_stats
• GET Get a connector /_connector/{connector_id}
• PUT Create or update a connector /_connector/{connector_id}
• DELETE Delete a connector /_connector/{connector_id}
• PUT Update the connector API key ID /_connector/{connector_id}/_api_key_id
• PUT Check in a connector /_connector/{connector_id}/_check_in
• PUT Update the connector configuration /_connector/{connector_id}/_configuration
• PUT Update the connector error field /_connector/{connector_id}/_error
• PUT Update the connector features /_connector/{connector_id}/_features
• PUT Update the connector filtering /_connector/{connector_id}/_filtering
• PUT Activate the connector draft filter /_connector/{connector_id}/_filtering/_activate
• PUT Update the connector draft filtering validation /_connector/{connector_id}/_filtering/_validation
• PUT Update the connector index name /_connector/{connector_id}/_index_name
• PUT Update the connector name and description /_connector/{connector_id}/_name
• PUT Update the connector is_native flag /_connector/{connector_id}/_native
• PUT Update the connector pipeline /_connector/{connector_id}/_pipeline
• PUT Update the connector scheduling /_connector/{connector_id}/_scheduling
• PUT Update the connector service type /_connector/{connector_id}/_service_type
• PUT Update the connector status /_connector/{connector_id}/_status

Data stream 15

• POST Convert an index alias to a data stream /_data_stream/_migrate/{name}
• POST Update data streams /_data_stream/_modify
• GET Get data streams /_data_stream/{name}
• PUT Create a data stream /_data_stream/{name}
• DELETE Delete data streams /_data_stream/{name}
• GET Get data stream lifecycles /_data_stream/{name}/_lifecycle
• PUT Update data stream lifecycles /_data_stream/{name}/_lifecycle
• GET Get data stream mappings /_data_stream/{name}/_mappings
• PUT Update data stream mappings /_data_stream/{name}/_mappings
• GET Get data stream options /_data_stream/{name}/_options
• PUT Update data stream options /_data_stream/{name}/_options
• GET Get data stream settings /_data_stream/{name}/_settings
• PUT Update data stream settings /_data_stream/{name}/_settings
• GET Get data stream lifecycle stats /_lifecycle/stats
• GET Get the status for a data stream lifecycle /{index}/_lifecycle/explain

Document 16

• POST Reindex documents /_reindex
• POST Throttle a reindex operation /_reindex/{task_id}/_rethrottle
• POST Bulk index or delete documents /{index}/_bulk
• POST Create a new document in the index /{index}/_create/{id}
• POST Delete documents /{index}/_delete_by_query
• GET Get a document by its ID /{index}/_doc/{id}
• POST Create or update a document in an index /{index}/_doc/{id}
• DELETE Delete a document /{index}/_doc/{id}
• HEAD Check a document /{index}/_doc/{id}
• POST Get multiple documents /{index}/_mget
• POST Get multiple term vectors /{index}/_mtermvectors
• GET Get a document's source /{index}/_source/{id}
• HEAD Check for a document source /{index}/_source/{id}
• POST Get term vector information /{index}/_termvectors/{id}
• POST Update a document /{index}/_update/{id}
• POST Update documents /{index}/_update_by_query

Enrich 4

• GET Get an enrich policy /_enrich/policy/{name}
• PUT Create an enrich policy /_enrich/policy/{name}
• DELETE Delete an enrich policy /_enrich/policy/{name}
• PUT Run an enrich policy /_enrich/policy/{name}/_execute

EQL 4

• GET Get the async EQL status /_eql/search/status/{id}
• GET Get async EQL search results /_eql/search/{id}
• DELETE Delete an async EQL search /_eql/search/{id}
• POST Get EQL search results /{index}/_eql/search

ES|QL 16

• POST Run an ES|QL query /_query
• POST Run an async ES|QL query /_query/async
• GET Get async ES|QL query results /_query/async/{id}
• DELETE Delete an async ES|QL query /_query/async/{id}
• POST Stop async ES|QL query /_query/async/{id}/stop
• GET Get ES|QL data sources /_query/data_source/{name}
• PUT Create or update an ES|QL data source /_query/data_source/{name}
• DELETE Delete ES|QL data sources /_query/data_source/{name}
• GET Get ES|QL datasets /_query/dataset/{name}
• PUT Create or update an ES|QL dataset /_query/dataset/{name}
• DELETE Delete ES|QL datasets /_query/dataset/{name}
• GET Get running ES|QL queries information /_query/queries
• GET Get a specific running ES|QL query information /_query/queries/{id}
• GET Get an ES|QL view /_query/view/{name}
• PUT Create or update an ES|QL view /_query/view/{name}
• DELETE Delete an ES|QL view /_query/view/{name}

Index 30

• POST Update aliases and delete indices atomically /_aliases
• GET Get component templates /_component_template/{name}
• POST Create or update a component template /_component_template/{name}
• DELETE Delete component templates /_component_template/{name}
• HEAD Check component templates /_component_template/{name}
• POST Simulate an index template /_index_template/_simulate/{name}
• POST Simulate an index /_index_template/_simulate_index/{name}
• GET Get index templates /_index_template/{name}
• POST Create or update an index template /_index_template/{name}
• DELETE Delete an index template /_index_template/{name}
• HEAD Check index templates /_index_template/{name}
• POST Resolve indices /_resolve/index/{name}
• POST Roll over to a new index /{alias}/_rollover/{new_index}
• GET Get index information /{index}
• PUT Create an index /{index}
• DELETE Delete indices /{index}
• HEAD Check indices /{index}
• GET Get aliases /{index}/_alias/{name}
• HEAD Check aliases /{index}/_alias/{name}
• POST Create or update an alias /{index}/_aliases/{name}
• DELETE Delete an alias /{index}/_aliases/{name}
• POST Get tokens from text analysis /{index}/_analyze
• PUT Add an index block /{index}/_block/{block}
• DELETE Remove an index block /{index}/_block/{block}
• GET Get mapping definitions /{index}/_mapping
• POST Update field mappings /{index}/_mapping
• POST Refresh an index /{index}/_refresh
• PUT Update index settings /{index}/_settings
• GET Get index settings /{index}/_settings/{name}
• POST Validate a query /{index}/_validate/query

Inference 44

• GET Get the inference region policy /_inference/_region_policy
• PUT Create or update the inference region policy /_inference/_region_policy
• DELETE Delete the inference region policy /_inference/_region_policy
• POST Perform non-streaming chat completion inference on the service /_inference/chat_completion/{inference_id}
• POST Perform streaming chat completion inference on the service /_inference/chat_completion/{inference_id}/_stream
• POST Perform completion inference on the service /_inference/completion/{inference_id}
• POST Perform streaming completion inference on the service /_inference/completion/{inference_id}/_stream
• POST Perform decision inference on the service /_inference/decision/{inference_id}
• POST Perform document extraction inference on the service /_inference/document_extraction/{inference_id}
• POST Perform dense embedding inference on the service /_inference/embedding/{inference_id}
• POST Perform reranking inference on the service /_inference/rerank/{inference_id}
• POST Perform sparse embedding inference on the service /_inference/sparse_embedding/{inference_id}
• POST Perform text embedding inference on the service /_inference/text_embedding/{inference_id}
• PUT Create a AI21 inference endpoint /_inference/{task_type}/{ai21_inference_id}
• PUT Create an AlibabaCloud AI Search inference endpoint /_inference/{task_type}/{alibabacloud_inference_id}
• PUT Create an Amazon Bedrock inference endpoint /_inference/{task_type}/{amazonbedrock_inference_id}
• PUT Create an Amazon SageMaker inference endpoint /_inference/{task_type}/{amazonsagemaker_inference_id}
• PUT Create an Anthropic inference endpoint /_inference/{task_type}/{anthropic_inference_id}
• PUT Create an Azure AI studio inference endpoint /_inference/{task_type}/{azureaistudio_inference_id}
• PUT Create an Azure OpenAI inference endpoint /_inference/{task_type}/{azureopenai_inference_id}
• PUT Create a Cohere inference endpoint /_inference/{task_type}/{cohere_inference_id}
• PUT Create an Contextual AI inference endpoint /_inference/{task_type}/{contextualai_inference_id}
• PUT Create a custom inference endpoint /_inference/{task_type}/{custom_inference_id}
• PUT Create a DeepSeek inference endpoint /_inference/{task_type}/{deepseek_inference_id}
• PUT Create an Elasticsearch inference endpoint /_inference/{task_type}/{elasticsearch_inference_id}
• PUT Create an ELSER inference endpoint /_inference/{task_type}/{elser_inference_id}
• PUT Create a Fireworks AI inference endpoint /_inference/{task_type}/{fireworksai_inference_id}
• PUT Create an Google AI Studio inference endpoint /_inference/{task_type}/{googleaistudio_inference_id}
• PUT Create a Google Vertex AI inference endpoint /_inference/{task_type}/{googlevertexai_inference_id}
• PUT Create a Groq inference endpoint /_inference/{task_type}/{groq_inference_id}
• PUT Create a Hugging Face inference endpoint /_inference/{task_type}/{huggingface_inference_id}
• GET Get an inference endpoint /_inference/{task_type}/{inference_id}
• POST Perform inference on the service /_inference/{task_type}/{inference_id}
• PUT Create an inference endpoint /_inference/{task_type}/{inference_id}
• DELETE Delete an inference endpoint /_inference/{task_type}/{inference_id}
• PUT Update an inference endpoint /_inference/{task_type}/{inference_id}/_update
• PUT Create an JinaAI inference endpoint /_inference/{task_type}/{jinaai_inference_id}
• PUT Create a Llama inference endpoint /_inference/{task_type}/{llama_inference_id}
• PUT Create a Mistral inference endpoint /_inference/{task_type}/{mistral_inference_id}
• PUT Create an Nvidia inference endpoint /_inference/{task_type}/{nvidia_inference_id}
• PUT Create an OpenAI inference endpoint /_inference/{task_type}/{openai_inference_id}
• PUT Create an OpenShift AI inference endpoint /_inference/{task_type}/{openshiftai_inference_id}
• PUT Create a VoyageAI inference endpoint /_inference/{task_type}/{voyageai_inference_id}
• PUT Create a Watsonx inference endpoint /_inference/{task_type}/{watsonx_inference_id}

Info 1

• GET Get cluster info /

Ingest 6

• GET Get pipelines /_ingest/pipeline/{id}
• PUT Create or update a pipeline /_ingest/pipeline/{id}
• DELETE Delete pipelines /_ingest/pipeline/{id}
• POST Simulate a pipeline /_ingest/pipeline/{id}/_simulate
• GET Run a grok processor /_ingest/processor/grok
• POST Simulate data ingestion /_ingest/{index}/_simulate

Licensing 1

• GET Get license information /_license

Logstash 3

• GET Get Logstash pipelines /_logstash/pipeline/{id}
• PUT Create or update a Logstash pipeline /_logstash/pipeline/{id}
• DELETE Delete a Logstash pipeline /_logstash/pipeline/{id}

Machine learning anomaly detection 32

• POST Estimate job model memory usage /_ml/anomaly_detectors/_estimate_model_memory
• GET Get anomaly detection jobs configuration info /_ml/anomaly_detectors/{job_id}
• PUT Create an anomaly detection job /_ml/anomaly_detectors/{job_id}
• DELETE Delete an anomaly detection job /_ml/anomaly_detectors/{job_id}
• POST Close anomaly detection jobs /_ml/anomaly_detectors/{job_id}/_close
• POST Force buffered data to be processed /_ml/anomaly_detectors/{job_id}/_flush
• POST Predict future behavior of a time series /_ml/anomaly_detectors/{job_id}/_forecast
• POST Open anomaly detection jobs /_ml/anomaly_detectors/{job_id}/_open
• POST Reset an anomaly detection job /_ml/anomaly_detectors/{job_id}/_reset
• GET Get anomaly detection job stats /_ml/anomaly_detectors/{job_id}/_stats
• POST Update an anomaly detection job /_ml/anomaly_detectors/{job_id}/_update
• POST Get overall bucket results /_ml/anomaly_detectors/{job_id}/results/overall_buckets
• POST Get calendar configuration info /_ml/calendars/{calendar_id}
• PUT Create a calendar /_ml/calendars/{calendar_id}
• DELETE Delete a calendar /_ml/calendars/{calendar_id}
• GET Get info about events in calendars /_ml/calendars/{calendar_id}/events
• POST Add scheduled events to the calendar /_ml/calendars/{calendar_id}/events
• DELETE Delete events from a calendar /_ml/calendars/{calendar_id}/events/{event_id}
• PUT Add anomaly detection job to calendar /_ml/calendars/{calendar_id}/jobs/{job_id}
• DELETE Delete anomaly jobs from a calendar /_ml/calendars/{calendar_id}/jobs/{job_id}
• GET Get datafeeds configuration info /_ml/datafeeds/{datafeed_id}
• PUT Create a datafeed /_ml/datafeeds/{datafeed_id}
• DELETE Delete a datafeed /_ml/datafeeds/{datafeed_id}
• POST Preview a datafeed /_ml/datafeeds/{datafeed_id}/_preview
• POST Start datafeeds /_ml/datafeeds/{datafeed_id}/_start
• GET Get datafeed stats /_ml/datafeeds/{datafeed_id}/_stats
• POST Stop datafeeds /_ml/datafeeds/{datafeed_id}/_stop
• POST Update a datafeed /_ml/datafeeds/{datafeed_id}/_update
• GET Get filters /_ml/filters/{filter_id}
• PUT Create a filter /_ml/filters/{filter_id}
• DELETE Delete a filter /_ml/filters/{filter_id}
• POST Update a filter /_ml/filters/{filter_id}/_update

Machine learning data frame analytics 9

• POST Evaluate data frame analytics /_ml/data_frame/_evaluate
• GET Get data frame analytics job configuration info /_ml/data_frame/analytics/{id}
• PUT Create a data frame analytics job /_ml/data_frame/analytics/{id}
• DELETE Delete a data frame analytics job /_ml/data_frame/analytics/{id}
• POST Preview features used by data frame analytics /_ml/data_frame/analytics/{id}/_preview
• POST Start a data frame analytics job /_ml/data_frame/analytics/{id}/_start
• GET Get data frame analytics job stats /_ml/data_frame/analytics/{id}/_stats
• POST Stop data frame analytics jobs /_ml/data_frame/analytics/{id}/_stop
• POST Update a data frame analytics job /_ml/data_frame/analytics/{id}/_update

Machine learning trained model 12

• GET Get trained model configuration info /_ml/trained_models/{model_id}
• PUT Create a trained model /_ml/trained_models/{model_id}
• DELETE Delete an unreferenced trained model /_ml/trained_models/{model_id}
• POST Evaluate a trained model /_ml/trained_models/{model_id}/_infer
• GET Get trained models usage info /_ml/trained_models/{model_id}/_stats
• PUT Create part of a trained model definition /_ml/trained_models/{model_id}/definition/{part}
• POST Start a trained model deployment /_ml/trained_models/{model_id}/deployment/_start
• POST Stop a trained model deployment /_ml/trained_models/{model_id}/deployment/_stop
• POST Update a trained model deployment /_ml/trained_models/{model_id}/deployment/_update
• PUT Create or update a trained model alias /_ml/trained_models/{model_id}/model_aliases/{model_alias}
• DELETE Delete a trained model alias /_ml/trained_models/{model_id}/model_aliases/{model_alias}
• PUT Create a trained model vocabulary /_ml/trained_models/{model_id}/vocabulary

Migration 3

• POST Create an index from a source index /_create_from/{source}/{dest}
• POST Cancel a migration reindex operation /_migration/reindex/{index}/_cancel
• GET Get the migration reindexing status /_migration/reindex/{index}/_status

Project 6

• POST Get tags /_project/tags
• GET Get project routing expressions /_project_routing
• PUT Create or update project routing expressions /_project_routing
• GET Get a project routing expression /_project_routing/{name}
• PUT Create or update a project routing expression /_project_routing/{name}
• DELETE Delete a project routing expression /_project_routing/{name}

Query rules 8

• GET Get all query rulesets /_query_rules
• GET Get a query ruleset /_query_rules/{ruleset_id}
• PUT Create or update a query ruleset /_query_rules/{ruleset_id}
• DELETE Delete a query ruleset /_query_rules/{ruleset_id}
• GET Get a query rule /_query_rules/{ruleset_id}/_rule/{rule_id}
• PUT Create or update a query rule /_query_rules/{ruleset_id}/_rule/{rule_id}
• DELETE Delete a query rule /_query_rules/{ruleset_id}/_rule/{rule_id}
• POST Test a query ruleset /_query_rules/{ruleset_id}/_test

Reindex 3

• GET Get information about all currently running reindex tasks /_reindex
• GET Get the status and progress of a specific reindex task /_reindex/{task_id}
• POST Cancel an ongoing reindex task /_reindex/{task_id}/_cancel

Script 4

• POST Run a script /_scripts/painless/_execute
• GET Get a script or search template /_scripts/{id}
• DELETE Delete a script or search template /_scripts/{id}
• POST Create or update a script or search template /_scripts/{id}/{context}

Search 20

• GET Get the async search status /_async_search/status/{id}
• GET Get async search results /_async_search/{id}
• DELETE Delete an async search /_async_search/{id}
• DELETE Close a point in time /_pit
• POST Render a search template /_render/template/{id}
• POST Run a scrolling search /_search/scroll/{scroll_id}
• DELETE Clear a scrolling search /_search/scroll/{scroll_id}
• POST Run an async search /{index}/_async_search
• POST Count search results /{index}/_count
• POST Explain a document match result /{index}/_explain/{id}
• POST Get the field capabilities /{index}/_field_caps
• POST Evaluate kNN search settings /{index}/_knn_eval
• POST Run multiple searches /{index}/_msearch
• POST Run multiple templated searches /{index}/_msearch/template
• POST Search a vector tile /{index}/_mvt/{field}/{zoom}/{x}/{y}
• POST Open a point in time /{index}/_pit
• POST Evaluate ranked search results /{index}/_rank_eval
• POST Run a search /{index}/_search
• POST Run a search with a search template /{index}/_search/template
• POST Get terms in an index /{index}/_terms_enum

Search application 5

• GET Get search applications /_application/search_application
• GET Get search application details /_application/search_application/{name}
• PUT Create or update a search application /_application/search_application/{name}
• DELETE Delete a search application /_application/search_application/{name}
• POST Run a search application search /_application/search_application/{name}/_search

Security 15

• GET Authenticate a user /_security/_authenticate
• POST Find API keys with a query /_security/_query/api_key
• POST Find roles with a query /_security/_query/role
• GET Get API key information /_security/api_key
• POST Create an API key /_security/api_key
• DELETE Invalidate API keys /_security/api_key
• POST Bulk update API keys /_security/api_key/_bulk_update
• PUT Update an API key /_security/api_key/{id}
• GET Get builtin privileges /_security/privilege/_builtin
• GET Get roles /_security/role/{name}
• POST Create or update roles /_security/role/{name}
• DELETE Delete roles /_security/role/{name}
• POST Create a service account token /_security/service/{namespace}/{service}/credential/token/{name}
• DELETE Delete service account tokens /_security/service/{namespace}/{service}/credential/token/{name}
• POST Check user privileges /_security/user/{user}/_has_privileges

SQL 6

• POST Get SQL search results /_sql
• DELETE Delete an async SQL search /_sql/async/delete/{id}
• GET Get the async SQL search status /_sql/async/status/{id}
• GET Get async SQL search results /_sql/async/{id}
• POST Clear an SQL search cursor /_sql/close
• POST Translate SQL into Elasticsearch queries /_sql/translate

Streams 3

• GET Get the status of streams /_streams/status
• POST Disable a named stream /_streams/{name}/_disable
• POST Enable a named stream /_streams/{name}/_enable

Synonyms 7

• GET Get all synonym sets /_synonyms
• GET Get a synonym set /_synonyms/{id}
• PUT Create or update a synonym set /_synonyms/{id}
• DELETE Delete a synonym set /_synonyms/{id}
• GET Get a synonym rule /_synonyms/{set_id}/{rule_id}
• PUT Create or update a synonym rule /_synonyms/{set_id}/{rule_id}
• DELETE Delete a synonym rule /_synonyms/{set_id}/{rule_id}

Task management 1

• GET Get task information /_tasks/{task_id}

Transform 11

• GET Get node stats /_transform/_node_stats
• GET Get transforms /_transform/{transform_id}
• PUT Create a transform /_transform/{transform_id}
• DELETE Delete a transform /_transform/{transform_id}
• POST Preview a transform /_transform/{transform_id}/_preview
• POST Reset a transform /_transform/{transform_id}/_reset
• POST Schedule a transform to start now /_transform/{transform_id}/_schedule_now
• POST Start a transform /_transform/{transform_id}/_start
• GET Get transform stats /_transform/{transform_id}/_stats
• POST Stop transforms /_transform/{transform_id}/_stop
• POST Update a transform /_transform/{transform_id}/_update

Types 0

Query DSL 1

• Query

Aggregations 2

• Aggregation
• Aggregation result

Ingest 1

• Processor