API Overview

The Uptime REST API lets you programmatically manage monitors, alerts, status pages, and more.

Last updated: 2026-09-05

The Uptime API is a RESTful API that allows you to manage all aspects of your monitoring infrastructure programmatically.

Base URL

All API requests should be made to:

https://uptime.sergiodxa.com/api/v1

Authentication

All API requests require authentication via an API key passed in the Authorization header. See Authentication for details on generating and using API keys.

Response Format

All responses are returned as JSON. Successful responses include a data field, while error responses include an error field with details about what went wrong. See Errors for the complete error format and status codes.

Identifiers

Every resource is identified by a prefixed string such as mon_01h455vb4pex5vsknk084sn02q. The prefix names the kind of resource the id points at — mon_ for an HTTP monitor, alt_ for an alert, sp_ for a status page — and each resource page lists the prefix it uses.

Send these ids back exactly as you received them, in both path segments and request bodies. An id whose prefix names another resource is refused rather than resolved, so a monitor id can never be mistaken for an alert id. Endpoints answer 400 VALIDATION_ERROR for an id they cannot read, except where a resource page documents otherwise.

Available Resources

  • Status - Check API health and your account status

  • Ping - Run a one-off HTTP, DNS or TCP check without creating a monitor

  • HTTP Monitors - Monitor websites and HTTP endpoints

  • DNS Monitors - Watch a domain's DNS records for changes

  • TCP Monitors - Monitor TCP ports and services

  • Flow Monitors - Run a multi-request spec on a schedule

  • Cron Jobs - Monitor scheduled tasks and cron jobs

  • Alerts - Configure alert channels and notifications

  • Status Pages - Manage public and private status pages

  • Maintenance Windows - Schedule maintenance periods

  • Team - Manage team members and permissions

  • Invites - Send and manage team invitations

  • API Keys - Create and revoke API keys

Pagination

Every endpoint that returns a list serves one page at a time and advertises the next in the Link header. See Pagination for how to walk a list from end to end.

Rate Limits

API requests are subject to rate limiting based on your plan. See Rate Limits for details on limits and how to handle rate limit errors.