Skip to content

Health Check API

The Health Check API documents GET /v1/health and a 200 JSON response containing ok. Use it for a small request-and-response check; it does not establish that every other API operation is working.

Request

Send GET {{API_BASE_URL}}/v1/health. This reference documents no parameters or request body for the operation. The request example preserves the exact method and path.

Response Body

The documented response is HTTP 200 with Content-Type application/json and a required boolean field named ok. The example sets ok to true. Check the HTTP status, content type and parsed field separately; a missing or non-boolean ok value does not match the documented shape. Only the 200 response is specified here, so this page does not assign error or retry behavior to other outcomes.

Health check response field map
FieldTypeRequiredDocumented example valueInterpretation
okbooleantruetruePresent in the documented healthy response example.

Limited to documented evidence; only 200 is documented.

Health check interpretation matrix
CheckExpected documented resultFailure signal
HTTP status200Any other status does not match the documented success contract.
Content typeapplication/jsonA different content type does not match the documented Response Body.
Response field okRequired boolean; example value trueMissing field, non-boolean value, or a value other than the documented example does not match the worked example.

Non-200 behavior is not documented in the supplied source and is not invented here.

Health check request
curl -X GET "{{API_BASE_URL}}/v1/health"
200 application/json response example
{
  "ok": true
}
Interface fields
ScopeFieldTypeType referenceRequiredDescription
response#1responseobject__0
response#1response.okboolean__1Yes