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.
| Field | Type | Required | Documented example value | Interpretation |
|---|---|---|---|---|
| ok | boolean | true | true | Present in the documented healthy response example. |
Limited to documented evidence; only 200 is documented.
| Check | Expected documented result | Failure signal |
|---|---|---|
| HTTP status | 200 | Any other status does not match the documented success contract. |
| Content type | application/json | A different content type does not match the documented Response Body. |
| Response field ok | Required boolean; example value true | Missing 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.
curl -X GET "{{API_BASE_URL}}/v1/health"{
"ok": true
}| Scope | Field | Type | Type reference | Required | Description |
|---|---|---|---|---|---|
| response#1 | response | object | __0 | ||
| response#1 | response.ok | boolean | __1 | Yes |