Overview
AlertKick API (0.2.0)
Section titled “AlertKick API (0.2.0)”HTTP API for AlertKick uptime monitoring, heartbeats, and alerting.
Authentication
Most endpoints take an account API key in the X-API-Key header
(ak_...). Create one in AlertKick → Settings → API Keys. Keys are
scoped to a single tenant subdomain: call https://{tenant}.alertkick.com
with a key created on that tenant.
Heartbeat pings are the exception: /hb/ping/{uuid} takes the
heartbeat’s own scoped key in the X-Heartbeat-Key header (hb....),
which is safe to embed in cron jobs and scripts because it can only
record pings for that one heartbeat.
One-line heartbeat provisioning
GET /hb/auto/{slug} creates a heartbeat on first ping and just pings
it afterwards, so a script or an AI agent can add monitoring in a
single line:
curl -fsS -H "X-API-Key: $ALERTKICK_API_KEY" \
"https://acme.alertkick.com/api/v1/hb/auto/nightly-backup?interval=86400&grace=3600"- AlertKick: https://alertkick.com
- OpenAPI version: 3.0.3
Authentication
Section titled “ Authentication ”apiKey
Section titled “apiKey ”Account API key (ak_...) from Settings → API Keys.
Security scheme type: apiKey
Header parameter name: X-API-Key
heartbeatKey
Section titled “heartbeatKey ”Per-heartbeat ping key (hb....), returned when the heartbeat is created. Only valid for /hb/ping/{uuid} on that heartbeat.
Security scheme type: apiKey
Header parameter name: X-Heartbeat-Key