---
title: "List Indexes for a OpenSearch Cluster"
method: GET
path: "/v2/databases/{database_cluster_uuid}/indexes"
tags: ["DigitalOcean-public.v2-new_Databases"]
---

# List Indexes for a OpenSearch Cluster

`GET /v2/databases/{database_cluster_uuid}/indexes`

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.

## Path parameters

- `database_cluster_uuid` string, uuid, required

## Response `200`

A JSON object with a key of `indexes`.

- object
  - `indexes` OpensearchIndex[]
    - `index_name` string — The name of the opensearch index.
    - `number_of_shards` integer — The number of shards for the index.
    - `number_of_replicas` integer — The number of replicas for the index.
    - `size` integer — The size of the index.
    - `created_time` string, date-time — The date and time the index was created.
    - `status` 'unknown' | 'open' | 'close' | 'none' — The status of the OpenSearch index.
    - `health` 'unknown' | 'green' | 'yellow' | 'red' | 'red*' — The health of the OpenSearch index.

## Other responses

- `401` — Authentication failed due to invalid credentials.
- `404` — The resource was not found.
- `429` — The API rate limit has been exceeded.
- `500` — There was a server error.
- `default` — There was an unexpected error.

---

[API](https://skmtc.net/digitalocean/apis/digitalocean-api.md) · [All operations](https://skmtc.net/digitalocean/apis/digitalocean-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalocean/digitalocean-api/versions/cb3bf9b21459/schema)