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
-
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 20
-
HEAD
Ping the cluster
/ -
POST
Explain the shard allocations
/_cluster/allocation/explain -
GET
Get the cluster health status
/_cluster/health/{index} -
GET
Get the pending cluster tasks
/_cluster/pending_tasks -
POST
Reroute the cluster
/_cluster/reroute -
GET
Get cluster-wide settings
/_cluster/settings -
PUT
Update the cluster settings
/_cluster/settings -
GET
Get the cluster state
/_cluster/state/{metric}/{index} -
GET
Get cluster statistics
/_cluster/stats/nodes/{node_id} -
POST
Update voting configuration exclusions
/_cluster/voting_config_exclusions -
DELETE
Clear cluster voting config exclusions
/_cluster/voting_config_exclusions -
GET
Get cluster subsystem info
/_info/{target} -
GET
Get cluster repositories metering
/_nodes/{node_id}/_repositories_metering -
DELETE
Clear the archived repositories metering
/_nodes/{node_id}/_repositories_metering/{max_archive_version} -
GET
Get the hot threads for nodes
/_nodes/{node_id}/hot_threads -
POST
Reload the keystore on nodes in the cluster
/_nodes/{node_id}/reload_secure_settings -
GET
Get node statistics
/_nodes/{node_id}/stats/{metric}/{index_metric} -
GET
Get feature usage information
/_nodes/{node_id}/usage/{metric} -
GET
Get node information
/_nodes/{node_id}/{metric} -
GET
Get remote cluster information
/_remote/info
Cluster - Health 1
Compact and aligned text (CAT) 27
-
GET
Get CAT help
/_cat -
GET
Get a compact list of aliases
/_cat/aliases/{name} -
GET
Get shard allocation information
/_cat/allocation/{node_id} -
GET
Get circuit breakers statistics
/_cat/circuit_breaker/{circuit_breaker_patterns} -
GET
Get a compact list of component templates
/_cat/component_templates/{name} -
POST
Get a document count
/_cat/count/{index} -
GET
Get field data cache information
/_cat/fielddata/{fields} -
GET
Get a compact cluster health summary
/_cat/health -
GET
Get a compact list of indices
/_cat/indices/{index} -
GET
Get master node information
/_cat/master -
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 node attribute information
/_cat/nodeattrs -
GET
Get a compact list of nodes
/_cat/nodes -
GET
Get pending task information
/_cat/pending_tasks -
GET
Get plugin information
/_cat/plugins -
GET
Get shard recovery information
/_cat/recovery/{index} -
GET
Get a compact list of snapshot repositories
/_cat/repositories -
GET
Get segment information
/_cat/segments/{index} -
GET
Get shard information
/_cat/shards/{index} -
GET
Get a compact list of snapshots
/_cat/snapshots/{repository} -
GET
Get a compact list of running tasks
/_cat/tasks -
GET
Get index template information
/_cat/templates/{name} -
GET
Get thread pool statistics
/_cat/thread_pool/{thread_pool_patterns} -
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
Cross-cluster replication 13
-
GET
Get auto-follow patterns
/_ccr/auto_follow/{name} -
PUT
Create or update auto-follow patterns
/_ccr/auto_follow/{name} -
DELETE
Delete auto-follow patterns
/_ccr/auto_follow/{name} -
POST
Pause an auto-follow pattern
/_ccr/auto_follow/{name}/pause -
POST
Resume an auto-follow pattern
/_ccr/auto_follow/{name}/resume -
GET
Get cross-cluster replication stats
/_ccr/stats -
PUT
Create a follower
/{index}/_ccr/follow -
POST
Forget a follower
/{index}/_ccr/forget_follower -
GET
Get follower information
/{index}/_ccr/info -
POST
Pause a follower
/{index}/_ccr/pause_follow -
POST
Resume a follower
/{index}/_ccr/resume_follow -
GET
Get follower stats
/{index}/_ccr/stats -
POST
Unfollow an index
/{index}/_ccr/unfollow
Data stream 19
-
POST
Convert an index alias to a data stream
/_data_stream/_migrate/{name} -
POST
Update data streams
/_data_stream/_modify -
POST
Promote a data stream
/_data_stream/_promote/{name} -
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 -
DELETE
Delete 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 stats
/_data_stream/{name}/_stats -
GET
Get data stream lifecycle stats
/_lifecycle/stats -
POST
Downsample an index
/{index}/_downsample/{target_index} -
GET
Get the status for a data stream lifecycle
/{index}/_lifecycle/explain
Document 18
-
POST
Throttle a delete by query operation
/_delete_by_query/{task_id}/_rethrottle -
POST
Reindex documents
/_reindex -
POST
Throttle a reindex operation
/_reindex/{task_id}/_rethrottle -
POST
Throttle an update by query operation
/_update_by_query/{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 5
EQL 4
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}
Features 2
Fleet 3
Graph explore 1
Index 55
-
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} -
GET
Get the dangling indices
/_dangling -
POST
Import a dangling index
/_dangling/{index_uuid} -
DELETE
Delete a dangling index
/_dangling/{index_uuid} -
DELETE
Delete data stream lifecycles
/_data_stream/{name}/_lifecycle -
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} -
GET
Resolve the cluster
/_resolve/cluster/{name} -
POST
Resolve indices
/_resolve/index/{name} -
GET
Get legacy index templates
/_template/{name} -
POST
Create or update a legacy index template
/_template/{name} -
DELETE
Delete a legacy index template
/_template/{name} -
HEAD
Check existence of index templates
/_template/{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} -
POST
Clear the cache
/{index}/_cache/clear -
POST
Clone an index
/{index}/_clone/{target} -
POST
Close an index
/{index}/_close -
POST
Analyze the index disk usage
/{index}/_disk_usage -
GET
Get field usage stats
/{index}/_field_usage_stats -
POST
Flush data streams or indices
/{index}/_flush -
POST
Force a merge
/{index}/_forcemerge -
GET
Get mapping definitions
/{index}/_mapping -
POST
Update field mappings
/{index}/_mapping -
GET
Get field mapping definitions
/{index}/_mapping/field/{fields} -
POST
Open a closed index
/{index}/_open -
GET
Get index recovery information
/{index}/_recovery -
POST
Refresh an index
/{index}/_refresh -
POST
Reload search analyzers
/{index}/_reload_search_analyzers -
GET
Get index segments
/{index}/_segments -
PUT
Update index settings
/{index}/_settings -
GET
Get index settings
/{index}/_settings/{name} -
GET
Get index shard stores
/{index}/_shard_stores -
POST
Shrink an index
/{index}/_shrink/{target} -
POST
Split an index
/{index}/_split/{target} -
GET
Get index statistics
/{index}/_stats/{metric} -
POST
Validate a query
/{index}/_validate/query
Index lifecycle management 11
-
POST
Migrate to data tiers routing
/_ilm/migrate_to_data_tiers -
POST
Move to a lifecycle step
/_ilm/move/{index} -
GET
Get lifecycle policies
/_ilm/policy/{policy} -
PUT
Create or update a lifecycle policy
/_ilm/policy/{policy} -
DELETE
Delete a lifecycle policy
/_ilm/policy/{policy} -
POST
Start the ILM plugin
/_ilm/start -
GET
Get the ILM status
/_ilm/status -
POST
Stop the ILM plugin
/_ilm/stop -
GET
Explain the lifecycle state
/{index}/_ilm/explain -
POST
Remove policies from an index
/{index}/_ilm/remove -
POST
Retry a policy
/{index}/_ilm/retry
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
Ingest 13
-
GET
Get GeoIP database configurations
/_ingest/geoip/database/{id} -
PUT
Create or update a GeoIP database configuration
/_ingest/geoip/database/{id} -
DELETE
Delete GeoIP database configurations
/_ingest/geoip/database/{id} -
GET
Get GeoIP statistics
/_ingest/geoip/stats -
GET
Get IP geolocation database configurations
/_ingest/ip_location/database/{id} -
PUT
Create or update an IP geolocation database configuration
/_ingest/ip_location/database/{id} -
DELETE
Delete IP geolocation database configurations
/_ingest/ip_location/database/{id} -
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 7
-
GET
Get license information
/_license -
POST
Update the license
/_license -
DELETE
Delete the license
/_license -
GET
Get the basic license status
/_license/basic_status -
POST
Start a basic license
/_license/start_basic -
POST
Start a trial
/_license/start_trial -
GET
Get the trial status
/_license/trial_status
Logstash 3
Machine learning 3
Machine learning anomaly detection 45
-
DELETE
Delete expired ML data
/_ml/_delete_expired_data/{job_id} -
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
Send data to an anomaly detection job for analysis
/_ml/anomaly_detectors/{job_id}/_data -
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 -
DELETE
Delete forecasts from a job
/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id} -
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 model snapshots info
/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id} -
DELETE
Delete a model snapshot
/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id} -
POST
Revert to a snapshot
/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert -
POST
Update a snapshot
/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update -
POST
Upgrade a snapshot
/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade -
GET
Get anomaly detection job model snapshot upgrade usage info
/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats -
POST
Get anomaly detection job results for buckets
/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp} -
POST
Get anomaly detection job results for categories
/_ml/anomaly_detectors/{job_id}/results/categories/{category_id} -
POST
Get anomaly detection job results for influencers
/_ml/anomaly_detectors/{job_id}/results/influencers -
POST
Get overall bucket results
/_ml/anomaly_detectors/{job_id}/results/overall_buckets -
POST
Get anomaly records for an anomaly detection job
/_ml/anomaly_detectors/{job_id}/results/records -
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 10
-
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
Explain data frame analytics config
/_ml/data_frame/analytics/{id}/_explain -
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 13
-
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 -
POST
Clear trained model deployment cache
/_ml/trained_models/{model_id}/deployment/cache/_clear -
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 7
-
POST
Create an index from a source index
/_create_from/{source}/{dest} -
POST
Reindex legacy backing indices
/_migration/reindex -
POST
Cancel a migration reindex operation
/_migration/reindex/{index}/_cancel -
GET
Get the migration reindexing status
/_migration/reindex/{index}/_status -
GET
Get feature migration information
/_migration/system_features -
POST
Start the feature migration
/_migration/system_features -
GET
Get deprecation information
/{index}/_migration/deprecations
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
Rollup 8
-
GET
Get the rollup job capabilities
/_rollup/data/{id} -
GET
Get rollup job information
/_rollup/job/{id} -
PUT
Create a rollup job
/_rollup/job/{id} -
DELETE
Delete a rollup job
/_rollup/job/{id} -
POST
Start rollup jobs
/_rollup/job/{id}/_start -
POST
Stop rollup jobs
/_rollup/job/{id}/_stop -
GET
Get the rollup index capabilities
/{index}/_rollup/data -
POST
Search rolled-up data
/{index}/_rollup_search
Script 6
-
GET
Get script contexts
/_script_context -
GET
Get script languages
/_script_language -
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 21
-
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 the search shards
/{index}/_search_shards -
POST
Get terms in an index
/{index}/_terms_enum
Search application 6
-
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
Render a search application query
/_application/search_application/{name}/_render_query -
POST
Run a search application search
/_application/search_application/{name}/_search
Searchable snapshots 4
-
GET
Get cache statistics
/_searchable_snapshots/{node_id}/cache/stats -
POST
Mount a snapshot
/_snapshot/{repository}/{snapshot}/_mount -
POST
Clear the searchable snapshots shared cache
/{index}/_searchable_snapshots/cache/clear -
GET
Get searchable snapshot statistics
/{index}/_searchable_snapshots/stats
Security 70
-
POST
Reset the project encryption key
/_encryption/_reset -
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 -
POST
Find users with a query
/_security/_query/user -
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 -
POST
Clone an API key
/_security/api_key/clone -
POST
Grant an API key
/_security/api_key/grant -
POST
Clear the API key cache
/_security/api_key/{ids}/_clear_cache -
PUT
Update an API key
/_security/api_key/{id} -
POST
Create a cross-cluster API key
/_security/cross_cluster/api_key -
PUT
Update a cross-cluster API key
/_security/cross_cluster/api_key/{id} -
POST
Delegate PKI authentication
/_security/delegate_pki -
GET
Enroll Kibana
/_security/enroll/kibana -
GET
Enroll a node
/_security/enroll/node -
POST
Get a token
/_security/oauth2/token -
DELETE
Invalidate a token
/_security/oauth2/token -
POST
Authenticate OpenID Connect
/_security/oidc/authenticate -
POST
Logout of OpenID Connect
/_security/oidc/logout -
POST
Prepare OpenID connect authentication
/_security/oidc/prepare -
POST
Create or update application privileges
/_security/privilege -
GET
Get builtin privileges
/_security/privilege/_builtin -
POST
Clear the privileges cache
/_security/privilege/{application}/_clear_cache -
GET
Get application privileges
/_security/privilege/{application}/{name} -
DELETE
Delete application privileges
/_security/privilege/{application}/{name} -
POST
Activate a user profile
/_security/profile/_activate -
POST
Check user profile privileges
/_security/profile/_has_privileges -
POST
Suggest a user profile
/_security/profile/_suggest -
GET
Get a user profile
/_security/profile/{uid} -
POST
Update user profile data
/_security/profile/{uid}/_data -
POST
Disable a user profile
/_security/profile/{uid}/_disable -
POST
Enable a user profile
/_security/profile/{uid}/_enable -
POST
Clear the user cache
/_security/realm/{realms}/_clear_cache -
POST
Bulk create or update roles
/_security/role -
DELETE
Bulk delete roles
/_security/role -
GET
Get roles
/_security/role/{name} -
POST
Create or update roles
/_security/role/{name} -
DELETE
Delete roles
/_security/role/{name} -
POST
Clear the roles cache
/_security/role/{name}/_clear_cache -
GET
Get role mappings
/_security/role_mapping/{name} -
POST
Create or update role mappings
/_security/role_mapping/{name} -
DELETE
Delete role mappings
/_security/role_mapping/{name} -
POST
Authenticate SAML
/_security/saml/authenticate -
POST
Logout of SAML completely
/_security/saml/complete_logout -
POST
Invalidate SAML
/_security/saml/invalidate -
POST
Logout of SAML
/_security/saml/logout -
GET
Create SAML service provider metadata
/_security/saml/metadata/{realm_name} -
POST
Prepare SAML authentication
/_security/saml/prepare -
GET
Get service accounts
/_security/service/{namespace}/{service} -
PUT
Create user-managed service accounts
/_security/service/{namespace}/{service} -
DELETE
Delete user-managed service accounts
/_security/service/{namespace}/{service} -
GET
Get service account credentials
/_security/service/{namespace}/{service}/credential -
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
Clear service account token caches
/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache -
GET
Get security index settings
/_security/settings -
PUT
Update security index settings
/_security/settings -
GET
Get security stats
/_security/stats -
GET
Get user privileges
/_security/user/_privileges -
GET
Get users
/_security/user/{username} -
POST
Create or update users
/_security/user/{username} -
DELETE
Delete users
/_security/user/{username} -
POST
Disable users
/_security/user/{username}/_disable -
POST
Enable users
/_security/user/{username}/_enable -
POST
Change passwords
/_security/user/{username}/_password -
POST
Check user privileges
/_security/user/{user}/_has_privileges -
GET
Get SSL certificates
/_ssl/certificates
Snapshot and restore 13
-
GET
Get snapshot repository information
/_snapshot/{repository} -
POST
Create or update a snapshot repository
/_snapshot/{repository} -
DELETE
Delete snapshot repositories
/_snapshot/{repository} -
POST
Analyze a snapshot repository
/_snapshot/{repository}/_analyze -
POST
Clean up the snapshot repository
/_snapshot/{repository}/_cleanup -
POST
Verify a snapshot repository
/_snapshot/{repository}/_verify -
POST
Verify the repository integrity
/_snapshot/{repository}/_verify_integrity -
GET
Get snapshot information
/_snapshot/{repository}/{snapshot} -
POST
Create a snapshot
/_snapshot/{repository}/{snapshot} -
DELETE
Delete snapshots
/_snapshot/{repository}/{snapshot} -
PUT
Clone a snapshot
/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot} -
POST
Restore a snapshot
/_snapshot/{repository}/{snapshot}/_restore -
GET
Get the snapshot status
/_snapshot/{repository}/{snapshot}/_status
Snapshot lifecycle management 9
-
POST
Run a retention policy
/_slm/_execute_retention -
GET
Get policy information
/_slm/policy/{policy_id} -
PUT
Create or update a policy
/_slm/policy/{policy_id} -
DELETE
Delete a policy
/_slm/policy/{policy_id} -
PUT
Run a policy
/_slm/policy/{policy_id}/_execute -
POST
Start snapshot lifecycle management
/_slm/start -
GET
Get snapshot lifecycle management statistics
/_slm/stats -
GET
Get the snapshot lifecycle management status
/_slm/status -
POST
Stop snapshot lifecycle management
/_slm/stop
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
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 3
Text structure 4
Transform 13
-
GET
Get node stats
/_transform/_node_stats -
POST
Upgrade all transforms
/_transform/_upgrade -
POST
Set upgrade_mode for transform indices
/_transform/set_upgrade_mode -
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
Usage 2
Watcher 13
-
POST
Query watches
/_watcher/_query/watches -
POST
Start the watch service
/_watcher/_start -
POST
Stop the watch service
/_watcher/_stop -
GET
Get Watcher index settings
/_watcher/settings -
PUT
Update Watcher index settings
/_watcher/settings -
GET
Get Watcher statistics
/_watcher/stats/{metric} -
GET
Get a watch
/_watcher/watch/{id} -
POST
Create or update a watch
/_watcher/watch/{id} -
DELETE
Delete a watch
/_watcher/watch/{id} -
POST
Run a watch
/_watcher/watch/{id}/_execute -
POST
Acknowledge a watch
/_watcher/watch/{watch_id}/_ack/{action_id} -
POST
Activate a watch
/_watcher/watch/{watch_id}/_activate -
POST
Deactivate a watch
/_watcher/watch/{watch_id}/_deactivate