Health

Health commands

Check if the server is up and responding

get

Returns a 200 OK if the server can be reached

Responses

200

Successful operation

application/jsonapplication/xml

statusstringOptionalExample: OK

get

/api/healthy

HTTPcURLJavaScriptPython

GET /api/healthy HTTP/1.1
Accept: */*

200

Successful operation

{
  "status": "OK"
}

Check if the server can connect to all its dependencies

get

Returns a 200 OK if the server can reach all its dependencies like databases, RabbitMQ and OpenSearch.

Responses

200

Successful operation

application/jsonapplication/xml

statusstringOptionalExample: OK

get

/api/ready

HTTPcURLJavaScriptPython

GET /api/ready HTTP/1.1
Accept: */*

200

Successful operation

{
  "status": "OK"
}