Uptimeify Logo
Back to Knowledge Hub

API Access

Uptimeify provides a comprehensive REST API that allows you to automate your monitoring workflow. You can programmatically create websites, manage alerts, and retrieve status reports.

Getting Started

Base URL

All API requests should be directed to:

https://uptimeify.io/api

Authentication

The API uses Bearer Token authentication. To get started:

  1. Log in to your Uptimeify dashboard.
  2. Go to Organization Settings > API Tokens.
  3. Click Create Token.
  4. Copy the generated token immediately (it won't be shown again).

Include this token in the Authorization header of your HTTP requests:

Authorization: Bearer YOUR_API_TOKEN

Common Use Cases

1. Syncing Inventory

Automatically add new customer websites to Uptimeify when they sign up for your service.

curl -X POST https://uptimeify.io/api/websites \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://new-customer.com",
    "name": "New Customer Site"
  }'

2. Fetching Status

Retrieve the current status of all your monitors to display on your own internal dashboard.

curl https://uptimeify.io/api/websites \
  -H "Authorization: Bearer YOUR_TOKEN"

3. Maintenance Mode

Script your deployment pipeline to automatically pause monitoring before a deployment and resume it afterwards.

# Pause Monitoring
curl -X PATCH https://uptimeify.io/api/websites/123 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{ "active": false }'

Rate Limits

To ensure stability, API access is rate-limited. Please refer to the response headers X-RateLimit-Limit and X-RateLimit-Remaining for your current status.