Sign in
Start free7-day free trial
Live API contract
API REFERENCE / API health

Check API health

GET/health

Read the API liveness response without sending credentials.

Authentication

This endpoint is public. No API key is required.

Authentication and API keys →

Responses

200 Response schema

application/json

okbooleanrequired
dbstringrequired

Allowed values: "ok", "error"

versionstringrequired
View complete response schema
HTTP 200 schema
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "db": {
      "type": "string",
      "enum": [
        "ok",
        "error"
      ]
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "ok",
    "db",
    "version"
  ],
  "additionalProperties": false
}

Authentication and validation failures use the shared error envelope. Save the request ID when diagnosing a failed call.

Build the surrounding workflow

Read the api health guide for ordering, verification and recovery. Browse the other api health endpoints when you need the next operation.