Health check

GET
https:/api.example.com/v1/health

Check the health status of the API

Response

API is healthy
  • status
    enum
    Required
    Overall health status
    • healthy
      string
    • unhealthy
      string
  • timestamp
    string
    Required
    When the health check was performed
  • version
    string
    Required
    API version
  • uptime
    number
    Required
    API uptime in seconds
Example request
curl --request \
--url https://api.example.com/v1 \
--header 'accept: application/json'
Example response
{
"status": "healthy",
"timestamp": "2019-08-24T14:15:22Z",
"version": "string",
"uptime": 0
}
Refresh tokenUser
Built with