OpenSearch

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

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

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

Compact tabular alias listing — alias, index, filter, routing, is_write_index.

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

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

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

Return persistent, transient, and default cluster settings.

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

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

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

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

Create a new Dashboards saved object.

Update the attributes of an existing Dashboards saved object.

Delete a Dashboards saved object by type + id.

Fetch many saved objects in a single request.

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

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

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

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

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

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

Fetch only the _source field of a document, without _seq_no / _primary_term / _version metadata.

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

Delete a document by ID.

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

Same NDJSON bulk semantics as bulk_operations, but scoped to a single index in the URL — operations can omit _index in…

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

Delete all documents matching a query in one call.

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

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

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

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

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

Permanently delete an index and all its data.

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

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

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

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

Force a refresh so recently indexed documents become searchable immediately.

Persist in-memory transaction log to disk.

Merge index segments to reduce their count; heavy operation.

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

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

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

Apply multiple alias add/remove operations atomically.

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

Remove an alias from an index.

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

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

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

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

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

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

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

Release the memory held by one or more scroll contexts.

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

Release a PIT so its heap can be reclaimed.

Return every registered snapshot repository on the cluster.

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

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

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

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

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

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

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

Restore indices from a snapshot back into the cluster.

Fetch the status of a running or completed task by task_id.

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