Quickstart Guide | 5-Minute Setup

Real-time monitoring for zero-downtime guarantees

Step 1

Prerequisites

Before initializing your first monitor, ensure your environment meets these baseline requirements.

Active UptimePulse Account

You'll need a registered account with at least one project workspace. Free tier accounts support up to 3 active endpoints and 10GB of monthly log retention.

Terminal Access

A POSIX-compatible shell (bash, zsh) or Windows PowerShell with cURL v7.80+ installed. OpenSSL support must be enabled for HTTPS probe validation.

Target Endpoint

A publicly accessible HTTPS service returning a 2xx status code. Internal staging URLs require a VPS bridge or port-forwarded tunnel.

Step 2

API Key Setup

Generate a programmatic access token scoped to your primary workspace. Navigate to Settings → Developer → API Keys, click Create New Key, and assign the monitor:write permission. Store the resulting key as an environment variable to prevent credential leakage in version control.

export UPTIMEPULSE_API_KEY="up_pk_live_8f3a9c2d1e7b4f6a0d5c8e2b1a9f7d3c"

Verify the variable is correctly loaded by running echo $UPTIMEPULSE_API_KEY in your terminal. The token should print exactly as generated without truncation.

Step 3

cURL Example

Deploy your first HTTP monitor by sending a structured JSON payload to the UptimePulse v2 endpoints API.

curl -X POST https://api.uptimepulse.io/v2/monitors \
  -H "Authorization: Bearer $UPTIMEPULSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "checkout-api-prod",
    "url": "https://api.aurorashop.io/v1/health",
    "interval_seconds": 60,
    "expected_status": 200,
    "alert_channels": ["slack-ops-main", "pagerduty-critical"],
    "tags": ["production", "ecommerce", "node-18"]
  }'

This request registers a 60-second polling cycle targeting your checkout service. UptimePulse automatically assigns a unique monitor ID and returns a 201 Created response with the new resource URI.

Step 4

Verification

Confirm your monitor is active by querying the dashboard API or checking your configured alert channels. Within 90 seconds, you should receive an initial status ping.

curl -X GET "https://api.uptimepulse.io/v2/monitors/checkout-api-prod/status" \
  -H "Authorization: Bearer $UPTIMEPULSE_API_KEY"

A successful response returns a JSON object with "state": "operational" and a "last_checked_at" timestamp. If the status reads "pending", allow up to 120 seconds for the global probe network to complete its first handshake across Frankfurt, Ashburn, and Singapore nodes. Need to adjust thresholds or add SSL expiry tracking? Use the Dashboard Editor or explore our Advanced Webhooks Guide.