Health

Health check

Returns the health status of the application and its dependencies (Valkey/Redis and Kafka)

get/health

Request

Base URL
https://integrators.prod.api.tabsplatform.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/tabsplatform/apis/tabs-external-api/docs/health/get.ts
A function with typed inputs. Its response is checked against the schema.

Health status retrieved successfully

status'ok' | 'partial' | 'down'

Overall health status

infoobject

Health information for each dependency

errorobject

Error information (empty if healthy)

detailsobject

Detailed health information for each dependency

{
  "status": "ok"
}

No recorded changes to this operation across all 1 revision of this API.