Uptimeify
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 are served from your installation base URL under:

https://YOUR_HOST/api

Authentication

The API uses Bearer Token authentication. To get started:

  1. Log in to your Uptimeify dashboard.
  2. Go to Admin > 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

Token Scopes (Organization vs Customer)

When creating an API token, you can optionally scope it to a single customer.

  • Organization-wide tokens can access resources across all customers in your organization.
  • Customer-scoped tokens can only access websites and maintenance windows that belong to that customer.

If a customer-scoped token tries to access a website outside its scope, the API returns 403 Forbidden.

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 by setting the website status to inactive (or use maintenance if you want to mark it explicitly as maintenance):

curl -X PATCH https://YOUR_HOST/api/websites/123 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "status": "inactive" }'

Resume monitoring:

curl -X PATCH https://YOUR_HOST/api/websites/123 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "status": "active" }'

4. Maintenance Windows

Create a maintenance window for a website:

curl -X POST https://YOUR_HOST/api/maintenance-windows \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "websiteId": 123,
    "name": "Deployment",
    "startTime": "2026-01-06T10:00:00Z",
    "endTime": "2026-01-06T10:15:00Z"
  }'