Getting Started with the UptimeKeeper API

Welcome to the UptimeKeeper API!

This guide will help you get started with using the UptimeKeeper API. We’ll walk you through authentication, making your first API calls, and understanding the response formats.

Authentication

  1. Generate an API key from your UptimeKeeper dashboard under Settings > API
  2. Include your API key in the request header as X-API-Key: your_api_key
  3. All API requests must use HTTPS

Base URL

All API requests should be made to:

https://api.uptimekeeper.com/v1

Making Your First API Call

Here’s a simple example to retrieve your monitors using cURL:

curl -X GET "https://api.uptimekeeper.com/v1/monitors" \
  -H "X-API-Key: your_api_key"

Response Format

The API returns responses in JSON format. A typical successful response looks like:

{
  "success": true,
  "data": { ... },
  "meta": { ... }
}

Next Steps

Now that you’re familiar with the basics, you might want to: