3.3 Keep Alive

A liveness check, called periodically — every few seconds — to confirm your API is still responding.

3.3.1 Check the API is alive

Method and URL:

GET /keep_alive

Return Data: an object with a flag indicating the state of the API.

is_alive [ boolean ]:

Whether the API is healthy and able to serve requests.

Example output data:

{
    "is_alive": true
}

Because this endpoint is polled frequently, it should be cheap. If your API is degraded but still able to respond, returning false is more useful to us than timing out.