Get index status

GET 
/api/v1/indices/:externalId/status

Whether the index is currently live or not (demised)

Request

Path Parameters

externalId stringrequired

ID of the Index

Responses

200

successful operation

application/json

Schema

Schema

serverTime date-time
error stringnullable

description of error in natural language, absent in case of successful operation

payload

object

nullable

The response data

id string

state string

Possible values: [LIVE, DEMISED]

Example (from schema)

{
  "serverTime": "2024-01-01T09:00:00.000Z",
  "error": "string",
  "payload": {
    "id": "string",
    "state": "LIVE"
  }
}

Loading...