Skip to main content

Overview

The Beepr Management API allows you to programmatically manage your monitors and alert groups. This is useful for:

  • Infrastructure as Code: Integrate with Ansible, Terraform, or other automation tools
  • CI/CD pipelines: Automatically create monitors for new deployments
  • Custom integrations: Build your own tooling around Beepr

API Reference​

The full API specification is available as an OpenAPI document at:

https://beepr.io/api/v1/openapi

You can use this with tools like Swagger UI or import it into API clients like Postman or Insomnia.

Base URL​

All API endpoints are under:

https://beepr.io/api/v1

Available Resources​

ResourceDescription
Alert GroupsManage alert groups and their members
HTTP MonitorsCreate and manage HTTP/API monitors
Cron MonitorsCreate and manage cron job monitors
Webhook MonitorsCreate and manage webhook/error monitors

Requirements​

The Management API is available on Pro, Teams, Business, and Partner plans. You'll need to create an API key from the web interface to get started.

Quick Example​

Here's a simple example using curl to list your alert groups:

curl -H "Authorization: Bearer bpr_your_api_key_here" \
https://beepr.io/api/v1/alert_groups