ScalixScalix Docs

System API

Health, metrics, and diagnostics

REST API endpoints for System. 4 operations.

Get service status

plaintext
GET /api/v1/services

Returns the operational status of Scalix Cloud services.

Auth: Bearer API key

Responses

StatusDescription
200Service status
401Missing or invalid API key
500Internal error

operationId: getServicesStatus

Liveness probe

plaintext
GET /healthz

Returns 200 while the gateway process is alive.

Auth: none

Responses

StatusDescription
200Gateway is alive

operationId: healthz

Get the OpenAPI spec

plaintext
GET /openapi.json

Returns this OpenAPI specification document.

Auth: none

Responses

StatusDescription
200This OpenAPI specification

operationId: getOpenapiSpec

Readiness probe

plaintext
GET /readyz

Returns 200 when the gateway is ready to serve traffic.

Auth: none

Responses

StatusDescription
200Gateway is ready to serve traffic

operationId: readyz