Developer Documentation

Authentication

Uptime monitoring without blind spots

Open API Settings View Rate Limits

Creating API Keys

UptimeGuard uses bearer tokens to authorize all client requests. Generate and manage keys directly from your workspace dashboard.

Navigate to Settings > API Access. Click "Generate New Key", assign a descriptive name such as "Production Monitor v2", and select the appropriate scope. Copy the 64-character string immediately; it will not be displayed again. Live keys are prefixed with `ug_live_` while sandbox keys use `ug_test_`.

Read-Only Scope

Grants access to uptime status, incident history, and webhook logs. Cannot modify monitors, adjust thresholds, or access billing data.

Admin Scope

Full control over monitor configuration, team invites, and API rate limit adjustments. Recommended for CI/CD pipelines and infrastructure scripts.

Security Rules

Protect your workspace by following these token management and access control guidelines.

UptimeGuard enforces strict origin validation and automatic token rotation. Never commit keys to public repositories, embed them in client-side JavaScript, or share them via unencrypted channels. Rotate credentials every 90 days or immediately after team member departure.

Rate Limits

Standard tier: 1,200 requests per minute. Enterprise tier: 5,000 requests per minute. Exceeding limits triggers a 429 status with a Retry-After header.

Audit Logs

Every authenticated request logs the originating IP, timestamp, and accessed endpoint. Review activity under Security > API Audit Trail.

Token Expiration

Live tokens do not expire by default. Test tokens expire after 24 hours. Use the dashboard to revoke compromised keys instantly.

Request Headers

Attach your token to every API call using the standard Authorization header.

UptimeGuard expects the header `Authorization: Bearer `. Do not URL-encode the token or append it to query parameters. Include `Content-Type: application/json` for POST and PUT requests. All endpoints require HTTPS; unencrypted calls return 403 Forbidden.

cURL Example

curl -X GET "https://api.uptimeguard.io/v1/monitors" -H "Authorization: Bearer ug_live_8f3a9c2d1e4b5f6a7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3