v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB

DigitalOcean-public.v2-new_Databases

List Indexes for a OpenSearch Cluster

To list all of a OpenSearch cluster's indexes, send a GET request to /v2/databases/$DATABASE_ID/indexes.

The result will be a JSON object with a indexes key.

get/v2/databases/{database_cluster_uuid}/indexes

Path parameters

database_cluster_uuidstring uuid required

A unique identifier for a database cluster.

Response

A JSON object with a key of indexes.

Example response

{
  "indexes": [
    {
      "index_name": "events",
      "number_of_shards": 2,
      "number_of_replicas": 3,
      "size": 208,
      "created_time": "2021-01-01T00:00:00Z",
      "status": "open",
      "health": "green"
    }
  ]
}