Health reference

Health endpoint authentication, parameters, request and response contracts.

Last updated: 10 November 2026

Paths, methods, parameters and available schemas are generated from the OpenAPI document in the repository.

Note: These endpoints form the browser application contract and do not provide the same versioning assurance as v1. Use the versioned API for external integrations.

GET /api/health

Health

Authentication: Authentication is not required. Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

For error meanings and client actions, see the error code glossary.