Quick start

Get started with the Uptime Monitor API

Follow this guide to provision an API key, send your first request, and understand the basic tooling needed to build integrations.

1. Enable API access

  1. Log in to your account dashboard.
  2. Open Account → API keys.
  3. Click Generate key, choose a descriptive name, and copy the value immediately.
  4. Store the key securely (for example in your secrets manager). Rotate keys regularly.

The plaintext API key is shown only once at creation time. If you misplace it, revoke the old key and create a new one.

2. Install tooling

You can interact with the API using any HTTP client. Popular choices include curl, HTTPie, and programming-language SDKs such as Axios (JavaScript) or Requests (Python).

For development, ensure you have network access to https://xuptimemonitor.com or your staging environment.

3. Make your first request

Use the Authorization: Bearer header to authenticate. Here’s how to fetch your monitors: 

curl https://xuptimemonitor.com/api/v1/monitors \
  -H "Authorization: Bearer <API_KEY>"

Replace <API_KEY> with the value you generated. A 200 OK response means everything is working.

4. Understand limits and headers

Every response includes X-API-* headers. Track them to avoid hitting your monthly request limit.

  • X-API-Limit: Maximum requests allowed this month.
  • X-API-Usage: Current usage at the account level.
  • X-API-Remaining: Remaining requests (only when a limit applies).
  • X-API-Reset: When counters reset (UTC).

See the Authentication guide for details on handling 401 and 429 responses.

5. Next steps

  • Review the endpoint directory.
  • Set up alerts or dashboards using the data returned by the API.
  • Automate API key rotation and usage monitoring within your platform.