health

Get API health status

get/v1/health

Request

  • Base URL: https://api.botdog.co
  • URL: https://api.botdog.co/v1/health
  • Auth: none declared

Response

The API is healthy

statusstring required

Current status of the API

timestampstring required

Current server timestamp

uptimenumber required

Server uptime in seconds

Example response

{
  "status": "ok",
  "timestamp": "2023-04-02T12:00:00.000Z",
  "uptime": 3600,
  "memoryUsage": {
    "rss": 47378432,
    "heapTotal": 23068672,
    "heapUsed": 11601456,
    "external": 1789775,
    "arrayBuffers": 1064517
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.