Health

Health check endpoints for monitoring service availability

Public health check

get

Returns the health status of the API. No authentication required.

Responses

200

Service is healthy

application/json

get

/health

CLIFetch

curl https://api.avo.so/health

200

Service is healthy

{
  "status": "healthy",
  "timestamp": "2025-12-27T07:51:02.617Z",
  "uptime": 91.807410068
}

Public ping endpoint

get

Simple ping endpoint to check if the service is reachable. No authentication required.

Responses

200

Pong response

text/plain

ResponsestringExample: pong

get

/ping

CLI

curl https://api.avo.so/ping

200

Pong response

pong

Authenticated health check

get

Returns detailed health status of the API gateway. Requires authentication.

Authorizations

bearerAuth

AuthorizationstringRequired

JWT token for authentication

Responses

200

Service is healthy

application/json

401

Authentication required or invalid token

application/json

get

/api/health

CLI

curl https://api.avo.so/api/health \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "success": true,
  "message": "Health check successful!",
  "uptime": "3600 seconds",
  "timestamp": "2025-01-15T10:30:00.000Z"
}