Skip to main content
GET
/
v1
/
health
Get API health status
curl --request GET \
  --url https://api.botdog.co/v1/health \
  --header 'x-api-key: <api-key>'
{
  "status": "ok",
  "timestamp": "2023-04-02T12:00:00.000Z",
  "uptime": 3600,
  "memoryUsage": {
    "rss": 47378432,
    "heapTotal": 23068672,
    "heapUsed": 11601456,
    "external": 1789775,
    "arrayBuffers": 1064517
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.botdog.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
default:bd_live_your_key_here
required

Response

The API is healthy

​
status
string
required

Current status of the API

Example:

"ok"

​
timestamp
string
required

Current server timestamp

Example:

"2023-04-02T12:00:00.000Z"

​
uptime
number
required

Server uptime in seconds

Example:

3600

​
memoryUsage
object
required

Memory usage statistics