> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenSearch

> How to set up the OpenSearch connector, plus the actions that are available.

![OpenSearch](https://stackone-logos.com/api/opensearch/filled/svg)

Previewv0.1.2[See changelog](https://docs.stackone.com/connectors/opensearch/changelog.md)

[69 actions](#actions) · 4 auth methods

Developer Tools

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Basic Authentication · Connector Profile](https://docs.stackone.com/connectors/opensearch/guides/connector-profile/basic-authentication.md)
>
> Basic HTTP authentication against the OpenSearch Security Plugin. Same credentials carry across every REST endpoint. Com...

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/opensearch/guides/connector-profile/api-key.md)
>
> OpenSearch API key authentication. Preferred over basic auth when the cluster's Security Plugin has API keys enabled (Op...

> [card] [JWT Bearer Token · Connector Profile](https://docs.stackone.com/connectors/opensearch/guides/connector-profile/jwt-bearer-token.md)
>
> JWT bearer-token authentication via the Security Plugin's \`jwt\_auth\_domain\`. The caller supplies a pre-issued JWT (typic...

> [card] [AWS IAM (SigV4) · Connector Profile](https://docs.stackone.com/connectors/opensearch/guides/connector-profile/aws-iam-sigv4.md)
>
> AWS Signature Version 4 signing — the only accepted auth mode for AWS OpenSearch Serverless (service \`aoss\`) and for AWS...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Basic Authentication · Link Account](https://docs.stackone.com/connectors/opensearch/guides/link-account/basic-authentication.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/opensearch/guides/link-account/api-key.md)

> [card] [JWT Bearer Token · Link Account](https://docs.stackone.com/connectors/opensearch/guides/link-account/jwt-bearer-token.md)

> [card] [AWS IAM (SigV4) · Link Account](https://docs.stackone.com/connectors/opensearch/guides/link-account/aws-iam-sigv4.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

AWS IAM (SigV4)

Basic Authentication

JWT Bearer Token

No auth methods found

69 actions

ActionDescription

List Indices (Cat)`opensearch_cat_indices`

Compact tabular listing of every index — health, status, docs count, disk usage, shards.

Cat Cluster Health`opensearch_cat_health`

One-line summary of cluster health — status, node counts, shard counts.

Cat Nodes`opensearch_cat_nodes`

Per-node overview — heap, CPU, load, disk, role, and cluster-manager status.

List Aliases (Cat)`opensearch_cat_aliases`

Compact tabular alias listing — alias, index, filter, routing, is\_write\_index.

Get Cluster Health`opensearch_get_cluster_health`

Snapshot of cluster health — status (green/yellow/red), active/relocating shards, and pending tasks. The canonical conne...

Get Cluster Statistics`opensearch_get_cluster_stats`

Aggregated statistics across the whole cluster — nodes, shards, storage, JVM heap, and OS/process metrics.

Get Cluster State`opensearch_get_cluster_state`

Full cluster state — routing table, metadata, node roster, and index settings. Very large payload; filter via the \`metri...

Get Cluster Settings`opensearch_get_cluster_settings`

Return persistent, transient, and default cluster settings.

Update Cluster Settings`opensearch_put_cluster_settings`

Set persistent or transient cluster settings. Persistent settings survive restarts; transient do not.

List Cluster Pending Tasks`opensearch_get_pending_tasks`

Tasks queued on the cluster manager but not yet executed — useful to spot backlogs during allocation storms.

Get Saved Object`opensearch_dashboards_get_saved_object`

Fetch a single Dashboards saved object (dashboard, visualization, index-pattern, etc.) by type + id.

Find Saved Objects`opensearch_dashboards_find_saved_objects`

Search and paginate Dashboards saved objects. The canonical enumeration endpoint for datasync discovery.

Create Saved Object`opensearch_dashboards_create_saved_object`

Create a new Dashboards saved object.

Update Saved Object`opensearch_dashboards_update_saved_object`

Update the attributes of an existing Dashboards saved object.

Delete Saved Object`opensearch_dashboards_delete_saved_object`

Delete a Dashboards saved object by type + id.

Bulk Get Saved Objects`opensearch_dashboards_bulk_get_saved_objects`

Fetch many saved objects in a single request.

Export Saved Objects`opensearch_dashboards_export_saved_objects`

Export a set of saved objects (with dependencies) as an NDJSON bundle. Response body is raw NDJSON text (one JSON object...

Import Saved Objects`opensearch_dashboards_import_saved_objects`

Import an NDJSON bundle of saved objects (produced by export or hand-crafted).

Index Document (Auto-ID)`opensearch_index_document`

Add a document to an index and let OpenSearch generate the ID.

Create Or Update Document (Explicit ID)`opensearch_upsert_document`

Index a document at a specific ID; overwrites if the ID already exists unless op\_type=create.

Get Document By ID`opensearch_get_document`

Fetch a single document (source + metadata) by its ID.

Check Document Exists`opensearch_document_exists`

Existence check for a document — returns 200 if the document exists, 404 if not.

Get Document Source Only`opensearch_get_document_source`

Fetch only the \_source field of a document, without \_seq\_no / \_primary\_term / \_version metadata.

Partial Update Document`opensearch_update_document`

Apply a partial update to a document using the update DSL (doc merge, script, or upsert).

Delete Document`opensearch_delete_document`

Delete a document by ID.

Bulk Index/Update/Delete (NDJSON)`opensearch_bulk_operations`

Execute many index/update/delete operations in a single request. \*\*Body must be NDJSON\*\* (newline-delimited JSON), not s...

Bulk Operations Scoped To One Index`opensearch_bulk_operations_by_index`

Same NDJSON bulk semantics as bulk\_operations, but scoped to a single index in the URL — operations can omit `_index` in...

Multi-Get Documents`opensearch_multi_get_documents`

Fetch multiple documents by ID in one round-trip, optionally across different indices.

Delete Documents By Query`opensearch_delete_by_query`

Delete all documents matching a query in one call.

Update Documents By Query`opensearch_update_by_query`

Apply a script or noop update to every document matching a query.

Reindex Documents`opensearch_reindex`

Copy documents from a source index (or remote cluster) to a destination index; the canonical datasync migration primitiv...

Create Index`opensearch_create_index`

Create a new index with optional settings, mappings, and aliases.

Get Index Info`opensearch_get_index`

Return the settings, mappings, and aliases of one or more indices.

Check Index Exists`opensearch_index_exists`

Existence check for an index — 200 if it exists, 404 if not.

Delete Index`opensearch_delete_index`

Permanently delete an index and all its data.

Update Mapping`opensearch_put_mapping`

Add new fields to an index mapping. Cannot change existing field types.

Get Mapping`opensearch_get_mapping`

Return the mapping (field types) for one or more indices.

Get Index Settings`opensearch_get_settings`

Return the settings for one or more indices (shard count, replicas, analysis, refresh interval).

Update Index Settings`opensearch_put_settings`

Update dynamic index settings (replica count, refresh interval, allocation, etc.).

Refresh Index`opensearch_refresh_index`

Force a refresh so recently indexed documents become searchable immediately.

Flush Index`opensearch_flush_index`

Persist in-memory transaction log to disk.

Force Merge Index`opensearch_forcemerge_index`

Merge index segments to reduce their count; heavy operation.

Open Index`opensearch_open_index`

Re-open a closed index so it becomes readable/writable.

Close Index`opensearch_close_index`

Close an index so it stops accepting reads/writes; frees cluster resources.

Clone Index`opensearch_clone_index`

Copy an existing index to a new name — source must have the write-block set before calling.

Atomic Update Of Aliases`opensearch_update_aliases`

Apply multiple alias add/remove operations atomically.

Add Alias To Index`opensearch_put_alias`

Attach a single alias to a single index (non-atomic — use update\_aliases for atomic swaps).

Delete Alias From Index`opensearch_delete_alias`

Remove an alias from an index.

Get Alias Info`opensearch_get_alias`

Return details of a specific alias on a specific index (or across a wildcard set).

List All Aliases`opensearch_get_aliases`

Return every alias across every index (or a filtered subset).

Search Index`opensearch_search`

Full-text and structured search over one or more indices using the Query DSL.

Search Across All Indices`opensearch_search_all`

Same as search but without an index in the URL — required when using a Point-in-Time reference.

Multi-Search (NDJSON)`opensearch_multi_search`

Run several searches in one round-trip; body is NDJSON with alternating header + query lines.

Count Documents Matching Query`opensearch_count_documents`

Return the count of documents matching a query, without returning the hits themselves.

Scroll (Deep Pagination — Legacy)`opensearch_scroll_search`

Fetch the next batch of a scroll context. Discouraged for new work — use PIT + search\_after instead.

Clear Scroll Context`opensearch_clear_scroll`

Release the memory held by one or more scroll contexts.

Create Point-in-Time`opensearch_create_point_in_time`

Freeze an index at a moment in time so subsequent searches see a consistent view.

Delete Point-in-Time`opensearch_delete_point_in_time`

Release a PIT so its heap can be reclaimed.

List Snapshot Repositories`opensearch_get_repositories`

Return every registered snapshot repository on the cluster.

Get Snapshot Repository`opensearch_get_repository`

Return details of a specific repository (type, settings).

Register Snapshot Repository`opensearch_create_repository`

Register a snapshot repository backed by fs, s3, gcs, or azure storage.

Delete Snapshot Repository`opensearch_delete_repository`

Unregister a snapshot repository. Does NOT delete the snapshots themselves — files remain in the backend storage.

List Snapshots In Repository`opensearch_get_snapshots`

List snapshots in the given repository — companion LIST for the create/get/delete snapshot actions.

Take Snapshot`opensearch_create_snapshot`

Create a snapshot of one or more indices to the target repository.

Get Snapshot Details`opensearch_get_snapshot`

Return details of one or more snapshots — status, indices, start/end times, shard counts.

Delete Snapshot`opensearch_delete_snapshot`

Delete a snapshot and reclaim its unique segments from the repository.

Restore Snapshot`opensearch_restore_snapshot`

Restore indices from a snapshot back into the cluster.

Get Task`opensearch_get_task`

Fetch the status of a running or completed task by task\_id.

Cancel Task`opensearch_cancel_task`

Cancel a running task by task\_id. Cancellation is cooperative — the task ends at the next check point.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.