50% bonus credits + 2x signup credits View Offer
Navigation
Coming Soon -This feature is currently in development. Details may change before release.

How do I use the UpCanary API?

Programmatic access to UpCanary for managing monitors, status pages, and incidents.

The UpCanary REST API is planned for a future release. It will give you full programmatic control over your monitoring setup - useful for infrastructure-as-code workflows, custom dashboards, and automated incident management.

What the API Will Cover

The initial API release is planned to include:

Monitors

  • Create, read, update, and delete monitors
  • Pause and resume monitors
  • Retrieve check history and response time data

Status Pages

  • Create and update status pages
  • Add, update, and remove components
  • Update component status manually (for scheduled maintenance notices)

Incidents

  • Create and resolve incidents
  • Post incident updates
  • Retrieve incident history

Billing

  • Query current credit balance
  • Retrieve usage breakdown by monitor

Monitors

The monitors endpoints will let you manage your entire monitoring configuration programmatically. This includes creating new HTTP, TCP, or other monitor types with the same configuration options available in the dashboard - check interval, expected response, alert thresholds, and so on. You will be able to retrieve check history and response time data for individual monitors, which is useful for feeding uptime metrics into internal dashboards or SLA reporting tools.

Pause and resume operations will let you integrate monitor state changes into your deployment workflows. For example, you could pause a monitor during a planned maintenance window triggered by your CI/CD pipeline and automatically resume it once the deployment is complete.

Status Pages

The status pages endpoints will support the full lifecycle of a status page from creation through ongoing maintenance. You will be able to create new pages, configure their components, and update component statuses in real time. Updating component status via the API is particularly useful for automated maintenance workflows - for example, a deployment script that sets a component to “Under Maintenance” at the start of a release and restores it to “Operational” once the deployment succeeds.

Incidents

The incidents endpoints will allow you to open, update, and resolve incidents from external systems. This enables integration with your existing alerting or on-call tools - for example, automatically opening an incident on your status page when a specific alert fires in a third-party monitoring tool, or posting a resolution update when a PagerDuty incident is closed.

Retrieving incident history will support reporting and audit use cases, such as calculating mean time to resolution across a time period or generating post-incident review data.

Billing

The billing endpoints will give you programmatic visibility into your credit usage. You will be able to query your current balance and retrieve a usage breakdown by monitor, which is helpful for cost allocation across teams or projects that share a single UpCanary workspace.

Authentication

Authentication will use API keys generated from your account settings. Each key will be a long-lived credential that you include in the Authorization header of every request.

Key scoping is planned so that you can create keys with restricted permissions - for example, a read-only key for a dashboard integration that should not be able to create or modify resources. This limits the blast radius if a key is accidentally exposed. You will be able to create multiple keys and revoke individual keys from account settings without affecting other integrations.

All requests must be made over HTTPS. Requests made over plain HTTP will be rejected.

Rate Limiting

Rate limiting is planned for the API to ensure fair usage and platform stability. The specific limits per plan have not been finalized, but the API will return standard HTTP 429 responses when a rate limit is exceeded, along with headers indicating when the limit resets. Integrations should be built to handle 429 responses gracefully by backing off and retrying.

Planned Availability

API access is planned to be available on the Enterprise plan. Starter and Pro plan availability may follow in later releases.

Authentication will use API keys generated from your account settings. All requests will be made over HTTPS with JSON request and response bodies.

Stay Updated

The API is actively being planned. To be notified when it launches:

  • Watch the UpCanary changelog for announcements
  • Contact us through the app if you have specific API use cases - early feedback helps shape the feature

If you have an urgent integration need in the meantime, reach out through the app to discuss what is possible.