Liveness probe
GET /health
Unauthenticated liveness probe. Returns 200 with {"status":"ok"}
while the service is up; intended for load balancers and uptime checks.
Responses
200
OK
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Service health status |
default
Error
Content type: application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
detail | string | No | A human-readable explanation specific to this occurrence of the problem. |
errors | array of object | No | Optional list of individual error details |
instance | string | No | A URI reference that identifies the specific occurrence of the problem. |
status | integer | No | HTTP status code |
title | string | No | A short, human-readable summary of the problem type. This value should not change between occurrences of the error. |
type | string | No | A URI reference to human-readable documentation for the error. |
errors[]
| Field | Type | Required | Description |
|---|---|---|---|
location | string | No | Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’ |
message | string | No | Error message text |
value | any | No | The value at the given location |