API Documentation

Build integrations with the Uptime Monitor API

Welcome to the public API reference. Here you will find authentication, rate limits, response formats, and every endpoint under /api/v1.

Authentication guideBrowse endpoints

Plan and product context

Before diving into endpoints, use these pages to compare uptime monitoring features, pricing, and rollout expectations.

Feature overviewReview monitoring, alerting, and status page capabilities first.Pricing plansCompare limits and choose the plan that fits your monitoring footprint.FAQCheck common implementation and billing questions before rollout.

Base URL & versioning

All client integrations should use the following base URL. Versioning is handled via the path to keep future releases backwards compatible.

Production
https://xuptimemonitor.com/api/v1

Authentication overview

Every request must include a valid API key generated from your dashboard. Requests without a key receive 401 Unauthorized.

Learn how to create keys, send them with requests, and interpret rate-limit headers on the authentication page.

Product guides

Learn the dashboard end-to-end—perfect for onboarding teammates fast.

Dashboard walkthrough

Step-by-step guide to creating monitors, deploying server agents, and publishing status pages.

Read the guide →

API quickstart

Generate keys, send your first request, and understand rate-limit headers.

View quickstart →

How-to tutorials

Short, action-oriented guides for the most common tasks.

Create a monitorAdd an HTTP/API check with tags and alerts.Use self-hosted clientsInstall private runners and choose when to combine with server agents.Install a server agentGenerate the install script, run with sudo, and verify heartbeats.Manual server agent installDownload the installer, skip systemd, and run without sudo.Update a server agentRe-run the install command safely to upgrade.Uninstall a server agentRemove the service and clean up the dashboard entry.Configure a status pageBrand it, choose components, and tune error budgets.Publish an incidentCreate, update, and resolve incidents with timelines.Post announcementsShare maintenance/FYIs without raising incidents.Download status reportsExport uptime, incidents, and error budget burn.

Quick start

  1. Log into your dashboard and open Account → API keys.
  2. Create an API key and copy the value (it is shown only once).
  3. Call the API using the Authorization: Bearer (key) header or any supported alternative.
  4. Inspect the X-API-* headers to monitor usage.

Sample request

Fetch the first 25 monitors for your account:

curl https://xuptimemonitor.com/api/v1/monitors?limit=25 \
  -H "Authorization: Bearer <YOUR_API_KEY>"

Response conventions

HTTP status codes

  • 200 – Success
  • 400 – Validation error (check message)
  • 401 – Missing or invalid API key
  • 429 – Monthly request limit reached
  • 500 – Unexpected server error

Error payload shape

Errors follow a consistent structure to simplify client handling:

{
  "statusCode": 401,
  "statusMessage": "Unauthorized",
  "data": {
    "reason": "API key missing or invalid"
  }
}

Grafana dashboardsNew

Connect Grafana to your account with an API key and visualize monitor status, latency, and uptime history with your own panels.

Grafana setup guide

Jira integrationNew

Automatically open Jira Service Management issues whenever a monitor goes down. Connect your Atlassian site, pick the right project, and control ticket fields.

Jira setup guide

Slack alertsNew

Send rich outage notifications directly to your team’s Slack channels. Generate incoming webhooks, customise alert templates, and keep sensitive data private.

Slack integration guide

Twitter alertsNew

Broadcast downtime notices from your official Twitter account. Collect the handle, generate a bearer token, and tailor the alert template before posting.

Twitter integration guide

Discord alerts

Post real-time downtime notifications into your Discord server. Create a webhook, customise alert messages, and test the integration safely.

Discord integration guide

Endpoints at a glance

  • GET/api/v1/monitors

    List monitors for the authenticated account.

    View details
  • GET/api/v1/monitors/:monitor/history

    Fetch time-series checks for one monitor owned by the authenticated account.

    View details