13.1What you can do with the API
With an API key (a secret code that lets a script act for your team), you can:
- list, create, change, pause and delete monitors,
- read check results, uptime and response times,
- run a check now, for example after a deploy,
- list and acknowledge incidents, set reminders, and see why nobody was alerted,
- manage alert channels, secrets, maintenance windows and your status page,
- read your plan limits and how much of them you use.
A key can do what a team member can, with a few exceptions. Section 13.2 lists them.
Every call (one action, such as ListMonitors) has its own address. It has this form:
https://www.obsrvly.com/api/gw/<area>/obsrvly.v1.<Service>/<Call>Use these values for <area> and <Service>:
| <area> | <Service> | What it covers |
|---|---|---|
monitor | MonitorConfigService | Monitors, alert channels, secrets, maintenance windows, the status page, plan limits, regions |
result | ResultService | Check results, uptime and response times |
alert | AlertService | Incidents, acknowledging them, the alert policy, why nobody was alerted |
notification | NotificationService | The notification log, test alerts |
scheduler | SchedulerService | Run a check now, see when a monitor runs next |