Skip to content

Commit 037683c

Browse files
committed
docs: note the new /heartbeat endpoint
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
1 parent d8aef5a commit 037683c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/reference/api.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -824,6 +824,24 @@ Delete another user's API key.
824824

825825
---
826826

827+
## Health Endpoints
828+
829+
### Heartbeat
830+
831+
**Endpoint:** `GET /heartbeat`
832+
833+
Returns a minimal response to confirm the service is up.
834+
835+
**Response:** `200 OK`
836+
837+
```json
838+
{
839+
"status": "ok"
840+
}
841+
```
842+
843+
---
844+
827845
## Authentication Methods
828846

829847
The API supports two authentication methods:

0 commit comments

Comments
 (0)