Skip to content
SupaCloud Docs
Select themeSelect language

Health endpoint with process status and global safety-switch state.

GET
/health
curl --request GET \
  --url https://example.com/health

Responses

Section titled “Responses”

200

Section titled “200”

Server is alive; body contains status and active safety-switch state

Media typeapplication/json
object
status
required
string
switches
required
Array<object>
object
enabled
required
boolean
id
required
string format: uuid
key
required
string
last_reason
string | null
updated_at
required
string format: date-time
updated_by
required
string
workspace_id
string | null format: uuid
Examplegenerated
{
  "status": "example",
  "switches": [
    {
      "enabled": true,
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key": "example",
      "last_reason": "example",
      "updated_at": "2026-04-15T12:00:00Z",
      "updated_by": "example",
      "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}