Skip to main content
GET
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Return 200 with a minimal liveness payload, or 503 on db failure.

Response

HealthResponse
string
required
Allowed values: 'ok', 'degraded'.
string
required
Static service identifier.
string
required
ISO 8601 UTC timestamp of the check.
object
required
Per-component check results. Currently only database. Additional keys map to values of type string.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026