Groups / Get

Fetch one group by guid.

Endpoint

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

Request

Key fields

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

Response

Top level

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

group

guid Group id.
name Group name.
color_hex Hex color like #336699, or null when unset.
monitor_count Monitors in this group.
heartbeat_count Heartbeats in this group.

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, "group": { "guid": "550e8400-e29b-41d4-a716-446655440000", "name": "Production", "color_hex": "#336699", "monitor_count": 4, "heartbeat_count": 1 }, "rate_limit": { "tier": 3, "cost": 1, "timeframe": "minute", "limit": 300, "used": 45, "remaining": 255 } }