API V1 / Heartbeats / Pause

Pause or resume one heartbeat. Set paused to true to pause monitoring, or false to resume. Resuming requires available heartbeat capacity.

Endpoint

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

Request

Key fields

`guid` key	Heartbeat id.
`paused` key	`true` to pause, `false` to resume.

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

Response

Top level

`ok`	Always `true` on success.
`heartbeat`	Pause result. Fields below apply to `heartbeat`.
`capacity`	Heartbeat quota for the account.
`rate_limit`	Rate limit state for the tier this endpoint consumes. Present on every successful response.

heartbeat

`guid`	Heartbeat id.
`paused`	Echoes the requested pause state.

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, "heartbeat": { "guid": "550e8400-e29b-41d4-a716-446655440000", "paused": true }, "capacity": { "limit": 5, "used": 1, "remaining": 4 }, "rate_limit": { "tier": 1, "cost": 1, "timeframe": "minute", "limit": 60, "used": 12, "remaining": 48 } }