Skip to content

Health Check

GET
/health

Successful Response

HealthCheckResponse

Response for GET /health.

object
success
required
Success

Whether the request succeeded.

boolean
data
Any of:
object
key
additional properties
any
error
Any of:
ErrorDetail
object
code
required
Code

Machine-readable error code (e.g., ‘NOT_FOUND’, ‘VALIDATION_ERROR’).

string
message
required
Message

Human-readable error message describing what went wrong.

string
details
Any of: