Get index status
GEThttps://www.cfbenchmarks.com/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
- Example (from 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
]
{
"serverTime": "2025-03-14T11:11:34.529Z",
"error": "string",
"payload": {
"id": "string",
"state": "LIVE"
}
}
- curl
- python
- java
- nodejs
- CURL
curl -L 'https://www.cfbenchmarks.com/api/v1/indices/:externalId/status' \
-H 'Accept: application/json'