Skip to main content

API Reference

Monitor

Send heartbeat pings from your services. No API key required — each monitor has a unique URL token.

Send Heartbeat

POST /api/v1/monitor/heartbeat/:token URL Token 60 req/min

Records a heartbeat for a monitor, marking it as up. The token is unique per monitor and shown in the monitor settings.

No X-Api-Key header is needed. The monitor token in the URL acts as authentication.

Example

curl -X POST https://squirrelstack.app/api/v1/monitor/heartbeat/your_monitor_token

Success Response

{
  "status": "ok"
}

Error Response

Returns 404 Not Found with an empty body if the token is invalid or the monitor is inactive.