Sections
Theme

Health

REST API reference for health

This reference is generated from the Invitebase OpenAPI contract.

Public service liveness checks.

Check API health

GET/v1/health

Public liveness check. It does not require an API key.

Authentication

No API key required.

Responses

200

API is available.

application/json schema:

{
  "type": "object",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "const": "ok"
    }
  }
}

On this page