Heartbeats / List

List heartbeats for the authenticated account. Does not include status; use /heartbeats/status for that. Optionally filter by group_id and/or tag_id. When both are sent, only heartbeats that match both filters are returned.

Endpoint

Method POST
Url https://downdar.com/api/v1/heartbeats/list

Request

Body fields

group_id opt Positive integer group id. When set, only heartbeats in that group are returned.
tag_id opt Positive integer tag id. When set, only heartbeats with that tag are returned.
{ "group_id": 12, "tag_id": 4 }

Response

Top level

ok Always true on success.
heartbeats Array of heartbeat summary objects.
capacity Heartbeat quota for the account.
rate_limit Rate limit state for the tier this endpoint consumes. Present on every successful response.

heartbeats[]

guid Heartbeat id.
name Heartbeat name.
url URL your job should call on schedule.

capacity

limit Maximum heartbeats allowed on your plan.
used Heartbeats currently in use.
remaining Heartbeats you can still create.

rate_limit

tier Rate tier this endpoint counts against (1-5).
cost Units consumed by this request against the tier window.
timeframe Rolling limit window: second, minute, hour, or day.
limit Maximum units allowed in the timeframe for this tier on your plan.
used Units already used in the current window.
remaining Units left before this tier returns HTTP 429.
{ "ok": true, "heartbeats": [ { "guid": "550e8400-e29b-41d4-a716-446655440000", "name": "Nightly backup", "url": "https://example.com/heartbeats/550e8400-e29b-41d4-a716-446655440000" }, { "guid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "name": "Report generator", "url": "https://example.com/heartbeats/6ba7b810-9dad-11d1-80b4-00c04fd430c8" } ], "capacity": { "limit": 5, "used": 2, "remaining": 3 }, "rate_limit": { "tier": 2, "cost": 1, "timeframe": "minute", "limit": 120, "used": 73, "remaining": 47 } }