Connectors

Databases & Data Warehouses

OpenSearch

Open source search engine: index, query, and aggregate documents across indices
OpenSearch documentationAPI checked August 16, 2026
Signs in with
Connection fields
Runs on
Cloud or On-Prem Worker
Operations
815
Ready-made triggers
0

Connect OpenSearch

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for OpenSearch and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. 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.
FieldWhat to enter
OpenSearch hostRequiredCluster hostname without a scheme or path.Example: search.example.com
Authorization valueOptionalSecretComplete Authorization value, such as a Bearer token or prebuilt Basic value.Example: Bearer ...
Basic auth usernameOptionalUsername for HTTP Basic authentication.Example: admin
Basic auth passwordOptionalSecretPassword for HTTP Basic authentication.

Use it in a flow

  1. Open a flow, open the node library and search for OpenSearch.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

To start a flow from OpenSearch without a ready-made trigger: a Poll for changes trigger on OpenSearch with your own query passes on new or changed records.

Operations

815 operations in 66 groups. Each one is a step you can add to a flow.

Alia13
Delete aliaindices_delete_alias_0DELETEDeletes an alias.
Get aliaindices_get_alias_1GETReturns an alias.
Get aliaindices_get_alias_3GETReturns an alias.
Inspect aliaindices_exists_alias_0HEADReturns information about whether a particular alias exists.
Inspect aliaindices_exists_alias_1HEADReturns information about whether a particular alias exists.
List aliasindices_get_alias_0GETReturns an alias.
List aliasindices_get_alias_2GETReturns an alias.
Replace aliaindices_put_alias_0PUTCreates or updates an alias.
Replace aliaindices_put_alias_2PUTCreates or updates an alias.
Replace aliaindices_put_alias_5PUTCreates or updates an alias.
Replace aliaindices_put_alias_7PUTCreates or updates an alias.
Update aliaindices_put_alias_1POSTCreates or updates an alias.
Update aliaindices_put_alias_6POSTCreates or updates an alias.
Aliase7
Create aliaseindices_update_aliases_0POSTUpdates index aliases.
Delete aliaseindices_delete_alias_1DELETEDeletes an alias.
Replace aliaseindices_put_alias_10PUTCreates or updates an alias.
Replace aliaseindices_put_alias_4PUTCreates or updates an alias.
Replace aliaseindices_put_alias_8PUTCreates or updates an alias.
Update aliaseindices_put_alias_3POSTCreates or updates an alias.
Update aliaseindices_put_alias_9POSTCreates or updates an alias.
Analyze4
Analyze analyzeindices_analyze_0GETPerforms the analysis process on a text and return the tokens breakdown of the text.
Analyze analyzeindices_analyze_1POSTPerforms the analysis process on a text and return the tokens breakdown of the text.
Analyze analyzeindices_analyze_2GETPerforms the analysis process on a text and return the tokens breakdown of the text.
Analyze analyzeindices_analyze_3POSTPerforms the analysis process on a text and return the tokens breakdown of the text.
Block1
Replace blockindices_add_block_0PUTAdds a block to an index.
Bulk8
Bulk bulkbulk_0POSTAllows to perform multiple index/update/delete operations in a single request.
Bulk bulkbulk_1PUTAllows to perform multiple index/update/delete operations in a single request.
Bulk bulkbulk_2POSTAllows to perform multiple index/update/delete operations in a single request.
Bulk bulkbulk_3PUTAllows to perform multiple index/update/delete operations in a single request.
Stream bulkbulk_stream_0POSTAllows to perform multiple index/update/delete operations using request response streaming.
Stream bulkbulk_stream_1PUTAllows to perform multiple index/update/delete operations using request response streaming.
Stream bulkbulk_stream_2POSTAllows to perform multiple index/update/delete operations using request response streaming.
Stream bulkbulk_stream_3PUTAllows to perform multiple index/update/delete operations using request response streaming.
Cache2
Clear cacheindices_clear_cache_0POSTClears all or specific caches for one or more indexes.
Clear cacheindices_clear_cache_1POSTClears all or specific caches for one or more indexes.
Cat36
All catcat_all_pit_segments_0GETLists all active CAT point-in-time segments.
Allocation catcat_allocation_0GETProvides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
Cat catcat_help_0GETReturns help for the Cat APIs.
Cluster Manager catcat_cluster_manager_0GETReturns information about the cluster-manager node.
Count catcat_count_0GETProvides quick access to the document count of the entire cluster or of an individual index.
Fielddata catcat_fielddata_0GETShows how much heap memory is currently being used by field data on every data node in the cluster.
Get catcat_aliases_1GETShows information about aliases currently configured to indexes, including filter and routing information.
Get catcat_allocation_1GETProvides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
Get catcat_count_1GETProvides quick access to the document count of the entire cluster or of an individual index.
Get catcat_fielddata_1GETShows how much heap memory is currently being used by field data on every data node in the cluster.
Get catcat_indices_1GETLists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
Get catcat_recovery_1GETReturns all completed and ongoing index and shard recoveries.
Get catcat_segment_replication_1GETReturns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.
Get catcat_segments_1GETProvides low-level information about the segments in the shards of an index.
Get catcat_shards_1GETLists the states of all primary and replica shards and how they are distributed.
Get catcat_snapshots_1GETLists all of the snapshots stored in a specific repository.
Get catcat_templates_1GETLists the names, patterns, order numbers, and version numbers of index templates.
Get catcat_thread_pool_1GETReturns cluster-wide thread pool statistics per node.
Health catcat_health_0GETReturns a concise representation of the cluster health.
List catscat_aliases_0GETShows information about aliases currently configured to indexes, including filter and routing information.
List catscat_indices_0GETLists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
List catscat_nodeattrs_0GETReturns information about custom node attributes.
List catscat_nodes_0GETReturns basic statistics about the performance of cluster nodes.
List catscat_pending_tasks_0GETReturns a concise representation of the cluster's pending tasks.
List catscat_pit_segments_0GETLists one or several CAT point-in-time segments.
List catscat_plugins_0GETReturns information about the names, components, and versions of the installed plugins.
List catscat_repositories_0GETReturns information about all snapshot repositories for a cluster.
List catscat_segments_0GETProvides low-level information about the segments in the shards of an index.
List catscat_shards_0GETLists the states of all primary and replica shards and how they are distributed.
List catscat_snapshots_0GETLists all of the snapshots stored in a specific repository.
List catscat_tasks_0GETLists the progress of all tasks currently running on the cluster.
List catscat_templates_0GETLists the names, patterns, order numbers, and version numbers of index templates.
Master catcat_master_0GETReturns information about the cluster-manager node.
Recovery catcat_recovery_0GETReturns all completed and ongoing index and shard recoveries.
Segment Replication catcat_segment_replication_0GETReturns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.
Thread Pool catcat_thread_pool_0GETReturns cluster-wide thread pool statistics per node.
Clone2
Replace cloneindices_clone_1PUTClones an index.
Update cloneindices_clone_0POSTClones an index.
Close1
Close closeindices_close_0POSTCloses an index.
Cluster27
Awareness clustercluster_delete_decommission_awareness_0DELETERecommissions a decommissioned zone.
Create clustercluster_post_voting_config_exclusions_0POSTUpdates the cluster voting configuration by excluding certain node IDs or names.
Delete clustercluster_delete_voting_config_exclusions_0DELETEClears any cluster voting configuration exclusions.
Delete clustercluster_delete_weighted_routing_0DELETEDelete weighted shard routing weights.
Explain clustercluster_allocation_explain_0GETExplains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.
Explain clustercluster_allocation_explain_1POSTExplains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.
Get clustercluster_health_1GETReturns basic information about the health of the cluster.
Get clustercluster_state_1GETReturns comprehensive information about the state of the cluster.
Get clustercluster_state_2GETReturns comprehensive information about the state of the cluster.
Get clustercluster_stats_1GETReturns a high-level overview of cluster statistics.
Get clustercluster_stats_2GETReturns a high-level overview of cluster statistics.
Get clustercluster_stats_3GETReturns a high-level overview of cluster statistics.
Health clustercluster_health_0GETReturns basic information about the health of the cluster.
List clusterscluster_get_settings_0GETReturns cluster settings.
List clusterscluster_get_weighted_routing_0GETFetches weighted shard routing weights.
List clusterscluster_pending_tasks_0GETReturns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.
List clusterscluster_stats_0GETReturns a high-level overview of cluster statistics.
List clustersnodes_hot_threads_0GETReturns information about hot threads on each node in the cluster.
List clustersnodes_hot_threads_0_supersededGETReturns information about hot threads on each node in the cluster.
List clustersnodes_hot_threads_2GETReturns information about hot threads on each node in the cluster.
List clustersnodes_hot_threads_2_supersededGETReturns information about hot threads on each node in the cluster.
Replace clustercluster_put_decommission_awareness_0PUTDecommissions a cluster zone based on awareness.
Replace clustercluster_put_settings_0PUTUpdates the cluster settings.
Replace clustercluster_put_weighted_routing_0PUTUpdates weighted shard routing weights.
Reroute clustercluster_reroute_0POSTAllows to manually change the allocation of individual shards in the cluster.
State clustercluster_state_0GETReturns comprehensive information about the state of the cluster.
Status clustercluster_get_decommission_awareness_0GETRetrieves the decommission status for all zones.
Component Template6
Component Template component templatecluster_get_component_template_0GETReturns one or more component templates.
Delete component templatecluster_delete_component_template_0DELETEDeletes a component template.
Get component templatecluster_get_component_template_1GETReturns one or more component templates.
Inspect component templatecluster_exists_component_template_0HEADReturns information about whether a particular component template exist.
Replace component templatecluster_put_component_template_1PUTCreates or updates a component template.
Update component templatecluster_put_component_template_0POSTCreates or updates a component template.
Count4
Count countcount_0GETReturns number of documents matching a query.
Count countcount_1POSTReturns number of documents matching a query.
Count countcount_2GETReturns number of documents matching a query.
Count countcount_3POSTReturns number of documents matching a query.
Create2
Replace createcreate_1PUTCreates a new document in the index.
Update createcreate_0POSTCreates a new document in the index.
Dangling3
Dangling danglingdangling_indices_list_dangling_indices_0GETReturns all dangling indexes.
Delete danglingdangling_indices_delete_dangling_index_0DELETEDeletes the specified dangling index.
Update danglingdangling_indices_import_dangling_index_0POSTImports the specified dangling index.
Data Stream6
Data Stream data streamindices_get_data_stream_0GETReturns data streams.
Delete data streamindices_delete_data_stream_0DELETEDeletes a data stream.
Get data streamindices_get_data_stream_1GETReturns data streams.
List data streamsindices_data_streams_stats_0GETProvides statistics on operations happening in a data stream.
List data streamsindices_data_streams_stats_1GETProvides statistics on operations happening in a data stream.
Replace data streamindices_create_data_stream_0PUTCreates or updates a data stream.
Delete By Query2
Delete By Query delete by querydelete_by_query_0POSTDeletes documents matching the provided query.
Rethrottle delete by querydelete_by_query_rethrottle_0POSTChanges the number of requests per second for a particular Delete By Query operation.
Doc6
Delete docdelete_0DELETERemoves a document from the index.
Doc docindex_0POSTCreates or updates a document in an index.
Get docget_0GETReturns a document.
Inspect docexists_0HEADReturns information about whether a document exists in an index.
Replace docindex_2PUTCreates or updates a document in an index.
Update docindex_1POSTCreates or updates a document in an index.
Explain2
Get explainexplain_0GETReturns information about why a specific document matches (or doesn't match) a query.
Update explainexplain_1POSTReturns information about why a specific document matches (or doesn't match) a query.
Field Cap4
Create field capfield_caps_1POSTReturns the information about the capabilities of fields among multiple indexes.
Create field capfield_caps_3POSTReturns the information about the capabilities of fields among multiple indexes.
List field capsfield_caps_0GETReturns the information about the capabilities of fields among multiple indexes.
List field capsfield_caps_2GETReturns the information about the capabilities of fields among multiple indexes.
Flush4
Flush flushindices_flush_0GETPerforms the flush operation on one or more indexes.
Flush flushindices_flush_1POSTPerforms the flush operation on one or more indexes.
Flush flushindices_flush_2GETPerforms the flush operation on one or more indexes.
Flush flushindices_flush_3POSTPerforms the flush operation on one or more indexes.
Forcemerge2
Forcemerge forcemergeindices_forcemerge_0POSTPerforms the force merge operation on one or more indexes.
Forcemerge forcemergeindices_forcemerge_1POSTPerforms the force merge operation on one or more indexes.
Index Template9
Delete index templateindices_delete_index_template_0DELETEDeletes an index template.
Get index templateindices_get_index_template_1GETReturns an index template.
Index Template index templateindices_get_index_template_0GETReturns an index template.
Inspect index templateindices_exists_index_template_0HEADReturns information about whether a particular index template exists.
Replace index templateindices_put_index_template_1PUTCreates or updates an index template.
Simulate index templateindices_simulate_template_0POSTSimulate resolving the given template name or body.
Update index templateindices_put_index_template_0POSTCreates or updates an index template.
Update index templateindices_simulate_index_template_0POSTSimulate matching the given index name against the index templates in the system.
Update index templateindices_simulate_template_1POSTSimulate resolving the given template name or body.
Ingest9
Delete ingestingest_delete_pipeline_0DELETEDeletes an ingest pipeline.
Get ingestingest_get_pipeline_1GETReturns an ingest pipeline.
Grok ingestingest_processor_grok_0GETReturns a list of built-in grok patterns.
Pipeline ingestingest_get_pipeline_0GETReturns an ingest pipeline.
Replace ingestingest_put_pipeline_0PUTCreates or updates an ingest pipeline.
Simulate ingestingest_simulate_0GETSimulates an ingest pipeline with example documents.
Simulate ingestingest_simulate_1POSTSimulates an ingest pipeline with example documents.
Simulate ingestingest_simulate_2GETSimulates an ingest pipeline with example documents.
Simulate ingestingest_simulate_3POSTSimulates an ingest pipeline with example documents.
Ingestion3
Pause ingestioningestion_pause_0POSTUse this API to pause ingestion for a given index.
Resume ingestioningestion_resume_0POSTUse this API to resume ingestion for the given index.
State ingestioningestion_get_state_0GETUse this API to retrieve the ingestion state for a given index.
Insight1
List insightsinsights_top_queries_0GETRetrieves the top queries based on the given metric type (latency, CPU, or memory).
List5
Get listlist_indices_1GETReturns paginated information about indexes including number of primaries and replicas, document counts, disk size.
Get listlist_shards_1GETReturns paginated details of shard allocation on nodes.
List listlist_help_0GETReturns help for the List APIs.
List listslist_indices_0GETReturns paginated information about indexes including number of primaries and replicas, document counts, disk size.
List listslist_shards_0GETReturns paginated details of shard allocation on nodes.
Ltr43
Clearcache ltrltr_clear_cache_0POSTClears the store caches.
Clearcache ltrltr_clear_cache_1POSTClears the store caches.
Create ltrltr_add_features_to_set_0POSTAdd features to an existing feature set in the default feature store.
Create ltrltr_add_features_to_set_2POSTAdd features to an existing feature set in the default feature store.
Createmodel ltrltr_create_model_from_set_0POSTCreate a model from an existing feature set in the default feature store.
Createmodel ltrltr_create_model_from_set_1POSTCreate a model from an existing feature set in the default feature store.
Delete ltrltr_delete_feature_0DELETEDelete a feature from the default feature store.
Delete ltrltr_delete_feature_1DELETEDelete a feature from the default feature store.
Delete ltrltr_delete_featureset_0DELETEDelete a feature set from the default feature store.
Delete ltrltr_delete_featureset_1DELETEDelete a feature set from the default feature store.
Delete ltrltr_delete_model_0DELETEDelete a model from the default feature store.
Delete ltrltr_delete_model_1DELETEDelete a model from the default feature store.
Delete ltrltr_delete_store_0DELETEDeletes a feature store with the specified name.
Feature ltrltr_search_features_0GETSearch for features in a feature store.
Feature ltrltr_search_features_1GETSearch for features in a feature store.
Featureset ltrltr_search_featuresets_0GETSearch for feature sets in a feature store.
Featureset ltrltr_search_featuresets_1GETSearch for feature sets in a feature store.
Get ltrltr_get_feature_0GETGet a feature from the default feature store.
Get ltrltr_get_feature_1GETGet a feature from the default feature store.
Get ltrltr_get_featureset_0GETGet a feature set from the default feature store.
Get ltrltr_get_featureset_1GETGet a feature set from the default feature store.
Get ltrltr_get_model_0GETGet a model from the default feature store.
Get ltrltr_get_model_1GETGet a model from the default feature store.
Get ltrltr_get_store_0GETChecks if a store exists.
List ltrsltr_cache_stats_0GETRetrieves cache statistics for all feature stores.
Ltr ltrltr_create_default_store_0PUTCreates the default feature store.
Ltr ltrltr_delete_default_store_0DELETEDeletes the default feature store.
Ltr ltrltr_list_stores_0GETLists all available feature stores.
Model ltrltr_search_models_0GETSearch for models in a feature store.
Model ltrltr_search_models_1GETSearch for models in a feature store.
Replace ltrltr_create_feature_0PUTCreate or update a feature in the default feature store.
Replace ltrltr_create_feature_1PUTCreate or update a feature in the default feature store.
Replace ltrltr_create_featureset_0PUTCreate or update a feature set in the default feature store.
Replace ltrltr_create_featureset_1PUTCreate or update a feature set in the default feature store.
Replace ltrltr_create_model_0PUTCreate or update a model in the default feature store.
Replace ltrltr_create_model_1PUTCreate or update a model in the default feature store.
Replace ltrltr_create_store_0PUTCreates a new feature store with the specified name.
Update ltrltr_add_features_to_set_by_query_0POSTAdd features to an existing feature set in the default feature store.
Update ltrltr_add_features_to_set_by_query_1POSTAdd features to an existing feature set in the default feature store.
Update ltrltr_update_feature_0POSTUpdate a feature in the default feature store.
Update ltrltr_update_feature_1POSTUpdate a feature in the default feature store.
Update ltrltr_update_featureset_0POSTUpdate a feature set in the default feature store.
Update ltrltr_update_featureset_1POSTUpdate a feature set in the default feature store.
Mapping6
Get mappingindices_get_field_mapping_0GETReturns mapping for one or more fields.
Get mappingindices_get_field_mapping_1GETReturns mapping for one or more fields.
Mapping mappingindices_get_mapping_0GETReturns mappings for one or more indexes.
Mapping mappingindices_get_mapping_1GETReturns mappings for one or more indexes.
Mapping mappingindices_put_mapping_0POSTUpdates the index mappings.
Mapping mappingindices_put_mapping_1PUTUpdates the index mappings.
Mget4
Mget mgetmget_0GETAllows to get multiple documents in one request.
Mget mgetmget_1POSTAllows to get multiple documents in one request.
Mget mgetmget_2GETAllows to get multiple documents in one request.
Mget mgetmget_3POSTAllows to get multiple documents in one request.
Msearch8
Msearch msearchmsearch_0GETAllows to execute several search operations in one request.
Msearch msearchmsearch_1POSTAllows to execute several search operations in one request.
Msearch msearchmsearch_2GETAllows to execute several search operations in one request.
Msearch msearchmsearch_3POSTAllows to execute several search operations in one request.
Template msearchmsearch_template_0GETAllows to execute several search template operations in one request.
Template msearchmsearch_template_1POSTAllows to execute several search template operations in one request.
Template msearchmsearch_template_2GETAllows to execute several search template operations in one request.
Template msearchmsearch_template_3POSTAllows to execute several search template operations in one request.
Mtermvector4
Create mtermvectormtermvectors_1POSTReturns multiple termvectors in one request.
Create mtermvectormtermvectors_3POSTReturns multiple termvectors in one request.
List mtermvectorsmtermvectors_0GETReturns multiple termvectors in one request.
List mtermvectorsmtermvectors_2GETReturns multiple termvectors in one request.
Node19
Create nodenodes_reload_secure_settings_0POSTReloads secure settings.
Create nodenodes_reload_secure_settings_1POSTReloads secure settings.
Get nodenodes_info_1GETReturns information about nodes in the cluster.
Get nodenodes_info_3GETReturns information about nodes in the cluster.
Get nodenodes_stats_1GETReturns statistical information about nodes in the cluster.
Get nodenodes_stats_2GETReturns statistical information about nodes in the cluster.
Get nodenodes_stats_4GETReturns statistical information about nodes in the cluster.
Get nodenodes_stats_5GETReturns statistical information about nodes in the cluster.
Get nodenodes_usage_1GETReturns low-level information about REST actions usage on nodes.
Get nodenodes_usage_3GETReturns low-level information about REST actions usage on nodes.
List nodesnodes_hot_threads_4GETReturns information about hot threads on each node in the cluster.
List nodesnodes_hot_threads_4_supersededGETReturns information about hot threads on each node in the cluster.
List nodesnodes_hot_threads_6GETReturns information about hot threads on each node in the cluster.
List nodesnodes_hot_threads_6_supersededGETReturns information about hot threads on each node in the cluster.
List nodesnodes_info_0GETReturns information about nodes in the cluster.
List nodesnodes_stats_0GETReturns statistical information about nodes in the cluster.
List nodesnodes_stats_3GETReturns statistical information about nodes in the cluster.
Usage nodenodes_usage_0GETReturns low-level information about REST actions usage on nodes.
Usage nodenodes_usage_2GETReturns low-level information about REST actions usage on nodes.
Open1
Open openindices_open_0POSTOpens an index.
Opendistro105
Account opendistrosecurity_change_password_0_supersededPUTChanges the password for the current user.
Account opendistrosecurity_get_account_details_0_supersededGETReturns account information for the current user.
Add opendistroism_add_policy_0_supersededPOSTAdds a policy to an index.
Allowlist opendistrosecurity_create_allowlist_0_supersededPUTCreates or replaces APIs permitted for users on the allow list.
Allowlist opendistrosecurity_get_allowlist_0_supersededGETRetrieves the current list of allowed APIs accessible to a normal user.
Allowlist opendistrosecurity_patch_allowlist_0_supersededPATCHUpdates the current list of APIs accessible for users on the allow list.
Asynchronous Search opendistroasynchronous_search_search_0_supersededPOSTPerforms an asynchronous search.
Authinfo opendistrosecurity_authinfo_0_supersededGETReturns or updates authentication information for the currently authenticated user.
Authinfo opendistrosecurity_authinfo_1_supersededPOSTReturns or updates authentication information for the currently authenticated user.
Authtoken opendistrosecurity_authtoken_0_supersededPOSTReturns the authorization token for the current user.
Authtoken opendistrosecurity_generate_user_token_0_supersededPOSTGenerates an authorization token for the specified user.
Authtoken opendistrosecurity_generate_user_token_legacy_0_supersededPOSTGenerates authorization token for the given user.
Cache opendistrosecurity_cache_1_supersededGETNot supported for the Cache API.
Cache opendistrosecurity_cache_2_supersededPOSTNot supported for the Cache API.
Cache opendistrosecurity_cache_3_supersededPUTNot supported for the Cache API.
Cache opendistrosecurity_flush_cache_0_supersededDELETEFlushes the Security plugin's user, authentication, and authorization cache.
Change Policy opendistroism_change_policy_0_supersededPOSTUpdates the managed index policy to a new policy.
Close opendistrosql_close_0_supersededPOSTCloses an open cursor to free server-side resources.
Config opendistrosecurity_create_update_tenancy_config_0_supersededPUTCreates or replaces the multi-tenancy configuration.
Config opendistrosecurity_get_tenancy_config_0_supersededGETRetrieves the multi-tenancy configuration.
Config opendistrosecurity_update_audit_configuration_0_supersededPUTUpdates the audit configuration.
Config opendistrosecurity_update_configuration_0_supersededPUTUpdates the settings for an existing security configuration.
Create opendistroppl_post_stats_1_supersededPOSTRetrieves filtered performance metrics for the PPL plugin.
Create opendistrosql_post_stats_1_supersededPOSTRetrieves filtered performance metrics for the SQL plugin.
Delete opendistroasynchronous_search_delete_0_supersededDELETEDeletes any responses from an asynchronous search.
Delete opendistroism_delete_policy_0_supersededDELETEDeletes a policy.
Delete opendistrorollups_delete_0_supersededDELETEDeletes an index rollup job configuration.
Delete opendistrosecurity_delete_action_group_0_supersededDELETEDeletes the specified action group.
Delete opendistrosecurity_delete_distinguished_name_0_supersededDELETEDeletes all distinguished names in the specified cluster or node allowlist.
Delete opendistrosecurity_delete_role_0_supersededDELETEDeletes the specified role.
Delete opendistrosecurity_delete_role_mapping_0_supersededDELETEDeletes the specified role mapping.
Delete opendistrosecurity_delete_tenant_0_supersededDELETEDeletes the specified tenant.
Delete opendistrosecurity_delete_user_0_supersededDELETEDeletes the specified internal user.
Delete opendistrosecurity_delete_user_legacy_0_supersededDELETEDelete the specified user.
Explain opendistroism_explain_policy_0_supersededGETRetrieves the currently applied policy on the specified indexes.
Explain opendistroism_explain_policy_1_supersededPOSTRetrieves the currently applied policy on the specified indexes.
Explain opendistroppl_explain_0_supersededPOSTReturns the execution plan for a PPL query.
Explain opendistrorollups_explain_0_supersededGETRetrieves the execution status information for an index rollup job.
Explain opendistrosql_explain_0_supersededPOSTReturns the execution plan for a SQL or PPL query.
Get opendistroasynchronous_search_get_0_supersededGETGets partial responses from an asynchronous search.
Get opendistroism_explain_policy_3_supersededGETRetrieves the currently applied policy on the specified indexes.
Get opendistroism_get_policy_0_supersededGETRetrieves a specific policy.
Get opendistroknn_stats_1_supersededGETProvides information about the current status of the k-NN plugin.
Get opendistroknn_stats_3_supersededGETProvides information about the current status of the k-NN plugin.
Get opendistroknn_warmup_0_supersededGETPreloads native library files into memory, reducing initial search latency for specified indexes.
Get opendistrorollups_get_0_supersededGETRetrieves an index rollup job configuration by ID.
Get opendistrosecurity_get_action_group_0_supersededGETRetrieves one action group.
Get opendistrosecurity_get_distinguished_name_0_supersededGETRetrieves all node distinguished names.
Get opendistrosecurity_get_role_0_supersededGETRetrieves one role.
Get opendistrosecurity_get_role_mapping_0_supersededGETRetrieves the specified role mapping.
Get opendistrosecurity_get_tenant_0_supersededGETRetrieves the specified tenant.
Get opendistrosecurity_get_user_0_supersededGETRetrieve information about the specified internal user.
Get opendistrosecurity_get_user_legacy_0_supersededGETRetrieve one user.
Health opendistrosecurity_health_0_supersededGETChecks to see if the Security plugin is running.
Health opendistrosecurity_health_1_supersededPOSTChecks to see if the Security plugin is running.
Inspect opendistroism_exists_policy_0_supersededHEADChecks for the existence of a policy.
Kibanainfo opendistrosecurity_get_dashboards_info_0_supersededGETRetrieves the current values for dynamic security settings for OpenSearch Dashboards.
Kibanainfo opendistrosecurity_post_dashboards_info_1_supersededPOSTRetrieves the current values for dynamic security settings for OpenSearch Dashboards.
List opendistrosasynchronous_search_stats_0_supersededGETMonitors any asynchronous searches that are running, completed, or persisted.
List opendistrosism_get_policies_0_supersededGETRetrieves the policies.
List opendistrosppl_get_stats_0_supersededGETRetrieves performance metrics for the PPL plugin.
List opendistrossecurity_get_certificates_0_supersededGETRetrieves the cluster security certificates.
List opendistrossecurity_get_tenants_0_supersededGETRetrieves all tenants.
List opendistrossql_get_stats_0_supersededGETRetrieves performance metrics for the SQL plugin.
Migrate opendistrosecurity_migrate_0_supersededPOSTMigrates the security configuration from v6 to v7.
Permissionsinfo opendistrosecurity_get_permissions_info_0_supersededGETRetrieves the evaluated REST API permissions for the currently logged in user.
Ppl opendistroppl_query_0_supersededPOSTExecutes a PPL query against OpenSearch indexes.
Remove opendistroism_remove_policy_0_supersededPOSTRemoves a policy from an index.
Replace opendistroism_put_policies_0_supersededPUTCreates or updates policies.
Replace opendistroism_put_policy_0_supersededPUTCreates or updates a policy.
Replace opendistrorollups_put_0_supersededPUTCreates or updates an index rollup job configuration.
Replace opendistrosecurity_create_action_group_0_supersededPUTCreates or replaces the specified action group.
Replace opendistrosecurity_create_role_0_supersededPUTCreates or replaces the specified role.
Replace opendistrosecurity_create_role_mapping_0_supersededPUTCreates or replaces the specified role mapping.
Replace opendistrosecurity_create_tenant_0_supersededPUTCreates or replaces the specified tenant.
Replace opendistrosecurity_create_user_0_supersededPUTCreates or replaces the specified user.
Replace opendistrosecurity_create_user_legacy_0_supersededPUTCreates or replaces the specified user.
Replace opendistrosecurity_reload_http_certificates_0_supersededPUTReloads the HTTP communication certificates.
Replace opendistrosecurity_reload_transport_certificates_0_supersededPUTReloads the transport communication certificates.
Replace opendistrosecurity_update_distinguished_name_0_supersededPUTAdds or updates the specified distinguished names in the cluster or node allowlist.
Replace opendistrosql_settings_0_supersededPUTUpdates SQL plugin settings in the OpenSearch cluster configuration.
Retry opendistroism_retry_index_0_supersededPOSTRetries the failed action for an index.
Securityconfig opendistrosecurity_get_configuration_0_supersededGETReturns the current Security plugin configuration in a JSON format.
Securityconfig opendistrosecurity_patch_configuration_0_supersededPATCHUpdates the existing security configuration using the REST API.
Sql opendistrosql_query_0_supersededPOSTExecutes SQL or PPL queries against OpenSearch indexes.
Sslinfo opendistrosecurity_get_sslinfo_0GETRetrieves information about the SSL configuration.
Start opendistrorollups_start_0_supersededPOSTStarts the execution of an index rollup job.
Stop opendistrorollups_stop_0_supersededPOSTStops the execution of an index rollup job.
Tenantinfo opendistrosecurity_tenant_info_0_supersededGETRetrieves the names of current tenants.
Tenantinfo opendistrosecurity_tenant_info_1_supersededPOSTRetrieves the names of current tenants.
Update opendistroism_add_policy_1_supersededPOSTAdds a policy to an index.
Update opendistroism_change_policy_1_supersededPOSTUpdates the managed index policy to a new policy.
Update opendistroism_explain_policy_4_supersededPOSTRetrieves the currently applied policy on the specified indexes.
Update opendistroism_refresh_search_analyzers_0_supersededPOSTRefreshes search analyzers in real time.
Update opendistroism_remove_policy_1_supersededPOSTRemoves a policy from an index.
Update opendistroism_retry_index_1_supersededPOSTRetries the failed action for an index.
Update opendistrosecurity_patch_action_group_0_supersededPATCHUpdates the individual attributes of an action group.
Update opendistrosecurity_patch_distinguished_name_0_supersededPATCHUpdates the distinguished cluster name for the specified cluster.
Update opendistrosecurity_patch_role_0_supersededPATCHUpdates the individual attributes of a role.
Update opendistrosecurity_patch_role_mapping_0_supersededPATCHUpdates the individual attributes of a role mapping.
Update opendistrosecurity_patch_tenant_0_supersededPATCHAdds, deletes, or modifies a single tenant.
Update opendistrosecurity_patch_tenants_0_supersededPATCHAdds, deletes, or modifies multiple tenants in a single request.
Update opendistrosecurity_patch_user_0_supersededPATCHUpdates individual attributes for an internal user.
User opendistrosecurity_get_users_legacy_0_supersededGETRetrieve all internal users.
Validate opendistrosecurity_validate_0_supersededGETChecks whether the v6 security configuration is valid and ready to be migrated to v7.
Plugin327
Account pluginsecurity_change_password_0PUTChanges the password for the current user.
Account pluginsecurity_get_account_details_0GETReturns account information for the current user.
Add pluginism_add_policy_0POSTAdds a policy to an index.
Allowlist pluginsecurity_create_allowlist_0PUTCreates or replaces APIs permitted for users on the allow list.
Allowlist pluginsecurity_get_allowlist_0GETRetrieves the current list of allowed APIs accessible to a normal user.
Allowlist pluginsecurity_patch_allowlist_0PATCHUpdates the current list of APIs accessible for users on the allow list.
Asynchronous Search pluginasynchronous_search_search_0POSTPerforms an asynchronous search.
Audit pluginsecurity_get_audit_configuration_0GETRetrieves the audit configuration.
Audit pluginsecurity_patch_audit_configuration_0PATCHUpdates the specified fields in the audit configuration.
Authinfo pluginsecurity_authinfo_0GETReturns or updates authentication information for the currently authenticated user.
Authinfo pluginsecurity_authinfo_1POSTReturns or updates authentication information for the currently authenticated user.
Authtoken pluginsecurity_authtoken_0POSTReturns the authorization token for the current user.
Authtoken pluginsecurity_generate_user_token_0POSTGenerates an authorization token for the specified user.
Authtoken pluginsecurity_generate_user_token_legacy_0POSTGenerates authorization token for the given user.
Autofollow pluginreplication_create_replication_rule_0POSTAutomatically starts the replication on indexes matching a specified pattern.
Autofollow pluginreplication_delete_replication_rule_0DELETEDeletes the specified replication rule.
Cache pluginsecurity_cache_1GETNot supported for the Cache API.
Cache pluginsecurity_cache_2POSTNot supported for the Cache API.
Cache pluginsecurity_cache_3PUTNot supported for the Cache API.
Cache pluginsecurity_flush_cache_0DELETEFlushes the Security plugin's user, authentication, and authorization cache.
Change Policy pluginism_change_policy_0POSTUpdates the managed index policy to a new policy.
Close pluginsql_close_0POSTCloses an open cursor to free server-side resources.
Config pluginsecurity_create_update_tenancy_config_0PUTCreates or replaces the multi-tenancy configuration.
Config pluginsecurity_get_tenancy_config_0GETRetrieves the multi-tenancy configuration.
Config pluginsecurity_update_audit_configuration_0PUTUpdates the audit configuration.
Config pluginsecurity_update_configuration_0PUTUpdates the settings for an existing security configuration.
Correlate pluginsecurity_analytics_search_finding_correlations_0GETList correlations for a finding.
Create pluginml_add_agentic_memory_0POSTAdd agentic memory to a memory container.
Create pluginml_create_connector_0POSTCreates a standalone connector.
Create pluginml_create_memory_container_0POSTCreate a memory container.
Create pluginml_create_memory_container_session_0POSTCreate session in a memory container.
Create pluginml_create_message_0POSTCreate a message.
Create pluginnotifications_create_config_0POSTCreate channel configuration.
Create pluginppl_post_stats_1POSTRetrieves filtered performance metrics for the PPL plugin.
Create pluginquery_datasources_create_0POSTCreates a new query data source.
Create pluginsearch_relevance_post_query_sets_0POSTCreates a new query set by sampling queries from the user behavior data.
Create pluginsql_post_stats_1POSTRetrieves filtered performance metrics for the SQL plugin.
Dashboardsinfo pluginsecurity_get_dashboards_info_0GETRetrieves the current values for dynamic security settings for OpenSearch Dashboards.
Dashboardsinfo pluginsecurity_post_dashboards_info_1POSTRetrieves the current values for dynamic security settings for OpenSearch Dashboards.
Datasource plugingeospatial_get_ip2geo_datasource_0GETGet one or more IP2Geo data sources, defaulting to returning all if no names specified.
Delete By Query pluginml_delete_agentic_memory_query_0POSTDelete multiple memories using a query to match specific criteria.
Delete pluginasynchronous_search_delete_0DELETEDeletes any responses from an asynchronous search.
Delete pluginflow_framework_delete_0DELETEDeletes a workflow template.
Delete plugingeospatial_delete_ip2geo_datasource_0DELETEDelete a specific IP2Geo data source.
Delete pluginism_delete_policy_0DELETEDeletes a policy.
Delete pluginknn_delete_model_0DELETEUsed to delete a particular model in the cluster.
Delete pluginml_delete_agent_0DELETEDelete an agent.
Delete pluginml_delete_agentic_memory_0DELETEDelete a specific memory by its type and ID.
Delete pluginml_delete_connector_0DELETEDeletes a standalone connector.
Delete pluginml_delete_controller_0DELETEDeletes a controller.
Delete pluginml_delete_memory_0DELETEDelete a memory.
Delete pluginml_delete_memory_container_0DELETEDelete a memory container.
Delete pluginml_delete_model_0DELETEDeletes a model.
Delete pluginml_delete_model_group_0DELETEDeletes a model group.
Delete pluginml_delete_task_0DELETEDeletes a task.
Delete pluginnotifications_delete_config_0DELETEDelete a channel configuration.
Delete pluginnotifications_delete_configs_0DELETEDelete multiple channel configurations.
Delete pluginobservability_delete_object_0DELETEDeletes specific observability object specified by ID.
Delete pluginquery_datasource_delete_0DELETEDeletes a specific data source by name.
Delete pluginrollups_delete_0DELETEDeletes an index rollup job configuration.
Delete pluginsearch_relevance_delete_experiments_0DELETEDeletes a specified experiment.
Delete pluginsearch_relevance_delete_judgments_0DELETEDeletes a specified judgment.
Delete pluginsearch_relevance_delete_query_sets_0DELETEDeletes a query set.
Delete pluginsearch_relevance_delete_scheduled_experiments_0DELETEDeletes a specified scheduled experiment.
Delete pluginsearch_relevance_delete_search_configurations_0DELETEDeletes a specified search configuration.
Delete pluginsecurity_delete_action_group_0DELETEDeletes the specified action group.
Delete pluginsecurity_delete_distinguished_name_0DELETEDeletes all distinguished names in the specified cluster or node allowlist.
Delete pluginsecurity_delete_role_0DELETEDeletes the specified role.
Delete pluginsecurity_delete_role_mapping_0DELETEDeletes the specified role mapping.
Delete pluginsecurity_delete_tenant_0DELETEDeletes the specified tenant.
Delete pluginsecurity_delete_user_0DELETEDeletes the specified internal user.
Delete pluginsecurity_delete_user_legacy_0DELETEDelete the specified user.
Delete pluginsm_delete_policy_0DELETEDeletes a snapshot management policy.
Delete plugintransforms_delete_0DELETEDelete an index transform.
Deploy pluginml_deploy_model_0POSTDeploys a model.
Deprovision pluginflow_framework_deprovision_0POSTDeprovision workflow's resources when you no longer need them.
Execute pluginml_execute_agent_0POSTExecute an agent.
Explain pluginism_explain_policy_0GETRetrieves the currently applied policy on the specified indexes.
Explain pluginism_explain_policy_1POSTRetrieves the currently applied policy on the specified indexes.
Explain pluginppl_explain_0POSTReturns the execution plan for a PPL query.
Explain pluginrollups_explain_0GETRetrieves the execution status information for an index rollup job.
Explain pluginsm_explain_policy_0GETExplains the state of the snapshot management policy.
Explain pluginsql_explain_0POSTReturns the execution plan for a SQL or PPL query.
Explain plugintransforms_explain_0GETReturns the status and metadata of a transform job.
Generateonbehalfoftoken pluginsecurity_generate_obo_token_0POSTGenerates a On-Behalf-Of token for the current user.
Get pluginasynchronous_search_get_0GETGets partial responses from an asynchronous search.
Get pluginflow_framework_get_0GETRetrieves a workflow template.
Get plugingeospatial_get_ip2geo_datasource_1GETGet one or more IP2Geo data sources, defaulting to returning all if no names specified.
Get pluginism_explain_policy_3GETRetrieves the currently applied policy on the specified indexes.
Get pluginism_get_policy_0GETRetrieves a specific policy.
Get pluginknn_get_model_0GETUsed to retrieve information about models present in the cluster.
Get pluginknn_stats_1GETProvides information about the current status of the k-NN plugin.
Get pluginknn_stats_3GETProvides information about the current status of the k-NN plugin.
Get pluginknn_warmup_0GETPreloads native library files into memory, reducing initial search latency for specified indexes.
Get pluginltr_stats_1GETProvides information about the current status of the LTR plugin.
Get pluginltr_stats_3GETProvides information about the current status of the LTR plugin.
Get pluginml_get_agent_0GETGet an agent.
Get pluginml_get_agentic_memory_0GETGet a specific memory by its type and ID.
Get pluginml_get_connector_0GETRetrieves a standalone connector.
Get pluginml_get_controller_0GETRetrieves a controller.
Get pluginml_get_memory_0GETGet a memory.
Get pluginml_get_memory_container_0GETGet a memory container.
Get pluginml_get_message_0GETGet a message.
Get pluginml_get_model_0GETRetrieves a model.
Get pluginml_get_model_group_0GETRetrieves a model group.
Get pluginml_get_profile_models_1GETGet a profile models.
Get pluginml_get_profile_tasks_1GETGet a profile tasks.
Get pluginml_get_stats_1GETGet stats.
Get pluginml_get_stats_3GETGet stats.
Get pluginml_get_task_0GETRetrieves a task.
Get pluginml_get_tool_0GETGet tools.
Get pluginneural_stats_1GETProvides information about the current status of the neural-search plugin.
Get pluginneural_stats_3GETProvides information about the current status of the neural-search plugin.
Get pluginnotifications_get_config_0GETGet a specific channel configuration.
Get pluginnotifications_send_test_0GETSend a test notification.
Get pluginobservability_get_object_0GETRetrieves specific observability object specified by ID.
Get pluginquery_datasource_retrieve_0GETRetrieves a specific data source by name.
Get pluginrollups_get_0GETRetrieves an index rollup job configuration by ID.
Get pluginsearch_relevance_get_experiments_1GETGets experiments.
Get pluginsearch_relevance_get_judgments_1GETGets judgments.
Get pluginsearch_relevance_get_node_stats_1GETGets stats by node.
Get pluginsearch_relevance_get_query_sets_1GETLists the current query sets available.
Get pluginsearch_relevance_get_scheduled_experiments_1GETGets the scheduled experiments.
Get pluginsearch_relevance_get_search_configurations_1GETGets the search configurations.
Get pluginsearch_relevance_get_stats_1GETGets stats.
Get pluginsecurity_get_action_group_0GETRetrieves one action group.
Get pluginsecurity_get_distinguished_name_0GETRetrieves all node distinguished names.
Get pluginsecurity_get_node_certificates_0GETRetrieves the specified node's security certificates.
Get pluginsecurity_get_role_0GETRetrieves one role.
Get pluginsecurity_get_role_mapping_0GETRetrieves the specified role mapping.
Get pluginsecurity_get_tenant_0GETRetrieves the specified tenant.
Get pluginsecurity_get_user_0GETRetrieve information about the specified internal user.
Get pluginsecurity_get_user_legacy_0GETRetrieve one user.
Get pluginsm_get_policy_0GETRetrieves a specific snapshot management policy by name.
Get plugintransforms_get_0GETReturns the status and metadata of a transform job.
Health pluginsecurity_health_0GETChecks to see if the Security plugin is running.
Health pluginsecurity_health_1POSTChecks to see if the Security plugin is running.
Initialize pluginubi_initialize_0POSTInitializes the UBI indexes.
Inspect pluginism_exists_policy_0HEADChecks for the existence of a policy.
List pluginsasynchronous_search_stats_0GETMonitors any asynchronous searches that are running, completed, or persisted.
List pluginsflow_framework_get_steps_0GETRetrieves available workflow steps.
List pluginsgeospatial_get_upload_stats_0GETRetrieves statistics for all geospatial uploads.
List pluginsism_get_policies_0GETRetrieves the policies.
List pluginsknn_stats_0GETProvides information about the current status of the k-NN plugin.
List pluginsknn_stats_2GETProvides information about the current status of the k-NN plugin.
List pluginsltr_stats_0GETProvides information about the current status of the LTR plugin.
List pluginsltr_stats_2GETProvides information about the current status of the LTR plugin.
List pluginsml_get_all_messages_0GETGet all messages in a memory.
List pluginsml_get_all_tools_0GETGet tools.
List pluginsml_get_message_traces_0GETGet a message traces.
List pluginsml_get_profile_models_0GETGet a profile models.
List pluginsml_get_profile_tasks_0GETGet a profile tasks.
List pluginsml_get_stats_0GETGet stats.
List pluginsml_get_stats_2GETGet stats.
List pluginsneural_stats_0GETProvides information about the current status of the neural-search plugin.
List pluginsneural_stats_2GETProvides information about the current status of the neural-search plugin.
List pluginsnotifications_get_configs_0GETGet multiple channel configurations with filtering.
List pluginsnotifications_list_channels_0GETList created notification channels.
List pluginsnotifications_list_features_0GETList supported channel configurations.
List pluginsobservability_get_localstats_0GETRetrieves local stats of all observability objects.
List pluginsppl_get_stats_0GETRetrieves performance metrics for the PPL plugin.
List pluginsquery_datasources_list_0GETRetrieves a list of all available data sources.
List pluginsreplication_autofollow_stats_0GETRetrieves information about any auto-follow activity and any replication rules configured on the specified cluster.
List pluginsreplication_follower_stats_0GETRetrieves information about any follower (syncing) indexes on a specified cluster.
List pluginsreplication_leader_stats_0GETRetrieves information about any replicated leader indexes on a specified cluster.
List pluginssearch_relevance_get_experiments_0GETGets experiments.
List pluginssearch_relevance_get_judgments_0GETGets judgments.
List pluginssearch_relevance_get_node_stats_0GETGets stats by node.
List pluginssearch_relevance_get_query_sets_0GETLists the current query sets available.
List pluginssearch_relevance_get_search_configurations_0GETGets the search configurations.
List pluginssearch_relevance_get_stats_0GETGets stats.
List pluginssecurity_analytics_get_alerts_0GETRetrieve alerts related to a specific detector type or detector ID.
List pluginssecurity_get_action_groups_0GETRetrieves all action groups.
List pluginssecurity_get_all_certificates_0GETRetrieves the cluster security certificates.
List pluginssecurity_get_certificates_0GETRetrieves the cluster security certificates.
List pluginssecurity_get_roles_0GETRetrieves all roles.
List pluginssecurity_get_tenants_0GETRetrieves all tenants.
List pluginssecurity_get_users_0GETRetrieve all internal users.
List pluginssm_get_policies_0GETRetrieves all snapshot management policies with optional pagination and filtering.
List pluginssql_get_stats_0GETRetrieves performance metrics for the SQL plugin.
Load pluginml_load_model_0POSTDeploys a model.
Memory pluginml_create_memory_0POSTCreate a memory.
Memory pluginml_get_all_memories_0GETGet all memories.
Meta pluginml_create_model_meta_0POSTRegisters model metadata.
Migrate pluginsecurity_migrate_0POSTMigrates the security configuration from v6 to v7.
Nodesdn pluginsecurity_get_distinguished_names_0GETRetrieves all node distinguished names.
Nodesdn pluginsecurity_patch_distinguished_names_0PATCHBulk updates specified node distinguished names.
Object pluginobservability_create_object_0POSTCreates a new observability object.
Object pluginobservability_delete_objects_0DELETEDeletes specific observability objects specified by ID or a list of IDs.
Object pluginobservability_list_objects_0GETRetrieves list of all observability objects.
Pause pluginreplication_pause_0POSTPauses the replication of the leader index.
Permissionsinfo pluginsecurity_get_permissions_info_0GETRetrieves the evaluated REST API permissions for the currently logged in user.
Ppl pluginppl_query_0POSTExecutes a PPL query against OpenSearch indexes.
Predict pluginml_predict_model_0POSTPredicts a model.
Preview plugintransforms_preview_0POSTReturns a preview of what a transformed index would look like.
Profile pluginml_get_profile_0GETGet a profile.
Provision pluginflow_framework_provision_0POSTProvisioning a workflow.
Register Meta pluginml_register_model_meta_0POSTRegisters model metadata.
Register pluginml_register_agents_0POSTRegister an agent.
Register pluginml_register_model_0POSTRegisters a model.
Register pluginml_register_model_group_0POSTRegisters a model group.
Remove pluginism_remove_policy_0POSTRemoves a policy from an index.
Replace pluginflow_framework_update_0PUTUpdates a workflow template that has not been provisioned.
Replace plugingeospatial_put_ip2geo_datasource_0PUTCreate a specific IP2Geo data source.
Replace plugingeospatial_put_ip2geo_datasource_settings_0PUTUpdate a specific IP2Geo data source.
Replace pluginism_put_policies_0PUTCreates or updates policies.
Replace pluginism_put_policy_0PUTCreates or updates a policy.
Replace pluginml_update_agentic_memory_0PUTUpdate a specific memory by its type and ID.
Replace pluginml_update_connector_0PUTUpdates a standalone connector.
Replace pluginml_update_controller_0PUTUpdates a controller.
Replace pluginml_update_memory_0PUTUpdate a memory.
Replace pluginml_update_memory_container_0PUTUpdate a memory container.
Replace pluginml_update_message_0PUTUpdate a message.
Replace pluginml_update_model_0PUTUpdates a model.
Replace pluginml_update_model_group_0PUTUpdates a model group.
Replace pluginnotifications_update_config_0PUTUpdate channel configuration.
Replace pluginobservability_update_object_0PUTUpdates an existing observability object.
Replace pluginquery_datasources_update_0PUTUpdates an existing query data source.
Replace pluginrollups_put_0PUTCreates or updates an index rollup job configuration.
Replace pluginsearch_relevance_put_experiments_0PUTCreates an experiment.
Replace pluginsearch_relevance_put_judgments_0PUTCreates a judgment.
Replace pluginsearch_relevance_put_query_sets_0PUTCreates a new query set by uploading manually.
Replace pluginsearch_relevance_put_search_configurations_0PUTCreates a search configuration.
Replace pluginsecurity_create_action_group_0PUTCreates or replaces the specified action group.
Replace pluginsecurity_create_role_0PUTCreates or replaces the specified role.
Replace pluginsecurity_create_role_mapping_0PUTCreates or replaces the specified role mapping.
Replace pluginsecurity_create_tenant_0PUTCreates or replaces the specified tenant.
Replace pluginsecurity_create_user_0PUTCreates or replaces the specified user.
Replace pluginsecurity_create_user_legacy_0PUTCreates or replaces the specified user.
Replace pluginsecurity_reload_http_certificates_0PUTReloads the HTTP communication certificates.
Replace pluginsecurity_reload_transport_certificates_0PUTReloads the transport communication certificates.
Replace pluginsecurity_update_distinguished_name_0PUTAdds or updates the specified distinguished names in the cluster or node allowlist.
Replace pluginsm_update_policy_0PUTUpdates an existing snapshot management policy.
Replace pluginsql_settings_0PUTUpdates SQL plugin settings in the OpenSearch cluster configuration.
Replace plugintransforms_put_0PUTCreate an index transform, or update a transform if if seq no and if primary term are provided.
Resume pluginreplication_resume_0POSTResumes replication of the leader index.
Retry pluginism_retry_index_0POSTRetries the failed action for an index.
Rolesmapping pluginsecurity_get_role_mappings_0GETRetrieves all role mappings.
Rolesmapping pluginsecurity_patch_role_mappings_0PATCHCreates or updates multiple role mappings in a single request.
Schedule pluginsearch_relevance_get_scheduled_experiments_0GETGets the scheduled experiments.
Schedule pluginsearch_relevance_post_scheduled_experiments_0POSTCreates a scheduled experiment.
Search pluginflow_framework_search_0POSTSearch for workflows by using a query matching a field.
Search pluginflow_framework_search_1GETSearch for workflows by using a query matching a field.
Search pluginflow_framework_search_state_0POSTSearch for workflows by using a query matching a field.
Search pluginflow_framework_search_state_1GETSearch for workflows by using a query matching a field.
Search pluginknn_search_models_0GETUse an OpenSearch query to search for models in the index.
Search pluginknn_search_models_1POSTUse an OpenSearch query to search for models in the index.
Search pluginml_search_agentic_memory_0GETSearch for memories of a specific type within a memory container.
Search pluginml_search_agents_0GETSearch agents.
Search pluginml_search_agents_1POSTSearch agents.
Search pluginml_search_connectors_0GETSearches for standalone connectors.
Search pluginml_search_connectors_1POSTSearches for standalone connectors.
Search pluginml_search_memory_0GETSearch memory.
Search pluginml_search_memory_1POSTSearch memory.
Search pluginml_search_memory_container_0POSTSearch memory containers.
Search pluginml_search_memory_container_1GETSearch memory containers.
Search pluginml_search_message_0GETSearch messages.
Search pluginml_search_message_1POSTSearch messages.
Search pluginml_search_model_group_0GETSearches for model groups.
Search pluginml_search_model_group_1POSTSearches for model groups.
Search pluginml_search_models_0GETSearches for models.
Search pluginml_search_models_1POSTSearches for models.
Search pluginml_search_tasks_0GETSearches for tasks.
Search pluginml_search_tasks_1POSTSearches for tasks.
Search pluginsecurity_analytics_get_findings_0GETRetrieve findings related to a specific detector type or detector ID.
Securityconfig pluginsecurity_get_configuration_0GETReturns the current Security plugin configuration in a JSON format.
Securityconfig pluginsecurity_patch_configuration_0PATCHUpdates the existing security configuration using the REST API.
Sql pluginsql_query_0POSTExecutes SQL or PPL queries against OpenSearch indexes.
Start pluginreplication_start_0PUTInitiates the replication of an index from the leader cluster to the follower cluster.
Start pluginrollups_start_0POSTStarts the execution of an index rollup job.
Start pluginsm_start_policy_0POSTStarts a snapshot management policy.
Start plugintransforms_start_0POSTStart transform.
Status pluginflow_framework_get_status_0GETRetrieves the current workflow provisioning status.
Status pluginreplication_status_0GETRetrieves the the status of an index replication.
Stop pluginreplication_stop_0POSTTerminates the replication and converts the follower index to a standard index.
Stop pluginrollups_stop_0POSTStops the execution of an index rollup job.
Stop pluginsm_stop_policy_0POSTStops a snapshot management policy.
Stop plugintransforms_stop_0POSTStop transform.
Stream pluginml_execute_agent_stream_0POSTExecute an agent in streaming mode.
Stream pluginml_predict_model_stream_0POSTPredicts a model in streaming mode.
Tenantinfo pluginsecurity_tenant_info_0GETRetrieves the names of current tenants.
Tenantinfo pluginsecurity_tenant_info_1POSTRetrieves the names of current tenants.
Train pluginknn_train_model_0POSTCreate and train a model that can be used for initializing k-NN native library indexes during indexing.
Train pluginknn_train_model_1POSTCreate and train a model that can be used for initializing k-NN native library indexes during indexing.
Transform plugintransforms_search_0GETReturns the details of all transform jobs.
Undeploy pluginml_undeploy_model_0POSTUndeploys a model.
Undeploy pluginml_undeploy_model_1POSTUndeploys a model.
Unload pluginml_unload_model_0POSTUnloads a model.
Unload pluginml_unload_model_1POSTUnloads a model.
Update pluginism_add_policy_1POSTAdds a policy to an index.
Update pluginism_change_policy_1POSTUpdates the managed index policy to a new policy.
Update pluginism_explain_policy_4POSTRetrieves the currently applied policy on the specified indexes.
Update pluginism_refresh_search_analyzers_0POSTRefreshes search analyzers in real time.
Update pluginism_remove_policy_1POSTRemoves a policy from an index.
Update pluginism_retry_index_1POSTRetries the failed action for an index.
Update pluginml_chunk_model_0POSTUploads model chunk.
Update pluginml_create_controller_0POSTCreates a controller.
Update pluginml_execute_algorithm_0POSTExecute an algorithm.
Update pluginml_execute_tool_0POSTExecute a tool.
Update pluginml_predict_0POSTPredicts new data with trained model.
Update pluginml_train_0POSTTrains a model synchronously.
Update pluginml_train_predict_0POSTTrains a model and predicts against the same training dataset.
Update pluginml_upload_chunk_0POSTUploads model chunk.
Update pluginnotifications_send_test_1POSTSend a test notification.
Update pluginreplication_update_settings_0PUTUpdates any settings on the follower index.
Update pluginsecurity_patch_action_group_0PATCHUpdates the individual attributes of an action group.
Update pluginsecurity_patch_action_groups_1PATCHCreates, updates, or deletes multiple action groups in a single request.
Update pluginsecurity_patch_distinguished_name_0PATCHUpdates the distinguished cluster name for the specified cluster.
Update pluginsecurity_patch_role_0PATCHUpdates the individual attributes of a role.
Update pluginsecurity_patch_role_mapping_0PATCHUpdates the individual attributes of a role mapping.
Update pluginsecurity_patch_roles_0PATCHCreates, updates, or deletes multiple roles in a single call.
Update pluginsecurity_patch_tenant_0PATCHAdds, deletes, or modifies a single tenant.
Update pluginsecurity_patch_tenants_0PATCHAdds, deletes, or modifies multiple tenants in a single request.
Update pluginsecurity_patch_user_0PATCHUpdates individual attributes for an internal user.
Update pluginsecurity_patch_users_0PATCHCreates, updates, or deletes multiple internal users in a single request.
Update pluginsm_create_policy_0POSTCreates a snapshot management policy.
Upgrade Check pluginsecurity_config_upgrade_check_0GETChecks whether or not an upgrade can be performed and which security resources can be updated.
Upgrade Perform pluginsecurity_config_upgrade_perform_0POSTAssists the cluster operator with upgrading missing default values and stale default definitions.
Upload plugingeospatial_geojson_upload_post_0POSTUse an OpenSearch query to upload GeoJSON, operation will fail if index exists.
Upload plugingeospatial_geojson_upload_put_0PUTUse an OpenSearch query to upload GeoJSON regardless if index exists.
Upload pluginml_upload_model_0POSTRegisters a model.
User pluginsecurity_get_users_legacy_0GETRetrieve all internal users.
Validate pluginsecurity_validate_0GETChecks whether the v6 security configuration is valid and ready to be migrated to v7.
Whoami pluginsecurity_who_am_i_0GETGets the identity information for the user currently logged in.
Whoami pluginsecurity_who_am_i_1POSTGets the identity information for the user currently logged in.
Whoamiprotected pluginsecurity_who_am_i_protected_0GETGets the identity information for the user currently logged in.
Workflow pluginflow_framework_create_0POSTCreates a new workflow template.
Rank Eval4
Rank Eval rank evalrank_eval_0GETAllows to evaluate the quality of ranked search results over a set of typical search queries.
Rank Eval rank evalrank_eval_1POSTAllows to evaluate the quality of ranked search results over a set of typical search queries.
Rank Eval rank evalrank_eval_2GETAllows to evaluate the quality of ranked search results over a set of typical search queries.
Rank Eval rank evalrank_eval_3POSTAllows to evaluate the quality of ranked search results over a set of typical search queries.
Recovery2
Recovery recoveryindices_recovery_0GETReturns information about ongoing index shard recoveries.
Recovery recoveryindices_recovery_1GETReturns information about ongoing index shard recoveries.
Refresh4
Refresh refreshindices_refresh_0GETPerforms the refresh operation in one or more indexes.
Refresh refreshindices_refresh_1POSTPerforms the refresh operation in one or more indexes.
Refresh refreshindices_refresh_2GETPerforms the refresh operation in one or more indexes.
Refresh refreshindices_refresh_3POSTPerforms the refresh operation in one or more indexes.
Reindex2
Reindex reindexreindex_0POSTAllows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote...
Rethrottle reindexreindex_rethrottle_0POSTChanges the number of requests per second for a particular reindex operation.
Remote1
Info remotecluster_remote_info_0GETReturns the information about configured remote clusters.
Remotestore1
Restore remotestoreremote_store_restore_0POSTRestores from remote store.
Render4
Get renderrender_search_template_2GETAllows to use the Mustache language to pre-render a search definition.
Template renderrender_search_template_0GETAllows to use the Mustache language to pre-render a search definition.
Template renderrender_search_template_1POSTAllows to use the Mustache language to pre-render a search definition.
Update renderrender_search_template_3POSTAllows to use the Mustache language to pre-render a search definition.
Resolve1
Get resolveindices_resolve_index_0GETReturns information about any matching indexes, aliases, and data streams.
Rollover2
Rollover rolloverindices_rollover_0POSTUpdates an alias to point to a new index when the existing index is considered to be too large or too old.
Update rolloverindices_rollover_1POSTUpdates an alias to point to a new index when the existing index is considered to be too large or too old.
Script8
Delete scriptdelete_script_0DELETEDeletes a script.
Execute scriptscripts_painless_execute_0GETAllows an arbitrary script to be executed and a result to be returned.
Execute scriptscripts_painless_execute_1POSTAllows an arbitrary script to be executed and a result to be returned.
Get scriptget_script_0GETReturns a script.
Replace scriptput_script_1PUTCreates or updates a script.
Replace scriptput_script_3PUTCreates or updates a script.
Update scriptput_script_0POSTCreates or updates a script.
Update scriptput_script_2POSTCreates or updates a script.
Script Context1
Script Context script contextget_script_context_0GETReturns all script contexts.
Script Language1
Script Language script languageget_script_languages_0GETReturns available script types, languages and contexts.
Search22
All searchdelete_all_pits_0DELETEDeletes all active point in time searches.
All searchget_all_pits_0GETLists all active point in time searches.
Delete searchclear_scroll_1DELETEExplicitly clears the search context for a scroll.
Delete searchsearch_pipeline_delete_0DELETEDeletes the specified search pipeline.
Get searchscroll_2GETAllows to retrieve a large numbers of results from a single search request.
Get searchsearch_pipeline_get_1GETRetrieves information about a specified search pipeline.
Pipeline searchsearch_pipeline_get_0GETRetrieves information about a specified search pipeline.
Point In Time searchcreate_pit_0POSTCreates point in time context.
Point In Time searchdelete_pit_0DELETEDeletes one or more point in time searches based on the IDs passed.
Replace searchsearch_pipeline_put_0PUTCreates or replaces the specified search pipeline.
Scroll searchclear_scroll_0DELETEExplicitly clears the search context for a scroll.
Scroll searchscroll_0GETAllows to retrieve a large numbers of results from a single search request.
Scroll searchscroll_1POSTAllows to retrieve a large numbers of results from a single search request.
Search searchsearch_0GETReturns results matching a query.
Search searchsearch_1POSTReturns results matching a query.
Search searchsearch_2GETReturns results matching a query.
Search searchsearch_3POSTReturns results matching a query.
Template searchsearch_template_0GETAllows to use the Mustache language to pre-render a search definition.
Template searchsearch_template_1POSTAllows to use the Mustache language to pre-render a search definition.
Template searchsearch_template_2GETAllows to use the Mustache language to pre-render a search definition.
Template searchsearch_template_3POSTAllows to use the Mustache language to pre-render a search definition.
Update searchscroll_3POSTAllows to retrieve a large numbers of results from a single search request.
Search Shard4
Create search shardsearch_shards_1POSTReturns information about the indexes and shards that a search request would be executed against.
Create search shardsearch_shards_3POSTReturns information about the indexes and shards that a search request would be executed against.
List search shardssearch_shards_0GETReturns information about the indexes and shards that a search request would be executed against.
List search shardssearch_shards_2GETReturns information about the indexes and shards that a search request would be executed against.
Segment2
List segmentsindices_segments_0GETProvides low-level information about segments in a Lucene index.
List segmentsindices_segments_1GETProvides low-level information about segments in a Lucene index.
Setting6
Get settingindices_get_settings_1GETReturns settings for one or more indexes.
Get settingindices_get_settings_3GETReturns settings for one or more indexes.
List settingsindices_get_settings_0GETReturns settings for one or more indexes.
List settingsindices_get_settings_2GETReturns settings for one or more indexes.
Replace settingindices_put_settings_0PUTUpdates the index settings.
Replace settingindices_put_settings_1PUTUpdates the index settings.
Shard Store2
List shard storesindices_shard_stores_0GETProvides store information for shard copies of indexes.
List shard storesindices_shard_stores_1GETProvides store information for shard copies of indexes.
Shrink2
Replace shrinkindices_shrink_1PUTAllow to shrink an existing index into a new index with fewer primary shards.
Update shrinkindices_shrink_0POSTAllow to shrink an existing index into a new index with fewer primary shards.
Snapshot16
Cleanup snapshotsnapshot_cleanup_repository_0POSTRemoves any stale data from a snapshot repository.
Delete snapshotsnapshot_delete_0DELETEDeletes a snapshot.
Delete snapshotsnapshot_delete_repository_0DELETEDeletes a snapshot repository.
Get snapshotsnapshot_get_0GETReturns information about a snapshot.
Get snapshotsnapshot_get_repository_1GETReturns information about a snapshot repository.
Replace snapshotsnapshot_clone_0PUTCreates a clone of all or part of a snapshot in the same repository as the original snapshot.
Replace snapshotsnapshot_create_1PUTCreates a snapshot within an existing repository.
Replace snapshotsnapshot_create_repository_1PUTCreates a snapshot repository.
Restore snapshotsnapshot_restore_0POSTRestores a snapshot.
Snapshot snapshotsnapshot_get_repository_0GETReturns information about a snapshot repository.
Status snapshotsnapshot_status_0GETReturns information about the status of a snapshot.
Status snapshotsnapshot_status_1GETReturns information about the status of a snapshot.
Status snapshotsnapshot_status_2GETReturns information about the status of a snapshot.
Update snapshotsnapshot_create_0POSTCreates a snapshot within an existing repository.
Update snapshotsnapshot_create_repository_0POSTCreates a snapshot repository.
Verify snapshotsnapshot_verify_repository_0POSTVerifies a repository.
Source2
Get sourceget_source_0GETReturns the source of a document.
Inspect sourceexists_source_0HEADReturns information about whether a document source exists in an index.
Split2
Replace splitindices_split_1PUTAllows you to split an existing index into a new index with more primary shards.
Update splitindices_split_0POSTAllows you to split an existing index into a new index with more primary shards.
Stat4
Get statindices_stats_1GETProvides statistics on operations happening in an index.
Get statindices_stats_3GETProvides statistics on operations happening in an index.
List statsindices_stats_0GETProvides statistics on operations happening in an index.
List statsindices_stats_2GETProvides statistics on operations happening in an index.
Task4
Cancel tasktasks_cancel_0POSTCancels a task, if it can be cancelled through an API.
Cancel tasktasks_cancel_1POSTCancels a task, if it can be cancelled through an API.
Get tasktasks_get_0GETReturns information about a task.
List taskstasks_list_0GETReturns a list of tasks.
Template6
Delete templateindices_delete_template_0DELETEDeletes an index template.
Get templateindices_get_template_1GETReturns an index template.
Inspect templateindices_exists_template_0HEADReturns information about whether a particular index template exists.
Replace templateindices_put_template_1PUTCreates or updates an index template.
Template templateindices_get_template_0GETReturns an index template.
Update templateindices_put_template_0POSTCreates or updates an index template.
Termvector4
Create termvectortermvectors_1POSTReturns information and statistics about terms in the fields of a particular document.
Get termvectortermvectors_2GETReturns information and statistics about terms in the fields of a particular document.
List termvectorstermvectors_0GETReturns information and statistics about terms in the fields of a particular document.
Update termvectortermvectors_3POSTReturns information and statistics about terms in the fields of a particular document.
Update1
Update updateupdate_0POSTUpdates a document with a script or partial document.
Update By Query2
Rethrottle update by queryupdate_by_query_rethrottle_0POSTChanges the number of requests per second for a particular Update By Query operation.
Update By Query update by queryupdate_by_query_0POSTPerforms an update on every document in the index without changing the source, for example to pick up a mapping change.
Upgrade4
Upgrade upgradeindices_get_upgrade_0GET
Upgrade upgradeindices_get_upgrade_1GET
Upgrade upgradeindices_upgrade_0POST
Upgrade upgradeindices_upgrade_1POST
Validate4
Query validateindices_validate_query_0GETAllows a user to validate a potentially expensive query without executing it.
Query validateindices_validate_query_1POSTAllows a user to validate a potentially expensive query without executing it.
Query validateindices_validate_query_2GETAllows a user to validate a potentially expensive query without executing it.
Query validateindices_validate_query_3POSTAllows a user to validate a potentially expensive query without executing it.
Wlm5
Delete wlmwlm_delete_query_group_0DELETEDeletes the specified query group.
Get wlmwlm_get_query_group_1GETRetrieves the specified query group.
Query Group wlmwlm_create_query_group_0PUTCreates a new query group and sets the resource limits for the new query group.
Query Group wlmwlm_get_query_group_0GETRetrieves the specified query group.
Replace wlmwlm_update_query_group_0PUTUpdates the specified query group.
General6
Delete generalindices_delete_0DELETEDeletes an index.
Get generalindices_get_0GETReturns information about one or more indexes.
Inspect generalindices_exists_0HEADReturns information about whether a particular index exists.
Inspect generalping_0HEADReturns whether the cluster is running.
List generalsinfo_0GETReturns basic information about the cluster.
Replace generalindices_create_0PUTCreates an index with optional settings and mappings.