API Documentation

Overview of the REST API. Select a resource from the left.

Base URL

All examples use a placeholder base URL:

BASE_URL="https://uptimeify.io"

Authentication

Most endpoints require authentication.

TOKEN="wsm_<your-api-token>"
curl -H "Authorization: Bearer $TOKEN" "$BASE_URL/api/websites"

API tokens generated in the dashboard always start with wsm_. Make sure you include the full token (including the prefix), otherwise the API will return 401 Unauthorized.

Responses and Errors

• 2xx indicates success
• 4xx indicates a request/auth problem
• 5xx indicates a server error

Example error response:

{
    "statusCode": 401,
    "statusMessage": "Unauthorized"
}