API Documentation

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

AI / LLM Text Exports

• LLMS index for AI agents
• LLMS full reference for AI ingestion
• German LLMS index for AI agents
• German LLMS full reference for AI ingestion

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.

UUID Path Parameters

For migrated resources, path parameters use the resource publicId UUID in the docs and examples.

• Use UUIDs for endpoint paths such as /api/websites/:websitePublicId, /api/customers/:customerPublicId, /api/organizations/:organizationPublicId, /api/incidents/:incidentPublicId, /api/customer-ips/:customerIpPublicId, /api/customer-domains/:customerDomainPublicId, and monitor-specific :...PublicId parameters.
• Internal numeric id fields may still appear in response payloads for internal references.
• Query/body fields like customerId, websiteId, or organizationId stay numeric unless the endpoint page explicitly says otherwise.

Responses and Errors

• 2xx indicates success
• 4xx indicates a request/auth problem
• 5xx indicates a server error
• Error codes and known API pitfalls

Example error response:

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