---
title: "Get Opensearch Index Status"
method: POST
path: "/vector/store/index/status"
tags: ["Vectorization"]
---

# Get Opensearch Index Status

`POST /vector/store/index/status`

## Endpoint to Get Index Status
This endpoint returns the status of the specified index.

***
## Request Body

| Field               | Type   | Description                      |
|---------------------|--------|----------------------------------|
| index_id            | str    | The ID of the index.             |

***
## Example Request Body

    ```json

    {
        "index_id": "b1c2b4c5-6d7e-8f9g-0h1i-2j3k4l5m6n7"
    }

    ```
***
## Response Body

| Field               | Type   | Description                      |
|---------------------|--------|----------------------------------|
| index_id            | str    | The ID of the index.             |
| status              | str    | The status of the index. Returns "ACTIVE" or "NOT_FOUND_OR_READY". |

***
#### Errors

- **400 Bad Request**: If the index is not found.
- **500 Internal Server Error**: If there is an unexpected error during the retrieval of the index status.

## Request body

- VectorIndexStatusRequest
  - `index_id` string, required

## Response `200`

Successful Response

- object

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/aws-samples/apis/generative-ai-foundational-platform-api.md) · [All operations](https://skmtc.dev/aws-samples/apis/generative-ai-foundational-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aws-samples/generative-ai-foundational-platform-api/revisions/8831d08902e9/schema)