Skip to main content

Phoenix Alerts Management API

Index of the Phoenix Alerts Management API reference: the ten articles covering authentication, account resources, and sending alerts in.

D
Written by Dave Rochwerger

The Phoenix Alerts Management API is a REST API for configuring your account: services, teams, users, on-call schedules, and escalation policies. Requests use a management key (pm_ prefix) sent as an Authorization: Bearer header. Sending alerts in from a monitoring tool uses a separate, more narrowly scoped ingestion key — see Sending alerts below.

  1. Getting started with the Phoenix Alerts API — Base URL, authentication, and the error format shared by every Management API request.

  2. API keys — Create, list, rotate, and revoke API keys, and the difference between ingestion and management keys.

  3. Services — Create, update, and delete services, the alert-routing targets that belong to a team.

  4. Teams and members — Create teams and manage their membership and roles.

  5. Users and contact methods — Create users, add and verify their contact methods, and list them.

  6. Schedules and on-call — Set up a team's on-call schedule, see who is on call, and create overrides.

  7. Escalation policies — Create escalation policies and steps that control who gets paged and when.

  8. Maintenance windows — Suppress alert paging for one or more services during planned maintenance.

  9. Alerts — List, view, acknowledge, resolve, reroute, and escalate alerts, and view their event timeline.

  10. Sending alerts — Send alerts in from a monitoring tool, deduplicate repeats, and resolve them automatically.

Did this answer your question?