API V1 / Heartbeats / Get

Fetch one heartbeat by guid. Does not include status; use /heartbeats/status for that.

Endpoint

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

Request

Key fields

guid key Heartbeat id.

{ "guid": "550e8400-e29b-41d4-a716-446655440000" }

Response

Top level

`ok`	Always `true` on success.
`heartbeat`	Full heartbeat object. Fields below apply to `heartbeat`.
`rate_limit`	Rate limit state for the tier this endpoint consumes. Present on every successful response.

heartbeat

`guid`	Heartbeat id.
`name`	String, max 255 characters.
`url`	URL your job should call on schedule.
`group_id`	Integer group id, or `0` for none.
`tag_ids`	Array of integer tag ids.
`alert_channel_keys`	Array of alert channel key strings.
`paused`	`true` when monitoring is paused.

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, "heartbeat": { "guid": "550e8400-e29b-41d4-a716-446655440000", "name": "Nightly backup", "url": "https://example.com/heartbeats/550e8400-e29b-41d4-a716-446655440000", "group_id": 0, "tag_ids": [], "alert_channel_keys": [], "paused": false }, "rate_limit": { "tier": 3, "cost": 1, "timeframe": "minute", "limit": 300, "used": 45, "remaining": 255 } }