Skip to main content

GET /api/v1/healthz

Returns a list of healthz resources.

This endpoint documentation is generated from the current Fastify route implementation and should be treated as the implementation-level contract for this version of the API.

Source route file: src/api/routes/external/public/healthz/get.ts

Request Method​

GET

Base URL​

https://api.userdocks.local:5000

Endpoint​

/api/v1/healthz

Path Variables​

No path variables.

Query Parameters​

No query parameters.

HTTP Headers​

No HTTP headers.

Successful Response​

Success status code(s): 200.

{
  "kind": "healthz",
  "totalItems": 1,
  "itemsLength": 1,
  "items": [
    {
      "id": 1,
      "name": "healthz",
      "description": "healthz",
      "random": 0.123456789,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Error Responses​

HTTP StatusExample Error
400{"errors":[{"validation":"error","code":"[E4000]","message":"Bad Request / validation error"}]}
500{"errors":[{"validation":"error","code":"[E0000]","message":"Internal Server Error"}]}

Example​

const url = `https://api.userdocks.local:5000/api/v1/healthz`;

const response = await fetch(url, {
  method: 'GET',
  headers: {},
});
const data = await response.json();
console.log(response.status, data);