Health

Check the health and availability of the REST API v2.

Get REST API Health Status

get

https://rest-api.app.kognitos.com/v2https://rest-api.eu.kognitos.com/v2https://rest-api.uk.kognitos.com/v2

/health

Checks the status of the REST API v2 and reports on system health.

Authorizations

APIKeyHeader

x-api-keystringRequired

Responses

200

The status of the system (OK)

application/json

Current health status of the REST API.

statusstringRequired

A status message reflecting the health of the REST API.

500

The status of the system (not OK)

application/json

get

/health

HTTPcURLJavaScriptPython

GET /v2/health HTTP/1.1
Host: rest-api.app.kognitos.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "status": "OK"
}