Uptimeify Docs

Appearance

Introduction ​

Welcome to the Uptimeify API documentation. This API allows you to programmatically manage your monitoring infrastructure, including organizations, customers, websites, and alerts.

Base URL ​

All API requests should be made to the following base URL:

https://uptimeify.io/api

Authentication ​

The API supports Bearer Token authentication for API integrations.

Generating an API Token ​

  1. Log in to your Uptimeify dashboard.
  2. Navigate to Organization Settings > API Tokens.
  3. Click Create Token, give it a name, and copy the generated secret.

Include the token in the Authorization header of your requests:

http
Authorization: Bearer <your_api_token>

Note: Session-based authentication (cookies) is used for the browser interface but is not recommended for API integrations.

Response Format ​

All responses are returned in standard JSON format.

Success Response ​

json
{
  "id": 123,
  "name": "Example Resource",
  "createdAt": "2023-01-01T12:00:00Z"
}

Error Response ​

Errors are returned with an appropriate HTTP status code and a JSON body containing details.

json
{
  "statusCode": 400,
  "statusMessage": "Bad Request",
  "message": "Validation failed: 'url' is required."
}

Rate Limiting ​

To ensure service stability, the API is rate-limited.

  • Limit: 100 requests per minute per IP.
  • Header: X-RateLimit-Remaining indicates your remaining quota.
  • Exceeded: Returns 429 Too Many Requests.