---
title: "List OpenSearch indexes"
method: GET
path: "/project/{project}/service/{service_name}/index"
tags: ["Service:_OpenSearch"]
---

# List OpenSearch indexes

`GET /project/{project}/service/{service_name}/index`

## Path parameters

- `project` string, required
- `service_name` string, required

## Response `200`

Response

- ServiceOpenSearchIndexListResponse — ServiceOpenSearchIndexListResponse
  - `errors` object[] — List of errors occurred during request processing
    - `message` string, required — Printable error message
    - `more_info` string — URL to the documentation of the error
    - `status` integer, required — HTTP error status code
  - `indexes` object[], required — List of OpenSearch indexes
    - `create_time` string, required — Timestamp in ISO 8601 format, always in UTC
    - `docs` integer — Number of documents in index. -1 means not available.
    - `health` 'green' | 'yellow' | 'red' | 'red*' | 'unknown' — Index health
    - `index_name` string, required — Index name
    - `number_of_replicas` integer, required — Number of replicas for an index
    - `number_of_shards` integer, required — Number of shards in an index
    - `read_only_allow_delete` boolean — Whether an index is set as read-only (but allows deletion). null means unknown.
    - `replication` object — Index replication
      - `leader_index` string — Leader index name
      - `leader_project` string — Leader project name
      - `leader_service` string — Leader service name
    - `size` integer — Index size in bytes. -1 means not available.
    - `status` 'unknown' | 'open' | 'close' | 'none' — Index status
  - `message` string — Printable result of the request

## Other responses

- `409` — Request conflict

---

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