v66

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0174265626.3 KB
liveness

Health check

Check if the Unkey API service is healthy and ready to handle requests.

Use this for load balancer health checks, monitoring systems, and orchestration platforms. No authentication required with minimal processing overhead.

Required Permissions

None - this endpoint requires no authentication.

Side Effects

None - this is a read-only health check that does not modify any data or state.

get/v2/liveness

Response

Service is healthy and ready to process requests. Returns 'OK' message for normal operation.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "message": "OK"
  }
}