Connectors
Databases & Data Warehouses
Elasticsearch
Search and analytics engine: index documents, run queries, and manage indices
Elasticsearch documentationAPI checked August 16, 2026
- Signs in with
- API key
- Runs on
- Cloud or On-Prem Worker
- Operations
- 440
- Ready-made triggers
- 0
Connect Elasticsearch
- In Neblex open Connect › Connections and click New Connection.
- Search for Elasticsearch and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
If the system is only reachable inside your network, choose an On-Prem Worker under Test from and run the flow on that Worker. See On-Prem Workers.
| Field | What to enter |
|---|---|
| Host (your Elasticsearch URL host)Required | |
| Authorization value (e.g. `ApiKey <key>`)RequiredSecret |
Use it in a flow
- Open a flow, open the node library and search for Elasticsearch.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Elasticsearch without a ready-made trigger: a Poll for changes trigger on Elasticsearch with your own query passes on new or changed records.
Operations
440 operations in 30 groups. Each one is a step you can add to a flow.
Analytic4
Create a behavioral analytics collectionsearch_application_put_behavioral_analytics | PUT | |
Delete a behavioral analytics collectionsearch_application_delete_behavioral_analytics | DELETE | The associated data stream is also deleted. |
Get behavioral analytics collectionssearch_application_get_behavioral_analytics | GET | |
Get behavioral analytics collectionssearch_application_get_behavioral_analytics_1 | GET |
Cat21
Get a document countcat_count | POST | Get quick access to a document count for a data stream, an index, or an entire cluster. |
Get a document countcat_count_1 | GET | Get quick access to a document count for a data stream, an index, or an entire cluster. |
Get a document countcat_count_2 | POST | Get quick access to a document count for a data stream, an index, or an entire cluster. |
Get a document countcat_count_3 | GET | Get quick access to a document count for a data stream, an index, or an entire cluster. |
Get aliasescat_aliases | GET | Get the cluster's index aliases, including filter and routing information. |
Get aliasescat_aliases_1 | GET | Get the cluster's index aliases, including filter and routing information. |
Get anomaly detection jobscat_ml_jobs | GET | Get configuration and usage information for anomaly detection jobs. |
Get anomaly detection jobscat_ml_jobs_1 | GET | Get configuration and usage information for anomaly detection jobs. |
Get CAT helpcat_help | GET | Get help for the CAT APIs. |
Get component templatescat_component_templates | GET | Get information about component templates in a cluster. |
Get component templatescat_component_templates_1 | GET | Get information about component templates in a cluster. |
Get data frame analytics jobscat_ml_data_frame_analytics | GET | Get configuration and usage information about data frame analytics jobs. |
Get data frame analytics jobscat_ml_data_frame_analytics_1 | GET | Get configuration and usage information about data frame analytics jobs. |
Get datafeedscat_ml_datafeeds | GET | Get configuration and usage information about datafeeds. |
Get datafeedscat_ml_datafeeds_1 | GET | Get configuration and usage information about datafeeds. |
Get index informationcat_indices | GET | Get high-level information about indices in a cluster, including backing indices for data streams. |
Get index informationcat_indices_1 | GET | Get high-level information about indices in a cluster, including backing indices for data streams. |
Get trained modelscat_ml_trained_models | GET | Get configuration and usage information about inference trained models. |
Get trained modelscat_ml_trained_models_1 | GET | Get configuration and usage information about inference trained models. |
Get transform informationcat_transforms | GET | Get configuration and usage information about transforms. |
Get transform informationcat_transforms_1 | GET | Get configuration and usage information about transforms. |
Cluster1
Get cluster infocluster_info | GET | Returns basic information about the cluster. |
Connector25
Activate the connector draft filterconnector_update_active_filtering | PUT | Activates the valid draft filtering for a connector. |
Cancel a connector sync jobconnector_sync_job_cancel | PUT | Cancel a connector sync job, which sets the status to cancelling and updates cancellation requested at to the current time. |
Check in a connectorconnector_check_in | PUT | Update the last seen field in the connector and set it to the current timestamp. |
Create a connectorconnector_post | POST | Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. |
Create a connector sync jobconnector_sync_job_post | POST | Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. |
Create or update a connectorconnector_put | PUT | |
Create or update a connectorconnector_put_1 | PUT | |
Delete a connectorconnector_delete | DELETE | Removes a connector and associated sync jobs. |
Delete a connector sync jobconnector_sync_job_delete | DELETE | Remove a connector sync job and its associated data. |
Get a connectorconnector_get | GET | Get the details about a connector. |
Get a connector sync jobconnector_sync_job_get | GET | |
Get all connector sync jobsconnector_sync_job_list | GET | Get information about all stored connector sync jobs listed by their creation date in ascending order. |
Get all connectorsconnector_list | GET | Get information about all connectors. |
Update the connector API key IDconnector_update_api_key_id | PUT | Update the api key id and api key secret id fields of a connector. |
Update the connector configurationconnector_update_configuration | PUT | Update the configuration field in the connector document. |
Update the connector draft filtering validationconnector_update_filtering_validation | PUT | Update the draft filtering validation info for a connector. |
Update the connector error fieldconnector_update_error | PUT | Set the error field for the connector. |
Update the connector filteringconnector_update_filtering | PUT | Update the draft filtering configuration of a connector and marks the draft validation state as edited. |
Update the connector index nameconnector_update_index_name | PUT | Update the index name field of a connector, specifying the index where the data ingested by the connector is stored. |
Update the connector is_native flagconnector_update_native | PUT | |
Update the connector name and descriptionconnector_update_name | PUT | |
Update the connector pipelineconnector_update_pipeline | PUT | When you create a new connector, the configuration of an ingest pipeline is populated with default settings. |
Update the connector schedulingconnector_update_scheduling | PUT | |
Update the connector service typeconnector_update_service_type | PUT | |
Update the connector statusconnector_update_status | PUT |
Data Stream15
Convert an index alias to a data streamindices_migrate_to_data_stream | POST | Converts an index alias to a data stream. |
Create a data streamindices_create_data_stream | PUT | You must have a matching index template with data stream enabled. |
Delete data streamsindices_delete_data_stream | DELETE | Deletes one or more data streams and their backing indices. |
Get data stream lifecyclesindices_get_data_lifecycle | GET | Get the data stream lifecycle configuration of one or more data streams. |
Get data stream mappingsindices_get_data_stream_mappings | GET | Get mapping information for one or more data streams. |
Get data stream optionsindices_get_data_stream_options | GET | Get the data stream options configuration of one or more data streams. |
Get data stream settingsindices_get_data_stream_settings | GET | Get setting information for one or more data streams. |
Get data streamsindices_get_data_stream | GET | Get information about one or more data streams. |
Get data streamsindices_get_data_stream_1 | GET | Get information about one or more data streams. |
Get the status for a data stream lifecycleindices_explain_data_lifecycle | GET | Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the... |
Update data stream lifecyclesindices_put_data_lifecycle | PUT | Update the data stream lifecycle of the specified data streams. |
Update data stream mappingsindices_put_data_stream_mappings | PUT | This API can be used to override mappings on specific data streams. |
Update data stream optionsindices_put_data_stream_options | PUT | Update the data stream options of the specified data streams. |
Update data stream settingsindices_put_data_stream_settings | PUT | NOTE: Available in 8.19. |
Update data streamsindices_modify_data_stream | POST | Performs one or more data stream modification actions in a single atomic operation. |
Document29
Bulk index or delete documentsbulk | POST | Perform multiple index, create, delete, and update actions in a single request. |
Bulk index or delete documentsbulk_1 | PUT | Perform multiple index, create, delete, and update actions in a single request. |
Bulk index or delete documentsbulk_2 | POST | Perform multiple index, create, delete, and update actions in a single request. |
Bulk index or delete documentsbulk_3 | PUT | Perform multiple index, create, delete, and update actions in a single request. |
Create a new document in the indexcreate | PUT | You can index a new JSON document with the / / doc/ or / / create/ APIs Using create guarantees that the document is indexed only if it does not already exist. |
Create a new document in the indexcreate_1 | POST | You can index a new JSON document with the / / doc/ or / / create/ APIs Using create guarantees that the document is indexed only if it does not already exist. |
Create or update a document in an indexindex | PUT | Add a JSON document to the specified data stream or index and make it searchable. |
Create or update a document in an indexindex_1 | POST | Add a JSON document to the specified data stream or index and make it searchable. |
Create or update a document in an indexindex_2 | POST | Add a JSON document to the specified data stream or index and make it searchable. |
Delete a documentdelete | DELETE | Remove a JSON document from the specified index. |
Delete documentsdelete_by_query | POST | Deletes documents that match the specified query. |
Get a document by its IDget | GET | Get a document and its source or stored fields from an index. |
Get a document's sourceget_source | GET | Get the source of a document. |
Get multiple documentsmget | GET | Get multiple JSON documents by ID from one or more indices. |
Get multiple documentsmget_1 | POST | Get multiple JSON documents by ID from one or more indices. |
Get multiple documentsmget_2 | GET | Get multiple JSON documents by ID from one or more indices. |
Get multiple documentsmget_3 | POST | Get multiple JSON documents by ID from one or more indices. |
Get multiple term vectorsmtermvectors | GET | Get multiple term vectors with a single request. |
Get multiple term vectorsmtermvectors_1 | POST | Get multiple term vectors with a single request. |
Get multiple term vectorsmtermvectors_2 | GET | Get multiple term vectors with a single request. |
Get multiple term vectorsmtermvectors_3 | POST | Get multiple term vectors with a single request. |
Get term vector informationtermvectors | GET | Get information and statistics about terms in the fields of a particular document. |
Get term vector informationtermvectors_1 | POST | Get information and statistics about terms in the fields of a particular document. |
Get term vector informationtermvectors_2 | GET | Get information and statistics about terms in the fields of a particular document. |
Get term vector informationtermvectors_3 | POST | Get information and statistics about terms in the fields of a particular document. |
Reindex documentsreindex | POST | Copy documents from a source to a destination. |
Throttle a reindex operationreindex_rethrottle | POST | Change the maximum number of documents to index per second for a particular reindex operation. |
Update a documentupdate | POST | Update a document by running a script or passing a partial document. |
Update documentsupdate_by_query | POST | Updates documents that match the specified query. |
Enrich5
Create an enrich policyenrich_put_policy | PUT | Creates an enrich policy. |
Delete an enrich policyenrich_delete_policy | DELETE | Deletes an existing enrich policy and its enrich index. |
Get an enrich policyenrich_get_policy | GET | Returns information about an enrich policy. |
Get an enrich policyenrich_get_policy_1 | GET | Returns information about an enrich policy. |
Run an enrich policyenrich_execute_policy | PUT | Create the enrich index for an existing enrich policy. |
Eql5
Delete an async EQL searcheql_delete | DELETE | Delete an async EQL search or a stored synchronous EQL search. |
Get async EQL search resultseql_get | GET | Get the current status and available results for an async EQL search or a stored synchronous EQL search. |
Get EQL search resultseql_search | GET | Returns search results for an Event Query Language (EQL) query. |
Get EQL search resultseql_search_1 | POST | Returns search results for an Event Query Language (EQL) query. |
Get the async EQL statuseql_get_status | GET | Get the current status for an async EQL search or a stored synchronous EQL search without returning results. |
Esql7
Create or update an ES|QL viewesql_put_view | PUT | |
Delete an ES|QL viewesql_delete_view | DELETE | Deletes a stored ES|QL view. |
Get a specific running ES|QL query informationesql_get_query | GET | Returns an object extended information about a running ES|QL query. |
Get an ES|QL viewesql_get_view | GET | Returns a stored ES|QL view. |
Get an ES|QL viewesql_get_view_1 | GET | Returns a stored ES|QL view. |
Get running ES|QL queries informationesql_list_queries | GET | Returns an object containing IDs and other information about the running ES|QL queries. |
Run an ES|QL queryesql_query | POST | Get search results for an ES|QL (Elasticsearch query language) query. |
Indice55
Add an index blockindices_add_block | PUT | Add an index block to an index. |
Create an indexindices_create | PUT | You can use the create index API to add a new index to an Elasticsearch cluster. |
Create or update a component templatecluster_put_component_template | PUT | Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. |
Create or update a component templatecluster_put_component_template_1 | POST | Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. |
Create or update an aliasindices_put_alias | PUT | Adds a data stream or index to an alias. |
Create or update an aliasindices_put_alias_1 | POST | Adds a data stream or index to an alias. |
Create or update an aliasindices_put_alias_2 | PUT | Adds a data stream or index to an alias. |
Create or update an aliasindices_put_alias_3 | POST | Adds a data stream or index to an alias. |
Create or update an aliasindices_update_aliases | POST | Adds a data stream or index to an alias. |
Create or update an index templateindices_put_index_template | PUT | Index templates define settings, mappings, and aliases that can be applied automatically to new indices. |
Create or update an index templateindices_put_index_template_1 | POST | Index templates define settings, mappings, and aliases that can be applied automatically to new indices. |
Delete an aliasindices_delete_alias | DELETE | Removes a data stream or index from an alias. |
Delete an aliasindices_delete_alias_1 | DELETE | Removes a data stream or index from an alias. |
Delete an index templateindices_delete_index_template | DELETE | The provided may contain multiple template names separated by a comma. |
Delete component templatescluster_delete_component_template | DELETE | Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. |
Delete indicesindices_delete | DELETE | Deleting an index deletes its documents, shards, and metadata. |
Get aliasesindices_get_alias | GET | Retrieves information for one or more data stream or index aliases. |
Get aliasesindices_get_alias_1 | GET | Retrieves information for one or more data stream or index aliases. |
Get aliasesindices_get_alias_2 | GET | Retrieves information for one or more data stream or index aliases. |
Get aliasesindices_get_alias_3 | GET | Retrieves information for one or more data stream or index aliases. |
Get component templatescluster_get_component_template | GET | Get information about component templates. |
Get component templatescluster_get_component_template_1 | GET | Get information about component templates. |
Get index informationindices_get | GET | Get information about one or more indices. |
Get index settingsindices_get_settings | GET | Get setting information for one or more indices. |
Get index settingsindices_get_settings_1 | GET | Get setting information for one or more indices. |
Get index settingsindices_get_settings_2 | GET | Get setting information for one or more indices. |
Get index settingsindices_get_settings_3 | GET | Get setting information for one or more indices. |
Get index templatesindices_get_index_template | GET | Get information about one or more index templates. |
Get index templatesindices_get_index_template_1 | GET | Get information about one or more index templates. |
Get mapping definitionsindices_get_mapping | GET | For data streams, the API retrieves mappings for the stream’s backing indices. |
Get mapping definitionsindices_get_mapping_1 | GET | For data streams, the API retrieves mappings for the stream’s backing indices. |
Get tokens from text analysisindices_analyze | GET | |
Get tokens from text analysisindices_analyze_1 | POST | |
Get tokens from text analysisindices_analyze_2 | GET | |
Get tokens from text analysisindices_analyze_3 | POST | |
Refresh an indexindices_refresh | POST | |
Refresh an indexindices_refresh_1 | GET | |
Refresh an indexindices_refresh_2 | POST | |
Refresh an indexindices_refresh_3 | GET | |
Remove an index blockindices_remove_block | DELETE | Remove an index block from an index. |
Resolve indicesindices_resolve_index | GET | Resolve the names and/or index patterns for indices, aliases, and data streams. |
Resolve indicesindices_resolve_index_1 | POST | Resolve the names and/or index patterns for indices, aliases, and data streams. |
Roll over to a new indexindices_rollover | POST | TIP: We recommend using the index lifecycle rollover action to automate rollovers. |
Roll over to a new indexindices_rollover_1 | POST | TIP: We recommend using the index lifecycle rollover action to automate rollovers. |
Simulate an indexindices_simulate_index_template | POST | Get the index configuration that would be applied to the specified index from an existing index template. |
Simulate an index templateindices_simulate_template | POST | Get the index configuration that would be applied by a particular index template. |
Simulate an index templateindices_simulate_template_1 | POST | Get the index configuration that would be applied by a particular index template. |
Update field mappingsindices_put_mapping | PUT | Add new fields to an existing data stream or index. |
Update field mappingsindices_put_mapping_1 | POST | Add new fields to an existing data stream or index. |
Update index settingsindices_put_settings | PUT | Changes dynamic index settings in real time. |
Update index settingsindices_put_settings_1 | PUT | Changes dynamic index settings in real time. |
Validate a queryindices_validate_query | GET | Validates a query without running it. |
Validate a queryindices_validate_query_1 | POST | Validates a query without running it. |
Validate a queryindices_validate_query_2 | GET | Validates a query without running it. |
Validate a queryindices_validate_query_3 | POST | Validates a query without running it. |
Inference45
Create a AI21 inference endpointinference_put_ai21 | PUT | Create an inference endpoint to perform an inference task with the ai21 service. |
Create a Cohere inference endpointinference_put_cohere | PUT | Create an inference endpoint to perform an inference task with the cohere service. |
Create a custom inference endpointinference_put_custom | PUT | The custom service gives more control over how to interact with external inference services that aren't explicitly supported through dedicated integrations. |
Create a DeepSeek inference endpointinference_put_deepseek | PUT | Create an inference endpoint to perform an inference task with the deepseek service. |
Create a Fireworks AI inference endpointinference_put_fireworksai | PUT | Create an inference endpoint to perform an inference task with the fireworksai service. |
Create a Google Vertex AI inference endpointinference_put_googlevertexai | PUT | Create an inference endpoint to perform an inference task with the googlevertexai service. |
Create a Groq inference endpointinference_put_groq | PUT | Create an inference endpoint to perform an inference task with the groq service. |
Create a Hugging Face inference endpointinference_put_hugging_face | PUT | Create an inference endpoint to perform an inference task with the hugging face service. |
Create a Llama inference endpointinference_put_llama | PUT | Create an inference endpoint to perform an inference task with the llama service. |
Create a Mistral inference endpointinference_put_mistral | PUT | Create an inference endpoint to perform an inference task with the mistral service. |
Create a VoyageAI inference endpointinference_put_voyageai | PUT | Create an inference endpoint to perform an inference task with the voyageai service. |
Create a Watsonx inference endpointinference_put_watsonx | PUT | Create an inference endpoint to perform an inference task with the watsonxai service. |
Create an AlibabaCloud AI Search inference endpointinference_put_alibabacloud | PUT | Create an inference endpoint to perform an inference task with the alibabacloud-ai-search service. |
Create an Amazon Bedrock inference endpointinference_put_amazonbedrock | PUT | Create an inference endpoint to perform an inference task with the amazonbedrock service. |
Create an Amazon SageMaker inference endpointinference_put_amazonsagemaker | PUT | Create an inference endpoint to perform an inference task with the amazon sagemaker service. |
Create an Anthropic inference endpointinference_put_anthropic | PUT | Create an inference endpoint to perform an inference task with the anthropic service. |
Create an Azure AI studio inference endpointinference_put_azureaistudio | PUT | Create an inference endpoint to perform an inference task with the azureaistudio service. |
Create an Azure OpenAI inference endpointinference_put_azureopenai | PUT | Create an inference endpoint to perform an inference task with the azureopenai service. |
Create an Contextual AI inference endpointinference_put_contextualai | PUT | Create an inference endpoint to perform an inference task with the contexualai service. |
Create an Elasticsearch inference endpointinference_put_elasticsearch | PUT | Create an inference endpoint to perform an inference task with the elasticsearch service. |
Create an ELSER inference endpointinference_put_elser | PUT | Create an inference endpoint to perform an inference task with the elser service. |
Create an Google AI Studio inference endpointinference_put_googleaistudio | PUT | Create an inference endpoint to perform an inference task with the googleaistudio service. |
Create an inference endpointinference_put | PUT | IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure... |
Create an inference endpointinference_put_1 | PUT | IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure... |
Create an JinaAI inference endpointinference_put_jinaai | PUT | Create an inference endpoint to perform an inference task with the jinaai service. |
Create an Nvidia inference endpointinference_put_nvidia | PUT | Create an inference endpoint to perform an inference task with the nvidia service. |
Create an OpenAI inference endpointinference_put_openai | PUT | Create an inference endpoint to perform an inference task with the openai service or openai compatible APIs. |
Create an OpenShift AI inference endpointinference_put_openshift_ai | PUT | Create an inference endpoint to perform an inference task with the openshift ai service. |
Delete an inference endpointinference_delete | DELETE | This API requires the manage inference cluster privilege (the built-in inference admin role grants this privilege). |
Delete an inference endpointinference_delete_1 | DELETE | This API requires the manage inference cluster privilege (the built-in inference admin role grants this privilege). |
Get an inference endpointinference_get | GET | This API requires the monitor inference cluster privilege (the built-in inference admin and inference user roles grant this privilege). |
Get an inference endpointinference_get_1 | GET | This API requires the monitor inference cluster privilege (the built-in inference admin and inference user roles grant this privilege). |
Get an inference endpointinference_get_2 | GET | This API requires the monitor inference cluster privilege (the built-in inference admin and inference user roles grant this privilege). |
Get an inference endpointinference_get_3 | GET | This API requires the monitor inference cluster privilege (the built-in inference admin and inference user roles grant this privilege). |
Perform chat completion inference on the serviceinference_chat_completion_unified | POST | The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. |
Perform completion inference on the serviceinference_completion | POST | Get responses for completion tasks. |
Perform dense embedding inference on the serviceinference_embedding | POST | |
Perform inference on the serviceinference_inference | POST | This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. |
Perform inference on the serviceinference_inference_1 | POST | This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. |
Perform reranking inference on the serviceinference_rerank | POST | |
Perform sparse embedding inference on the serviceinference_sparse_embedding | POST | |
Perform streaming completion inference on the serviceinference_stream_completion | POST | Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. |
Perform text embedding inference on the serviceinference_text_embedding | POST | |
Update an inference endpointinference_update | PUT | Modify task settings, secrets (within service settings), or num allocations for an inference endpoint, depending on the specific endpoint service and task type. |
Update an inference endpointinference_update_1 | PUT | Modify task settings, secrets (within service settings), or num allocations for an inference endpoint, depending on the specific endpoint service and task type. |
Info1
Get cluster infoinfo | GET | Get basic build, version, and cluster information. |
Ingest9
Create or update a pipelineingest_put_pipeline | PUT | Changes made using this API take effect immediately. |
Delete pipelinesingest_delete_pipeline | DELETE | Delete one or more ingest pipelines. |
Get pipelinesingest_get_pipeline | GET | Get information about one or more ingest pipelines. |
Get pipelinesingest_get_pipeline_1 | GET | Get information about one or more ingest pipelines. |
Run a grok processoringest_processor_grok | GET | Extract structured fields out of a single text field within a document. |
Simulate a pipelineingest_simulate | GET | Run an ingest pipeline against a set of provided documents. |
Simulate a pipelineingest_simulate_1 | POST | Run an ingest pipeline against a set of provided documents. |
Simulate a pipelineingest_simulate_2 | GET | Run an ingest pipeline against a set of provided documents. |
Simulate a pipelineingest_simulate_3 | POST | Run an ingest pipeline against a set of provided documents. |
License1
Get license informationlicense_get | GET | Get information about your Elastic license including its type, its status, when it was issued, and when it expires. |
Logstash4
Create or update a Logstash pipelinelogstash_put_pipeline | PUT | Create a pipeline that is used for Logstash Central Management. |
Delete a Logstash pipelinelogstash_delete_pipeline | DELETE | Delete a pipeline that is used for Logstash Central Management. |
Get Logstash pipelineslogstash_get_pipeline | GET | Get pipelines that are used for Logstash Central Management. |
Get Logstash pipelineslogstash_get_pipeline_1 | GET | Get pipelines that are used for Logstash Central Management. |
Migration4
Cancel a migration reindex operationindices_cancel_migrate_reindex | POST | Cancel a migration reindex attempt for a data stream or index. |
Create an index from a source indexindices_create_from | PUT | Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values. |
Create an index from a source indexindices_create_from_1 | POST | Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values. |
Get the migration reindexing statusindices_get_migrate_reindex_status | GET | Get the status of a migration reindex attempt for a data stream or index. |
Ml Anomaly43
Add anomaly detection job to calendarml_put_calendar_job | PUT | |
Add scheduled events to the calendarml_post_calendar_events | POST | |
Close anomaly detection jobsml_close_job | POST | A job can be opened and closed multiple times throughout its lifecycle. |
Create a calendarml_put_calendar | PUT | |
Create a datafeedml_put_datafeed | PUT | Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. |
Create a filterml_put_filter | PUT | A filter contains a list of strings. |
Create an anomaly detection jobml_put_job | PUT | If you include a datafeed config, you must have read index privileges on the source index. |
Delete a calendarml_delete_calendar | DELETE | Remove all scheduled events from a calendar, then delete it. |
Delete a datafeedml_delete_datafeed | DELETE | |
Delete a filterml_delete_filter | DELETE | If an anomaly detection job references the filter, you cannot delete the filter. |
Delete an anomaly detection jobml_delete_job | DELETE | All job configuration, model state and results are deleted. |
Delete anomaly jobs from a calendarml_delete_calendar_job | DELETE | |
Delete events from a calendarml_delete_calendar_event | DELETE | |
Estimate job model memory usageml_estimate_model_memory | POST | Make an estimation of the memory usage for an anomaly detection job model. |
Force buffered data to be processedml_flush_job | POST | The flush jobs API is only applicable when sending data for analysis using the post data API. |
Get anomaly detection job statsml_get_job_stats | GET | |
Get anomaly detection job statsml_get_job_stats_1 | GET | |
Get anomaly detection jobs configuration infoml_get_jobs | GET | You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. |
Get anomaly detection jobs configuration infoml_get_jobs_1 | GET | You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. |
Get calendar configuration infoml_get_calendars | GET | |
Get calendar configuration infoml_get_calendars_1 | POST | |
Get calendar configuration infoml_get_calendars_2 | GET | |
Get calendar configuration infoml_get_calendars_3 | POST | |
Get datafeed statsml_get_datafeed_stats | GET | You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. |
Get datafeed statsml_get_datafeed_stats_1 | GET | You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. |
Get datafeeds configuration infoml_get_datafeeds | GET | You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. |
Get datafeeds configuration infoml_get_datafeeds_1 | GET | You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. |
Get filtersml_get_filters | GET | You can get a single filter or all filters. |
Get filtersml_get_filters_1 | GET | You can get a single filter or all filters. |
Get info about events in calendarsml_get_calendar_events | GET | |
Get overall bucket resultsml_get_overall_buckets | GET | Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs. |
Get overall bucket resultsml_get_overall_buckets_1 | POST | Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs. |
Open anomaly detection jobsml_open_job | POST | An anomaly detection job must be opened to be ready to receive and analyze data. |
Preview a datafeedml_preview_datafeed | GET | This API returns the first "page" of search results from a datafeed. |
Preview a datafeedml_preview_datafeed_1 | POST | This API returns the first "page" of search results from a datafeed. |
Preview a datafeedml_preview_datafeed_2 | GET | This API returns the first "page" of search results from a datafeed. |
Preview a datafeedml_preview_datafeed_3 | POST | This API returns the first "page" of search results from a datafeed. |
Reset an anomaly detection jobml_reset_job | POST | All model state and results are deleted. |
Start datafeedsml_start_datafeed | POST | A datafeed must be started in order to retrieve data from Elasticsearch. |
Stop datafeedsml_stop_datafeed | POST | A datafeed that is stopped ceases to retrieve data from Elasticsearch. |
Update a datafeedml_update_datafeed | POST | You must stop and start the datafeed for the changes to be applied. |
Update a filterml_update_filter | POST | Updates the description of a filter, adds items, or removes items from the list. |
Update an anomaly detection jobml_update_job | POST | Updates certain properties of an anomaly detection job. |
Ml Data Frame14
Create a data frame analytics jobml_put_data_frame_analytics | PUT | This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index. |
Delete a data frame analytics jobml_delete_data_frame_analytics | DELETE | |
Evaluate data frame analyticsml_evaluate_data_frame | POST | The API packages together commonly used evaluation metrics for various types of machine learning features. |
Get data frame analytics job configuration infoml_get_data_frame_analytics | GET | You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. |
Get data frame analytics job configuration infoml_get_data_frame_analytics_1 | GET | You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. |
Get data frame analytics job statsml_get_data_frame_analytics_stats | GET | |
Get data frame analytics job statsml_get_data_frame_analytics_stats_1 | GET | |
Preview features used by data frame analyticsml_preview_data_frame_analytics | GET | Preview the extracted features used by a data frame analytics config. |
Preview features used by data frame analyticsml_preview_data_frame_analytics_1 | POST | Preview the extracted features used by a data frame analytics config. |
Preview features used by data frame analyticsml_preview_data_frame_analytics_2 | GET | Preview the extracted features used by a data frame analytics config. |
Preview features used by data frame analyticsml_preview_data_frame_analytics_3 | POST | Preview the extracted features used by a data frame analytics config. |
Start a data frame analytics jobml_start_data_frame_analytics | POST | A data frame analytics job can be started and stopped multiple times throughout its lifecycle. |
Stop data frame analytics jobsml_stop_data_frame_analytics | POST | A data frame analytics job can be started and stopped multiple times throughout its lifecycle. |
Update a data frame analytics jobml_update_data_frame_analytics | POST |
Ml Trained Model14
Create a trained modelml_put_trained_model | PUT | Enable you to supply a trained model that is not created by data frame analytics. |
Create a trained model vocabularyml_put_trained_model_vocabulary | PUT | This API is supported only for natural language processing (NLP) models. |
Create or update a trained model aliasml_put_trained_model_alias | PUT | A trained model alias is a logical name used to reference a single trained model. |
Create part of a trained model definitionml_put_trained_model_definition_part | PUT | |
Delete a trained model aliasml_delete_trained_model_alias | DELETE | This API deletes an existing model alias that refers to a trained model. |
Delete an unreferenced trained modelml_delete_trained_model | DELETE | The request deletes a trained inference model that is not referenced by an ingest pipeline. |
Evaluate a trained modelml_infer_trained_model | POST | |
Get trained model configuration infoml_get_trained_models | GET | |
Get trained model configuration infoml_get_trained_models_1 | GET | |
Get trained models usage infoml_get_trained_models_stats | GET | You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. |
Get trained models usage infoml_get_trained_models_stats_1 | GET | You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. |
Start a trained model deploymentml_start_trained_model_deployment | POST | It allocates the model to every machine learning node. |
Stop a trained model deploymentml_stop_trained_model_deployment | POST | |
Update a trained model deploymentml_update_trained_model_deployment | POST |
Project7
Create or update a project routing expressionproject_create_routing | PUT | |
Create or update project routing expressionsproject_create_many_routing | PUT | |
Delete a project routing expressionproject_delete_routing | DELETE | |
Get a project routing expressionproject_get_routing | GET | |
Get project routing expressionsproject_get_many_routing | GET | |
Get tagsproject_tags | GET | Get the tags that are defined for the project. |
Get tagsproject_tags_1 | POST | Get the tags that are defined for the project. |
Query Rule8
Create or update a query rulequery_rules_put_rule | PUT | Create or update a query rule within a query ruleset. |
Create or update a query rulesetquery_rules_put_ruleset | PUT | There is a limit of 100 rules per ruleset. |
Delete a query rulequery_rules_delete_rule | DELETE | Delete a query rule within a query ruleset. |
Delete a query rulesetquery_rules_delete_ruleset | DELETE | Remove a query ruleset and its associated data. |
Get a query rulequery_rules_get_rule | GET | Get details about a query rule within a query ruleset. |
Get a query rulesetquery_rules_get_ruleset | GET | Get details about a query ruleset. |
Get all query rulesetsquery_rules_list_rulesets | GET | Get summarized information about the query rulesets. |
Test a query rulesetquery_rules_test | POST | Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. |
Reindex3
Cancel an ongoing reindex taskcancel_reindex | POST | If wait for completion is true (the default), the response contains the final task state after cancellation. |
Get information about all currently running reindex taskslist_reindex | GET | Reindex tasks that are mid-relocation between nodes are reported once, under their original task ID, so callers do not see duplicates across the relocation chain. |
Get the status and progress of a specific reindex taskget_reindex | GET | This API follows reindex tasks across node-shutdown relocations, so callers can keep using the original task ID throughout the lifetime of the operation. |
Script8
Create or update a script or search templateput_script | PUT | Creates or updates a stored script or search template. |
Create or update a script or search templateput_script_1 | POST | Creates or updates a stored script or search template. |
Create or update a script or search templateput_script_2 | PUT | Creates or updates a stored script or search template. |
Create or update a script or search templateput_script_3 | POST | Creates or updates a stored script or search template. |
Delete a script or search templatedelete_script | DELETE | Deletes a stored script or search template. |
Get a script or search templateget_script | GET | Retrieves a stored script or search template. |
Run a scriptscripts_painless_execute | GET | Runs a script and returns a result. |
Run a scriptscripts_painless_execute_1 | POST | Runs a script and returns a result. |
Search51
Clear a scrolling searchclear_scroll | DELETE | Clear the search context and results for a scrolling search. |
Clear a scrolling searchclear_scroll_1 | DELETE | Clear the search context and results for a scrolling search. |
Close a point in timeclose_point_in_time | DELETE | A point in time must be opened explicitly before being used in search requests. |
Count search resultscount | POST | Get the number of documents matching a query. |
Count search resultscount_1 | GET | Get the number of documents matching a query. |
Count search resultscount_2 | POST | Get the number of documents matching a query. |
Count search resultscount_3 | GET | Get the number of documents matching a query. |
Delete an async searchasync_search_delete | DELETE | If the asynchronous search is still running, it is cancelled. |
Evaluate ranked search resultsrank_eval | GET | Evaluate the quality of ranked search results over a set of typical search queries. |
Evaluate ranked search resultsrank_eval_1 | POST | Evaluate the quality of ranked search results over a set of typical search queries. |
Evaluate ranked search resultsrank_eval_2 | GET | Evaluate the quality of ranked search results over a set of typical search queries. |
Evaluate ranked search resultsrank_eval_3 | POST | Evaluate the quality of ranked search results over a set of typical search queries. |
Explain a document match resultexplain | GET | Get information about why a specific document matches, or doesn't match, a query. |
Explain a document match resultexplain_1 | POST | Get information about why a specific document matches, or doesn't match, a query. |
Get async search resultsasync_search_get | GET | Retrieve the results of a previously submitted asynchronous search request. |
Get terms in an indexterms_enum | GET | Discover terms that match a partial string in an index. |
Get terms in an indexterms_enum_1 | POST | Discover terms that match a partial string in an index. |
Get the async search statusasync_search_status | GET | Get the status of a previously submitted async search request given its identifier, without retrieving search results. |
Get the field capabilitiesfield_caps | GET | Get information about the capabilities of fields among multiple indices. |
Get the field capabilitiesfield_caps_1 | POST | Get information about the capabilities of fields among multiple indices. |
Get the field capabilitiesfield_caps_2 | GET | Get information about the capabilities of fields among multiple indices. |
Get the field capabilitiesfield_caps_3 | POST | Get information about the capabilities of fields among multiple indices. |
Open a point in timeopen_point_in_time | POST | A search request by default runs against the most recent visible data of the target indices, which is called point in time. |
Render a search templaterender_search_template | GET | Render a search template as a search request body. |
Render a search templaterender_search_template_1 | POST | Render a search template as a search request body. |
Render a search templaterender_search_template_2 | GET | Render a search template as a search request body. |
Render a search templaterender_search_template_3 | POST | Render a search template as a search request body. |
Run a scrolling searchscroll | GET | IMPORTANT: The scroll API is no longer recommend for deep pagination. |
Run a scrolling searchscroll_1 | POST | IMPORTANT: The scroll API is no longer recommend for deep pagination. |
Run a scrolling searchscroll_2 | GET | IMPORTANT: The scroll API is no longer recommend for deep pagination. |
Run a scrolling searchscroll_3 | POST | IMPORTANT: The scroll API is no longer recommend for deep pagination. |
Run a searchsearch | GET | Get search hits that match the query defined in the request. |
Run a searchsearch_1 | POST | Get search hits that match the query defined in the request. |
Run a searchsearch_2 | GET | Get search hits that match the query defined in the request. |
Run a searchsearch_3 | POST | Get search hits that match the query defined in the request. |
Run a search with a search templatesearch_template | GET | |
Run a search with a search templatesearch_template_1 | POST | |
Run a search with a search templatesearch_template_2 | GET | |
Run a search with a search templatesearch_template_3 | POST | |
Run an async searchasync_search_submit | POST | When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. |
Run an async searchasync_search_submit_1 | POST | When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. |
Run multiple searchesmsearch | GET | |
Run multiple searchesmsearch_1 | POST | |
Run multiple searchesmsearch_2 | GET | |
Run multiple searchesmsearch_3 | POST | |
Run multiple templated searchesmsearch_template | GET | Run multiple templated searches with a single request. |
Run multiple templated searchesmsearch_template_1 | POST | Run multiple templated searches with a single request. |
Run multiple templated searchesmsearch_template_2 | GET | Run multiple templated searches with a single request. |
Run multiple templated searchesmsearch_template_3 | POST | Run multiple templated searches with a single request. |
Search a vector tilesearch_mvt | POST | Search a vector tile for geospatial values. |
Search a vector tilesearch_mvt_1 | GET | Search a vector tile for geospatial values. |
Search Application6
Create or update a search applicationsearch_application_put | PUT | |
Delete a search applicationsearch_application_delete | DELETE | Remove a search application and its associated alias. |
Get search application detailssearch_application_get | GET | |
Get search applicationssearch_application_list | GET | Get information about search applications. |
Run a search application searchsearch_application_search | GET | Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. |
Run a search application searchsearch_application_search_1 | POST | Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. |
Security24
Authenticate a usersecurity_authenticate | GET | Authenticates a user and returns information about the authenticated user. |
Check user privilegessecurity_has_privileges | GET | Determine whether the specified user has a specified list of privileges. |
Check user privilegessecurity_has_privileges_1 | POST | Determine whether the specified user has a specified list of privileges. |
Check user privilegessecurity_has_privileges_2 | GET | Determine whether the specified user has a specified list of privileges. |
Check user privilegessecurity_has_privileges_3 | POST | Determine whether the specified user has a specified list of privileges. |
Create a service account tokensecurity_create_service_token | PUT | Create a service accounts token for access without requiring basic authentication. |
Create a service account tokensecurity_create_service_token_1 | POST | Create a service accounts token for access without requiring basic authentication. |
Create a service account tokensecurity_create_service_token_2 | POST | Create a service accounts token for access without requiring basic authentication. |
Create an API keysecurity_create_api_key | PUT | Create an API key for access without requiring basic authentication. |
Create an API keysecurity_create_api_key_1 | POST | Create an API key for access without requiring basic authentication. |
Create or update rolessecurity_put_role | PUT | The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. |
Create or update rolessecurity_put_role_1 | POST | The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. |
Delete rolessecurity_delete_role | DELETE | Delete roles in the native realm. |
Delete service account tokenssecurity_delete_service_token | DELETE | Delete service account tokens for a service in a specified namespace. |
Find API keys with a querysecurity_query_api_keys | GET | Get a paginated list of API keys and their information. |
Find API keys with a querysecurity_query_api_keys_1 | POST | Get a paginated list of API keys and their information. |
Find roles with a querysecurity_query_role | GET | Get roles in a paginated manner. |
Find roles with a querysecurity_query_role_1 | POST | Get roles in a paginated manner. |
Get API key informationsecurity_get_api_key | GET | Retrieves information for one or more API keys. |
Get builtin privilegessecurity_get_builtin_privileges | GET | Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. |
Get rolessecurity_get_role | GET | Get roles in the native realm. |
Get rolessecurity_get_role_1 | GET | Get roles in the native realm. |
Invalidate API keyssecurity_invalidate_api_key | DELETE | This API invalidates API keys created by the create API key or grant API key APIs. |
Update an API keysecurity_update_api_key | PUT | Update attributes of an existing API key. |
Sql8
Clear an SQL search cursorsql_clear_cursor | POST | |
Delete an async SQL searchsql_delete_async | DELETE | Delete an async SQL search or a stored synchronous SQL search. |
Get async SQL search resultssql_get_async | GET | Get the current status and available results for an async SQL search or stored synchronous SQL search. |
Get SQL search resultssql_query | POST | Run an SQL request. |
Get SQL search resultssql_query_1 | GET | Run an SQL request. |
Get the async SQL search statussql_get_async_status | GET | Get the current status of an async SQL search or a stored synchronous SQL search. |
Translate SQL into Elasticsearch queriessql_translate | POST | Translate an SQL search into a search API request containing Query DSL. |
Translate SQL into Elasticsearch queriessql_translate_1 | GET | Translate an SQL search into a search API request containing Query DSL. |
Synonym7
Create or update a synonym rulesynonyms_put_synonym_rule | PUT | Create or update a synonym rule in a synonym set. |
Create or update a synonym setsynonyms_put_synonym | PUT | Synonym sets are limited to a maximum of 100,000 synonym rules per set by default. |
Delete a synonym rulesynonyms_delete_synonym_rule | DELETE | Delete a synonym rule from a synonym set. |
Delete a synonym setsynonyms_delete_synonym | DELETE | You can only delete a synonyms set that is not in use by any index analyzer. |
Get a synonym rulesynonyms_get_synonym_rule | GET | Get a synonym rule from a synonym set. |
Get a synonym setsynonyms_get_synonym | GET | |
Get all synonym setssynonyms_get_synonyms_sets | GET | Get a summary of all defined synonym sets. |
Task1
Get task informationtasks_get | GET | Get information about a task currently running in the cluster. |
Transform15
Create a transformtransform_put_transform | PUT | Creates a transform. |
Delete a transformtransform_delete_transform | DELETE | |
Get node statstransform_get_node_stats | GET | Get per-node information about transform usage. |
Get transform statstransform_get_transform_stats | GET | Get usage information for transforms. |
Get transformstransform_get_transform | GET | Get configuration information for transforms. |
Get transformstransform_get_transform_1 | GET | Get configuration information for transforms. |
Preview a transformtransform_preview_transform | GET | Generates a preview of the results that you will get when you create a transform with the same configuration. |
Preview a transformtransform_preview_transform_1 | POST | Generates a preview of the results that you will get when you create a transform with the same configuration. |
Preview a transformtransform_preview_transform_2 | GET | Generates a preview of the results that you will get when you create a transform with the same configuration. |
Preview a transformtransform_preview_transform_3 | POST | Generates a preview of the results that you will get when you create a transform with the same configuration. |
Reset a transformtransform_reset_transform | POST | Before you can reset it, you must stop it; alternatively, use the force query parameter. |
Schedule a transform to start nowtransform_schedule_now_transform | POST | Instantly run a transform to process data. |
Start a transformtransform_start_transform | POST | When you start a transform, it creates the destination index if it does not already exist. |
Stop transformstransform_stop_transform | POST | Stops one or more transforms. |
Update a transformtransform_update_transform | POST | Updates certain properties of a transform. |