Alerts / Get

Fetch one alert channel by channel_key.

Endpoint

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

Request

Key fields

channel_key key Alert channel key. Built-in email is email; custom channels use {type}:{guid} (for example discord:550e8400-e29b-41d4-a716-446655440000).
{ "channel_key": "discord:550e8400-e29b-41d4-a716-446655440000" }

Response

Top level

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

alert_channel

guid Alert channel id. Built-in email uses 00000000-0000-0000-0000-000000000001.
channel_type Channel type.
channel_key Key for alert_channel_keys on monitors and heartbeats.
name Channel name. For built-in email, the account owner address.
system true for the platform email channel. Cannot be created, updated, paused, or deleted.
paused true when delivery is paused.
monitor_count Monitors linked to this channel.
heartbeat_count Heartbeats linked to this channel.
webhook_url Present for discord, slack, teams, and webhook.
bot_token Present for telegram.
chat_id Present for telegram.
auth_bearer Optional bearer token for webhook.
signing_secret Optional signing secret for webhook.

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, "alert_channel": { "guid": "550e8400-e29b-41d4-a716-446655440000", "channel_type": "discord", "channel_key": "discord:550e8400-e29b-41d4-a716-446655440000", "name": "Ops Discord", "paused": false, "monitor_count": 3, "heartbeat_count": 1, "webhook_url": "https://discord.com/api/webhooks/1234567890/example-token" }, "rate_limit": { "tier": 3, "cost": 1, "timeframe": "minute", "limit": 300, "used": 45, "remaining": 255 } }