Skip to main content

Get index status

GET 

https://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

successful operation

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]

curl -L 'https://www.cfbenchmarks.com/api/v1/indices/:externalId/status' \
-H 'Accept: application/json'
Request Collapse all
Base URL
https://www.cfbenchmarks.com
Auth
Parameters
— pathrequired