---
title: "Get API health status"
method: GET
path: "/v1/health"
tags: ["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 `200`

The API is healthy

- HealthCheckResponse
  - `status` string, required: Current status of the API
  - `timestamp` string, required: Current server timestamp
  - `uptime` number, required: Server uptime in seconds
  - `memoryUsage` MemoryUsage, required
    - `rss` number, required: Resident Set Size - total memory allocated for the process execution
    - `heapTotal` number, required: Total size of the allocated heap
    - `heapUsed` number, required: Actual memory used by the heap
    - `external` number, required: Memory used by C++ objects bound to JavaScript objects
    - `arrayBuffers` number: Memory allocated for ArrayBuffers and SharedArrayBuffers

---

[API](https://skmtc.dev/botdog/apis/botdog-api.md) · [All operations](https://skmtc.dev/botdog/apis/botdog-api/llms.txt) · [OpenAPI document](https://skmtc.dev/botdog/apis/botdog-api/revisions/6c0213d8a608?raw)