Heartbeats / Status

Current status for one heartbeat. Lighter than get; returns only guid and status.

Endpoint

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

Request

Key fields

guid key Heartbeat id.
{ "guid": "550e8400-e29b-41d4-a716-446655440000" }

Response

Fields

ok Always true on success.
guid Heartbeat id.
status unknown, up, warn, down, or paused.
rate_limit Rate limit state for the tier this endpoint consumes. Present on every successful response.

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, "guid": "550e8400-e29b-41d4-a716-446655440000", "status": "up", "rate_limit": { "tier": 3, "cost": 1, "timeframe": "minute", "limit": 300, "used": 45, "remaining": 255 } }