Skip to main content
Basic health check
curl --request GET \
  --url http://localhost:3001/health
{
  "status": "ok"
}

Headers

Accept
enum<string>

Response format selector. Set to application/x-protobuf for Protobuf encoding; any other value (or absent) returns JSON.

Available options:
application/json,
application/x-protobuf

Response

Service is accepting connections.

Minimal health indicator returned by GET /health.

status
string
required

Always "ok" when the HTTP server is accepting connections.

Example:

"ok"