Status API

Users of the Timeseries API can use this endpoint to check the status of the Timeseries API to ensure it is up and running. Currently, the endpoint only returns the current API version but future releases will include dependency checks. A user does not need to be authorized to access this endpoint.

URL

https://{{HOST}}/timeseries/status

Method

GET

Required IMS Scopes

  • Read
  • Write

Versions Supported

  • 2.0 (Default)
  • 2.1

URL Path Parameters

Name Description Example Type
id
optional		 Id of Needed for the Endpoint /endpoint/id string

URL Query Parameters

Name Description Example Type
v
optional		 Version of the API to use v=2.0 string

Request Header Parameters

Type Value Description
Authentication Bearer {access_token}
required		 Retrieve access token
Content-Type application/json
required		 Description

Example

Request

curl -X GET 
  'https://qa-api.digitalvault.cloud/timeseries/status' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Cache-Control: no-cache'

Response

{
    "api": "timeseriesapi",
    "version": "2.0.1.317"
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
api Current API string
version API Build string