API Monitoring Quick Setup Guide

This guide walks you through creating your first API monitoring check in UptimeDock. You'll learn how to configure HTTP requests, add custom headers, send POST data, and validate response content.

Prerequisites

Before you begin, make sure you have:

• An active UptimeDock account
• The API endpoint URL you want to monitor
• Any required authentication tokens or API keys
• Sample request payload (if monitoring POST/PUT endpoints)

Step 1: Select Check Type

Navigate to the Create New Check page. From the check type selection screen, find the Website Monitoring category and click Continue on the API card.

Step 2: Basic Configuration

Configure the basic settings for your API monitoring check:

Select the appropriate HTTP method based on your API endpoint:

Step 3: Choose Monitor Regions

Select the geographic regions from which UptimeDock will monitor your API:

You can select individual locations, entire regions, or click Select all regions for comprehensive global coverage. Monitoring from multiple regions helps detect regional issues and provides a better picture of global API performance.

Step 4: Verification Options

Configure verification settings to reduce false positives:

Step 5: Configure Post Data

If your API endpoint requires a request body (for POST, PUT, or PATCH methods), expand the Post Data section.

First, select the content type from the dropdown:

After selecting a content type, enter your request body in the text area. For example, a JSON login request:

{
  "email": "monitor@example.com",
  "password": "your-secure-password"
}

Step 6: Add Request Headers

Many APIs require authentication or custom headers. Click New in the Request Headers section to add headers:

You can add multiple headers. Each header requires both a name and value. To remove a header, click the delete button next to it.

Step 7: Response Body Validation

Response body validation allows you to verify that your API returns expected content. This catches issues where an API returns HTTP 200 but with error content.

Toggle on Response Body Validation and configure:

Enter the validation text in the text area. When validation fails, UptimeDock marks the check as down and triggers your configured alerts.

Step 8: Configure Alerts

Expand the Alarms section to configure when you should be notified:

For each alert type, select the notification groups that should receive alerts. You can create notification groups in the Notifications section to define who gets notified via email, SMS, Slack, webhooks, and more.

Step 9: Schedule & Maintenance

Configure when monitoring should run and when to pause for maintenance:

Schedule

By default, monitoring runs 24/7. You can customize the schedule by selecting specific hours and days when monitoring should be active.

Maintenance Windows

Schedule planned maintenance periods when checks should be paused. During maintenance windows:

• No checks will be performed
• No alerts will be triggered
• Uptime statistics won't be affected

This is useful for scheduled deployments or planned API maintenance.

Step 10: Create Your Check

Review your configuration and click the Create button at the bottom of the page. Your API monitoring check will be created and will start collecting data immediately.

What's Next?

Now that your API check is running, explore these resources:

• API Monitoring Overview – Learn about all available features
• Website Monitoring – Monitor web pages alongside your APIs