Skip to main content
GET
/
api
/
v1
/
health
Health check
curl --request GET \
  --url http://localhost:3000/api/v1/health \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "data": {
    "status": "<string>",
    "version": "<string>",
    "uptime": 123
  }
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token. Configure via the apiKeys field in polpo.json or the POLPO_API_KEY environment variable.

Response

200 - application/json

Server status, version, uptime

ok
boolean
required
data
object
required