# Website Monitoring API Full Reference
> Expanded LLM-oriented export of the canonical REST API documentation, covering customer-facing, organization-scoped, and administrative workflows.

Canonical docs base: https://uptimeify.io/docs/api
Compact index: https://uptimeify.io/llms.txt
API base URL: https://uptimeify.io/api
Authentication: Bearer tokens generated in the dashboard. Tokens documented in the API reference usually start with wsm_.
Use this file when you need more context than llms.txt provides, but still want a text-first representation of the current API docs.

## Postman Collection Snapshot
Aligned with the bundled Postman collection "Uptimeify API Collection" (162 requests across 16 groups).
Description: Postman collection for the Uptimeify monitoring platform. Set {{baseUrl}} to your Uptimeify instance and provide {{apiToken}} for authenticated requests.

### Auth & Session
Requests: 1
Sample endpoints: GET /api/auth/get-session

### Configurations
Requests: 8
Sample endpoints: POST /api/maintenance-windows/check/batch | GET /api/maintenance-windows/check/:websiteId | POST /api/maintenance-windows

### Customer Management
Requests: 10
Sample endpoints: POST /api/customers/:customerPublicId/cancel | PATCH /api/customers/:customerPublicId | POST /api/customers

### Monitoring Data & Reports
Requests: 8
Sample endpoints: GET /api/websites/:websitePublicId/report.pdf | GET /api/websites/:websitePublicId/alert-history | GET /api/websites/:websitePublicId/check-history

### Monitors
Requests: 62
Sample endpoints: POST /api/dns-monitors | DELETE /api/dns-monitors/:dnsMonitorPublicId | GET /api/dns-monitors/:dnsMonitorPublicId/check-history

### Organization & Billing
Requests: 15
Sample endpoints: DELETE /api/organizations/:id/package-configs/:packageType | GET /api/organizations/:id/billing | GET /api/organizations/:organizationPublicId

### Users
Requests: 5
Sample endpoints: POST /api/users | DELETE /api/users/:id | GET /api/users/:id

### Website Management
Requests: 8
Sample endpoints: PATCH /api/websites/:websitePublicId | POST /api/websites | DELETE /api/websites/:websitePublicId

### Status Pages
Requests: 13
Sample endpoints: GET /api/status-pages | POST /api/status-pages | GET /api/status-pages/1

### Notification Channels
Requests: 5
Sample endpoints: GET /api/notification-channels | POST /api/notification-channels | PATCH /api/notification-channels/:id

### Escalation Config
Requests: 3
Sample endpoints: GET /api/escalation-config/:id | PATCH /api/escalation-config/:id | POST /api/escalation-config/:id/test

### Custom Fields
Requests: 4
Sample endpoints: GET /api/custom-fields | POST /api/custom-fields | PATCH /api/custom-fields/:id

### API Tokens
Requests: 6
Sample endpoints: GET /api/customer/tokens | POST /api/customer/tokens | DELETE /api/customer/tokens/:id

### Whitelabel
Requests: 8
Sample endpoints: GET /api/organization/whitelabel/branding | PATCH /api/organization/whitelabel/branding | POST /api/organization/whitelabel/branding/upload

### Organization SMTP
Requests: 4
Sample endpoints: POST /api/organization/smtp/test | GET /api/organization/smtp/logs?limit=100 | GET /api/organization/smtp

### Monitoring Locations
Requests: 2
Sample endpoints: GET /api/monitoring-locations/countries | GET /api/public/monitoring-locations

## Getting Started
Core entry points, authentication, token scope guidance, and end-to-end examples.

### API Documentation
URL: https://uptimeify.io/docs/api
Description: Overview of the REST API. Select a resource from the left.
Key Sections: AI / LLM Text Exports | Base URL | Authentication | UUID Path Parameters | Responses and Errors
Summary: 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" }

### Introduction
URL: https://uptimeify.io/docs/api/introduction
Description: Welcome to the Uptimeify API documentation. With this REST API, you can programmatically manage your monitoring infrastructure – e.g., organizations, customers, websites, and alerts.
Key Sections: Base URL | Authentication | Create API Token | Token Scopes (Organization vs Customer) | Response Format | Success Response | Error Response | Rate Limiting
Summary: Welcome to the Uptimeify API documentation. With this REST API, you can programmatically manage your monitoring infrastructure – e.g., organizations, customers, websites, and alerts. Base URL All API requests should be sent to the following base URL: https://uptimeify.io/api Authentication The API supports Bearer Token authentication for integrations. Create API Token Log in to the Uptimeify dashboard. Open Settings API in the dashboard. Click on Create Token , enter a name, and copy the generated secret. Add the token to the Authorization header of your requests: Authorization: Bearer wsm <your api token Uptimeify API tokens always start with wsm . If your token does not have that prefix, you are likely using the wrong credential (and requests will return 401 Unauthorized). Token Scopes (Organization vs Customer) API tokens can optionally be created with a Customer Scope : Organization-wide Token : can read/modify resources across all customers of the organization. Customer-Scoped Token : can only read/modify resources (websites, maintenance windows, etc.) within that specific customer. Customer-scoped tokens are recommended for agencies and external integrations. Requests outside the scope return 403 Forbidden. Note: Session-based authentication (cookies) is used for the web interface but is not recommended for integrations. Response Format All responses are returned in JSON format. Success Response { "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. { "statusCode": 400, "statusMessage": "Bad Request", "message": "Validation failed: 'url' is required." } Rate Limiting To ensure service stability, the API is rate-limited. Limit : 600 requests per minute per IP Header : X-RateLimit-Remaining shows your remaining quota Exceeded : 429 Too Many Requests Pages Generate API Token Token Scopes (Organization vs Customer) Success Response Error Response

#### Error Response
URL: https://uptimeify.io/docs/api/introduction/error-response
Description: Errors are returned with an appropriate HTTP status code and a JSON body containing details.
Key Sections: Rate limiting
Summary: Error Response Errors are returned with an appropriate HTTP status code and a JSON body containing details. { "statusCode": 400, "statusMessage": "Bad Request", "message": "Validation failed: 'url' is required." } Rate limiting To ensure service stability, the API is rate-limited. Limit : 600 requests per minute per IP Header : X-RateLimit-Remaining shows your remaining quota Exceeded : 429 Too Many Requests

#### Generate API Token
URL: https://uptimeify.io/docs/api/introduction/generate-api-token
Summary: Generate API Token Log in to the Uptimeify dashboard. Open Settings API in the dashboard. Click Create Token , enter a name, and copy the generated secret. Add the token to the Authorization header of your requests: Authorization: Bearer wsm <your api token Uptimeify API tokens always start with wsm . If your token does not have that prefix, you are likely using the wrong credential.

#### Success Response
URL: https://uptimeify.io/docs/api/introduction/success-response
Description: On success, the API returns a JSON body with the requested data.
Summary: Success Response On success, the API returns a JSON body with the requested data. { "id": 123, "name": "example-resource", "createdAt": "2023-01-01T12:00:00Z" }

#### Token Scopes (Organization vs Customer)
URL: https://uptimeify.io/docs/api/introduction/token-scopes-organization-vs-customer
Description: API tokens can optionally be created with a Customer Scope:
Summary: Token Scopes (Organization vs Customer) API tokens can optionally be created with a Customer Scope : Organization-wide token : can read/modify resources across all customers of the organization. Customer-scoped token : can only read/modify resources (websites, maintenance windows, etc.) within that specific customer. Customer-scoped tokens are recommended for agencies and external integrations. Requests outside the scope return 403 Forbidden. Note: Session-based authentication (cookies) is used for the web interface but is not recommended for integrations.

### Auth & Session
URL: https://uptimeify.io/docs/api/auth
Description: Manage your current user session and retrieve profile information.
Key Sections: Endpoints
Summary: Manage your current user session and retrieve profile information. Endpoints Get Current User

#### Get Current User
URL: https://uptimeify.io/docs/api/auth/get-current-user
Description: GET /api/auth/get-session
Endpoints: GET /api/auth/get-session
Key Sections: Request | Response
Summary: Get Current User GET /api/auth/get-session Returns a reduced view of the currently authenticated user and their session. Request GET /api/auth/get-session HTTP/1.1 This endpoint returns a public-safe session payload. For integrations, use API tokens (Authorization: Bearer wsm ...) with the REST endpoints under /api/ . Sensitive internal app fields such as email, role, language, isGlobalAdmin, isGlobalSupporter, emailVerified, image, and platform-admin customer context are intentionally not included. Response { "user": { "id": "user 12345", "name": "Max Mustermann", "firstName": "Max", "lastName": "Mustermann", "organizationId": 1, "organizationStatus": "active", "isActive": true, "createdAt": "2026-03-31T15:50:49.030Z", "updatedAt": "2026-03-31T15:50:49.030Z" }, "session": { "userId": "user 12345", "expiresAt": "2027-03-31T15:58:26.618Z", "token": "session-token-value" } }

### Examples
URL: https://uptimeify.io/docs/api/examples
Description: Practical examples for common workflows with customers, websites, and monitors.
Summary: Examples Here you’ll find step-by-step examples for common API workflows. Create a customer + website Delete a customer including all websites Create a customer + all monitor types Create a customer + multiple monitors

#### Customer + all monitors
URL: https://uptimeify.io/docs/api/examples/create-customer-and-all-monitors
Description: Example automation: create one website and then create one monitor of each type.
Key Sections: 1) Create customer + website | 2) Create monitors (one per type) | Example: create a DNS monitor | Example: create an ICMP monitor | Notes
Summary: Create a customer + all monitor types This example is useful if you want to bootstrap a customer with a complete monitoring baseline . High-level flow: Create customer Create website Create monitors (one per monitor type) 1) Create customer + website Reuse: Create a customer + website 2) Create monitors (one per type) Monitor APIs are organized by type. API reference overview: Monitors API Typical types you might create: DNS Monitor ICMP Monitor SMTP Monitor SSH Monitor FTP Monitor IMAP/POP Monitor For details and required fields, follow the per-type API docs. Example: create a DNS monitor curl -X POST "$API BASE URL/api/dns-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "DNS: acme.example", "hostname": "acme.example", "dnsConfig": { "rrtypes": ["A", "AAAA"], "matchMode": "exact", "expectedValues": { "A": ["93.184.216.34"], "AAAA": ["2606:2800:220:1:248:1893:25c8:1946"] } } }' Example: create an ICMP monitor curl -X POST "$API BASE URL/api/icmp-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "Ping: gateway", "hostname": "gateway.acme.example" }' Notes Not every installation exposes every monitor type, and required fields can vary (plan/package). For website (HTTP) checks, start with the website’s own monitoring settings: Website Configuration API

#### Customer + multiple monitors
URL: https://uptimeify.io/docs/api/examples/create-customer-and-multiple-monitors
Description: Example: create a customer and set up multiple monitors (same type and mixed types).
Key Sections: 1) Create customer + website | 2) Create multiple monitors | Option A: Multiple monitors of the same type (DNS) | Option B: Mix different monitor types | Tips | Reference
Summary: Create a customer + multiple monitors This example shows how to set up multiple monitors for a single customer, e.g.: Two different hostnames for DNS monitoring Multiple servers for ICMP A mix of DNS + ICMP + SMTP 1) Create customer + website Create a customer + website 2) Create multiple monitors Option A: Multiple monitors of the same type (DNS) DNS monitor 1 curl -X POST "$API BASE URL/api/dns-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "DNS: app.acme.example", "hostname": "app.acme.example", "dnsConfig": { "rrtypes": ["A"], "matchMode": "exact", "expectedValues": { "A": ["93.184.216.34"] } } }' DNS monitor 2 curl -X POST "$API BASE URL/api/dns-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "DNS: mail.acme.example", "hostname": "mail.acme.example", "dnsConfig": { "rrtypes": ["MX", "TXT"], "matchMode": "contains", "expectedValues": { "MX": ["10 mail.acme.example"], "TXT": ["v=spf1 include: spf.acme.example all"] } } }' Option B: Mix different monitor types ICMP curl -X POST "$API BASE URL/api/icmp-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "Ping: edge-1", "hostname": "edge-1.acme.example" }' SMTP curl -X POST "$API BASE URL/api/smtp-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "SMTP: outbound", "hostname": "smtp.acme.example", "port": 587 }' Tips Use consistent naming conventions (prefix by type: DNS:, Ping:, SMTP:). Start with conservative intervals and tighten later. Reference Monitoring Types Monitors API

#### Create customer + website
URL: https://uptimeify.io/docs/api/examples/create-customer-and-website
Description: End-to-end example: create a customer and then create the first website.
Key Sections: Prerequisites | 1) Create customer | 2) Create website for the customer | 3) Verify the website | Next steps
Summary: Create a customer + website This example shows a typical onboarding flow: Create a customer Create a website for that customer (Optional) Attach monitoring configuration If you prefer the UI: you can create customers and websites in the Admin area. The API is useful for automation and bulk setups. Prerequisites An API token with the required scopes Your API base URL (e.g. https://your-instance.tld) See the API introduction first: API Introduction 1) Create customer API reference: Customers API Example (pseudo request): curl -X POST "$API BASE URL/api/customers" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme GmbH", "email": "ops@acme.example" }' Store the returned customerId. 2) Create website for the customer API reference: Websites API curl -X POST "$API BASE URL/api/websites" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 123, "name": "Acme Marketing Website", "url": "https://acme.example" }' Important: url must include the protocol (https://...). 3) Verify the website API reference: Get website curl -X GET "$API BASE URL/api/websites/456" \ -H "Authorization: Bearer $TOKEN" Next steps Configure monitoring behavior per website: Website Configuration API Learn which monitor types exist: Monitoring Types

#### Delete customer + websites
URL: https://uptimeify.io/docs/api/examples/delete-customer-and-all-websites
Description: Safe deletion flow: remove websites first, then delete the customer.
Key Sections: Prerequisites | 1) List websites for the customer | 2) Delete each website | 3) Delete the customer | Notes
Summary: Delete a customer including all websites This example focuses on a safe, explicit deletion flow . Depending on your configuration, deleting a customer may or may not automatically delete related websites. To avoid surprises, we recommend deleting websites explicitly first. Prerequisites An API token with the required scopes 1) List websites for the customer API reference: List websites Pseudo request: curl -X GET "$API BASE URL/api/websites?customerId=123" \ -H "Authorization: Bearer $TOKEN" Collect all website IDs. 2) Delete each website API reference: Delete website curl -X DELETE "$API BASE URL/api/websites/456" \ -H "Authorization: Bearer $TOKEN" Repeat for all websites of that customer. 3) Delete the customer API reference: Customers API curl -X DELETE "$API BASE URL/api/customers/123" \ -H "Authorization: Bearer $TOKEN" Notes If your backend supports cascade deletes, step 2 might be optional — but doing it explicitly keeps automation predictable.

## Customer API
Customer-safe resources for websites, monitoring data, monitors, and website-level configuration.

### Website Management
URL: https://uptimeify.io/docs/api/websites
Description: Manage monitored websites.
Key Sections: Endpoints
Summary: Manage monitored websites. Path-based website endpoints use websitePublicId UUIDs. Endpoints List Websites Create Website Get Website Get Website Details Update Website Change Status Delete Website

#### Change Website Status
URL: https://uptimeify.io/docs/api/websites/change-status
Description: PATCH /api/websites/:websitePublicId (status)
Endpoints: PATCH /api/websites/:websitePublicId
Key Sections: Example (cURL) | Request Body | Response | Common errors
Summary: Change Website Status PATCH /api/websites/:websitePublicId Changes the monitoring status of a website. There is no dedicated .../status endpoint — status changes are part of PATCH /api/websites/:websitePublicId. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "status": "maintenance" }' Request Body { "status": "active" } Allowed values: active inactive (you may also send paused, it will be mapped to inactive) maintenance Response Returns the updated website record. Common errors 401 Unauthorized when you are not logged in 403 Forbidden when you cannot write to the website 403 Active website limit reached... when switching to active would exceed the customer/package limit

#### Create Website
URL: https://uptimeify.io/docs/api/websites/create-website
Description: POST /api/websites
Endpoints: POST /api/websites
Key Sections: Example (cURL) | Request Body | Core fields | Authentication | HTTP Request Configuration | mTLS (Mutual TLS) | Playwright Monitoring | Expected Response Validation
Summary: Create Website POST /api/websites Creates a new website monitor for a customer. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST "$BASE URL/api/websites" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "customerId": "059e1469-0f05-4c93-bd4d-89c45bb2afd9", "name": "New Landing Page", "url": "https://landing.example.com", "monitoringType": "combined", "checkInterval": 5 }' Request Body Core fields Field Type Required Default Description ------- ------ ---------- --------- ------------- customerId number\ string Yes — Customer public ID (preferred) or legacy numeric ID name string Yes — Display name (1–255 chars) url string Yes — URL to monitor (1–2048 chars). Required for non-heartbeat monitors. For DNS monitors, use a hostname without protocol. monitoringType string No combined combined, http status, ssl check, playwright, heartbeat, dns status string No active active, inactive, maintenance (paused accepted, mapped to inactive) checkInterval number No 30 Check interval in minutes (1–60, min depends on package) timeoutSeconds number No 30 Request timeout in seconds (1–60) expectedStatusCodes string No 200,301,302 Comma-separated expected HTTP status codes allowedCheckCountryCodes string[]\ null No org default Array of 2-letter country codes to restrict monitoring locations searchTerm string\ null No null Keyword to search for in response body (max 255 chars) customFields object\ null No null Custom field values as key-value pairs Authentication Field Type Required Default Description ------- ------ ---------- --------- ------------- authMode string No none none, authorization header, basic authorizationHeader string\ null No null Required when authMode is authorization header (1–4096 chars). Encrypted at rest. basicAuthUsername string\ null No null Required when authMode is basic (1–255 chars) basicAuthPassword string\ null No null Required when authMode is basic (1–4096 chars). Encrypted at rest. HTTP Request Configuration Field Type Required Default Description ------- ------ ---------- --------- ------------- httpMethod string No GET GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS customHeaders object\ null No null Custom HTTP headers as key-value pairs. Keys: 1–100 chars, values: max 8192 chars. Encrypted at rest. requestBody string\ null No null Request body for POST/PUT/PATCH requests (max 100KB). Encrypted at rest. followRedirects boolean No true Whether to follow HTTP redirects cookieHandling string No none none or jar (maintain cookie jar across redirects) mTLS (Mutual TLS) Field Type Required Default Description ------- ------ ---------- --------- ------------- mtlsEnabled boolean No false Enable mutual TLS authentication mtlsClientCert string\ null No null Required when mtlsEnabled is true (1–100000 chars). Encrypted at rest. mtlsClientKey string\ null No null Required when mtlsEnabled is true (1–100000 chars). Encrypted at rest. Playwright Monitoring Field Type Required Default Description ------- ------ ---------- --------- ------------- playwrightScript string\ null No null Required when monitoringType is playwright (1–20000 chars) playwrightEnv object\ null No {} Environment variables (max 50, keys 1–64 chars, values max 2000 chars) playwrightDevice string\ null No null Device emulation preset (1–100 chars) playwrightViewportWidth number\ null No null Viewport width (1–3840). Must be set with playwrightViewportHeight. playwrightViewportHeight number\ null No null Viewport height (1–3840). Must be set with playwrightViewportWidth. playwrightRetries number\ null No 0 Number of retries (0–5) playwrightTimeoutMs number\ null No 30000 Timeout in milliseconds (1000–180000) Expected Response Validation Field Type Required Default Description ------- ------ ---------- --------- ------------- checkExpectedResponseEnabled boolean No false Enable response body validation expectedResponseMatchType string\ null No contains contains, equals, json path equals expectedResponseValue string\ null No null Required when checkExpectedResponseEnabled is true (max 10000 chars) expectedResponseJsonPath string\ null No null Required when expectedResponseMatchType is json path equals (max 500 chars) Check Configuration Field Type Required Default Description ------- ------ ---------- --------- ------------- checkSslEnabled boolean No true Enable SSL certificate checks (disabled for Playwright) checkHttpsRedirectEnabled boolean No true Check HTTPS redirect (disabled for Playwright) checkStatusEnabled boolean No true Check HTTP status (disabled for Playwright) checkSizeEnabled boolean No true Check response size (disabled for Playwright) checkResponseTimeEnabled boolean No true Check response time (disabled for Playwright) checkKeywordEnabled boolean No true Enable keyword search (disabled for Playwright) SSL & Domain Thresholds Field Type Required Default Description ------- ------ ---------- --------- -------------...

#### Delete Website
URL: https://uptimeify.io/docs/api/websites/delete-website
Description: DELETE /api/websites/:websitePublicId
Endpoints: DELETE /api/websites/:websitePublicId
Key Sections: Example (cURL) | Response | Common errors
Summary: Delete Website DELETE /api/websites/:websitePublicId Irrevocably removes a website and its monitoring history. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "success": true } Common errors 400 Website public ID (UUID) required when :websitePublicId is invalid 401 Unauthorized when you are not logged in 500 Failed to delete website on server errors

#### Get Website
URL: https://uptimeify.io/docs/api/websites/get-website
Description: GET /api/websites/:websitePublicId
Endpoints: GET /api/websites/:websitePublicId | GET /api/websites/:websitePublicId/details
Key Sections: Example (cURL) | Response | Common errors
Summary: Get Website GET /api/websites/:websitePublicId Returns a single website (basic/sanitized). Sensitive fields like encrypted credentials are removed. If you need the full “mega” representation (including additional computed/status fields), use: GET /api/websites/:websitePublicId/details Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "id": 101, "organizationId": 1, "customerId": 1, "name": "Main Marketing Site", "url": "https://example.com", "status": "active", "monitoringType": "combined", "checkInterval": 1, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z" } Common errors 400 Website public ID (UUID) required when :websitePublicId is missing/invalid 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the website 404 Not Found when the website does not exist

#### Get Website Details
URL: https://uptimeify.io/docs/api/websites/get-website-details
Description: GET /api/websites/:websitePublicId/details
Endpoints: GET /api/websites/:websitePublicId/details
Key Sections: Example (cURL) | Query Parameters | Response | Common errors
Summary: Get Website Details GET /api/websites/:websitePublicId/details Returns the website detail page data in one call (mega endpoint). This includes monitoring stats, alert history, incident history, monitoring chart data, and maintenance windows. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10/details?range=day" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Query Parameters range (optional): day week month year (default: day) date (optional): reference date for calendar views startDate / endDate (optional): custom date window for zoomed views granularity (optional): e.g. minute for non-aggregated data (when supported) Response { "website": { "id": 101, "name": "Main Marketing Site", "url": "https://example.com", "status": "active", "monitoringType": "combined", "customerId": 1 }, "uptimeStats": { "day": "100.00", "month": "99.95", "year": "99.90", "dayAvgResponse": 125, "monthAvgResponse": 118, "yearAvgResponse": 120 }, "monitoringData": { "responseTimeData": [], "statusData": [], "uptimePercentage": "99.95", "checkSuccessRatePercentage": "99.80", "totalChecks": 100, "successfulChecks": 99 }, "incidents": { "history": [], "total": 0, "ongoing": 0, "totalDowntime": "0m" }, "alerts": { "history": [], "total": 0, "notificationContext": null }, "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } Common errors 400 Invalid website public ID (UUID) when :websitePublicId is invalid 401 Unauthorized when you are not logged in 403 Forbidden when you have no access to the website 500 Failed to fetch website details on server errors

#### List Websites
URL: https://uptimeify.io/docs/api/websites/list-websites
Description: GET /api/websites
Endpoints: GET /api/websites
Key Sections: Query Parameters | Example (cURL) | Response | Common errors
Summary: List Websites GET /api/websites Lists websites within an organization (paginated). Results are scoped by your session/permissions. Query Parameters organizationId (optional): Defaults to your session organization. customerId (optional): Filter websites by customer. search (optional): Search by website/customer fields. monitoringType (optional): combined http status ssl check playwright heartbeat dns excludeMonitoringType (optional): same values as monitoringType page (optional, default: 1) perPage (optional, default: 50, max: 200) Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "items": [ { "id": 101, "publicId": "11111111-1111-4111-8111-111111111111", "customerId": 1, "customerPublicId": "22222222-2222-4222-8222-222222222222", "customerName": "Acme Corp", "name": "Main Marketing Site", "url": "https://example.com", "status": "active", "monitoringType": "combined", "checkInterval": 1, "createdAt": "2026-02-26T12:00:00.000Z" } ], "total": 1, "page": 1, "perPage": 50 } Each item contains flat customerName and customerPublicId fields, not a full embedded customer object. Common errors 400 Invalid customerId when customerId is invalid 400 Invalid monitoringType when monitoringType is not supported 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### Update Website
URL: https://uptimeify.io/docs/api/websites/update-website
Description: PATCH /api/websites/:websitePublicId
Endpoints: PATCH /api/websites/:websitePublicId
Key Sections: Example (cURL) — Partial update | Example (cURL) — Full update with HTTP configuration | Request Body | Core fields | Authentication | HTTP Request Configuration | mTLS (Mutual TLS) | Playwright Monitoring
Summary: Update Website PATCH /api/websites/:websitePublicId Updates a website. Supports both partial updates (only sent fields are changed) and full updates (all required fields must be present). A request is treated as a full update when customerId, name, and url are all present in the body. Otherwise, it is treated as a partial update. Example (cURL) — Partial update BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "Updated Website Name", "checkInterval": 5, "timeoutSeconds": 10 }' Example (cURL) — Full update with HTTP configuration curl -X PATCH "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "customerId": 5, "name": "API Endpoint Monitor", "url": "https://api.example.com/health", "httpMethod": "POST", "customHeaders": { "X-API-Key": "abc123", "Content-Type": "application/json" }, "requestBody": "{\"check\": true}", "followRedirects": false, "cookieHandling": "jar", "mtlsEnabled": true, "mtlsClientCert": "-----BEGIN CERTIFICATE-----\n...", "mtlsClientKey": "-----BEGIN PRIVATE KEY-----\n..." }' Request Body All fields are optional for partial updates. For full updates, customerId, name, and url are required. Core fields Field Type Description ------- ------ ------------- customerId number\ string Customer public ID (preferred) or legacy numeric ID name string Display name (1–255 chars) url string URL to monitor (1–2048 chars). For DNS monitors, use hostname without protocol. monitoringType string combined, http status, ssl check, playwright, heartbeat, dns status string active, inactive, maintenance (paused → inactive) checkInterval number Check interval in minutes (1–60) timeoutSeconds number Request timeout in seconds (1–60) expectedStatusCodes string Comma-separated expected HTTP status codes allowedCheckCountryCodes string[]\ null Array of 2-letter country codes, or null to reset to org default searchTerm string\ null Keyword to search for (null clears it) customFields object\ null Custom field values Authentication Field Type Description ------- ------ ------------- authMode string none, authorization header, basic. Setting to none clears auth credentials. authorizationHeader string\ null Required when authMode is authorization header. Encrypted at rest. basicAuthUsername string\ null Required when authMode is basic. basicAuthPassword string\ null Required when authMode is basic. Encrypted at rest. HTTP Request Configuration Field Type Description ------- ------ ------------- httpMethod string GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS customHeaders object\ null Custom HTTP headers (keys: 1–100 chars, values: max 8192 chars). Null clears them. Encrypted at rest. requestBody string\ null Request body for POST/PUT/PATCH (max 100KB). Null clears it. Encrypted at rest. followRedirects boolean Whether to follow HTTP redirects cookieHandling string none or jar (maintain cookie jar across redirects) mTLS (Mutual TLS) Field Type Description ------- ------ ------------- mtlsEnabled boolean Enable mutual TLS authentication. Setting to false clears cert and key. mtlsClientCert string\ null Client certificate (max 100KB). Required when mtlsEnabled is true. Encrypted at rest. mtlsClientKey string\ null Client private key (max 100KB). Required when mtlsEnabled is true. Encrypted at rest. Playwright Monitoring Field Type Description ------- ------ ------------- playwrightScript string\ null Required when monitoringType is playwright (1–20000 chars) playwrightEnv object\ null Environment variables (max 50, keys must match ^[A-Z ][A-Z0-9 ] $) playwrightDevice string\ null Device emulation preset playwrightViewportWidth number\ null Viewport width (1–3840). Must be set with playwrightViewportHeight. playwrightViewportHeight number\ null Viewport height (1–3840). Must be set with playwrightViewportWidth. playwrightRetries number\ null Retries (0–5) playwrightTimeoutMs number\ null Timeout in milliseconds (1000–180000) Expected Response Validation Field Type Description ------- ------ ------------- checkExpectedResponseEnabled boolean Enable response body validation expectedResponseMatchType string\ null contains, equals, json path equals expectedResponseValue string\ null Value to match (max 10000 chars). Required when enabled. expectedResponseJsonPath string\ null JSON path (max 500 chars). Required when json path equals. Check Configuration Field Type Description ------- ------ ------------- checkSslEnabled boolean Enable SSL checks (disabled for Playwright) checkHttpsRedirectEnabled boolean Check HTTPS redirect (disabled for Playwright) checkStatusEnabled boolean Check HTTP status (disabled for Playwright) checkSizeEnabled boolean Check response size (disabled for Playwright)...

### Monitoring Data & Reports
URL: https://uptimeify.io/docs/api/monitoring
Endpoints: GET /api/websites/:websitePublicId/uptime-stats | GET /api/websites/:websitePublicId/check-history | GET /api/websites/:websitePublicId/incident-history | GET /api/websites/:websitePublicId/alert-history | GET /api/websites/:websitePublicId/monitoring-data?range=day|week|month|year | GET /api/incidents/:incidentPublicId | GET /api/incidents?organizationId=:organizationId | GET /api/websites/:websitePublicId/report.pdf?period=last-week|last-month|last-quarter&startDate=YYYY-MM-DD&endDate=YYYY-MM-DD
Key Sections: Monitoring Data | Get Uptime Stats | Get Check History | Get Incident History | Get Alert History | Get Monitoring Data | Get Incident Details | List Incidents (Organization)
Summary: Monitoring Data Get Uptime Stats GET /api/websites/:websitePublicId/uptime-stats Returns uptime percentages and average response times (day/month/year). Get Check History GET /api/websites/:websitePublicId/check-history Returns the latest monitoring checks for a website. Get Incident History GET /api/websites/:websitePublicId/incident-history Returns incidents for a website (latest 100). Get Alert History GET /api/websites/:websitePublicId/alert-history Returns notification/escalation attempts for incidents of a website. Get Monitoring Data GET /api/websites/:websitePublicId/monitoring-data?range=day week month year Returns aggregated time series data used for charts. Get Incident Details GET /api/incidents/:incidentPublicId Returns details of a specific incident. List Incidents (Organization) GET /api/incidents?organizationId=:organizationId Lists incidents for an organization (scoped by your permissions). Reports Download PDF Report GET /api/websites/:websitePublicId/report.pdf?period=last-week last-month last-quarter&startDate=YYYY-MM-DD&endDate=YYYY-MM-DD Downloads a generated PDF report for a website. Endpoints Get Uptime Stats Get Check History Get Incident History Get Alert History Get Monitoring Data List Incidents (Organization) Get Incident Details Download PDF Report

#### Download PDF Report
URL: https://uptimeify.io/docs/api/monitoring/download-report-pdf
Description: GET /api/websites/:websitePublicId/report.pdf
Endpoints: GET /api/websites/:websitePublicId/report.pdf
Key Sections: Query Parameters | Example (cURL) | Response | Common Errors
Summary: Download PDF Report GET /api/websites/:websitePublicId/report.pdf Downloads a PDF report for a website. Query Parameters You can either use a predefined period or a custom date range. period (optional, default: last-month): last-week, last-month, last-quarter startDate / endDate (optional): YYYY-MM-DD If startDate and endDate are provided, they take precedence. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -L "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/report.pdf?period=last-month" \ -H "Authorization: Bearer $TOKEN" \ -o report.pdf Response The response is a PDF (application/pdf). Common Errors 400 Website public ID (UUID) required if :websitePublicId is invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the website 404 Website not found if the website does not exist

#### Get Alert History
URL: https://uptimeify.io/docs/api/monitoring/get-alert-history
Description: GET /api/websites/:websitePublicId/alert-history
Endpoints: GET /api/websites/:websitePublicId/alert-history
Key Sections: Example (cURL) | Example Response | Common Errors
Summary: Get Alert History GET /api/websites/:websitePublicId/alert-history Returns notification/escalation attempts (alert history) for incidents of a website. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/alert-history" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "alerts": [ { "id": 987, "incidentId": 123, "type": "email", "status": "sent", "channelName": "Ops Email", "sentAt": "2026-02-26T12:11:00.000Z", "errorMessage": null } ], "total": 1 } Common Errors 400 Website public ID (UUID) required if :websitePublicId is invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the website

#### Get Check History
URL: https://uptimeify.io/docs/api/monitoring/get-check-history
Description: GET /api/websites/:websitePublicId/check-history
Endpoints: GET /api/websites/:websitePublicId/check-history
Key Sections: Query Parameters | Path Parameters | Example (cURL) | Example Response | Common Errors
Summary: Get Check History GET /api/websites/:websitePublicId/check-history Returns the latest monitoring checks for a website. Query Parameters limit (optional, default: 50, max: 200) checkType (optional, supports values such as http status, ssl check, combined, playwright, heartbeat, dns, plus legacy values like http and ssl) Path Parameters websitePublicId (recommended): website public UUID Backward compatibility: legacy numeric website IDs are still accepted Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/check-history?limit=25&checkType=dns" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "data": [ { "id": "chk 01H...", "status": "success", "errorMessage": null, "warningMessage": null, "timingDns": 12, "diagnostics": null, "checkedAt": "2026-02-26T12:34:56.000Z", "locationId": 1, "locationName": "Frankfurt", "locationCode": "de-fra" } ] } Common Errors 400 Invalid Website identifier if :websitePublicId is neither a valid UUID nor a legacy numeric ID 400 Invalid checkType if you send an unsupported checkType 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the website

#### Get Incident Details
URL: https://uptimeify.io/docs/api/monitoring/get-incident-details
Description: GET /api/incidents/:incidentPublicId
Endpoints: GET /api/incidents/:incidentPublicId
Key Sections: Authentication | Parameters | Example (cURL) | Example Response (excerpt) | Common Errors
Summary: Get Incident Details GET /api/incidents/:incidentPublicId Returns detailed incident data, including a timeline of failed/recovery checks and alert events. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters incidentPublicId (Path, required): Incident public UUID. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/incidents/6bfec6f6-245a-47ce-843b-157d97d56f88" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Note: evidenceCheck can be null. screenshotUrl is only set when hasScreenshot is true. Example Response (excerpt) { "incident": { "id": 123, "websiteId": 101, "type": "downtime", "status": "open", "startedAt": "2026-02-26T12:10:00.000Z", "resolvedAt": null, "statusCode": null, "errorMessage": "Timeout", "responseTimeMs": null }, "timeline": { "outageStartedAt": "2026-02-26T12:08:00.000Z", "outageStartedCheck": { "id": "chk 01H...", "checkedAt": "2026-02-26T12:08:00.000Z", "status": "failure", "statusCode": 503, "errorMessage": "Timeout", "responseTimeMs": null, "location": { "id": 1, "code": "fra", "name": "Frankfurt" } }, "confirmationAt": "2026-02-26T12:10:00.000Z", "failedChecks": [], "failedChecksTotal": 2, "alertEvents": [ { "id": 987, "sentAt": "2026-02-26T12:11:00.000Z", "type": "email", "status": "sent", "channelName": "Ops Email", "errorMessage": null } ], "recoveryChecks": [], "recoveryChecksTotal": 0 }, "evidenceCheck": { "id": "chk 01H...", "checkedAt": "2026-02-26T12:08:00.000Z", "diagnostics": null, "hasScreenshot": false, "screenshotUrl": null } } Common Errors 400 Incident public ID (UUID) required if :incidentPublicId is invalid 401 Unauthorized if you are not authenticated 403 Forbidden if the incident exists but you do not have access 404 Incident not found if the incident does not exist

#### Get Incident History
URL: https://uptimeify.io/docs/api/monitoring/get-incident-history
Description: GET /api/websites/:websitePublicId/incident-history
Endpoints: GET /api/websites/:websitePublicId/incident-history
Key Sections: Authentication | Parameters | Example (cURL) | Example Response | Common Errors
Summary: Get Incident History GET /api/websites/:websitePublicId/incident-history Returns incidents for a single website (latest 100), including a computed duration. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters websitePublicId (Path, required): Website public UUID. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/incident-history" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "incidents": [ { "id": 123, "type": "downtime", "status": "resolved", "startedAt": "Feb 26, 2026, 12:10:00", "endedAt": "Feb 26, 2026, 12:12:30", "duration": "2m 30s", "durationMs": 150000, "details": "HTTP/2 503 - Response time: 1.20s", "isOngoing": false } ], "total": 1 } Note: startedAt and endedAt are formatted strings (server-side en-US). Common Errors 400 Website public ID (UUID) required if :websitePublicId is invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the website 500 Failed to fetch incident history on unexpected errors

#### Get Monitoring Data
URL: https://uptimeify.io/docs/api/monitoring/get-monitoring-data
Description: GET /api/websites/:websitePublicId/monitoring-data
Endpoints: GET /api/websites/:websitePublicId/monitoring-data?range=day|week|month|year
Key Sections: Query Parameters | Example (cURL) | Example Response (excerpt) | Common Errors
Summary: Get Monitoring Data GET /api/websites/:websitePublicId/monitoring-data?range=day week month year Returns time series data used for charts (response times, status tracker, uptime percentage). To keep responses small, the endpoint down-samples the returned data points if needed. Query Parameters range (optional, default: day): day, week, month, year maxPoints (optional, default: 300, max: 2000): Limits the number of returned data points. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites/6bfec6f6-245a-47ce-843b-157d97d56f88/monitoring-data?range=week" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response (excerpt) { "responseTimeData": [ { "timestamp": "2026-02-26T12:00:00.000Z", "responseTime": 123, "status": "success", "success": true, "timingDns": 12, "timingTcp": 20, "timingTls": 30, "timingTtfb": 50, "timingTransfer": 11 } ], "statusData": [ { "date": "26.02", "status": "online" } ], "uptimePercentage": "99.95", "checkSuccessRatePercentage": "99.80", "totalChecks": 100, "successfulChecks": 99 } Common Errors 400 Website public ID (UUID) required if :websitePublicId is invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the website 500 Failed to fetch monitoring data on server errors

#### Get Uptime Stats
URL: https://uptimeify.io/docs/api/monitoring/get-uptime-stats
Description: GET /api/websites/:websitePublicId/uptime-stats
Endpoints: GET /api/websites/:websitePublicId/uptime-stats
Key Sections: Path Parameters | Example (cURL) | Example Response | Common Errors
Summary: Get Uptime Stats GET /api/websites/:websitePublicId/uptime-stats Returns uptime percentages and average response times for the last day, month and year. Path Parameters websitePublicId (recommended): website public UUID Backward compatibility: legacy numeric website IDs are still accepted Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10/uptime-stats" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "day": "100.00", "month": "99.95", "year": "99.90", "dayAvgResponse": 125, "monthAvgResponse": 118, "yearAvgResponse": 120 } Common Errors 400 Invalid Website identifier if :websitePublicId is neither a valid UUID nor a legacy numeric ID 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the website

#### List Incidents (Organization)
URL: https://uptimeify.io/docs/api/monitoring/list-incidents
Description: GET /api/incidents?organizationId=:organizationId
Endpoints: GET /api/incidents?organizationId=:organizationId
Key Sections: Authentication | Query Parameters | Example (cURL) | Example Response (excerpt) | Common Errors
Summary: List Incidents (Organization) GET /api/incidents?organizationId=:organizationId Lists incidents for an organization. If organizationId is omitted, the API falls back to the organization from your session. Readonly users only see incidents for customers they are assigned to. Authentication Requires a valid session. Header: Authorization: Bearer <token Query Parameters organizationId (optional): Organization ID. Defaults to your session organization. limit (optional, default: 100, max: 500): Maximum number of incidents to return. offset (optional, default: 0): Pagination offset. includeTotal (optional, default: 0): If set to 1 (or true), the response includes total, limit, and offset. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/incidents?organizationId=1" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" To paginate: curl -X GET "$BASE URL/api/incidents?organizationId=1&limit=100&offset=0" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response (excerpt) [ { "id": 123, "websiteId": 101, "status": "open", "severity": "downtime", "started at": "2026-02-26T12:10:00.000Z", "resolved at": null, "last notified at": "2026-02-26T12:11:00.000Z", "error message": "Timeout", "status code": null, "response time ms": null, "website": { "id": 101, "name": "Main Marketing Site", "url": "https://example.com", "status": "active" }, "customer": { "id": 12, "email": "ops@example.com", "company": "Acme Corp" } } ] If includeTotal=1, the response shape changes to: { "incidents": [], "total": 1234, "limit": 100, "offset": 0 } Common Errors 400 Organization ID is required if the API cannot infer an organization 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the organization 500 Failed to fetch incidents on unexpected errors

### Monitors
URL: https://uptimeify.io/docs/api/monitors
Description: Manage protocol monitors (ICMP, SMTP, SSH, FTP, IMAP/POP).
Key Sections: Resources
Summary: Manage protocol monitors (ICMP, SMTP, SSH, FTP, IMAP/POP). Protocol monitor detail/update/delete/check endpoints use monitor-specific publicId UUIDs in the path. Resources ICMP Monitors SMTP Monitors SSH Monitors FTP Monitors IMAP/POP Monitors DNS Monitors DNSBL Monitoring (Customer IPs) Domain Expiry Monitoring (Customer Domains)

#### DNS Monitors
URL: https://uptimeify.io/docs/api/monitors/dns-monitors
Description: Manage DNS record monitors.
Key Sections: Endpoints
Summary: Manage DNS monitors that check DNS resolution/records for a hostname. Path-based DNS monitor endpoints use dnsMonitorPublicId UUIDs. Endpoints List DNS Monitors Create DNS Monitor Get DNS Monitor Update DNS Monitor Delete DNS Monitor Trigger DNS Check Get DNS Monitor Check History

#### Create DNS Monitor
URL: https://uptimeify.io/docs/api/monitors/dns-monitors/create-dns-monitor
Description: POST /api/dns-monitors
Endpoints: POST /api/dns-monitors
Key Sections: Request Body | Example (cURL) | Common errors
Summary: Create DNS Monitor POST /api/dns-monitors Creates a new DNS monitor for a customer. Request Body { "customerId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "name": "Example DNS", "hostname": "example.com", "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": ["A", "AAAA"], "matchMode": "exact", "expectedValues": { "A": ["93.184.216.34"], "AAAA": ["2606:2800:220:1:248:1893:25c8:1946"] }, "triggerOn": { "resolveError": true, "mismatch": true } } } Notes: customerId, name, hostname, dnsConfig.rrtypes, dnsConfig.matchMode, and dnsConfig.expectedValues are required. customerId accepts either the internal numeric ID or the customer publicId UUID. Global supporters and readonly users cannot create DNS monitors. hostname must be a hostname (no protocol, no path). dnsConfig.expectedValues must contain at least one expected value for every RR type listed in dnsConfig.rrtypes. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST \ "$BASE URL/api/dns-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"customerId":"6bfec6f6-245a-47ce-843b-157d97d56f88","name":"Example DNS","hostname":"example.com","dnsConfig":{"rrtypes":["A"],"matchMode":"exact","expectedValues":{"A":["93.184.216.34"]},"triggerOn":{"resolveError":true,"mismatch":true}}}' Common errors 400 Invalid Customer identifier 400 hostname must be a valid hostname (no protocol, no path) 400 Expected values are required for RR type <TYPE 401 Unauthorized 403 Forbidden (readonly/global supporter or no access) 404 Customer not found

#### Delete DNS Monitor
URL: https://uptimeify.io/docs/api/monitors/dns-monitors/delete-dns-monitor
Description: DELETE /api/dns-monitors/:dnsMonitorPublicId
Endpoints: DELETE /api/dns-monitors/:dnsMonitorPublicId
Key Sections: Example (cURL) | Common errors
Summary: Delete DNS Monitor DELETE /api/dns-monitors/:dnsMonitorPublicId Deletes a DNS monitor. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE \ "$BASE URL/api/dns-monitors/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" Common errors 401 Unauthorized 403 Forbidden 404 DNS monitor not found

#### Get DNS Monitor
URL: https://uptimeify.io/docs/api/monitors/dns-monitors/get-dns-monitor
Description: GET /api/dns-monitors/:dnsMonitorPublicId
Endpoints: GET /api/dns-monitors/:dnsMonitorPublicId
Key Sections: Example response | Example (cURL) | Common errors
Summary: Get DNS Monitor GET /api/dns-monitors/:dnsMonitorPublicId Returns a single DNS monitor. The response contains the DNS monitor itself and does not embed the full customer record. Example response { "id": 1, "publicId": "3c741f27-7015-4202-93ea-0f97cc6bc769", "organizationId": 2, "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "name": "haupt.design", "hostname": "haupt.design", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": ["A"], "matchMode": "exact", "triggerOn": { "mismatch": true, "resolveError": true }, "expectedValues": { "A": ["76.76.21.21"] } }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-03T14:55:00.005Z", "createdAt": "2026-02-23T20:24:54.731Z", "updatedAt": "2026-04-03T14:55:01.193Z" } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/dns-monitors/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Common errors 400 DNS monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 DNS monitor not found

#### Get DNS Monitor Check History
URL: https://uptimeify.io/docs/api/monitors/dns-monitors/get-dns-monitor-check-history
Description: GET /api/dns-monitors/:dnsMonitorPublicId/check-history
Endpoints: GET /api/dns-monitors/:dnsMonitorPublicId/check-history
Key Sections: Query Parameters | Example (cURL) | Example Response | Common errors
Summary: Get DNS Monitor Check History GET /api/dns-monitors/:dnsMonitorPublicId/check-history Returns recent DNS check results for a monitor. Query Parameters limit (optional, default 50, max 200) Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/dns-monitors/11111111-1111-4111-8111-111111111111/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "data": [] } Common errors 400 DNS monitor public ID (UUID) required 401 Unauthorized 403 Forbidden

#### List DNS Monitors
URL: https://uptimeify.io/docs/api/monitors/dns-monitors/list-dns-monitors
Description: GET /api/dns-monitors
Endpoints: GET /api/dns-monitors
Key Sections: Query Parameters | Example (cURL) | Example Response | Common errors
Summary: List DNS Monitors GET /api/dns-monitors Lists DNS monitors for an organization (with pagination). Each item contains the DNS monitor itself and does not embed the full customer record. Query Parameters organizationId (optional): defaults to your session organization customerId (optional) search (optional) page (optional, default 1) perPage (optional, default 50, max 200) Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/dns-monitors?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "items": [ { "id": 5, "publicId": "79fbe9b0-f9c6-4026-86de-1dbebc84d9bb", "organizationId": 2, "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "name": "Primary DNS Monitor", "hostname": "claas.sh", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": {}, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-03T14:54:56.561Z", "createdAt": "2026-04-03T14:54:56.383Z", "updatedAt": "2026-04-03T14:54:56.740Z" } ], "total": 0, "page": 1, "perPage": 50 } Common errors 400 Invalid organizationId when organizationId is invalid 400 Invalid customerId when customerId is invalid 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### Trigger DNS Check
URL: https://uptimeify.io/docs/api/monitors/dns-monitors/trigger-check-dns-monitor
Description: POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check
Endpoints: POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check
Key Sections: Example (cURL) | Example Response | Common errors
Summary: Trigger DNS Check POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check Triggers an immediate DNS check across eligible monitoring locations. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST \ "$BASE URL/api/dns-monitors/11111111-1111-4111-8111-111111111111/trigger-check" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "success": true, "message": "Checks triggered successfully", "dnsMonitorId": 123, "locationCodes": ["fra"], "queueNames": ["dns-monitor-checks-fra"] } Common errors 400 DNS monitor public ID (UUID) required 401 Unauthorized 403 Forbidden (requires write access) 503 No active monitoring locations available

#### Update DNS Monitor
URL: https://uptimeify.io/docs/api/monitors/dns-monitors/update-dns-monitor
Description: PATCH /api/dns-monitors/:dnsMonitorPublicId
Endpoints: PATCH /api/dns-monitors/:dnsMonitorPublicId
Key Sections: Request Body (example) | Example (cURL) | Common errors
Summary: Update DNS Monitor PATCH /api/dns-monitors/:dnsMonitorPublicId Updates a DNS monitor. Notes: Readonly users may only change status. Global supporters cannot update DNS monitors. If you send customerId, it accepts either the internal numeric ID or the customer publicId UUID. Request Body (example) { "customerId": "6764e84f-f02a-43e6-a46d-cecaec556723", "status": "maintenance", "name": "Primary DNS Monitor", "hostname": "claas.sh", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": ["A"], "matchMode": "exact", "expectedValues": { "A": ["76.76.21.21"] }, "triggerOn": { "resolveError": true, "mismatch": true } } } If you send dnsConfig, it must include rrtypes, matchMode, and at least one expectedValues entry for every RR type listed. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH \ "$BASE URL/api/dns-monitors/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"customerId":"6764e84f-f02a-43e6-a46d-cecaec556723","status":"maintenance","name":"Primary DNS Monitor","hostname":"claas.sh","checkInterval":30,"timeoutSeconds":30,"dnsConfig":{"rrtypes":["A"],"matchMode":"exact","expectedValues":{"A":["76.76.21.21"]},"triggerOn":{"resolveError":true,"mismatch":true}}}' Common errors 400 DNS monitor ID is required 400 Invalid status 400 Invalid Customer identifier 400 Expected values are required for RR type <TYPE 401 Unauthorized 403 Forbidden 404 Customer not found

#### DNSBL Monitoring (Customer IPs)
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring
Description: Manage IPs used for DNSBL blacklist monitoring.
Key Sections: Endpoints
Summary: DNSBL monitoring is configured via customer IPs . These IPs are periodically checked against DNS-based blacklists. Endpoints List Customer IPs (Org) Get Customer IP Update Customer IP Delete Customer IP List Customer IPs (Customer) Create Customer IP (Customer)

#### Create Customer Ip For Customer
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/create-customer-ip-for-customer
Endpoints: POST /api/customers/:customerPublicId/ips
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: title: Create Customer IP (Customer) description: POST /api/customers/:customerPublicId/ips --- Create Customer IP (Customer) POST /api/customers/:customerPublicId/ips Creates a new customer IP for DNSBL monitoring. Request Body { "ipAddress": "203.0.113.10", "label": "Mail Server", "ipFamily": "v4", "status": "active" } Notes: customerPublicId should be the customer public UUID. Legacy numeric customer IDs remain supported for compatibility. ipFamily is optional; if omitted, it is inferred from the IP address. If ipFamily is provided, it must match the IP address version. Creating an active IP may be blocked by quota limits. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/ips" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"ipAddress":"203.0.113.10","label":"Mail Server","status":"active"}' Response Returns the newly created customer IP record. Common errors 400 Invalid Customer identifier when :customerPublicId is missing/invalid 400 Invalid IP address when ipAddress is invalid 400 IP family mismatch... when ipFamily does not match the IP 401 Unauthorized when you are not logged in 403 Forbidden for readonly/global supporter users, or when you cannot access the customer 403 Active IP limit reached... when creating/activating would exceed your quota 404 Customer not found when the customer does not exist 409 IP already exists for this customer when the IP is already present

#### Delete Customer IP
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/delete-customer-ip
Description: DELETE /api/customer-ips/:customerIpPublicId
Endpoints: DELETE /api/customer-ips/:customerIpPublicId
Key Sections: Example (cURL) | Example Response | Common errors
Summary: Delete Customer IP DELETE /api/customer-ips/:customerIpPublicId Deletes a customer IP. Notes: Readonly users and global supporters cannot delete customer IPs. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE "$BASE URL/api/customer-ips/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" Example Response { "success": true } Common errors 400 Invalid IP identifier when :customerIpPublicId is neither a valid UUID nor a legacy numeric ID 401 Unauthorized when you are not logged in 403 Forbidden for readonly/global supporter users, or when you cannot access the customer 404 IP not found when the IP does not exist

#### Get Customer IP
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/get-customer-ip
Description: GET /api/customer-ips/:customerIpPublicId
Endpoints: GET /api/customer-ips/:customerIpPublicId
Key Sections: Path Parameters | Example (cURL) | Example response | Common errors
Summary: Get Customer IP GET /api/customer-ips/:customerIpPublicId Returns a customer IP including DNSBL status (if available). The response contains the customer IP itself and, if available, a dnsbl object. It does not embed the full customer record. Path Parameters customerIpPublicId (recommended): customer IP public UUID Backward compatibility: legacy numeric IDs are still accepted Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/customer-ips/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example response { "id": 1, "publicId": "a19effb9-eb5f-459b-b5d6-2f615b574651", "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "label": "Kurbelix Adminserver", "ipAddress": "77.75.254.185", "ipFamily": "v4", "status": "active", "createdAt": "2026-02-03T15:06:46.469Z", "updatedAt": "2026-02-03T15:06:46.469Z", "dnsbl": { "isListed": true, "listedCount": 1, "listings": [ { "name": "all.s5h.net", "reason": "Listed in all.s5h.net", "listKey": "all.s5h.net", "delistUrl": "http://s5h.net", "resultCode": "127.0.0.2" } ], "lastError": null, "lastCheckedAt": "2026-04-03T15:13:00.083Z", "lastChangedAt": "2026-02-04T10:00:00.121Z", "lastListedAt": "2026-04-03T15:13:00.083Z", "lastCleanAt": null, "lastNotifiedListedAt": "2026-04-02T20:55:04.969Z", "lastNotifiedCleanAt": null } } Common errors 400 Invalid IP identifier when :customerIpPublicId is neither a valid UUID nor a legacy numeric ID 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the customer 404 IP not found when the IP does not exist

#### List Customer IPs (Org)
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/list-customer-ips
Description: GET /api/customer-ips
Endpoints: GET /api/customer-ips
Key Sections: Query Parameters | Example (cURL) | Example Response | Common errors
Summary: List Customer IPs (Org) GET /api/customer-ips Lists customer IPs within an organization (pagination + search). This is the primary API for DNSBL monitoring configuration. Query Parameters organizationId (optional): defaults to your session organization customerId (optional): accepts the customer public UUID (recommended) or a legacy numeric customer ID search (optional) page (optional, default 1) perPage (optional, default 50, max 200) Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/customer-ips?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "items": [], "total": 0, "page": 1, "perPage": 50 } Common errors 400 Organization ID required when the organization cannot be derived 400 query validation errors (e.g. invalid organizationId, customerId, page, perPage) 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### List Customer Ips For Customer
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/list-customer-ips-for-customer
Endpoints: GET /api/customers/:customerPublicId/ips
Key Sections: Path Parameters | Example (cURL) | Response | Common errors
Summary: title: List Customer IPs (Customer) description: GET /api/customers/:customerPublicId/ips --- List Customer IPs (Customer) GET /api/customers/:customerPublicId/ips Lists IPs for a single customer, including DNSBL status. Path Parameters customerPublicId (recommended): Customer public UUID Legacy compatibility: numeric customer IDs are still accepted Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/ips" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response Returns an array of customer IP objects. Each item may include a dnsbl object. Common errors 400 Invalid Customer identifier when :customerPublicId is missing/invalid 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the customer 404 Customer not found when the customer does not exist

#### Update Customer IP
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/update-customer-ip
Description: PATCH /api/customer-ips/:customerIpPublicId
Endpoints: PATCH /api/customer-ips/:customerIpPublicId
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Update Customer IP PATCH /api/customer-ips/:customerIpPublicId Updates a customer IP (e.g. label or status). Notes: Readonly users and global supporters cannot update customer IPs. Activating an IP can be denied when quota limits are reached. Request Body { "label": "Mail Server", "status": "active" } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH "$BASE URL/api/customer-ips/11111111-1111-4111-8111-111111111111" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"label":"Mail Server","status":"active"}' Response Returns the updated customer IP record. Common errors 400 Invalid IP identifier when :customerIpPublicId is neither a valid UUID nor a legacy numeric ID 400 body validation errors (e.g. invalid status) 401 Unauthorized when you are not logged in 403 Forbidden for readonly/global supporter users, or when you cannot access the customer 403 Active IP limit reached... when activating would exceed your quota 404 IP not found when the IP does not exist

#### Domain Expiry Monitoring (Customer Domains)
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring
Description: Manage domains used for domain expiry monitoring.
Key Sections: Endpoints
Summary: Domain expiry monitoring is configured via customer domains . Endpoints Create Customer Domain (Customer) List Customer Domains (Org) Get Customer Domain Update Customer Domain Delete Customer Domain List Domain Expiry (Websites)

#### Create Customer Domain
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/create-customer-domain
Endpoints: POST /api/customers/:customerPublicId/domains
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: title: Create Customer Domain (Customer) description: POST /api/customers/:customerPublicId/domains --- Create Customer Domain (Customer) POST /api/customers/:customerPublicId/domains Creates a customer domain for expiry monitoring. Request Body { "domainName": "example.com", "label": "Main Domain", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7 } Notes: customerPublicId should be the customer public UUID. Legacy numeric customer IDs remain supported for compatibility. domainName must be a valid domain like example.com (no protocol, no path). Creating an active domain may be blocked by quota limits. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/domains" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"domainName":"example.com","label":"Main Domain","status":"active","expiryWarningDays":30,"expiryErrorDays":7}' Response Returns the newly created customer domain record. Common errors 400 Invalid Customer identifier when :customerPublicId is missing/invalid 400 Invalid domain name... when domainName is invalid 401 Unauthorized when you are not logged in 403 Forbidden for readonly/global supporter users, or when you cannot access the customer 403 Active domain limit reached... when creating/activating would exceed your quota 404 Customer not found when the customer does not exist

#### Delete Customer Domain
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/delete-customer-domain
Description: DELETE /api/customer-domains/:customerDomainPublicId
Endpoints: DELETE /api/customer-domains/:customerDomainPublicId
Key Sections: Example (cURL) | Example Response | Common errors
Summary: Delete Customer Domain DELETE /api/customer-domains/:customerDomainPublicId Deletes a customer domain. Notes: Readonly users and global supporters cannot delete customer domains. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE "$BASE URL/api/customer-domains/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" Example Response { "success": true } Common errors 400 Invalid Domain identifier when :customerDomainPublicId is neither a valid UUID nor a legacy numeric ID 401 Unauthorized when you are not logged in 403 Forbidden for readonly/global supporter users, or when you cannot access the domain/customer 404 Domain not found when the domain does not exist

#### Get Customer Domain
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/get-customer-domain
Description: GET /api/customer-domains/:customerDomainPublicId
Endpoints: GET /api/customer-domains/:customerDomainPublicId
Key Sections: Path Parameters | Example (cURL) | Example response | Common errors
Summary: Get Customer Domain GET /api/customer-domains/:customerDomainPublicId Returns a single customer domain. The response contains the customer domain itself and does not embed the full customer record. Path Parameters customerDomainPublicId (recommended): customer domain public UUID Backward compatibility: legacy numeric IDs are still accepted Notes: Some registries/TLDs (e.g. .de) may not publish an expiration date via RDAP. In that case, expiry.domainExpiresAt can be null and expiry.lastError may contain an explanatory message. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/customer-domains/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example response { "id": 20, "publicId": "d70884d9-4cef-4fe5-9b15-341b7dd9e196", "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "label": "Primary Domain", "domainName": "cacheassist.io", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7, "createdAt": "2026-04-03T15:28:40.602Z", "updatedAt": "2026-04-03T15:28:40.602Z", "expiry": { "domainExpiresAt": null, "domainRegistrar": null, "isExpired": false, "lastError": "RDAP query error for cacheassist.io: fetch failed", "lastCheckedAt": "2026-04-03T15:29:00.200Z", "lastChangedAt": null, "lastNotifiedWarningAt": null, "lastNotifiedErrorAt": null, "lastNotifiedExpiredAt": null } } Common errors 400 Invalid Domain identifier when :customerDomainPublicId is neither a valid UUID nor a legacy numeric ID 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the domain/customer 404 Domain not found when the domain does not exist

#### List Customer Domains (Org)
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/list-customer-domains
Description: GET /api/customer-domains
Endpoints: GET /api/customer-domains
Key Sections: Query Parameters | Example (cURL) | Response | Common errors
Summary: List Customer Domains (Org) GET /api/customer-domains Lists customer domains within an organization (pagination + search). Query Parameters organizationId (optional): defaults to your session organization customerId (optional): accepts the customer public UUID (recommended) or a legacy numeric customer ID search (optional) page (optional, default 1) perPage (optional, default 50, max 200) Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/customer-domains?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response Returns a paginated response: { "items": [ { "id": 1, "publicId": "34eb0ec1-315d-45c4-aefe-0e5d12b11183", "customerId": 2, "customerName": "Zaskoku & Haupt GbR", "customerPublicId": "6764e84f-f02a-43e6-a46d-cecaec556723", "label": null, "domainName": "digitalduett.com", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7, "createdAt": "2026-02-13T21:21:03.001Z", "updatedAt": "2026-02-13T21:21:03.001Z", "expiry": { "domainExpiresAt": "2026-12-20T20:44:45.000Z", "domainRegistrar": "NameCheap, Inc.", "isExpired": false, "lastError": null, "lastCheckedAt": "2026-04-03T10:59:00.321Z", "lastChangedAt": "2026-04-03T10:59:00.321Z", "lastNotifiedWarningAt": null, "lastNotifiedErrorAt": null, "lastNotifiedExpiredAt": null } } ], "total": 0, "page": 1, "perPage": 50 } Each item includes flat customer fields plus an expiry object (or null). Common errors 400 Organization ID required when the organization cannot be derived 400 query validation errors (e.g. invalid organizationId, customerId, page, perPage) 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### List Domain Expiry (Websites)
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/list-domain-expiry-websites
Description: GET /api/domains
Endpoints: GET /api/domains
Key Sections: Query Parameters | Example (cURL) | Response | Field notes | Common errors
Summary: List Domain Expiry (Websites) GET /api/domains Lists websites with latest known domain expiry information. Query Parameters organizationId (optional): defaults to your session organization customerId (optional) search (optional) page (optional, default 1) perPage (optional, default 50, max 200) Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/domains?organizationId=1&page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "items": [ { "id": 101, "name": "Example Website", "url": "https://example.com", "status": "active", "customerId": 10, "customerName": "Example Customer", "checkDomainExpiryEnabled": true, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "domainExpiresAt": "2026-12-31T00:00:00.000Z", "domainRegistrar": "Example Registrar", "lastDomainCheckAt": "2026-03-03T10:00:00.000Z", "daysUntilExpiry": 303, "expiryStatus": "ok" } ], "total": 1, "page": 1, "perPage": 50 } Field notes expiryStatus can be: ok, warning, critical, expired, unknown, disabled. daysUntilExpiry is null when no expiration date is available. Common errors 400 Organization ID required when the organization cannot be derived 400 Invalid customerId when customerId is invalid 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### Update Customer Domain
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/update-customer-domain
Description: PATCH /api/customer-domains/:customerDomainPublicId
Endpoints: PATCH /api/customer-domains/:customerDomainPublicId
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Update Customer Domain PATCH /api/customer-domains/:customerDomainPublicId Updates a customer domain (e.g. label, status, expiry thresholds). Notes: Readonly users and global supporters cannot update customer domains. Activating a disabled domain can be denied when quota limits are reached. Request Body { "label": "Main Domain", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7 } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH "$BASE URL/api/customer-domains/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"status":"active"}' Response Returns the updated customer domain record. Common errors 400 body validation errors (e.g. invalid thresholds) 400 Invalid Domain identifier when :customerDomainPublicId is neither a valid UUID nor a legacy numeric ID 401 Unauthorized when you are not logged in 403 Forbidden for readonly/global supporter users, or when you cannot access the domain/customer 403 Active domain limit reached... when activating would exceed your quota 404 Domain not found when the domain does not exist

#### FTP Monitors
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors
Description: Manage FTP monitors.
Key Sections: Endpoints
Summary: Manage FTP monitors. Path-based FTP monitor endpoints use ftpMonitorPublicId UUIDs. Endpoints List FTP Monitors Create FTP Monitor Get FTP Monitor Get FTP Monitor Details Get FTP Monitor Check History Update FTP Monitor (Change Status) Delete FTP Monitor Trigger FTP Check

#### Create FTP Monitor
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/create-ftp-monitor
Description: POST /api/ftp-monitors
Endpoints: POST /api/ftp-monitors
Key Sections: Authentication | Request Body | ftpConfig | Example (cURL) | Response | Common Errors
Summary: Create FTP Monitor POST /api/ftp-monitors Creates a new FTP monitor. Authentication This endpoint requires an API token: Authorization: Bearer <token Request Body customerId (required, number string): internal numeric customer ID or customer publicId UUID name (required, string) hostname (required, string): Must be a hostname (no protocol, no path). port (optional, number null): If omitted/null, the worker uses a default port. status (optional): active, maintenance, disabled (also accepts inactive and normalizes it to disabled) checkInterval (optional, number): Minutes (min: 1, max: 60) timeoutSeconds (optional, number): Seconds (min: 1, max: 60) ftpConfig (optional, object): FTP connection options (stored as JSON) ftpConfig The monitoring worker reads these keys: user (optional, string): Defaults to anonymous password (optional, string): Defaults to anonymous@ secure (optional, boolean "implicit"): - false (default): plain FTP - true: explicit TLS - "implicit": implicit TLS (worker defaults port to 990 when port is not provided) { "customerId": "6764e84f-f02a-43e6-a46d-cecaec556723", "name": "FTP Availability", "hostname": "claas.sh", "port": 21, "status": "active", "checkInterval": 5, "timeoutSeconds": 30, "ftpConfig": { "user": "root", "password": "exampleRoot", "secure": "explicit" } } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST \ "$BASE URL/api/ftp-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"customerId":"6764e84f-f02a-43e6-a46d-cecaec556723","name":"FTP Availability","hostname":"claas.sh","port":21,"status":"active","checkInterval":5,"timeoutSeconds":30,"ftpConfig":{"user":"root","password":"exampleRoot","secure":"explicit"}}' Response { "id": 400, "organizationId": 1, "customerId": 2, "name": "FTP Availability", "hostname": "claas.sh", "port": 21, "status": "active", "checkInterval": 5, "timeoutSeconds": 30, "allowedCheckCountryCodes": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-25T10:00:00.000Z", "updatedAt": "2026-02-25T10:00:00.000Z", "config": { "user": "root", "password": "exampleRoot", "secure": "explicit" }, "ftpConfig": { "user": "root", "password": "exampleRoot", "secure": "explicit" } } Common Errors 400 Invalid Customer identifier if customerId is neither a valid UUID nor a legacy numeric ID 400 hostname must be a valid hostname (no protocol, no path) on invalid hostnames 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access or are not allowed to create monitors (e.g. read-only or global supporter) 404 Customer not found if the customerId does not exist

#### Delete FTP Monitor
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/delete-ftp-monitor
Description: DELETE /api/ftp-monitors/:ftpMonitorPublicId
Endpoints: DELETE /api/ftp-monitors/:ftpMonitorPublicId
Key Sections: Authentication | Parameters | Example (cURL) | Response | Common Errors
Summary: Delete FTP Monitor DELETE /api/ftp-monitors/:ftpMonitorPublicId Deletes an FTP monitor. Authentication Authorization: Bearer <token Parameters ftpMonitorPublicId (Path, required): FTP monitor public UUID. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Common Errors 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have write access (e.g. global supporter or read-only) 404 FTP monitor not found if the monitor does not exist

#### Get FTP Monitor
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/get-ftp-monitor
Description: GET /api/ftp-monitors/:ftpMonitorPublicId
Endpoints: GET /api/ftp-monitors/:ftpMonitorPublicId
Key Sections: Authentication | Parameters | Example (cURL) | Response | Common Errors
Summary: Get FTP Monitor GET /api/ftp-monitors/:ftpMonitorPublicId Returns details of a specific FTP monitor. The response contains the FTP monitor itself and does not embed the full customer record. Authentication Authorization: Bearer <token Parameters ftpMonitorPublicId (Path, required): FTP monitor public UUID. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555" \ -H "Authorization: Bearer $TOKEN" Response { "id": 400, "organizationId": 1, "customerId": 10, "name": "Partner FTP", "hostname": "ftp.example.com", "port": 21, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "allowedCheckCountryCodes": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-25T10:00:00.000Z", "updatedAt": "2026-02-25T10:00:00.000Z", "config": { "user": "monitor", "password": "<ftp-password ", "secure": false }, "ftpConfig": { "user": "monitor", "password": "<ftp-password ", "secure": false } } Common Errors 400 FTP monitor public ID (UUID) required if ftpMonitorPublicId is missing or invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access 404 FTP monitor not found if the monitor does not exist

#### Get FTP Monitor Check History
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/get-ftp-monitor-check-history
Description: GET /api/ftp-monitors/:ftpMonitorPublicId/check-history
Endpoints: GET /api/ftp-monitors/:ftpMonitorPublicId/check-history
Key Sections: Authentication | Parameters | Example (cURL) | Example Response | Common Errors
Summary: Get FTP Monitor Check History GET /api/ftp-monitors/:ftpMonitorPublicId/check-history Returns recent FTP check results for a monitor. Authentication Authorization: Bearer <token Parameters ftpMonitorPublicId (Path, required): FTP monitor public UUID. limit (Query, optional): Number of results (default: 50, max: 200) Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555/check-history?limit=25" \ -H "Authorization: Bearer $TOKEN" Example Response { "data": [ { "id": "2fd6d5ab-1e2a-4b4f-9c42-0f3a33a4a1d2", "status": "success", "errorMessage": null, "warningMessage": null, "timingFtp": 123, "diagnostics": { "message": "FTP connection successful" }, "checkedAt": "2026-02-25T10:05:00.000Z", "locationId": 1, "locationName": "Frankfurt", "locationCode": "DE" } ] } Common Errors 400 FTP monitor public ID (UUID) required if ftpMonitorPublicId is missing or invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access 404 FTP monitor not found if the monitor does not exist

#### Get FTP Monitor Details
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/get-ftp-monitor-details
Description: GET /api/ftp-monitors/:ftpMonitorPublicId/details
Endpoints: GET /api/ftp-monitors/:ftpMonitorPublicId/details
Key Sections: Authentication | Parameters | Query Parameters | Example (cURL) | Example Response (shape) | Common Errors
Summary: Get FTP Monitor Details GET /api/ftp-monitors/:ftpMonitorPublicId/details Returns the FTP monitor detail page data in one call (mega endpoint). Authentication Authorization: Bearer <token Parameters ftpMonitorPublicId (Path, required): FTP monitor public UUID. Query Parameters range (optional): day (default), week, month, year date (optional): Reference date (ISO string) startDate / endDate (optional): Override the time window (ISO strings) granularity (optional): When omitted the server may aggregate automatically for large time ranges. Use granularity=raw to force raw data. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555/details?range=day" \ -H "Authorization: Bearer $TOKEN" Example Response (shape) The response is a single object with these top-level keys: { "ftpMonitorId": 400, "monitor": {}, "latestCheck": {}, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 120, "monthAvgResponse": 130, "yearAvgResponse": 140 }, "uptimeStatsMeta": {}, "monitoringData": { "responseTimeData": [], "statusData": [], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "100.00", "totalChecks": 10, "successfulChecks": 10 }, "incidents": { "history": [], "total": 0, "ongoing": 0, "totalDowntime": "0s" }, "alerts": { "history": [], "total": 0, "notificationContext": {} }, "testResultLog": null, "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } Common Errors 400 Invalid FTP monitor public ID (UUID) if ftpMonitorPublicId is invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access 500 Failed to fetch FTP monitor details on server errors

#### List FTP Monitors
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/list-ftp-monitors
Description: GET /api/ftp-monitors
Endpoints: GET /api/ftp-monitors
Key Sections: Authentication | Parameters | Example (cURL) | Response | Common Errors
Summary: List FTP Monitors GET /api/ftp-monitors Lists FTP monitors in an organization. Authentication Authorization: Bearer <token Parameters organizationId (Query, optional): Organization ID. Defaults to the current user's organization. customerId (Query, optional): Filter by customer ID. search (Query, optional): Search by monitor name, hostname, or customer. page (Query, optional): Page number (default: 1). perPage (Query, optional): Items per page (default: 50, max: 200). Note: The results are also limited by your customer scope (if your account is restricted to a subset of customers). Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/ftp-monitors?page=1&perPage=50&search=ftp" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 400, "organizationId": 1, "customerId": 10, "customerName": "Example Customer", "name": "Partner FTP", "hostname": "ftp.example.com", "port": 21, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "allowedCheckCountryCodes": null, "config": { "user": "monitor", "password": "<ftp-password ", "secure": false }, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-25T10:00:00.000Z", "updatedAt": "2026-02-25T10:00:00.000Z" } ], "total": 1, "page": 1, "perPage": 50 } Each item contains the FTP monitor itself and a flat customerName, not a full embedded customer record. Common Errors 400 Invalid organizationId if organizationId is not a valid number 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access to the organization

#### Trigger FTP Check
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/trigger-check-ftp-monitor
Description: POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check
Endpoints: POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check
Key Sections: Authentication | Parameters | Example (cURL) | Response | Common Errors
Summary: Trigger FTP Check POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check Triggers an immediate check from all eligible monitoring locations. Authentication Authorization: Bearer <token Parameters ftpMonitorPublicId (Path, required): FTP monitor public UUID. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "ftpMonitorId": 400, "locationCodes": ["DE", "US"], "queueNames": ["ftp-monitor-checks-DE", "ftp-monitor-checks-US"] } Common Errors 400 FTP monitor public ID (UUID) required if ftpMonitorPublicId is missing or invalid 400 No eligible monitoring locations for the selected allowed countries if your country restrictions match no active locations 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have write access 503 No active monitoring locations available if no worker locations are active

#### Update FTP Monitor (Change Status)
URL: https://uptimeify.io/docs/api/monitors/ftp-monitors/update-ftp-monitor
Description: PATCH /api/ftp-monitors/:ftpMonitorPublicId
Endpoints: PATCH /api/ftp-monitors/:ftpMonitorPublicId
Key Sections: Authentication | Parameters | Request Body | Example (cURL) | Response | Common Errors
Summary: Update FTP Monitor (Change Status) PATCH /api/ftp-monitors/:ftpMonitorPublicId Updates an FTP monitor and/or changes its status. Authentication Authorization: Bearer <token Parameters ftpMonitorPublicId (Path, required): FTP monitor public UUID. Request Body status (optional): active, maintenance, disabled (also accepts inactive/paused and normalizes them to disabled) customerId (optional, number): Must belong to the same organization name (optional, string) hostname (optional, string): Must be a hostname (no protocol, no path) port (optional, number null) checkInterval (optional, number) timeoutSeconds (optional, number) allowedCheckCountryCodes (optional, string[] null): ISO-3166-1 alpha-2, e.g. "DE", "US" ftpConfig (optional, object): Replaces the stored FTP config JSON config (optional, object): Alias of ftpConfig Note: Read-only users may only change status. Note: If you omit ftpConfig/config, the current config remains unchanged. { "status": "maintenance" } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH \ "$BASE URL/api/ftp-monitors/55555555-5555-4555-8555-555555555555" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"status":"active","allowedCheckCountryCodes":["DE","US"],"ftpConfig":{"user":"monitor","password":"<ftp-password ","secure":false}}' Response { "id": 400, "status": "maintenance", "config": {}, "ftpConfig": {} } Common Errors 400 Invalid status if status is not valid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have write access (e.g. read-only user tries to change other fields, or global supporter) 404 FTP monitor not found if the monitor does not exist

#### ICMP Monitors
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors
Description: Manage ICMP (ping) monitors.
Key Sections: Endpoints
Summary: Manage ICMP (ping) monitors. Path-based ICMP monitor endpoints use icmpMonitorPublicId UUIDs. Endpoints List ICMP Monitors Create ICMP Monitor Get ICMP Monitor Get ICMP Monitor Details Get ICMP Monitor Check History Update ICMP Monitor Delete ICMP Monitor Trigger ICMP Check

#### Create ICMP Monitor
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/create-icmp-monitor
Description: POST /api/icmp-monitors
Endpoints: POST /api/icmp-monitors
Key Sections: Authentication | Request Body | Fields | icmpConfig (worker-supported keys) | cURL | Response | Errors
Summary: Create ICMP Monitor POST /api/icmp-monitors Creates a new ICMP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Request Body { "customerId": "6764e84f-f02a-43e6-a46d-cecaec556723", "name": "Ping Gateway", "hostname": "claas.sh", "status": "active", "checkInterval": 5, "timeoutSeconds": 10, "icmpConfig": { "packetSize": 56, "count": 4 } } Fields customerId (number string, required) - Accepts the internal numeric customer ID or the customer publicId UUID. name (string, required) hostname (string, required) - Must be a hostname or IP only (no protocol like https://, no path like /ping). status (string, optional) - Allowed: active, maintenance, disabled, paused, inactive - Note: paused / inactive are normalized to disabled. checkInterval (number, optional) timeoutSeconds (number, optional) icmpConfig (object, optional) - Stored as the monitor's config JSON. icmpConfig (worker-supported keys) packetSize (number) - Default: 56 count (number) - Default: 3 cURL curl -X POST "https://YOUR DOMAIN/api/icmp-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": "6764e84f-f02a-43e6-a46d-cecaec556723", "name": "Ping Gateway", "hostname": "claas.sh", "status": "active", "checkInterval": 5, "timeoutSeconds": 10, "icmpConfig": { "packetSize": 56, "count": 4 } }' Response { "id": 123, "organizationId": 1, "customerId": 2, "name": "Ping Gateway", "hostname": "claas.sh", "port": null, "status": "active", "checkInterval": 5, "timeoutSeconds": 10, "allowedCheckCountryCodes": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "config": { "packetSize": 56, "count": 4 }, "icmpConfig": { "packetSize": 56, "count": 4 } } Errors 400 Invalid Customer identifier 400 Invalid hostname or invalid request body 401 Unauthorized 403 Forbidden (e.g. readonly or global supporter) 404 Customer not found

#### Delete ICMP Monitor
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/delete-icmp-monitor
Description: DELETE /api/icmp-monitors/:icmpMonitorPublicId
Endpoints: DELETE /api/icmp-monitors/:icmpMonitorPublicId
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Delete ICMP Monitor DELETE /api/icmp-monitors/:icmpMonitorPublicId Deletes an ICMP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters icmpMonitorPublicId (Path, required): ICMP monitor public UUID. cURL curl -X DELETE "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Errors 400 ICMP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 ICMP monitor not found

#### Get ICMP Monitor
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/get-icmp-monitor
Description: GET /api/icmp-monitors/:icmpMonitorPublicId
Endpoints: GET /api/icmp-monitors/:icmpMonitorPublicId
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Get ICMP Monitor GET /api/icmp-monitors/:icmpMonitorPublicId Returns details of a specific ICMP monitor. The response contains the ICMP monitor itself and does not embed the full customer record. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters icmpMonitorPublicId (Path, required): ICMP monitor public UUID. cURL curl "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" Response { "id": 123, "organizationId": 1, "customerId": 10, "name": "Core Router", "hostname": "10.0.0.1", "port": null, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "config": { "packetSize": 56, "count": 3 }, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "icmpConfig": { "packetSize": 56, "count": 3 } } Errors 400 ICMP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 ICMP monitor not found

#### Get ICMP Monitor Check History
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/get-icmp-monitor-check-history
Description: GET /api/icmp-monitors/:icmpMonitorPublicId/check-history
Endpoints: GET /api/icmp-monitors/:icmpMonitorPublicId/check-history
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Get ICMP Monitor Check History GET /api/icmp-monitors/:icmpMonitorPublicId/check-history Returns recent check results for the ICMP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters icmpMonitorPublicId (Path, required): ICMP monitor public UUID. limit (Query, optional): Maximum number of results (default: 50, max: 200). cURL curl -X GET "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": "f6b0e5a7-4c4a-4d3b-9f6b-0e5a74c4a4d3", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 22, "diagnostics": { "min": 11.1, "avg": 22.2, "max": 33.3, "packetLoss": 0 }, "checkedAt": "2026-02-26T12:00:00.000Z", "locationId": 1, "locationName": "Frankfurt", "locationCode": "fra" } ] } Errors 400 ICMP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 ICMP monitor not found

#### Get ICMP Monitor Details
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/get-icmp-monitor-details
Description: GET /api/icmp-monitors/:icmpMonitorPublicId/details
Endpoints: GET /api/icmp-monitors/:icmpMonitorPublicId/details
Key Sections: Authentication | Parameters | Time range query parameters | cURL | Response | Errors
Summary: Get ICMP Monitor Details GET /api/icmp-monitors/:icmpMonitorPublicId/details Returns a consolidated payload used by the monitor details page, including the monitor, customer, and aggregated check data for a given time range. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters icmpMonitorPublicId (Path, required): ICMP monitor public UUID. Time range query parameters The endpoint supports multiple ways to define the time range. Use the simplest option for your use case: range (Query, optional): Preset range. - Allowed: day (default), week, month, year date (Query, optional): Reference date used as the default end date. - Example: 2026-02-26 startDate (Query, optional): Start date/time. endDate (Query, optional): End date/time. granularity (Query, optional): Controls aggregation. - Use raw to disable aggregation. - Any other value enables aggregation. - If omitted, the server may aggregate automatically for larger ranges. If you provide multiple, the server resolves them according to its internal precedence rules. cURL curl -X GET "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222/details?range=day&granularity=raw" \ -H "Authorization: Bearer $TOKEN" Response Top-level fields (current shape): icmpMonitorId monitor latestCheck uptimeStats, uptimeStatsMeta monitoringData incidents alerts testResultLog maintenance Example: { "icmpMonitorId": 123, "monitor": { "id": 123, "customerId": 10, "organizationId": 1, "name": "Core Router", "hostname": "10.0.0.1", "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "port": null, "config": { "packetSize": 56, "count": 3 }, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z" }, "latestCheck": null, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 22, "monthAvgResponse": 22, "yearAvgResponse": 22 }, "uptimeStatsMeta": { "day": { "window": "24h", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 24, "checksFailed": 0 }, "month": { "window": "30d", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 720, "checksFailed": 0 }, "year": { "window": "YTD", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1000, "checksFailed": 0 } }, "monitoringData": { "responseTimeData": [ { "timestamp": "2026-02-26T12:00:00.000Z", "responseTime": 22, "status": "success", "success": true, "timingDns": 0, "timingTcp": 22, "timingTls": 0, "timingTtfb": 0, "timingTransfer": 0 } ], "statusData": [{ "date": "26.02", "status": "online" }], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "100.00", "totalChecks": 100, "successfulChecks": 100 }, "incidents": { "history": [], "total": 0, "ongoing": 0, "totalDowntime": "0s" }, "alerts": { "history": [], "total": 0, "notificationContext": { "orgDefaultEmail": null, "orgDefaultPhoneNumber": null, "customerEmail": null, "notificationTargets": [] } }, "testResultLog": [], "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } Errors 400 ICMP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 ICMP monitor not found 500 Failed to fetch ICMP monitor details

#### List ICMP Monitors
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/list-icmp-monitors
Description: GET /api/icmp-monitors
Endpoints: GET /api/icmp-monitors
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: List ICMP Monitors GET /api/icmp-monitors Lists ICMP monitors in an organization. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters organizationId (Query, optional): Organization ID. Defaults to the current user's organization. customerId (Query, optional): Filter by customer ID. search (Query, optional): Search by monitor name, hostname, or customer. page (Query, optional): Page number (default: 1). perPage (Query, optional): Items per page (default: 50, max: 200). cURL curl "https://YOUR DOMAIN/api/icmp-monitors?page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 123, "organizationId": 1, "customerId": 10, "customerName": "Example Customer", "name": "Core Router", "hostname": "10.0.0.1", "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "port": null, "config": { "packetSize": 56, "count": 3 }, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z" } ], "total": 1, "page": 1, "perPage": 50 } Each item contains the ICMP monitor itself and a flat customerName, not a full embedded customer record. Errors 400 Invalid query parameters (e.g. organizationId, customerId) 401 Unauthorized 403 Forbidden

#### Trigger ICMP Check
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/trigger-check-icmp-monitor
Description: POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check
Endpoints: POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Trigger ICMP Check POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check Triggers an immediate check from all eligible monitoring locations. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters icmpMonitorPublicId (Path, required): ICMP monitor public UUID. cURL curl -X POST "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "icmpMonitorId": 123, "locationCodes": ["fra", "nyc"], "queueNames": ["icmp-monitor-checks-fra", "icmp-monitor-checks-nyc"] } Errors 400 ICMP monitor public ID (UUID) required or no eligible locations 401 Unauthorized 403 Forbidden 404 ICMP monitor not found 503 No active monitoring locations available 500 Failed to trigger check

#### Update ICMP Monitor
URL: https://uptimeify.io/docs/api/monitors/icmp-monitors/update-icmp-monitor
Description: PATCH /api/icmp-monitors/:icmpMonitorPublicId
Endpoints: PATCH /api/icmp-monitors/:icmpMonitorPublicId
Key Sections: Authentication | Parameters | Request Body | cURL | Response | Errors
Summary: Update ICMP Monitor PATCH /api/icmp-monitors/:icmpMonitorPublicId Updates an ICMP monitor. This endpoint is also used to change the monitor status. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters icmpMonitorPublicId (Path, required): ICMP monitor public UUID. Request Body All fields are optional. status (optional) - Allowed: active, maintenance, disabled, paused, inactive - Note: paused / inactive are normalized to disabled. name, hostname, checkInterval, timeoutSeconds (optional) port (optional) - Supported by the API, but currently not used by the ICMP worker. allowedCheckCountryCodes (optional) - Normalized to upper-case and de-duplicated. icmpConfig (optional) - Alias for the stored config JSON. config (optional) - Alternative way to update the same stored config JSON. Note: Read-only users may only change status (and sending any other fields will result in 403). { "status": "maintenance", "allowedCheckCountryCodes": ["DE", "US"] } Example updating config: { "icmpConfig": { "packetSize": 56, "count": 3 } } cURL curl -X PATCH "https://YOUR DOMAIN/api/icmp-monitors/22222222-2222-4222-8222-222222222222" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "status": "disabled" }' Response { "id": 123, "organizationId": 1, "customerId": 10, "name": "Core Router", "hostname": "10.0.0.1", "port": null, "status": "maintenance", "checkInterval": 30, "timeoutSeconds": 30, "allowedCheckCountryCodes": ["DE", "US"], "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:05:00.000Z", "config": { "packetSize": 56, "count": 3 }, "icmpConfig": { "packetSize": 56, "count": 3 } } Errors 400 Invalid request body, invalid status, or invalid hostname 401 Unauthorized 403 Forbidden (e.g. readonly or global supporter) 404 ICMP monitor not found

#### IMAP/POP Monitors
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors
Description: Manage IMAP/POP monitors.
Key Sections: Endpoints
Summary: Manage IMAP/POP monitors. Path-based IMAP/POP monitor endpoints use imapPopMonitorPublicId UUIDs. Endpoints List IMAP/POP Monitors Create IMAP/POP Monitor Get IMAP/POP Monitor Update IMAP/POP Monitor Delete IMAP/POP Monitor Trigger IMAP/POP Check Get IMAP/POP Monitor Details Get IMAP/POP Monitor Check History

#### Create IMAP/POP Monitor
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/create-imap-pop-monitor
Description: POST /api/imap-pop-monitors
Endpoints: POST /api/imap-pop-monitors
Key Sections: Authentication | Request Body | Fields | imapPopConfig (worker-supported keys) | Default ports (worker behavior) | cURL | Response | Errors
Summary: Create IMAP/POP Monitor POST /api/imap-pop-monitors Creates a new IMAP/POP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Request Body { "customerId": "11111111-1111-4111-8111-111111111111", "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "imapPopConfig": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true, "tlsOptions": { "rejectUnauthorized": true } } } Fields customerId (number string, required) - Accepts either the internal numeric customer ID or the public customer UUID. name (string, required) hostname (string, required) - Must be a hostname only (no protocol like https://, no path like /imap). port (number null, optional) - If omitted or null, the worker chooses a default port depending on imapPopConfig.protocol and imapPopConfig.tls. status (string, optional) - Allowed: active, maintenance, disabled, paused, inactive - Note: paused / inactive are normalized to disabled. checkInterval (number, optional) timeoutSeconds (number, optional) imapPopConfig (object, optional) - Stored as the monitor's config JSON. imapPopConfig (worker-supported keys) protocol (imap pop3) - Default: imap user (string) password (string) tls (boolean) - Default: false tlsOptions.rejectUnauthorized (boolean) - Used by the IMAP worker library; POP3 currently ignores this option. Default ports (worker behavior) If port is omitted or null: IMAP: - TLS (tls: true): 993 - Non-TLS (tls: false): 143 POP3: - TLS (tls: true): 995 - Non-TLS (tls: false): 110 cURL curl -X POST "https://YOUR DOMAIN/api/imap-pop-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": "11111111-1111-4111-8111-111111111111", "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "status": "active", "checkInterval": 30, "timeoutSeconds": 30, "imapPopConfig": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true } }' Response { "id": 500, "organizationId": 1, "customerId": 10, "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "checkInterval": 30, "timeoutSeconds": 30, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "config": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true }, "imapPopConfig": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true } } Errors 400 Invalid hostname or invalid request body 400 Invalid Customer identifier 401 Unauthorized 403 Forbidden (e.g. readonly or global supporter) 404 Customer not found

#### Delete IMAP/POP Monitor
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/delete-imap-pop-monitor
Description: DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId
Endpoints: DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId
Key Sections: Authentication | Parameters | Response | Errors
Summary: Delete IMAP/POP Monitor DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId Deletes an IMAP/POP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters imapPopMonitorPublicId (Path, required): IMAP/POP monitor public UUID. Response { "success": true } Errors 400 IMAP/POP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden (e.g. readonly or global supporter) 404 IMAP/POP monitor not found

#### Get IMAP/POP Monitor
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/get-imap-pop-monitor
Description: GET /api/imap-pop-monitors/:imapPopMonitorPublicId
Endpoints: GET /api/imap-pop-monitors/:imapPopMonitorPublicId
Key Sections: Authentication | Parameters | Response | Errors
Summary: Get IMAP/POP Monitor GET /api/imap-pop-monitors/:imapPopMonitorPublicId Returns details of a specific IMAP/POP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters imapPopMonitorPublicId (Path, required): IMAP/POP monitor public UUID. Response { "id": 500, "organizationId": 1, "customerId": 10, "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "checkInterval": 30, "timeoutSeconds": 30, "config": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "customer": { "id": 10, "organizationId": 1, "name": "Example Customer", "email": "ops@example.com", "allowedCheckCountryCodes": null, "customFields": null, "alertLocationThresholdCount": 1, "createdAt": "2026-02-01T12:00:00.000Z", "updatedAt": "2026-02-01T12:00:00.000Z" }, "imapPopConfig": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true } } Errors 400 IMAP/POP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 IMAP/POP monitor not found

#### Get IMAP/POP Monitor Check History
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/get-imap-pop-monitor-check-history
Description: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history
Endpoints: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Get IMAP/POP Monitor Check History GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history Returns recent check results for the IMAP/POP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters imapPopMonitorPublicId (Path, required): IMAP/POP monitor public UUID. limit (Query, optional): Maximum number of results (default: 50, max: 200). cURL curl -X GET "https://YOUR DOMAIN/api/imap-pop-monitors/66666666-6666-4666-8666-666666666666/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": 123, "status": "success", "errorMessage": null, "warningMessage": null, "timingImapPop": 142, "diagnostics": { "message": "IMAP connection successful" }, "checkedAt": "2026-02-26T12:00:00.000Z", "locationId": 1, "locationName": "Frankfurt", "locationCode": "fra" } ] } Errors 400 IMAP/POP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 IMAP/POP monitor not found

#### Get IMAP/POP Monitor Details
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/get-imap-pop-monitor-details
Description: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details
Endpoints: GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Get IMAP/POP Monitor Details GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details Consolidated endpoint that returns the IMAP/POP monitor detail page payload in a single call (latest check, uptime stats, incidents, alert history, maintenance windows, chart data, etc.). Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters imapPopMonitorPublicId (Path, required): IMAP/POP monitor public UUID. range (Query, optional): day week month year (default: day). date (Query, optional): Reference date as ISO string. startDate (Query, optional): Override start date as ISO string. endDate (Query, optional): Override end date as ISO string. granularity (Query, optional): If set and not raw, the backend may aggregate monitoring chart data. cURL curl -X GET "https://YOUR DOMAIN/api/imap-pop-monitors/66666666-6666-4666-8666-666666666666/details?range=day" \ -H "Authorization: Bearer $TOKEN" Response The response is a large object. Key top-level fields: imapPopMonitorId monitor latestCheck uptimeStats, uptimeStatsMeta monitoringData incidents alerts testResultLog maintenance Example (truncated): { "imapPopMonitorId": 500, "monitor": { "id": 500, "hostname": "mail.example.com", "status": "active" }, "latestCheck": { "id": 123, "status": "success", "checkedAt": "2026-02-26T12:00:00.000Z" }, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 142, "monthAvgResponse": 150, "yearAvgResponse": 160 }, "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } Errors 400 Invalid IMAP/POP monitor public ID (UUID) 401 Unauthorized 403 Forbidden 404 IMAP/POP monitor not found 500 Failed to fetch IMAP/POP monitor details

#### List IMAP/POP Monitors
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/list-imap-pop-monitors
Description: GET /api/imap-pop-monitors
Endpoints: GET /api/imap-pop-monitors
Key Sections: Authentication | Parameters | Response | Errors
Summary: List IMAP/POP Monitors GET /api/imap-pop-monitors Lists IMAP/POP monitors in an organization. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters organizationId (Query, optional): Organization ID. Defaults to the current user's organization. customerId (Query, optional): Filter by customer ID. search (Query, optional): Search by monitor name, hostname, or customer. page (Query, optional): Page number (default: 1). perPage (Query, optional): Items per page (default: 50, max: 200). Response { "items": [ { "id": 500, "organizationId": 1, "customerId": 10, "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "checkInterval": 30, "timeoutSeconds": 30, "customerName": "Example Customer", "config": { "protocol": "imap", "user": "monitor@example.com", "password": "password", "tls": true }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z" } ], "total": 1, "page": 1, "perPage": 50 } Errors 400 Invalid query parameters (e.g. organizationId, customerId) 401 Unauthorized 403 Forbidden

#### Trigger IMAP/POP Check
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/trigger-check-imap-pop-monitor
Description: POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check
Endpoints: POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check
Key Sections: Authentication | Parameters | Response | Errors
Summary: Trigger IMAP/POP Check POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check Triggers an immediate check from all eligible monitoring locations. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters imapPopMonitorPublicId (Path, required): IMAP/POP monitor public UUID. Response { "success": true, "message": "Checks triggered successfully", "imapPopMonitorId": 500, "locationCodes": ["fra", "nyc"], "queueNames": ["imap-pop-monitor-checks-fra", "imap-pop-monitor-checks-nyc"] } Errors 400 Invalid IMAP/POP monitor public ID (UUID) or no eligible locations 401 Unauthorized 403 Forbidden 404 IMAP/POP monitor not found 503 No active monitoring locations available 500 Failed to trigger check

#### Update IMAP/POP Monitor
URL: https://uptimeify.io/docs/api/monitors/imap-pop-monitors/update-imap-pop-monitor
Description: PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId
Endpoints: PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId
Key Sections: Authentication | Parameters | Request Body | Response | Errors
Summary: Update IMAP/POP Monitor PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId Updates an IMAP/POP monitor and/or changes its status. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters imapPopMonitorPublicId (Path, required): IMAP/POP monitor public UUID. Request Body status (optional) - Allowed: active, maintenance, disabled, paused, inactive - Note: paused / inactive are normalized to disabled. name, hostname, port, checkInterval, timeoutSeconds (optional) allowedCheckCountryCodes (optional) - Normalized to upper-case and de-duplicated. imapPopConfig (optional) - Alias for the stored config JSON. config (optional) - Alternative way to update the same stored config JSON. Note: Read-only users may only change status (and sending any other fields will result in 403). { "status": "active" } Example updating config: { "imapPopConfig": { "protocol": "pop3", "tls": true, "user": "monitor@example.com", "password": "password" } } Response { "id": 500, "organizationId": 1, "customerId": 10, "name": "Mailbox Access", "hostname": "mail.example.com", "port": 993, "checkInterval": 30, "timeoutSeconds": 30, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:05:00.000Z", "config": { "protocol": "pop3", "tls": true, "user": "monitor@example.com", "password": "password" }, "imapPopConfig": { "protocol": "pop3", "tls": true, "user": "monitor@example.com", "password": "password" } } Errors 400 Invalid request body, invalid status, or invalid hostname 401 Unauthorized 403 Forbidden (e.g. readonly or global supporter) 404 IMAP/POP monitor not found

#### SMTP Monitors
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors
Description: Manage SMTP monitors via the API.
Key Sections: Endpoints
Summary: Manage SMTP monitors. Path-based SMTP monitor endpoints use smtpMonitorPublicId UUIDs. Endpoints List SMTP Monitors Create SMTP Monitor Get SMTP Monitor Get SMTP Monitor Details Get SMTP Monitor Check History Update SMTP Monitor Delete SMTP Monitor Trigger Check for SMTP Monitor

#### Create SMTP Monitor
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/create-smtp-monitor
Description: POST /api/smtp-monitors
Endpoints: POST /api/smtp-monitors
Key Sections: Authentication | Request Body | Fields | smtpConfig (worker-supported keys) | cURL | Response | Errors
Summary: Create SMTP Monitor POST /api/smtp-monitors Creates a new SMTP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Request Body { "customerId": "11111111-1111-4111-8111-111111111111", "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "smtpConfig": { "secure": false, "ignoreTls": false, "requireTls": false, "auth": { "user": "username", "pass": "password" } } } Fields customerId (number string, required) - Accepts either the internal numeric customer ID or the public customer UUID. name (string, required) hostname (string, required) - Must be a hostname only (no protocol like https://, no path like /smtp). port (number null, optional) - If omitted or null, the worker defaults to 465 when smtpConfig.secure=true, otherwise 25. status (string, optional) - Allowed: active, maintenance, disabled, paused, inactive checkInterval (number, optional) timeoutSeconds (number, optional) smtpConfig (object, optional) - Stored as the monitor's config JSON. smtpConfig (worker-supported keys) The SMTP worker coerces/uses these keys: secure (boolean, default false) ignoreTls (boolean, default false) requireTls (boolean, default false) auth.user and auth.pass (strings) - Credentials are only used when both user and pass are provided. cURL curl -X POST "https://YOUR DOMAIN/api/smtp-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": "11111111-1111-4111-8111-111111111111", "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "smtpConfig": { "secure": false, "ignoreTls": false, "requireTls": false, "auth": { "user": "username", "pass": "password" } } }' Response { "id": 200, "organizationId": 1, "customerId": 10, "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": null, "createdAt": "2026-01-01T12:00:00.000Z", "updatedAt": "2026-01-01T12:00:00.000Z", "config": { "secure": false, "ignoreTls": false, "requireTls": false, "auth": { "user": "username", "pass": "password" } }, "smtpConfig": { "secure": false, "ignoreTls": false, "requireTls": false, "auth": { "user": "username", "pass": "password" } } } Errors 400 Invalid hostname or invalid request body 400 Invalid Customer identifier 401 Unauthorized 403 Forbidden (e.g. readonly or global supporter)

#### Delete SMTP Monitor
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/delete-smtp-monitor
Description: DELETE /api/smtp-monitors/:smtpMonitorPublicId
Endpoints: DELETE /api/smtp-monitors/:smtpMonitorPublicId
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Delete SMTP Monitor DELETE /api/smtp-monitors/:smtpMonitorPublicId Deletes an SMTP monitor. Authentication Requires a valid session and write access. Header: Authorization: Bearer <token Parameters smtpMonitorPublicId (Path, required): SMTP monitor public UUID. cURL curl -X DELETE "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Errors 400 SMTP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found

#### Get SMTP Monitor
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/get-smtp-monitor
Description: GET /api/smtp-monitors/:smtpMonitorPublicId
Endpoints: GET /api/smtp-monitors/:smtpMonitorPublicId
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Get SMTP Monitor GET /api/smtp-monitors/:smtpMonitorPublicId Returns details of a specific SMTP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters smtpMonitorPublicId (Path, required): SMTP monitor public UUID. cURL curl "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333" \ -H "Authorization: Bearer $TOKEN" Response { "id": 200, "organizationId": 1, "customerId": 10, "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-01-01T12:00:00.000Z", "createdAt": "2026-01-01T12:00:00.000Z", "updatedAt": "2026-01-01T12:00:00.000Z", "config": { "secure": false, "ignoreTls": false, "requireTls": false }, "smtpConfig": { "secure": false, "ignoreTls": false, "requireTls": false } } Errors 400 SMTP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found

#### Get SMTP Monitor Check History
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/get-smtp-monitor-check-history
Description: GET /api/smtp-monitors/:smtpMonitorPublicId/check-history
Endpoints: GET /api/smtp-monitors/:smtpMonitorPublicId/check-history
Key Sections: Authentication | Parameters | Query Parameters | cURL | Response | Errors
Summary: Get SMTP Monitor Check History GET /api/smtp-monitors/:smtpMonitorPublicId/check-history Returns recent check results for an SMTP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters smtpMonitorPublicId (Path, required): SMTP monitor public UUID. Query Parameters limit (number, optional) - Default: 50 - Max: 200 cURL curl "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": 12345, "status": "success", "errorMessage": null, "warningMessage": null, "timingSmtp": 123, "diagnostics": { "raw": "optional diagnostic payload" }, "checkedAt": "2026-01-01T12:00:00.000Z", "locationId": 1, "locationName": "Nuremberg (DE)", "locationCode": "de-nbg" } ] } Errors 400 SMTP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found

#### Get SMTP Monitor Details
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/get-smtp-monitor-details
Description: GET /api/smtp-monitors/:smtpMonitorPublicId/details
Endpoints: GET /api/smtp-monitors/:smtpMonitorPublicId/details
Key Sections: Authentication | Parameters | Query Parameters | cURL | Response | Errors
Summary: Get SMTP Monitor Details GET /api/smtp-monitors/:smtpMonitorPublicId/details Consolidated endpoint that returns the SMTP monitor details page data in one call. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters smtpMonitorPublicId (Path, required): SMTP monitor public UUID. Query Parameters range (string, optional): day, week, month, year (default: day) date (string, optional): Reference date (parsed by new Date(date)) startDate (string, optional) endDate (string, optional) granularity (string, optional) - If set to raw, disables aggregation. cURL curl "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333/details?range=day" \ -H "Authorization: Bearer $TOKEN" Response The response is a single object with these top-level keys: smtpMonitorId monitor latestCheck uptimeStats uptimeStatsMeta monitoringData incidents alerts testResultLog maintenance Example (truncated): { "smtpMonitorId": 200, "monitor": { "id": 200, "customerId": 10, "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "config": { "secure": false, "requireTls": true } }, "latestCheck": { "status": "success", "checkedAt": "2026-01-01T12:00:00.000Z", "timingSmtp": 123, "locationCode": "de-nbg", "locationName": "Nuremberg (DE)" }, "uptimeStats": { "day": 99.9, "month": 99.5, "year": 99.0, "dayAvgResponse": 120, "monthAvgResponse": 140, "yearAvgResponse": 150 }, "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } Errors 400 Invalid SMTP monitor public ID (UUID) 401 Unauthorized 403 Forbidden 404 Not found 500 Failed to fetch SMTP monitor details

#### List SMTP Monitors
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/list-smtp-monitors
Description: GET /api/smtp-monitors
Endpoints: GET /api/smtp-monitors
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: List SMTP Monitors GET /api/smtp-monitors Lists SMTP monitors in an organization. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters organizationId (Query, optional): Organization ID. Defaults to the current user's organization. customerId (Query, optional): Filter by customer ID. search (Query, optional): Search by monitor name, hostname, or customer. page (Query, optional): Page number (default: 1). perPage (Query, optional): Items per page (default: 50, max: 200). cURL curl "https://YOUR DOMAIN/api/smtp-monitors?page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 200, "organizationId": 1, "customerId": 10, "name": "Outbound SMTP", "hostname": "smtp.example.com", "port": 587, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-01-01T12:00:00.000Z", "createdAt": "2026-01-01T12:00:00.000Z", "updatedAt": "2026-01-01T12:00:00.000Z", "config": { "secure": false, "ignoreTls": false, "requireTls": false } } ], "total": 1, "page": 1, "perPage": 50 } Errors 400 Invalid organizationId or customerId 401 Unauthorized 403 Forbidden

#### Trigger Check for SMTP Monitor
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/trigger-check-smtp-monitor
Description: POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check
Endpoints: POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Trigger Check for SMTP Monitor POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check Triggers an immediate check from all eligible monitoring locations. Authentication Requires a valid session and write access. Header: Authorization: Bearer <token Parameters smtpMonitorPublicId (Path, required): SMTP monitor public UUID. cURL curl -X POST "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "smtpMonitorId": 200, "locationCodes": ["de-nbg", "fi-hel"], "queueNames": ["smtp-monitor-checks-de-nbg", "smtp-monitor-checks-fi-hel"] } Errors 400 SMTP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found 500 Failed to trigger check (the status message may include e.g. "No active monitoring locations available")

#### Update SMTP Monitor
URL: https://uptimeify.io/docs/api/monitors/smtp-monitors/update-smtp-monitor
Description: PATCH /api/smtp-monitors/:smtpMonitorPublicId
Endpoints: PATCH /api/smtp-monitors/:smtpMonitorPublicId
Key Sections: Authentication | Parameters | Request Body | Notes | cURL | Response | Errors
Summary: Update SMTP Monitor PATCH /api/smtp-monitors/:smtpMonitorPublicId Updates an SMTP monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters smtpMonitorPublicId (Path, required): SMTP monitor public UUID. Request Body All fields are optional. { "name": "Outbound SMTP (Primary)", "hostname": "smtp.example.com", "port": 587, "status": "paused", "checkInterval": 60, "timeoutSeconds": 30, "allowedCheckCountryCodes": ["de", "us"], "smtpConfig": { "secure": false, "requireTls": true, "auth": { "user": "username", "pass": "password" } } } Notes status accepts active, maintenance, disabled, paused, inactive. - paused and inactive are normalized to disabled. allowedCheckCountryCodes is normalized to uppercase ISO codes (e.g. DE, US). Empty lists become null. SMTP config can be provided as smtpConfig or as config (alias). If neither is provided, the stored config is not changed. Users with readonly role can only change status. cURL curl -X PATCH "https://YOUR DOMAIN/api/smtp-monitors/33333333-3333-4333-8333-333333333333" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "status": "disabled" }' Response { "id": 200, "organizationId": 1, "customerId": 10, "name": "Outbound SMTP (Primary)", "hostname": "smtp.example.com", "port": 587, "status": "disabled", "checkInterval": 60, "timeoutSeconds": 30, "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-01-01T12:00:00.000Z", "createdAt": "2026-01-01T12:00:00.000Z", "updatedAt": "2026-01-01T12:01:00.000Z", "config": { "secure": false, "requireTls": true, "auth": { "user": "username", "pass": "password" } }, "smtpConfig": { "secure": false, "requireTls": true, "auth": { "user": "username", "pass": "password" } } } Errors 400 SMTP monitor public ID (UUID) required 401 Unauthorized 403 Forbidden (readonly users may only update status; global supporters cannot update) 404 Not found

#### SSH Monitors
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors
Description: Manage SSH monitors via the API.
Key Sections: Endpoints
Summary: Manage SSH monitors. Path-based SSH monitor endpoints use sshMonitorPublicId UUIDs. Endpoints List SSH Monitors Create SSH Monitor Get SSH Monitor Get SSH Monitor Details Get SSH Monitor Check History Update SSH Monitor Delete SSH Monitor Trigger Check for SSH Monitor

#### Create SSH Monitor
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/create-ssh-monitor
Description: POST /api/ssh-monitors
Endpoints: POST /api/ssh-monitors
Key Sections: Authentication | Request Body | Fields | sshConfig (worker-supported keys) | cURL | Response | Errors
Summary: Create SSH Monitor POST /api/ssh-monitors Creates a new SSH monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Request Body { "customerId": "11111111-1111-4111-8111-111111111111", "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "sshConfig": { "username": "root", "password": "password", "privateKey": "-----BEGIN OPENSSH PRIVATE KEY-----..." } } Fields customerId (number string, required) - Accepts either the internal numeric customer ID or the public customer UUID. name (string, required) hostname (string, required) - Must be a hostname only (no protocol like https://, no path like /ssh). port (number null, optional) - If omitted or null, the worker defaults to port 22. status (string, optional) - Allowed: active, maintenance, disabled, paused, inactive checkInterval (number, optional) timeoutSeconds (number, optional) sshConfig (object, optional) - Stored as the monitor's config JSON. sshConfig (worker-supported keys) username (string) - If omitted, the worker uses anonymous. password (string) privateKey (string) cURL curl -X POST "https://YOUR DOMAIN/api/ssh-monitors" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": "11111111-1111-4111-8111-111111111111", "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "sshConfig": { "username": "root", "password": "password" } }' Response { "id": 300, "organizationId": 1, "customerId": 10, "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "config": { "username": "root", "password": "password" }, "sshConfig": { "username": "root", "password": "password" } } Errors 400 Invalid hostname or invalid request body 400 Invalid Customer identifier 401 Unauthorized 403 Forbidden (e.g. readonly or global supporter)

#### Delete SSH Monitor
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/delete-ssh-monitor
Description: DELETE /api/ssh-monitors/:sshMonitorPublicId
Endpoints: DELETE /api/ssh-monitors/:sshMonitorPublicId
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Delete SSH Monitor DELETE /api/ssh-monitors/:sshMonitorPublicId Deletes an SSH monitor. Authentication Requires a valid session and write access. Header: Authorization: Bearer <token Parameters sshMonitorPublicId (Path, required): SSH monitor public UUID. cURL curl -X DELETE "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Errors 400 SSH monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found

#### Get SSH Monitor
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/get-ssh-monitor
Description: GET /api/ssh-monitors/:sshMonitorPublicId
Endpoints: GET /api/ssh-monitors/:sshMonitorPublicId
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Get SSH Monitor GET /api/ssh-monitors/:sshMonitorPublicId Returns details of a specific SSH monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters sshMonitorPublicId (Path, required): SSH monitor public UUID. cURL curl "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444" \ -H "Authorization: Bearer $TOKEN" Response { "id": 300, "organizationId": 1, "customerId": 10, "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-02-26T12:00:00.000Z", "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "config": { "username": "root" }, "sshConfig": { "username": "root" } } Errors 400 SSH monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found

#### Get SSH Monitor Check History
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/get-ssh-monitor-check-history
Description: GET /api/ssh-monitors/:sshMonitorPublicId/check-history
Endpoints: GET /api/ssh-monitors/:sshMonitorPublicId/check-history
Key Sections: Authentication | Parameters | Query Parameters | cURL | Response | Errors
Summary: Get SSH Monitor Check History GET /api/ssh-monitors/:sshMonitorPublicId/check-history Returns recent check results for an SSH monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters sshMonitorPublicId (Path, required): SSH monitor public UUID. Query Parameters limit (number, optional) - Default: 50 - Max: 200 cURL curl "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444/check-history?limit=50" \ -H "Authorization: Bearer $TOKEN" Response { "data": [ { "id": 12345, "status": "success", "errorMessage": null, "warningMessage": null, "timingSsh": 123, "diagnostics": { "message": "SSH connection successful" }, "checkedAt": "2026-02-26T12:00:00.000Z", "locationId": 1, "locationName": "Nuremberg (DE)", "locationCode": "de-nbg" } ] } Errors 400 SSH monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found

#### Get SSH Monitor Details
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/get-ssh-monitor-details
Description: GET /api/ssh-monitors/:sshMonitorPublicId/details
Endpoints: GET /api/ssh-monitors/:sshMonitorPublicId/details
Key Sections: Authentication | Parameters | Query Parameters | cURL | Response | Errors
Summary: Get SSH Monitor Details GET /api/ssh-monitors/:sshMonitorPublicId/details Consolidated endpoint that returns the SSH monitor details page data in one call. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters sshMonitorPublicId (Path, required): SSH monitor public UUID. Query Parameters range (string, optional): day, week, month, year (default: day) date (string, optional): Reference date (parsed by new Date(date)) startDate (string, optional) endDate (string, optional) granularity (string, optional) - If set to raw, disables aggregation. cURL curl "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444/details?range=day" \ -H "Authorization: Bearer $TOKEN" Response The response is a single object with these top-level keys: sshMonitorId monitor latestCheck uptimeStats uptimeStatsMeta monitoringData incidents alerts testResultLog maintenance Example (truncated): { "sshMonitorId": 300, "monitor": { "id": 300, "customerId": 10, "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "config": { "username": "root" } }, "latestCheck": { "status": "success", "checkedAt": "2026-02-26T12:00:00.000Z", "timingSsh": 123, "locationCode": "de-nbg", "locationName": "Nuremberg (DE)" }, "uptimeStats": { "day": 99.9, "month": 99.5, "year": 99.0, "dayAvgResponse": 120, "monthAvgResponse": 140, "yearAvgResponse": 150 }, "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } Errors 400 Invalid SSH monitor public ID (UUID) 401 Unauthorized 403 Forbidden 404 Not found 500 Failed to fetch SSH monitor details

#### List SSH Monitors
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/list-ssh-monitors
Description: GET /api/ssh-monitors
Endpoints: GET /api/ssh-monitors
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: List SSH Monitors GET /api/ssh-monitors Lists SSH monitors in an organization. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters organizationId (Query, optional): Organization ID. Defaults to the current user's organization. customerId (Query, optional): Filter by customer ID. search (Query, optional): Search by monitor name, hostname, or customer. page (Query, optional): Page number (default: 1). perPage (Query, optional): Items per page (default: 50, max: 200). cURL curl "https://YOUR DOMAIN/api/ssh-monitors?page=1&perPage=50" \ -H "Authorization: Bearer $TOKEN" Response { "items": [ { "id": 300, "organizationId": 1, "customerId": 10, "name": "Bastion Host", "hostname": "ssh.example.com", "port": 22, "status": "active", "checkInterval": 60, "timeoutSeconds": 30, "customerName": "Example Customer", "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-02-26T12:00:00.000Z", "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "config": { "username": "root" } } ], "total": 1, "page": 1, "perPage": 50 } Errors 400 Invalid organizationId or customerId 401 Unauthorized 403 Forbidden

#### Trigger Check for SSH Monitor
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/trigger-check-ssh-monitor
Description: POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check
Endpoints: POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check
Key Sections: Authentication | Parameters | cURL | Response | Errors
Summary: Trigger Check for SSH Monitor POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check Triggers an immediate check from all eligible monitoring locations. Authentication Requires a valid session and write access. Header: Authorization: Bearer <token Parameters sshMonitorPublicId (Path, required): SSH monitor public UUID. cURL curl -X POST "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444/trigger-check" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Checks triggered successfully", "sshMonitorId": 300, "locationCodes": ["de-nbg", "fi-hel"], "queueNames": ["ssh-monitor-checks-de-nbg", "ssh-monitor-checks-fi-hel"] } Errors 400 SSH monitor public ID (UUID) required 401 Unauthorized 403 Forbidden 404 Not found 500 Failed to trigger check (the status message may include e.g. "No active monitoring locations available")

#### Update SSH Monitor
URL: https://uptimeify.io/docs/api/monitors/ssh-monitors/update-ssh-monitor
Description: PATCH /api/ssh-monitors/:sshMonitorPublicId
Endpoints: PATCH /api/ssh-monitors/:sshMonitorPublicId
Key Sections: Authentication | Parameters | Request Body | Notes | cURL | Response | Errors
Summary: Update SSH Monitor PATCH /api/ssh-monitors/:sshMonitorPublicId Updates an SSH monitor. Authentication Requires a valid session. Header: Authorization: Bearer <token Parameters sshMonitorPublicId (Path, required): SSH monitor public UUID. Request Body All fields are optional. { "name": "Bastion Host (Primary)", "hostname": "ssh.example.com", "port": 22, "status": "paused", "checkInterval": 60, "timeoutSeconds": 30, "allowedCheckCountryCodes": ["de", "us"], "sshConfig": { "username": "root", "privateKey": "-----BEGIN OPENSSH PRIVATE KEY-----..." } } Notes status accepts active, maintenance, disabled, paused, inactive. - paused and inactive are normalized to disabled. allowedCheckCountryCodes is normalized to uppercase ISO codes (e.g. DE, US). Empty lists become null. SSH config can be provided as sshConfig or as config (alias). If neither is provided, the stored config is not changed. Users with readonly role can only change status. cURL curl -X PATCH "https://YOUR DOMAIN/api/ssh-monitors/44444444-4444-4444-8444-444444444444" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "status": "disabled" }' Response { "id": 300, "organizationId": 1, "customerId": 10, "name": "Bastion Host (Primary)", "hostname": "ssh.example.com", "port": 22, "status": "disabled", "checkInterval": 60, "timeoutSeconds": 30, "notificationEmail": null, "notificationPhoneNumber": null, "lastCheckedAt": "2026-02-26T12:00:00.000Z", "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:01:00.000Z", "config": { "username": "root" }, "sshConfig": { "username": "root" } } Errors 400 SSH monitor ID is required / invalid fields 401 Unauthorized 403 Forbidden (readonly users may only update status; global supporters cannot update) 404 Not found

### Configurations
URL: https://uptimeify.io/docs/api/website-configuration
Description: Manage check configuration, notification channels and maintenance windows.
Endpoints: PATCH /api/websites/:websiteId/check-config | GET /api/maintenance-windows?websiteId=:websiteId | GET /api/maintenance-windows/:id | POST /api/maintenance-windows | PATCH /api/maintenance-windows/:id | DELETE /api/maintenance-windows/:id | GET /api/maintenance-windows/check/:websiteId | POST /api/maintenance-windows/check/batch
Key Sections: Authentication | Check Configuration | Update Check Settings | Request Body | Alerting Configuration | Notification Channels | Maintenance Windows | List Maintenance Windows
Summary: Manage advanced monitoring settings for your websites. Authentication All examples assume a bearer token: BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Check Configuration Update Check Settings PATCH /api/websites/:websiteId/check-config Configure which aspects of the website should be monitored. Request Body { "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": false, "checkDomainExpiryEnabled": true, "minPageSize": 1024, "maxPageSize": 5242880 } Example (cURL): curl -X PATCH \ "$BASE URL/api/websites/101/check-config" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"checkSslEnabled":true,"checkHttpsRedirectEnabled":true,"checkStatusEnabled":true,"checkSizeEnabled":true,"checkResponseTimeEnabled":true,"checkKeywordEnabled":false}' Alerting Configuration Alerting-related defaults and feature flags are configured via organization package configs . See: List Package Configs Upsert Package Config Delete Package Config Notification Channels Maintenance Windows List Maintenance Windows GET /api/maintenance-windows?websiteId=:websiteId Get Maintenance Window GET /api/maintenance-windows/:id Create Maintenance Window POST /api/maintenance-windows Update Maintenance Window PATCH /api/maintenance-windows/:id Delete Maintenance Window DELETE /api/maintenance-windows/:id Check Maintenance (Website) GET /api/maintenance-windows/check/:websiteId Check Maintenance (Batch) POST /api/maintenance-windows/check/batch Endpoints Update Check Settings List Maintenance Windows Get Maintenance Window Create Maintenance Window Update Maintenance Window Delete Maintenance Window Check Maintenance (Website) Check Maintenance (Batch)

#### Check Maintenance (Website)
URL: https://uptimeify.io/docs/api/website-configuration/check-maintenance-window
Description: GET /api/maintenance-windows/check/:websiteId
Endpoints: GET /api/maintenance-windows/check/:websiteId
Key Sections: Parameters | Example (cURL) | Example Response | Common errors
Summary: Check Maintenance (Website) GET /api/maintenance-windows/check/:websiteId Checks if a website is currently in an active maintenance window. This endpoint requires authentication via browser session or API token. Parameters websiteId (Path, required): Internal numeric website ID or websitePublicId (UUID). Example (cURL) BASE URL="https://uptimeify.io" API TOKEN="wsm your real api token" curl -X GET "$BASE URL/api/maintenance-windows/check/cd11a84d-96a2-41aa-a957-b1db8ee01b72" \ -H "Authorization: Bearer $API TOKEN" \ -H "Accept: application/json" Example Response { "inMaintenance": true, "activeWindows": [ { "id": 5, "name": "Weekly maintenance", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "description": "Planned downtime" } ] } Common errors 401 Unauthorized when no valid session or API token is sent 403 Forbidden when the website is outside the allowed customer/organization scope 400 Invalid Website identifier when :websiteId is neither a positive integer ID nor a UUID 404 Website not found when the provided websitePublicId does not resolve to a website

#### Check Maintenance (Batch)
URL: https://uptimeify.io/docs/api/website-configuration/check-maintenance-window-batch
Description: POST /api/maintenance-windows/check/batch
Endpoints: POST /api/maintenance-windows/check/batch
Key Sections: Request Body | Fields | Example (cURL) | Example Response | Common errors
Summary: Check Maintenance (Batch) POST /api/maintenance-windows/check/batch Batch-check multiple websites for active maintenance windows. This endpoint requires authentication via browser session or API token. Request Body { "websiteIds": [101, "cd11a84d-96a2-41aa-a957-b1db8ee01b72", 103] } Fields websiteIds ((number string)[], required): numeric website IDs or websitePublicId UUIDs Example (cURL) BASE URL="https://uptimeify.io" API TOKEN="wsm your real api token" curl -X POST "$BASE URL/api/maintenance-windows/check/batch" \ -H "Authorization: Bearer $API TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"websiteIds":[101,"cd11a84d-96a2-41aa-a957-b1db8ee01b72",103]}' Example Response { "results": { "101": { "inMaintenance": true, "activeWindows": [ { "id": 5, "name": "Weekly maintenance", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "description": "Planned downtime" } ] }, "cd11a84d-96a2-41aa-a957-b1db8ee01b72": { "inMaintenance": false, "activeWindows": [] } } } Common errors 400 websiteIds array required when websiteIds is missing/empty 400 All websiteIds must be valid identifiers when any entry is neither a positive integer ID nor a UUID 401 Unauthorized when no valid session or API token is sent 403 Forbidden when at least one website is outside the allowed customer/organization scope 404 Website not found when a provided websitePublicId does not resolve to a website

#### Create Maintenance Window
URL: https://uptimeify.io/docs/api/website-configuration/create-maintenance-window
Description: POST /api/maintenance-windows
Endpoints: POST /api/maintenance-windows
Key Sections: Authentication | Request Body | Fields | Example (cURL) | Example Response | Common Errors
Summary: Create Maintenance Window POST /api/maintenance-windows Creates a new maintenance window. Important: You must provide exactly one target ID (e.g. websiteId or icmpMonitorId, smtpMonitorId, sshMonitorId, ftpMonitorId, imapPopMonitorId). All target IDs and customerId accept either the internal numeric ID or the matching public UUID. Authentication Requires a valid session or API token. Header: Authorization: Bearer <token Note: Global supporter users are not allowed to create maintenance windows (403). Read-only users are allowed. Request Body { "websiteId": "521e3338-4597-4d1d-8eeb-dc56d271e71c", "name": "Server Upgrade", "description": "Planned downtime", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] }, "isActive": true } Fields Target (exactly one required): websiteId (number string) icmpMonitorId (number string) smtpMonitorId (number string) sshMonitorId (number string) ftpMonitorId (number string) imapPopMonitorId (number string) customerId (number string, optional) Identifier rule: Internal numeric IDs or public UUIDs are accepted. Other fields: name (string, required) description (string, optional) - Max length: 2000 - If omitted (or empty), it is stored as null. startTime (string/date, required) endTime (string/date, required) - Must be after startTime. isRecurring (boolean, optional) - Default: false recurrencePattern (object, optional) - Stored as JSON. - Typical keys include frequency, interval, daysOfWeek, dayOfMonth, endRecurrenceDate. isActive (boolean, optional) - Default: true Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X POST \ "$BASE URL/api/maintenance-windows" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"websiteId":"521e3338-4597-4d1d-8eeb-dc56d271e71c","name":"Server Upgrade","description":"Planned downtime","startTime":"2026-02-25T02:00:00.000Z","endTime":"2026-02-25T04:00:00.000Z","isRecurring":true,"recurrencePattern":{"frequency":"weekly","interval":1,"daysOfWeek":[1]},"isActive":true}' Example Response { "id": 5, "websiteId": 101, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 12, "name": "Server Upgrade", "description": "Planned downtime", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] }, "isActive": true, "createdBy": "<user-id ", "createdAt": "2026-02-20T10:00:00.000Z", "updatedAt": "2026-02-20T10:00:00.000Z" } Common Errors 400 Exactly one target ID must be provided if no or multiple target IDs are sent 400 Invalid Website identifier or the corresponding target error if an identifier is neither an integer ID nor a UUID 400 End time must be after start time if endTime <= startTime 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access (or are a global supporter)

#### Delete Maintenance Window
URL: https://uptimeify.io/docs/api/website-configuration/delete-maintenance-window
Description: DELETE /api/maintenance-windows/:id
Endpoints: DELETE /api/maintenance-windows/:id
Key Sections: Authentication | Parameters | Example (cURL) | Example Response | Common Errors
Summary: Delete Maintenance Window DELETE /api/maintenance-windows/:id Deletes a maintenance window. Authentication Requires a valid session. Header: Authorization: Bearer <token Note: Global supporter users are not allowed to delete maintenance windows (403). Read-only users are allowed. Parameters id (Path, required): Maintenance window ID. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE \ "$BASE URL/api/maintenance-windows/5" \ -H "Authorization: Bearer $TOKEN" Example Response { "success": true } Common Errors 400 Invalid maintenance window ID if :id is invalid 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access 404 Maintenance window not found if the maintenance window does not exist

#### Get Maintenance Window
URL: https://uptimeify.io/docs/api/website-configuration/get-maintenance-window
Description: GET /api/maintenance-windows/:id
Endpoints: GET /api/maintenance-windows/:id
Key Sections: Authentication | Parameters | Example (cURL) | Example Response | Common errors
Summary: Get Maintenance Window GET /api/maintenance-windows/:id Returns a single maintenance window by ID (including its target relation). Authentication Requires a valid session. Header: Authorization: Bearer <token Note (API token scope): If you use a customer-scoped API token, the window must belong to that customer. Parameters id (Path, required): Maintenance window ID. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/maintenance-windows/5" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response { "id": 5, "websiteId": 101, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 12, "name": "Weekly maintenance", "description": "Planned downtime", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] }, "isActive": true, "createdBy": "<user-id ", "createdAt": "2026-02-20T10:00:00.000Z", "updatedAt": "2026-02-20T10:00:00.000Z", "website": { "id": 101, "url": "https://example.com" } } Note: Depending on the target, the response may also include one of these relations: icmpMonitor, smtpMonitor, sshMonitor, ftpMonitor, imapPopMonitor. Nested customer objects are not returned. Common errors 400 Invalid maintenance window ID when :id is invalid 404 Maintenance window not found when the window does not exist 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the target/customer 500 Maintenance window target is missing if the window has no valid target

#### List Maintenance Windows
URL: https://uptimeify.io/docs/api/website-configuration/list-maintenance-windows
Description: GET /api/maintenance-windows
Endpoints: GET /api/maintenance-windows
Key Sections: Authentication | Query Parameters | Example (cURL) | Example Response | Common Errors
Summary: List Maintenance Windows GET /api/maintenance-windows Returns maintenance windows scoped to your organization by default. You can filter by a specific target (e.g. websiteId) or by customer/organization. Authentication Requires a valid session. Header: Authorization: Bearer <token Query Parameters websiteId (optional) customerId (optional) organizationId (optional, defaults to your session organization) activeOnly (optional): set to true to only return active windows Target filters (optional, exactly one is typically used when narrowing down): - icmpMonitorId, smtpMonitorId, sshMonitorId, ftpMonitorId, imapPopMonitorId Note: When websiteId is provided, access is enforced for that website. Note (API token scope): If you use a customer-scoped API token, results are restricted to that customer. Providing a different customerId returns 403. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/maintenance-windows?websiteId=101" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Example Response [ { "id": 5, "websiteId": 101, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 12, "customerName": "Acme Corp", "name": "Weekly maintenance", "description": "Planned downtime", "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] }, "isActive": true, "createdBy": "<user-id ", "createdAt": "2026-02-20T10:00:00.000Z", "updatedAt": "2026-02-20T10:00:00.000Z", "website": { "id": 101, "url": "https://example.com" } } ] Note: The list endpoint only includes the website relation (when websiteId is set). It does not include nested customer objects or monitor relations. A lightweight top-level customerName is included for display/filtering. Common Errors 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access

#### Update Check Settings
URL: https://uptimeify.io/docs/api/website-configuration/update-check-settings
Description: PATCH /api/websites/:websiteId/check-config
Endpoints: PATCH /api/websites/:websiteId/check-config
Key Sections: Request Body | Example (cURL) | Example Response | Common errors
Summary: Update Check Settings PATCH /api/websites/:websiteId/check-config Configure which aspects of the website should be monitored. Request Body { "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": false, "checkDomainExpiryEnabled": true, "minPageSize": 1024, "maxPageSize": 5242880 } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH \ "$BASE URL/api/websites/101/check-config" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"checkSslEnabled":true,"checkHttpsRedirectEnabled":true,"checkStatusEnabled":true,"checkSizeEnabled":true,"checkResponseTimeEnabled":true,"checkKeywordEnabled":false,"checkDomainExpiryEnabled":true,"minPageSize":1024,"maxPageSize":5242880}' Example Response { "success": true } Common errors 400 Invalid website ID when :websiteId is invalid 401 Unauthorized when you are not logged in 403 Forbidden when you do not have write access to the website 404 Website not found when the website does not exist

#### Update Maintenance Window
URL: https://uptimeify.io/docs/api/website-configuration/update-maintenance-window
Description: PATCH /api/maintenance-windows/:id
Endpoints: PATCH /api/maintenance-windows/:id
Key Sections: Authentication | Parameters | Request Body | Example (cURL) | Example Response | Common Errors
Summary: Update Maintenance Window PATCH /api/maintenance-windows/:id Updates an existing maintenance window. Authentication Requires a valid session. Header: Authorization: Bearer <token Note: Global supporter users are not allowed to update maintenance windows (403). Read-only users are allowed. Parameters id (Path, required): Maintenance window ID. Request Body All fields are optional. { "name": "Server Upgrade (updated)", "description": null, "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] }, "isActive": true } Notes: You cannot change the target IDs (websiteId, icmpMonitorId, ...). Only the window fields can be updated. description can be set to null to clear it. If you update startTime and/or endTime, endTime must be after startTime. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH \ "$BASE URL/api/maintenance-windows/5" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"name":"Server Upgrade (updated)","description":null,"startTime":"2026-02-25T02:00:00.000Z","endTime":"2026-02-25T04:00:00.000Z","isRecurring":true,"recurrencePattern":{"frequency":"weekly","interval":1,"daysOfWeek":[1]},"isActive":true}' Example Response { "id": 5, "websiteId": 101, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 12, "name": "Server Upgrade (updated)", "description": null, "startTime": "2026-02-25T02:00:00.000Z", "endTime": "2026-02-25T04:00:00.000Z", "isRecurring": true, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [1] }, "isActive": true, "createdBy": "<user-id ", "createdAt": "2026-02-20T10:00:00.000Z", "updatedAt": "2026-02-21T11:00:00.000Z" } Common Errors 400 Invalid maintenance window ID if :id is invalid 400 End time must be after start time if you update the time range to an invalid value 401 Unauthorized if you are not authenticated 403 Forbidden if you do not have access 404 Maintenance window not found if the maintenance window does not exist

## Organization API
Organization-scoped resources for customer management, billing, users, and escalation settings.

### Customer Management
URL: https://uptimeify.io/docs/api/customers
Description: Path-based customer endpoints use customerPublicId UUIDs.
Key Sections: Endpoints
Summary: Path-based customer endpoints use customerPublicId UUIDs. Endpoints List Customers Create Customer Get Customer Details Update Customer Change Package Cancel Customer

#### Cancel Customer
URL: https://uptimeify.io/docs/api/customers/cancel-customer
Description: POST /api/customers/:customerPublicId/cancel
Endpoints: POST /api/customers/:customerPublicId/cancel
Key Sections: Authentication | Example Request | Example Response | Common Errors
Summary: Cancel Customer POST /api/customers/:customerPublicId/cancel Marks a customer for cancellation and starts the 3-day grace period immediately. Authentication This endpoint requires authentication. BASE URL="https://uptimeify.io" TOKEN="wsm <your-api-token " Example Request curl -X POST "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88/cancel" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" Example Response { "id": 101, "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "organizationId": 1, "name": "Customer A GmbH", "email": "contact@customer-a.de", "notificationPhoneNumber": "+491701234567", "notificationEmail": "alerts@customer-a.de", "packageId": 3, "packageType": "acquisition test", "status": "marked for cancellation", "cancellationDate": "2026-03-01T19:37:00.000Z", "cancelledAt": "2026-02-26T19:37:00.000Z", "customFields": { "internalReference": "KD-999" }, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "createdAt": "2026-02-20T09:15:00.000Z", "updatedAt": "2026-02-26T19:37:00.000Z" } Notes: cancelledAt is the timestamp when the cancellation was requested and the grace period started. cancellationDate is the effective end of the grace period. This endpoint currently sets it to 3 days after cancelledAt. Common Errors 400 Invalid Customer identifier 401 Unauthorized 403 Forbidden / Organization ID not found 404 Customer not found 500 Failed to mark customer for cancellation

#### Change Package
URL: https://uptimeify.io/docs/api/customers/change-package
Description: PATCH /api/customers/:customerPublicId
Endpoints: PATCH /api/customers/:customerPublicId
Key Sections: Authentication | Request Body | Example Request | Example Response | Common Errors
Summary: Change Package PATCH /api/customers/:customerPublicId Changes the customer's package assignment. This uses the same endpoint as Update Customer — you usually send packageId. Legacy packageType values are still accepted for backward compatibility. Authentication BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Request Body { "packageId": 12 } Example Request curl -X PATCH "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "packageId": 12 }' Example Response { "id": 101, "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "organizationId": 1, "name": "Customer A GmbH", "email": "contact@customer-a.de", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 12, "status": "active", "monthlyReportsEnabled": true, "customFields": {}, "notificationChannels": null, "notificationTargets": null, "updatedAt": "2026-02-26T19:37:00.000Z" } Common Errors 400 Invalid Customer identifier 401 Unauthorized 403 Forbidden / Organization ID not found 404 Customer not found 500 Failed to update customer

#### Create Customer
URL: https://uptimeify.io/docs/api/customers/create-customer
Description: POST /api/customers
Endpoints: POST /api/customers
Key Sections: Authentication | Request Body | Response
Summary: Create Customer POST /api/customers Creates a new customer and assigns an organization-defined package via packageType. Authentication This endpoint requires authentication. BASE URL="https://uptimeify.io" TOKEN="wsm <your-api-token " Request Body { "name": "Customer Name", "email": "customer@example.com", "packageType": "business", // use the configured packageType or displayName for the organization "organizationId": 1, // optional (required only for global admins) "status": "active", // optional, Default: active "customFields": { ... } // optional } Notes: packageType can contain the configured package key or the package display name of the organization. Known aliases such as aquisition test are normalized automatically. If no configured package matches, the request is rejected with 400 Bad Request. For non-global-admin users, organizationId is derived from your session/token and must not be overridden. For global admins, organizationId must be provided explicitly. Response { "success": true, "customer": { "id": 64, "publicId": "6d74c32b-a97c-49b9-be3e-2b5e24bed826", "organizationId": 2, "name": "Example Customer", "email": "example@test.com", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 7, "packageType": "essential", "status": "active", "allowedCheckCountryCodes": null, "cancellationDate": null, "cancelledAt": null, "customFields": { "region": "EU", "planOwner": "Operations" }, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "createdAt": "2026-04-04T12:27:13.415Z", "updatedAt": "2026-04-04T12:27:13.415Z" } }

#### Get Customer Details
URL: https://uptimeify.io/docs/api/customers/get-customer-details
Description: GET /api/customers/:customerPublicId
Endpoints: GET /api/customers/:customerPublicId
Key Sections: Response | Common Errors
Summary: Get Customer Details GET /api/customers/:customerPublicId Returns details of a specific customer. packageDisplayName is the configured display label of the assigned organization package. It is not a normalized global enum and may contain organization-specific names such as aquisition test. Response { "id": 101, "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "organizationId": 1, "name": "Customer A GmbH", "email": "contact@customer-a.de", "notificationPhoneNumber": "+491701234567", "notificationEmail": "alerts@customer-a.de", "packageId": 3, "packageDisplayName": "Growth", "status": "active", "customFields": { "internalReference": "KD-999" }, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "updatedAt": "2023-05-15T10:00:00Z", "createdAt": "2023-05-15T10:00:00Z" } Common Errors 400 Invalid Customer identifier 401 Unauthorized 403 Forbidden / Organization ID not found 404 Customer not found

#### List Customers
URL: https://uptimeify.io/docs/api/customers/list-customers
Description: GET /api/customers
Endpoints: GET /api/customers
Key Sections: Query Parameters | Response
Summary: List Customers GET /api/customers Lists all customers of the organization. Query Parameters organizationId (required): The ID of the organization. Response [ { "id": 101, "organizationId": 1, "name": "Customer A GmbH", "email": "contact@customer-a.de", "packageId": 4, "packageDisplayName": "Business", "status": "active", "cancellationDate": null, "notificationEmail": "alerts@customer-a.de", "createdAt": "2023-05-15T10:00:00Z" }, { "id": 102, "organizationId": 1, "name": "StartUp XY", "email": "info@startup-xy.com", "packageId": 1, "packageDisplayName": "Essential", "status": "marked for cancellation", "cancellationDate": "2024-12-31T23:59:59Z", "createdAt": "2023-06-20T14:30:00Z" } ] Note: The list response intentionally no longer exposes the raw packageType. Use packageDisplayName for display and packageId for technical mapping. packageDisplayName comes from the assigned organization package config and may therefore be organization-specific.

#### Update Customer
URL: https://uptimeify.io/docs/api/customers/update-customer
Description: PATCH /api/customers/:customerPublicId
Endpoints: PATCH /api/customers/:customerPublicId
Key Sections: Authentication | Request Body | Example Request | Example Response | Common Errors
Summary: Update Customer PATCH /api/customers/:customerPublicId Updates customer details. Authentication BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Request Body All fields are optional. Omitted fields keep their current values. { "name": "New Name", "email": "new@example.com", "status": "active", "packageType": "business", // configured packageType or displayName for the organization "notificationEmail": "alerts@customer-a.de", "notificationPhoneNumber": "+491701234567", "monthlyReportsEnabled": true, "customFields": { "internalReference": "KD-999" } } Notes: packageType can contain the configured package key or the package display name of the organization. Known aliases such as aquisition test are normalized automatically. Example Request curl -X PATCH "$BASE URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Customer A GmbH (Updated)", "monthlyReportsEnabled": true }' Example Response { "id": 101, "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88", "organizationId": 1, "name": "Customer A GmbH (Updated)", "email": "contact@customer-a.de", "notificationPhoneNumber": "+491701234567", "notificationEmail": "alerts@customer-a.de", "packageId": 3, "status": "active", "monthlyReportsEnabled": true, "customFields": { "internalReference": "KD-999" }, "notificationChannels": null, "notificationTargets": null, "updatedAt": "2026-02-26T19:37:00.000Z" } Common Errors 400 Invalid Customer identifier 401 Unauthorized 403 Forbidden / Organization ID not found 404 Customer not found 500 Failed to update customer

### Organization & Billing
URL: https://uptimeify.io/docs/api/organization
Description: Path-based organization endpoints use organizationPublicId UUIDs.
Key Sections: Endpoints
Summary: Path-based organization endpoints use organizationPublicId UUIDs. Endpoints Get Organization Details Update Organization List Package Configs Upsert Package Config Delete Package Config Get Billing Details Update Billing Details List Invoices Error codes and known API pitfalls

#### Delete Package Config
URL: https://uptimeify.io/docs/api/organization/delete-package-config
Description: DELETE /api/package-configs/:packageType
Endpoints: DELETE /api/package-configs/:packageType | DELETE /api/organizations/:organizationPublicId/package-configs/:packageType | DELETE /api/organizations/package-configs/:packageType
Key Sections: Example (cURL) | Response | Common errors
Summary: Delete Package Config DELETE /api/package-configs/:packageType Deletes a package config for an organization. Deletion is only allowed if no customers currently use the given :packageType. The package is resolved directly from the path parameter, so values like test1 work as long as they match the stored packageType. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X DELETE "$BASE URL/api/package-configs/pro" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Notes: The organization is derived automatically from your authenticated session or API token. The legacy route DELETE /api/organizations/:organizationPublicId/package-configs/:packageType remains supported for compatibility. The plural org-less alias DELETE /api/organizations/package-configs/:packageType is also supported. Global admins need an active organization context in the authenticated session for the org-less route. Response { "success": true } Common errors 404 Package not found when the config does not exist 409 Package is still in use by customers when customers are assigned this package type 400 Package type is required when :packageType is missing 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization Authorization note: Write access is required (organization admin or global admin).

#### Get Billing Details
URL: https://uptimeify.io/docs/api/organization/get-billing-details
Description: GET /api/organization/billing
Endpoints: GET /api/organization/billing | GET /api/organizations/:organizationPublicId/billing | GET /api/organizations/billing
Key Sections: Example (cURL) | Response | Common errors
Summary: Get Billing Details GET /api/organization/billing Returns billing information and payment methods for the organization in your authenticated session. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/organization/billing" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Notes: The organization is derived automatically from your authenticated session or API token. The legacy route GET /api/organizations/:organizationPublicId/billing remains supported for compatibility. The plural org-less alias GET /api/organizations/billing is also supported. Global admins need an active organization context in the authenticated session for the org-less route. Response { "billingEmail": "billing@example.com", "paymentMethod": "mollie" } Common errors 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### Get Organization Details
URL: https://uptimeify.io/docs/api/organization/get-organization-details
Description: GET /api/organization
Endpoints: GET /api/organization | GET /api/organizations/:organizationPublicId | GET /api/organizations
Key Sections: Example (cURL) | Response | Common errors
Summary: Get Organization Details GET /api/organization Returns details of the organization from your authenticated session. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/organization" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Notes: The organization is derived automatically from your authenticated session or API token. The legacy route GET /api/organizations/:organizationPublicId remains supported for compatibility. The plural org-less alias GET /api/organizations is also supported. Global admins need an active organization context in the authenticated session for the org-less route. Response { "id": 1, "name": "My Org", "companyName": "My Company GmbH", "street": "Sample St. 1", "postalCode": "12345", "city": "Berlin", "country": "DE", "vatId": "DE123456789", "billingEmail": "billing@example.com", "createdAt": "2023-01-01T00:00:00.000Z" } Common errors 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### List Invoices
URL: https://uptimeify.io/docs/api/organization/list-invoices
Description: GET /api/mollie/invoices
Endpoints: GET /api/mollie/invoices | GET /api/organizations/:organizationPublicId/mollie/invoices
Key Sections: Example (cURL) | Response | Common errors
Summary: List Invoices GET /api/mollie/invoices Lists all invoices for the organization (Mollie). Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET \ "$BASE URL/api/mollie/invoices" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Notes: The organization is derived automatically from your authenticated session or API token. The legacy route GET /api/organizations/:organizationPublicId/mollie/invoices remains supported for compatibility. The pdfUrl values in the response use the org-less download route /api/invoices/:invoiceId/pdf. Global admins need an active organization context in the authenticated session for the org-less route. Response { "invoices": [ { "id": "inv 123456", "reference": "INV-2024-001", "status": "paid", "issuedAt": "2024-01-15T10:00:00.000Z", "netAmount": { "value": "29.99", "currency": "EUR" }, "pdfUrl": "/api/invoices/inv 123456/pdf" }, { "id": "inv 123455", "reference": "INV-2023-128", "status": "paid", "issuedAt": "2023-12-15T10:00:00.000Z", "netAmount": { "value": "29.99", "currency": "EUR" }, "pdfUrl": "/api/invoices/inv 123455/pdf" } ] } Common errors 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Not authorized when you cannot access the organization

#### List Package Configs
URL: https://uptimeify.io/docs/api/organization/list-package-configs
Description: GET /api/package-configs
Endpoints: GET /api/package-configs | GET /api/organizations/:organizationPublicId/package-configs
Key Sections: Example (cURL) | Response | Common errors
Summary: List Package Configs GET /api/package-configs Returns all package configurations for the organization in your authenticated session. Each config also includes a usedByCustomerCount field. Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/package-configs" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Notes: The organization is derived automatically from your authenticated session or API token. The legacy route GET /api/organizations/:organizationPublicId/package-configs remains supported for compatibility. Global admins need an active organization context in the authenticated session for the org-less route. Response [ { "id": 10, "packageType": "pro", "maxUrls": 100, "dataRetentionMonths": 12, "checkIntervalMinutes": 1, "checkLocations": 3, "notificationDelayMinutes": 0, "reminderDelayMinutes": 10, "alertConsecutiveChecks": 3, "alertLocationThreshold": "majority", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "enableSslCheck": true, "enableHttpsCheck": true, "enableStatusCheck": true, "enableSizeCheck": true, "enableResponseTimeCheck": true, "enableKeywordCheck": false, "enableEmailAlerts": true, "enableSmsAlerts": true, "enableWebhookAlerts": true, "enableIntegrationAlerts": true, "enablePostRequestEscalation": false, "enableMaintenanceWindows": true, "enablePdfReports": true, "notes": null, "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z", "usedByCustomerCount": 4 } ] Common errors 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization

#### Update Billing Details
URL: https://uptimeify.io/docs/api/organization/update-billing-details
Description: PATCH /api/organization/billing
Endpoints: PATCH /api/organization/billing | PATCH /api/organizations/:organizationPublicId/billing | PATCH /api/organizations/billing
Key Sections: Request Body | Example (cURL) | Notes | Common errors
Summary: Update Billing Details PATCH /api/organization/billing Updates billing information for the organization in your authenticated session. Request Body { "billingEmail": "billing@example.com" } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH "$BASE URL/api/organization/billing" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "billingEmail": "billing@example.com" }' Notes billingEmail is currently the only supported field for this endpoint. The organization is derived automatically from your authenticated session or API token. The legacy route PATCH /api/organizations/:organizationPublicId/billing remains supported for compatibility. The plural org-less alias PATCH /api/organizations/billing is also supported. Global admins need an active organization context in the authenticated session for the org-less route. Common errors 400 Invalid request body when the payload does not match the schema 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Forbidden when you do not have admin access to update billing settings

#### Update Organization
URL: https://uptimeify.io/docs/api/organization/update-organization
Description: PATCH /api/organization
Endpoints: PATCH /api/organization | PATCH /api/organizations/:organizationPublicId | PATCH /api/organizations
Key Sections: Request Body | Example (cURL) | Common errors
Summary: Update Organization PATCH /api/organization Updates the organization from your authenticated session. Request Body { "name": "New Name", "companyName": "New Company Name", "street": "New Street", "postalCode": "54321", "city": "New City", "country": "US", "vatId": "US123", "billingEmail": "new@example.com", "defaultNotificationChannels": { "email": true, "sms": false, "webhook": true, "integrations": false }, "defaultNotificationTargets": { "email": "both", // customer, organization, both "sms": "organization", "webhook": "organization", "integrations": "customer" } } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH "$BASE URL/api/organization" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "New Name", "billingEmail": "new@example.com" }' Notes: The organization is derived automatically from your authenticated session or API token. The legacy route PATCH /api/organizations/:organizationPublicId remains supported for compatibility. The plural org-less alias PATCH /api/organizations is also supported. Global admins need an active organization context in the authenticated session for the org-less route. Common errors 400 Invalid request body when the payload does not match the schema 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Forbidden when you do not have admin access to update the organization

#### Upsert Package Config
URL: https://uptimeify.io/docs/api/organization/upsert-package-config
Description: PATCH /api/package-configs/:packageType
Endpoints: PATCH /api/package-configs/:packageType | PATCH /api/package-configs | PATCH /api/organizations/:organizationPublicId/package-configs/:packageType | PATCH /api/organizations/package-configs/:packageType
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Upsert Package Config PATCH /api/package-configs/:packageType Creates a new package config (by :packageType) or updates an existing one. packageType is a free-form identifier chosen by the organization, and customer endpoints can later reference that same key. This endpoint is the source of truth for alerting-related defaults like alertConsecutiveChecks and feature flags like enableEmailAlerts. Request Body All fields are optional and can be updated over time. If you want a human-friendly package label in the UI, set displayName in addition to the technical packageType key. { "displayName": "Pro Care", "maxUrls": 100, "dataRetentionMonths": 12, "checkIntervalMinutes": 1, "checkLocations": 3, "notificationDelayMinutes": 0, "reminderDelayMinutes": 10, "alertConsecutiveChecks": 3, "alertLocationThreshold": "majority", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "enableEmailAlerts": true, "enableSmsAlerts": true, "enableWebhookAlerts": true, "enableIntegrationAlerts": true, "enableMaintenanceWindows": true, "enablePdfReports": true, "notes": "Default for PRO customers" } Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X PATCH "$BASE URL/api/package-configs/pro" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "displayName":"Pro Care", "maxUrls":100, "dataRetentionMonths":12, "checkIntervalMinutes":1, "checkLocations":3, "notificationDelayMinutes":0, "reminderDelayMinutes":10, "alertConsecutiveChecks":3, "alertLocationThreshold":"majority", "alertLocationThresholdCount":2, "alertReminderInterval":60, "enableEmailAlerts":true, "enableSmsAlerts":true, "enableWebhookAlerts":true, "enableIntegrationAlerts":true, "enableMaintenanceWindows":true, "enablePdfReports":true, "notes":"Default for PRO customers" }' Response Returns the created/updated package config. { "id": 10, "packageType": "pro", "displayName": "Pro Care", "maxUrls": 100, "dataRetentionMonths": 12, "checkIntervalMinutes": 1, "checkLocations": 3, "notificationDelayMinutes": 0, "reminderDelayMinutes": 10, "alertConsecutiveChecks": 3, "alertLocationThreshold": "majority", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "enableEmailAlerts": true, "enableSmsAlerts": true, "enableWebhookAlerts": true, "enableIntegrationAlerts": true, "enableMaintenanceWindows": true, "enablePdfReports": true, "notes": "Default for PRO customers", "createdAt": "2026-02-26T12:00:00.000Z", "updatedAt": "2026-02-26T12:00:00.000Z" } Notes: The organization is derived automatically from your authenticated session or API token. The body-based variant PATCH /api/package-configs is also supported when packageType is sent in the request body. The legacy route PATCH /api/organizations/:organizationPublicId/package-configs/:packageType remains supported for compatibility. The plural org-less alias PATCH /api/organizations/package-configs/:packageType is also supported. Global admins need an active organization context in the authenticated session for the org-less route. Common errors 400 Package type is required when :packageType is missing 400 Organization ID is required in the authenticated session when no organization can be derived from the current session/token 401 Unauthorized when you are not logged in 403 Forbidden when you cannot access the organization Authorization note: Write access is required (organization admin or global admin).

### Users
URL: https://uptimeify.io/docs/api/users
Description: Manage users within your organization.
Key Sections: Endpoints
Summary: Manage users within your organization. Endpoints List Users Create User Get User Update User Delete User

#### Create User
URL: https://uptimeify.io/docs/api/users/create-user
Description: POST /api/users
Endpoints: POST /api/users
Key Sections: Request Body
Summary: Create User POST /api/users Creates a new user in the organization. Request Body { "email": "jane@example.com", "firstName": "Jane", "lastName": "Doe", "role": "user", // "admin" or "user" "password": "temporaryPassword123", // Optional, user can set it later "customerIds": ["11111111-1111-4111-8111-111111111111", "22222222-2222-4222-8222-222222222222"] // Optional: Limit access to specific customers via public IDs } Notes: customerIds accepts customer public IDs and legacy numeric IDs. Public IDs are the preferred format for new integrations.

#### Delete User
URL: https://uptimeify.io/docs/api/users/delete-user
Description: DELETE /api/users/:id
Endpoints: DELETE /api/users/:id
Key Sections: Response
Summary: Delete User DELETE /api/users/:id Removes a user from the organization. Response On success: 204 No Content.

#### Get User
URL: https://uptimeify.io/docs/api/users/get-user
Description: GET /api/users/:id
Endpoints: GET /api/users/:id
Key Sections: Response
Summary: Get User GET /api/users/:id Returns the details of a specific user. Response { "id": "user 123", "name": "Max Mustermann", "email": "max@example.com", "role": "admin", "isActive": true, "createdAt": "2023-01-01T00:00:00Z" }

#### List Users
URL: https://uptimeify.io/docs/api/users/list-users
Description: GET /api/users
Endpoints: GET /api/users
Key Sections: Response
Summary: List Users GET /api/users Lists all users in the organization. Response { "id": "user 123", "name": "Max Mustermann", "email": "max@example.com", "role": "admin", "isActive": true, "createdAt": "2023-01-01T00:00:00Z" }

#### Update User
URL: https://uptimeify.io/docs/api/users/update-user
Description: PATCH /api/users/:id
Endpoints: PATCH /api/users/:id
Key Sections: Request Body
Summary: Update User PATCH /api/users/:id Updates the details and permissions of a user. Request Body { "firstName": "Jane", "lastName": "Smith", "role": "admin", "isActive": true, "customerIds": ["11111111-1111-4111-8111-111111111111", "22222222-2222-4222-8222-222222222222"] // Update the list of assigned customers via public IDs } Notes: customerIds accepts customer public IDs and legacy numeric IDs. Public IDs are the preferred format for new integrations.

### Escalation Config
URL: https://uptimeify.io/docs/api/escalation
Description: Configure organization-level webhook escalation and notification defaults.
Key Sections: Authentication | Default Webhook Body Template Variables | Endpoints
Summary: Escalation Config Manage organization-level webhook escalation settings and default notification channels. The escalation config auto-creates with sensible defaults when first accessed. Authentication All endpoints accept either session cookies or API bearer tokens: BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Default Webhook Body Template Variables Variable Description ---------- ------------- {{websiteName}} Name of the affected website {{websiteUrl}} URL of the affected website {{status}} Current status (e.g. down, up) {{startedAt}} Incident start timestamp {{incident}} Incident details object {{errorMessage}} Error message if available Endpoints Get Escalation Config Update Escalation Config Test Escalation Config

#### Get Escalation Config
URL: https://uptimeify.io/docs/api/escalation/get-escalation-config
Description: GET /api/escalation-config/:id
Endpoints: GET /api/escalation-config/:id
Key Sections: Example (cURL) | Response | Common errors
Summary: Get Escalation Config GET /api/escalation-config/:id Returns the escalation config for an organization. The :id parameter is the organization ID . If no config exists, one is auto-created with defaults. Also returns the organization's default notification settings and all notification channels. Example (cURL) curl -X GET "$BASE URL/api/escalation-config/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "id": 1, "organizationId": 1, "webhookUrl": "https://example.com/webhook", "webhookMethod": "POST", "webhookHeaders": { "Content-Type": "application/json" }, "webhookBodyTemplate": "{\"websiteName\":\"{{websiteName}}\",...}", "webhookTimeout": 30, "webhookRetryAttempts": 3, "webhookRetryDelay": 60, "expectedStatusCodes": "200,201,202,204", "isActive": false, "lastTestedAt": null, "lastTestStatus": null, "lastTestError": null, "organization": { "defaultEmail": "ops@example.com", "defaultPhoneNumber": "+1234567890", "defaultNotificationChannels": null, "defaultNotificationTargets": null, "defaultNotificationRules": null }, "notificationChannels": [] } Common errors 401 Unauthorized when not authenticated 403 Forbidden with insufficient permissions

#### Test Escalation Config
URL: https://uptimeify.io/docs/api/escalation/test-escalation-config
Description: POST /api/escalation-config/:id/test
Endpoints: POST /api/escalation-config/:id/test
Key Sections: Request Body (all optional) | Example (cURL) — Webhook test | Example (cURL) — PagerDuty test | Response (webhook) | Response (PagerDuty) | Common errors
Summary: Test Escalation Config POST /api/escalation-config/:id/test Tests the escalation config by sending a test webhook, PagerDuty event, or Pushover notification. All body fields are optional and override DB values for testing. Request Body (all optional) Field Type Description ------- ------ ------------- type string pagerduty or pushover for dedicated handlers config object PagerDuty config {routingKey} or Pushover config {userKey, apiToken} webhookUrl string Override webhook URL for test webhookMethod string Override webhook method webhookHeaders object Override webhook headers webhookBodyTemplate string Override webhook body template webhookTimeout number Override webhook timeout expectedStatusCodes string Override expected status codes Example (cURL) — Webhook test curl -X POST "$BASE URL/api/escalation-config/1/test" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "webhookUrl": "https://httpbin.org/post", "webhookMethod": "POST", "webhookTimeout": 15 }' Example (cURL) — PagerDuty test curl -X POST "$BASE URL/api/escalation-config/1/test" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "type": "pagerduty", "config": { "routingKey": "your-routing-key-here" } }' Response (webhook) { "success": true, "statusCode": 200, "message": "Webhook delivered successfully" } Response (PagerDuty) { "success": true, "message": "PagerDuty event enqueued successfully" } Common errors 401 Unauthorized when not authenticated 403 Forbidden with insufficient permissions

#### Update Escalation Config
URL: https://uptimeify.io/docs/api/escalation/update-escalation-config
Description: PATCH /api/escalation-config/:id
Endpoints: PATCH /api/escalation-config/:id
Key Sections: Request Body (all optional) | Example (cURL) | Common errors
Summary: Update Escalation Config PATCH /api/escalation-config/:id Updates the escalation config. The :id parameter is the organization ID . If no config exists, one is upserted. Request Body (all optional) Field Type Description ------- ------ ------------- webhookUrl string\ null Webhook URL. Set to null to deactivate the webhook channel. webhookMethod string HTTP method: POST, PUT, or PATCH webhookHeaders object\ string JSON headers object webhookBodyTemplate string JSON body template with {{variables}} webhookTimeout integer Timeout in seconds webhookRetryAttempts integer Number of retries webhookRetryDelay integer Seconds between retries expectedStatusCodes string Comma-separated expected status codes isActive boolean Enable or disable the webhook defaultEmail string Side-effect: creates/updates an org-level email notification channel defaultPhoneNumber string Side-effect: creates/updates an org-level SMS notification channel Example (cURL) curl -X PATCH "$BASE URL/api/escalation-config/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "webhookUrl": "https://example.com/webhook", "webhookMethod": "POST", "webhookHeaders": { "Content-Type": "application/json" }, "webhookTimeout": 30, "webhookRetryAttempts": 3, "isActive": true, "defaultEmail": "alerts@example.com" }' Common errors 401 Unauthorized when not authenticated 403 Forbidden with insufficient permissions

## Status Pages & Notification Channels
Public status pages, notification channels (email, SMS, webhook, Slack, Discord, PagerDuty, Pushover, Opsgenie), and escalation webhooks.

### Status Pages
URL: https://uptimeify.io/docs/api/status-pages
Description: Create and manage public status pages showing uptime, incidents, and maintenance.
Key Sections: Authentication | Endpoints
Summary: Status Pages Create and manage public status pages that display the operational status of your monitored websites, recent incidents, and maintenance windows. Status pages can be public (accessible by anyone) or restricted to customer members. Custom domains are supported with DNS verification. Authentication All examples assume a bearer token: BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Endpoints List Status Pages Create Status Page Get Status Page Update Status Page Delete Status Page Get Public Status Page Get Status Page Design Update Status Page Design Add Custom Domain Remove Custom Domain Verify Status Page Domain Activate Status Page Domain

#### Activate Status Page Domain
URL: https://uptimeify.io/docs/api/status-pages/activate-status-page-domain
Description: POST /api/status-pages/domains/activate
Endpoints: POST /api/status-pages/domains/activate
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Activate Status Page Domain POST /api/status-pages/domains/activate Activates a verified custom domain for a status page. Admin-only. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- domainId number Yes — The verified domain ID to activate Example (cURL) curl -X POST "$BASE URL/api/status-pages/domains/activate" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "domainId": 42 }' Response { "activated": true, "domain": { "id": 42, "hostname": "status.example.com", "status": "active", "role": "status page", "isPrimary": false, "verificationToken": "abc123-def456-ghi789", "verifiedAt": "2026-05-01T12:00:00.000Z", "createdAt": "2026-05-01T11:00:00.000Z", "updatedAt": "2026-05-01T12:30:00.000Z" } } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 400 Bad Request when the domain is not yet verified

#### Add Custom Domain to Status Page
URL: https://uptimeify.io/docs/api/status-pages/add-status-page-domain
Description: POST /api/status-pages/domains
Endpoints: POST /api/status-pages/domains
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Add Custom Domain to Status Page POST /api/status-pages/domains Adds a custom hostname to an existing status page and returns the DNS TXT record needed for verification. Admin-only. Request Body Field Type Required Description ------- ------ ---------- ------------- statusPageId number \ string Yes The status page ID or publicId hostname string Yes The custom hostname (e.g. status.example.com) Example (cURL) curl -X POST "$BASE URL/api/status-pages/domains" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "statusPageId": 1, "hostname": "status.example.com" }' Response { "domain": { "id": 42, "hostname": "status.example.com", "status": "pending", "role": "status page", "verificationToken": "abc123-def456-ghi789", "verifiedAt": null, "createdAt": "2026-05-01T11:00:00.000Z", "updatedAt": "2026-05-01T11:00:00.000Z" }, "dns": { "txtName": " uptimeify-verify.status.example.com", "txtValue": "abc123-def456-ghi789" } } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 404 Not found when the status page does not exist 409 Conflict when the hostname is already in use 422 Unprocessable Entity when the hostname is reserved or invalid

#### Create Status Page
URL: https://uptimeify.io/docs/api/status-pages/create-status-page
Description: POST /api/status-pages
Endpoints: POST /api/status-pages
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Create Status Page POST /api/status-pages Creates a new status page. Requires admin role. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- customerId number Yes — Customer ID (must belong to your organization) name string Yes — Display name (1–120 chars). Slug auto-generated from name. slug string No auto URL slug (1–120 chars, auto-normalized to lowercase-hyphens) description string No null Description (max 1000 chars) visibility string No public public or customer members only isPublished boolean No true Whether the page is publicly visible customDomainHostname string No null Custom domain (3–253 chars). Creates a pending DNS verification record. Example (cURL) curl -X POST "$BASE URL/api/status-pages" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customerId": 5, "name": "Production Status", "description": "Real-time status of our production services", "visibility": "public" }' Response { "statusPage": { "id": 1, "publicId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "organizationId": 1, "customerId": 5, "name": "Production Status", "slug": "production-status", "description": "Real-time status of our production services", "visibility": "public", "isPublished": true, "showRecentIncidents": false, "showRecentMaintenance": false, "customDomainId": null, "createdAt": "2026-01-15T10:00:00.000Z", "updatedAt": "2026-01-15T10:00:00.000Z" }, "dns": null } If customDomainHostname is provided, the response includes DNS verification instructions: { "dns": { "txtName": " uptimeify-verify.status.example.com", "txtValue": "abc123-def456-ghi789" } } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 409 Conflict when slug is already taken

#### Delete Status Page
URL: https://uptimeify.io/docs/api/status-pages/delete-status-page
Description: DELETE /api/status-pages/:id
Endpoints: DELETE /api/status-pages/:id
Key Sections: Example (cURL) | Response | Common errors
Summary: Delete Status Page DELETE /api/status-pages/:id Permanently deletes a status page. Requires admin role. Example (cURL) curl -X DELETE "$BASE URL/api/status-pages/1" \ -H "Authorization: Bearer $TOKEN" Response { "deleted": true, "id": 1 } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 404 Not found when the status page does not exist

#### Get Public Status Page
URL: https://uptimeify.io/docs/api/status-pages/get-public-status-page
Description: GET /api/status-pages/public/:slug or GET /api/status-pages/public/by-id/:id
Endpoints: GET /api/status-pages/public/:slug | GET /api/status-pages/public/by-id/:id
Key Sections: Response | Common errors
Summary: Get Public Status Page Two endpoints serve the public status page view: GET /api/status-pages/public/:slug — lookup by URL slug GET /api/status-pages/public/by-id/:id — lookup by numeric ID No authentication required for visibility: public pages. Customer-member authentication required for visibility: customer members only pages. Response { "statusPage": { "id": 1, "organizationId": 1, "customerId": 5, "name": "Production Status", "slug": "production-status", "description": "Real-time status of our production services", "visibility": "public", "isPublished": true, "showRecentIncidents": true, "showRecentMaintenance": true, "overallState": "operational", "createdAt": "2026-01-15T10:00:00.000Z", "updatedAt": "2026-01-15T10:00:00.000Z" }, "websites": [ { "id": 101, "name": "Main Site", "url": "https://example.com", "status": "active", "state": "operational", "inMaintenance": false, "openIncidents": 0, "lastCheckedAt": "2026-05-01T12:00:00.000Z" } ], "maintenanceHistory": [], "incidentHistory": [] } state values: operational, warning (SSL-only incidents), degraded (non-SSL incidents), maintenance (active maintenance window). overallState is the most severe state across all websites. Common errors 404 Not found when the status page does not exist or is not published 403 Forbidden for customer members only pages when the user is not a member

#### Get Status Page
URL: https://uptimeify.io/docs/api/status-pages/get-status-page
Description: GET /api/status-pages/:id
Endpoints: GET /api/status-pages/:id
Key Sections: Example (cURL) | Common errors
Summary: Get Status Page GET /api/status-pages/:id Returns a single status page by numeric ID or publicId UUID. Example (cURL) curl -X GET "$BASE URL/api/status-pages/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Common errors 401 Unauthorized when not authenticated 404 Not found when the status page does not exist

#### Get Status Page Design
URL: https://uptimeify.io/docs/api/status-pages/get-status-page-design
Description: GET /api/status-pages/:id/design
Endpoints: GET /api/status-pages/:id/design
Key Sections: Path Parameter | Example (cURL) | Response | Common errors
Summary: Get Status Page Design GET /api/status-pages/:id/design Returns the current visual design configuration for a status page. Requires admin role. Path Parameter Parameter Description ----------- ------------- id Status page ID or publicId (UUID) Example (cURL) curl "$BASE URL/api/status-pages/db58058e-4b58-4d97-a314-3bb8e279a182/design" \ -H "Authorization: Bearer $TOKEN" Response { "designConfig": { "layout": "timeline", "colorScheme": "dark", "accentColor": "#f59e0b", "headerStyle": "simple", "fontFamily": "system", "cardRadius": "md", "pageWidth": "lg", "customTitle": "", "customSubtitle": "", "showPoweredBy": true, "showUptimeStats": true, "showServiceUrls": false, "showLastChecked": false, "showHistory": true } } If no design has been saved yet all fields reflect the defaults. Common errors 401 Unauthorized — not authenticated 403 Forbidden — not an admin 404 Not found — status page does not exist

#### List Status Pages
URL: https://uptimeify.io/docs/api/status-pages/list-status-pages
Description: GET /api/status-pages
Endpoints: GET /api/status-pages
Key Sections: Example (cURL) | Response | Common errors
Summary: List Status Pages GET /api/status-pages Returns all status pages for the organization. Each page includes its custom domain info if configured. Example (cURL) curl -X GET "$BASE URL/api/status-pages" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "statusPages": [ { "id": 1, "publicId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "organizationId": 1, "customerId": 5, "customerPublicId": "f7e6d5c4-b3a2-1098-7654-321fedcba098", "name": "Production Status", "slug": "production-status", "description": "Real-time status of our production services", "visibility": "public", "isPublished": true, "showRecentIncidents": true, "showRecentMaintenance": true, "customDomainId": null, "createdAt": "2026-01-15T10:00:00.000Z", "updatedAt": "2026-01-15T10:00:00.000Z" } ] } Common errors 401 Unauthorized when not authenticated

#### Remove Custom Domain from Status Page
URL: https://uptimeify.io/docs/api/status-pages/remove-status-page-domain
Description: DELETE /api/status-pages/domains/:id
Endpoints: DELETE /api/status-pages/domains/:id
Key Sections: Path Parameters | Example (cURL) | Response | Common errors
Summary: Remove Custom Domain from Status Page DELETE /api/status-pages/domains/:id Removes a custom domain from a status page. Deletes the domain record; the status page's customDomainId is automatically set to null. Admin-only. Path Parameters Parameter Type Description ----------- ------ ------------- id number The domain ID to remove Example (cURL) curl -X DELETE "$BASE URL/api/status-pages/domains/42" \ -H "Authorization: Bearer $TOKEN" Response 204 No Content Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 404 Not found when the domain does not exist 422 Unprocessable Entity when the domain ID is invalid

#### Update Status Page
URL: https://uptimeify.io/docs/api/status-pages/update-status-page
Description: PATCH /api/status-pages/:id
Endpoints: PATCH /api/status-pages/:id
Key Sections: Request Body (all optional) | Example (cURL) | Common errors
Summary: Update Status Page PATCH /api/status-pages/:id Updates a status page. At least one field must be provided. Requires admin role. Request Body (all optional) Field Type Description ------- ------ ------------- customerId number Move status page to another customer name string Display name (1–120 chars) slug string URL slug (1–120 chars, 409 on conflict) description string\ null Description (max 1000 chars). null clears it. visibility string public or customer members only isPublished boolean Publish or unpublish the page showRecentIncidents boolean Show recent incidents section showRecentMaintenance boolean Show recent maintenance section designConfig object Visual design settings (layout, colors, typography, …). See Update Status Page Design for all fields. Example (cURL) curl -X PATCH "$BASE URL/api/status-pages/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Production Status - Updated", "isPublished": true, "showRecentIncidents": true }' Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 404 Not found when the status page does not exist 409 Conflict when slug is already taken

#### Update Status Page Design
URL: https://uptimeify.io/docs/api/status-pages/update-status-page-design
Description: PATCH /api/status-pages/:id/design
Endpoints: PATCH /api/status-pages/:id/design
Key Sections: Path Parameter | Request Body (all optional) | Layout | Colors | Typography & Style | Header | Display options | Example — switch to dark timeline layout
Summary: Update Status Page Design PATCH /api/status-pages/:id/design Updates the visual design configuration of a status page. Only the fields you provide are changed — all other settings keep their current values. Requires admin role. Path Parameter Parameter Description ----------- ------------- id Status page ID or publicId (UUID) Request Body (all optional) Layout Field Type Values Default Description ------- ------ -------- --------- ------------- layout string classic cards minimal sleek board split timeline compact classic Visual layout template pageWidth string sm md lg xl lg Max content width: sm = 672 px, md = 896 px, lg = 1024 px, xl = 1280 px Colors Field Type Values Default Description ------- ------ -------- --------- ------------- colorScheme string light dark auto auto Color mode. auto follows the visitor's system preference. accentColor string hex, e.g. #6366f1 #6366f1 Brand accent color used for highlights, borders, and gradients Typography & Style Field Type Values Default Description ------- ------ -------- --------- ------------- fontFamily string system mono system system = default sans-serif, mono = monospace cardRadius string none md xl md Card corner radius: none = sharp, md = rounded, xl = pill Header Field Type Values Default Description ------- ------ -------- --------- ------------- headerStyle string simple centered hero simple simple = left-aligned, centered = centered, hero = full gradient banner customTitle string max 120 chars "" Overrides the status page name in the header. Leave empty to use the page name. customSubtitle string max 200 chars "" Optional tagline below the title Display options Field Type Default Description ------- ------ --------- ------------- showUptimeStats boolean true Show uptime percentage and service counts showServiceUrls boolean false Show the monitored URL below each service name showLastChecked boolean false Show the last check timestamp per service showHistory boolean true Show the recent incidents & maintenance section showPoweredBy boolean true Show "Powered by …" badge in the footer Example — switch to dark timeline layout curl -X PATCH "$BASE URL/api/status-pages/db58058e-4b58-4d97-a314-3bb8e279a182/design" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "layout": "timeline", "colorScheme": "dark", "accentColor": "#f59e0b", "pageWidth": "lg" }' Example — minimal, no branding, full width curl -X PATCH "$BASE URL/api/status-pages/db58058e-4b58-4d97-a314-3bb8e279a182/design" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "layout": "minimal", "colorScheme": "light", "pageWidth": "xl", "showPoweredBy": false, "showUptimeStats": false, "customTitle": "System Status", "customSubtitle": "Live overview of all services" }' Response { "designConfig": { "layout": "timeline", "colorScheme": "dark", "accentColor": "#f59e0b", "headerStyle": "simple", "fontFamily": "system", "cardRadius": "md", "pageWidth": "lg", "customTitle": "", "customSubtitle": "", "showPoweredBy": true, "showUptimeStats": true, "showServiceUrls": false, "showLastChecked": false, "showHistory": true } } Common errors 400 Bad Request — invalid field value (e.g. unknown layout name or malformed hex color) 401 Unauthorized — not authenticated 403 Forbidden — not an admin 404 Not found — status page does not exist

#### Verify Status Page Domain
URL: https://uptimeify.io/docs/api/status-pages/verify-status-page-domain
Description: POST /api/status-pages/domains/verify
Endpoints: POST /api/status-pages/domains/verify
Key Sections: Request Body | Example (cURL) | Response (success) | Common errors
Summary: Verify Status Page Domain POST /api/status-pages/domains/verify Verifies DNS TXT records for a custom status page domain. Admin-only. Request Body Field Type Required Description ------- ------ ---------- ------------- domainId number Yes The domain ID to verify Example (cURL) curl -X POST "$BASE URL/api/status-pages/domains/verify" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "domainId": 42 }' Response (success) { "verified": true, "status": "verified", "domain": { "id": 42, "hostname": "status.example.com", "status": "verified", "role": "status page", "verificationToken": "abc123-def456-ghi789", "verifiedAt": "2026-05-01T12:00:00.000Z", "createdAt": "2026-05-01T11:00:00.000Z", "updatedAt": "2026-05-01T12:00:00.000Z" } } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 404 Not found when the domain does not exist

### Notification Channels
URL: https://uptimeify.io/docs/api/notification-channels
Description: Manage alert notification channels for email, SMS, webhook, Slack, Discord, PagerDuty, Pushover, and Opsgenie.
Key Sections: Authentication | Channel Types and Config | Webhook Signature Verification | Scope Resolution | Endpoints
Summary: Notification Channels Manage how and where alerts are delivered. Channels can be organization-level (default for all customers), customer-level (override for a specific customer), or website-level (override for a specific monitor). Authentication All examples assume a bearer token: BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Channel Types and Config Each channel type has a specific config structure: Type Config Fields Notes ------ -------------- ------- email { email, to } Email address and recipient name sms { phoneNumber } Phone number in international format webhook { url, method?, headers?, bodyTemplate?, timeout?, retryAttempts?, retryDelay?, expectedStatusCodes?, secret? } HTTP webhook. secret for HMAC signing slack { secret } Slack incoming webhook URL discord { secret } Discord incoming webhook URL pagerduty { routingKey } PagerDuty Events API v2 routing key pushover { userKey, apiToken } Pushover user key and API token opsgenie { apiKey } Opsgenie API key Secrets (webhook secret, Slack/Discord URLs, PagerDuty routing keys, Pushover credentials, Opsgenie API keys) are encrypted at rest and redacted in API responses (replaced with null, with hasSecret: true flags). Webhook Signature Verification When a secret is configured on a webhook channel, Uptimeify signs outgoing payloads so receivers can verify authenticity. Algorithm: HMAC-SHA256 Header: X-Webhook-Signature — hex-encoded HMAC-SHA256 digest Companion headers sent with every webhook: Header Value -------- ------- X-Webhook-Signature Hex-encoded HMAC-SHA256 digest X-Webhook-Signature-Algorithm sha256 X-Webhook-Timestamp ISO 8601 timestamp (e.g. 2026-05-05T12:00:00.000Z) X-Webhook-Attempt 1-based retry number (e.g. 1, 2, 3) X-Webhook-Event Event type: alert, recovery, or dnsbl Verification steps: Read the raw request body as a string (do not parse as JSON first). Compute HMAC-SHA256 using the secret you configured in the channel as the key and the raw body string as the message. Compare the result (hex-encoded) with the value of the X-Webhook-Signature header using a constant-time comparison. Optionally check X-Webhook-Timestamp for replay protection. // Node.js verification example const crypto = require('crypto') function verifySignature(rawBody, signature, secret) { const expected = crypto .createHmac('sha256', secret) .update(rawBody) .digest('hex') return crypto.timingSafeEqual( Buffer.from(signature), Buffer.from(expected) ) } Python verification example import hmac, hashlib def verify signature(raw body, signature, secret): expected = hmac.new( secret.encode('utf-8'), raw body.encode('utf-8'), hashlib.sha256 ).hexdigest() return hmac.compare digest(signature, expected) Scope Resolution When listing channels, the scope determines which channels are returned: Organization-level (organizationId only, no customerId/websiteId): Default channels for all customers Customer-level (customerId set, no websiteId): Customer-specific overrides Website-level (websiteId set): Per-monitor overrides Endpoints List Notification Channels Create Notification Channel Update Notification Channel Delete Notification Channel Test Notification Channel

#### Create Notification Channel
URL: https://uptimeify.io/docs/api/notification-channels/create-notification-channel
Description: POST /api/notification-channels
Endpoints: POST /api/notification-channels
Key Sections: Request Body | Example (cURL) — Email channel | Example (cURL) — Slack channel | Example (cURL) — Webhook channel | Common errors
Summary: Create Notification Channel POST /api/notification-channels Creates a new notification channel. Secrets in config are encrypted server-side. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- type string Yes — Channel type: email, sms, webhook, slack, discord, pagerduty, pushover, opsgenie name string Yes — Display name config object\ string Yes — Channel configuration (see type table). Pass as JSON object or JSON string. organizationId number No from session Organization scope customerId number No null Customer scope websiteId number No null Website scope. Requires sourceChannelId. sourceChannelId number\ string Conditional null Parent channel ID for website overrides category string No direct direct or integration priority number No 1 Lower = higher priority delaySeconds number No 0 Delay before sending alert conditions object\ string No null Alert conditions (e.g., {"onlyFullService": true, "minIncidentDuration": 300}) isActive boolean No true Whether the channel is active Example (cURL) — Email channel curl -X POST "$BASE URL/api/notification-channels" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "type": "email", "name": "Ops Email", "config": { "email": "ops@example.com", "to": "Ops Team" }, "organizationId": 1 }' Example (cURL) — Slack channel curl -X POST "$BASE URL/api/notification-channels" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "type": "slack", "name": "Alerts Slack Channel", "config": { "secret": "https://hooks.slack.com/services/T00/B00/xxx" }, "organizationId": 1 }' Example (cURL) — Webhook channel curl -X POST "$BASE URL/api/notification-channels" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "type": "webhook", "name": "Custom Webhook", "config": { "url": "https://example.com/webhook", "method": "POST", "headers": { "X-Custom-Header": "value" }, "bodyTemplate": "{\"text\": \"{{websiteName}} is {{status}}\"}", "timeout": 30, "retryAttempts": 3, "retryDelay": 60, "expectedStatusCodes": "200,201,204" }, "organizationId": 1 }' Common errors 401 Unauthorized when not authenticated 403 Forbidden when creating channels for an organization you cannot write to 409 Conflict when a duplicate website-level override already exists

#### Delete Notification Channel
URL: https://uptimeify.io/docs/api/notification-channels/delete-notification-channel
Description: DELETE /api/notification-channels/:id
Endpoints: DELETE /api/notification-channels/:id
Key Sections: Example (cURL) | Response | Common errors
Summary: Delete Notification Channel DELETE /api/notification-channels/:id Deletes a notification channel. If the channel was an org-level default, organization defaults are automatically synced. Example (cURL) curl -X DELETE "$BASE URL/api/notification-channels/1" \ -H "Authorization: Bearer $TOKEN" Response { "success": true } Common errors 401 Unauthorized when not authenticated 403 Forbidden when accessing channels outside your scope 404 Not found when the channel does not exist

#### List Notification Channels
URL: https://uptimeify.io/docs/api/notification-channels/list-notification-channels
Description: GET /api/notification-channels
Endpoints: GET /api/notification-channels
Key Sections: Query Parameters | Example (cURL) | Response | Common errors
Summary: List Notification Channels GET /api/notification-channels Returns notification channels scoped by organization, customer, or website. Query Parameters Parameter Type Required Description ----------- ------ ---------- ------------- organizationId number No Scope to organization customerId number No Scope to customer websiteId number No Scope to website (includes org + customer channels) Example (cURL) curl -X GET "$BASE URL/api/notification-channels?organizationId=1" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response [ { "id": 1, "organizationId": 1, "customerId": null, "websiteId": null, "type": "email", "category": "direct", "name": "Ops Email", "config": { "email": "ops@example.com", "to": "Ops Team" }, "priority": 1, "delaySeconds": 0, "conditions": null, "isActive": true, "allowedPackageTypes": null } ] Common errors 401 Unauthorized when not authenticated 403 Forbidden when accessing channels outside your scope

#### Test Notification Channel
URL: https://uptimeify.io/docs/api/notification-channels/test-notification-channel
Description: POST /api/notification-channels/test
Endpoints: POST /api/notification-channels/test
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Test Notification Channel POST /api/notification-channels/test Tests a notification channel configuration. Optionally sends a real test message. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- type string Yes — webhook, slack, discord, pagerduty, pushover, opsgenie config object Yes {} Channel config with secrets organizationId number No from session Organization scope customerId number No null Customer scope websiteId number No null Website scope dryRun boolean No false If true, validates only (no actual send) Example (cURL) curl -X POST "$BASE URL/api/notification-channels/test" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "type": "webhook", "config": { "url": "https://example.com/webhook", "method": "POST", "timeout": 15 }, "dryRun": false }' Response { "success": true, "mode": "send", "message": "Webhook delivered successfully", "validation": { "ok": true, "errors": [], "warnings": [] }, "request": { "url": "https://example.com/webhook", "method": "POST", "timeoutSeconds": 15, "headers": {}, "bodyPreview": "...", "bodySize": 256 }, "response": { "reachable": true, "ok": true, "statusCode": 200, "statusText": "OK", "durationMs": 150, "headers": {}, "bodyPreview": null, "bodySize": null } } HTTP 429 responses are treated as "reachable but rate-limited" (success: true). Common errors 401 Unauthorized when not authenticated 400 Bad Request when config is invalid for the given type

#### Update Notification Channel
URL: https://uptimeify.io/docs/api/notification-channels/update-notification-channel
Description: PATCH /api/notification-channels/:id
Endpoints: PATCH /api/notification-channels/:id
Key Sections: Request Body (all optional) | Example (cURL) | Common errors
Summary: Update Notification Channel PATCH /api/notification-channels/:id Updates a notification channel. Config is merged with existing secrets, preserving encrypted fields that are not provided. Request Body (all optional) Field Type Description ------- ------ ------------- type string Channel type name string Display name config object\ string Merged with existing secrets priority number Priority order delaySeconds number Delay before sending conditions object\ string\ null Alert conditions allowedPackageTypes string[]\ null Package types this channel applies to isActive boolean Whether the channel is active Example (cURL) curl -X PATCH "$BASE URL/api/notification-channels/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Updated Email Channel", "isActive": true }' Common errors 401 Unauthorized when not authenticated 403 Forbidden when accessing channels outside your scope 404 Not found when the channel does not exist

### Escalation Config
URL: https://uptimeify.io/docs/api/escalation
Description: Configure organization-level webhook escalation and notification defaults.
Key Sections: Authentication | Default Webhook Body Template Variables | Endpoints
Summary: Escalation Config Manage organization-level webhook escalation settings and default notification channels. The escalation config auto-creates with sensible defaults when first accessed. Authentication All endpoints accept either session cookies or API bearer tokens: BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Default Webhook Body Template Variables Variable Description ---------- ------------- {{websiteName}} Name of the affected website {{websiteUrl}} URL of the affected website {{status}} Current status (e.g. down, up) {{startedAt}} Incident start timestamp {{incident}} Incident details object {{errorMessage}} Error message if available Endpoints Get Escalation Config Update Escalation Config Test Escalation Config

#### Get Escalation Config
URL: https://uptimeify.io/docs/api/escalation/get-escalation-config
Description: GET /api/escalation-config/:id
Endpoints: GET /api/escalation-config/:id
Key Sections: Example (cURL) | Response | Common errors
Summary: Get Escalation Config GET /api/escalation-config/:id Returns the escalation config for an organization. The :id parameter is the organization ID . If no config exists, one is auto-created with defaults. Also returns the organization's default notification settings and all notification channels. Example (cURL) curl -X GET "$BASE URL/api/escalation-config/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "id": 1, "organizationId": 1, "webhookUrl": "https://example.com/webhook", "webhookMethod": "POST", "webhookHeaders": { "Content-Type": "application/json" }, "webhookBodyTemplate": "{\"websiteName\":\"{{websiteName}}\",...}", "webhookTimeout": 30, "webhookRetryAttempts": 3, "webhookRetryDelay": 60, "expectedStatusCodes": "200,201,202,204", "isActive": false, "lastTestedAt": null, "lastTestStatus": null, "lastTestError": null, "organization": { "defaultEmail": "ops@example.com", "defaultPhoneNumber": "+1234567890", "defaultNotificationChannels": null, "defaultNotificationTargets": null, "defaultNotificationRules": null }, "notificationChannels": [] } Common errors 401 Unauthorized when not authenticated 403 Forbidden with insufficient permissions

#### Test Escalation Config
URL: https://uptimeify.io/docs/api/escalation/test-escalation-config
Description: POST /api/escalation-config/:id/test
Endpoints: POST /api/escalation-config/:id/test
Key Sections: Request Body (all optional) | Example (cURL) — Webhook test | Example (cURL) — PagerDuty test | Response (webhook) | Response (PagerDuty) | Common errors
Summary: Test Escalation Config POST /api/escalation-config/:id/test Tests the escalation config by sending a test webhook, PagerDuty event, or Pushover notification. All body fields are optional and override DB values for testing. Request Body (all optional) Field Type Description ------- ------ ------------- type string pagerduty or pushover for dedicated handlers config object PagerDuty config {routingKey} or Pushover config {userKey, apiToken} webhookUrl string Override webhook URL for test webhookMethod string Override webhook method webhookHeaders object Override webhook headers webhookBodyTemplate string Override webhook body template webhookTimeout number Override webhook timeout expectedStatusCodes string Override expected status codes Example (cURL) — Webhook test curl -X POST "$BASE URL/api/escalation-config/1/test" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "webhookUrl": "https://httpbin.org/post", "webhookMethod": "POST", "webhookTimeout": 15 }' Example (cURL) — PagerDuty test curl -X POST "$BASE URL/api/escalation-config/1/test" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "type": "pagerduty", "config": { "routingKey": "your-routing-key-here" } }' Response (webhook) { "success": true, "statusCode": 200, "message": "Webhook delivered successfully" } Response (PagerDuty) { "success": true, "message": "PagerDuty event enqueued successfully" } Common errors 401 Unauthorized when not authenticated 403 Forbidden with insufficient permissions

#### Update Escalation Config
URL: https://uptimeify.io/docs/api/escalation/update-escalation-config
Description: PATCH /api/escalation-config/:id
Endpoints: PATCH /api/escalation-config/:id
Key Sections: Request Body (all optional) | Example (cURL) | Common errors
Summary: Update Escalation Config PATCH /api/escalation-config/:id Updates the escalation config. The :id parameter is the organization ID . If no config exists, one is upserted. Request Body (all optional) Field Type Description ------- ------ ------------- webhookUrl string\ null Webhook URL. Set to null to deactivate the webhook channel. webhookMethod string HTTP method: POST, PUT, or PATCH webhookHeaders object\ string JSON headers object webhookBodyTemplate string JSON body template with {{variables}} webhookTimeout integer Timeout in seconds webhookRetryAttempts integer Number of retries webhookRetryDelay integer Seconds between retries expectedStatusCodes string Comma-separated expected status codes isActive boolean Enable or disable the webhook defaultEmail string Side-effect: creates/updates an org-level email notification channel defaultPhoneNumber string Side-effect: creates/updates an org-level SMS notification channel Example (cURL) curl -X PATCH "$BASE URL/api/escalation-config/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "webhookUrl": "https://example.com/webhook", "webhookMethod": "POST", "webhookHeaders": { "Content-Type": "application/json" }, "webhookTimeout": 30, "webhookRetryAttempts": 3, "isActive": true, "defaultEmail": "alerts@example.com" }' Common errors 401 Unauthorized when not authenticated 403 Forbidden with insufficient permissions

## Whitelabel & API Tokens
White-label branding, custom domains, SMTP config, API token management, and custom fields.

### Whitelabel & Branding
URL: https://uptimeify.io/docs/api/whitelabel
Description: Customize branding, logos, favicons, and custom domains for your organization.
Key Sections: Authentication | Endpoints | Branding | Domains
Summary: Whitelabel & Branding Customize your organization's product name, theme colors, logos, favicons, and custom domains. All whitelabel endpoints require admin or global admin role. Authentication All whitelabel endpoints require session authentication (not API tokens): BASE URL="https://uptimeify.io" Endpoints Branding Get Branding Update Branding Upload Branding Asset Domains List Domains Add Domain Verify Domain Activate Domain Delete Domain

#### Activate Domain
URL: https://uptimeify.io/docs/api/whitelabel/activate-domain
Description: POST /api/organization/whitelabel/domains/activate
Endpoints: POST /api/organization/whitelabel/domains/activate
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Activate Domain POST /api/organization/whitelabel/domains/activate Activates a verified custom domain. Optionally sets it as the primary domain. Admin-only. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- domainId number Yes — The verified domain ID to activate makePrimary boolean No auto Set this domain as primary. Auto-set to true if no primary exists. Example (cURL) curl -X POST "$BASE URL/api/organization/whitelabel/domains/activate" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "domainId": 2, "makePrimary": true }' Response { "activated": true, "domain": { "id": 2, "hostname": "app.example.com", "status": "active", "role": "app", "isPrimary": true, "verificationToken": "xyz789-abc456", "verifiedAt": "2026-04-15T12:30:00.000Z", "createdAt": "2026-04-15T12:00:00.000Z", "updatedAt": "2026-04-15T13:00:00.000Z" } } Common errors 400 Domain must be verified before activation 404 Domain not found

#### Add Domain
URL: https://uptimeify.io/docs/api/whitelabel/add-domain
Description: POST /api/organization/whitelabel/domains
Endpoints: POST /api/organization/whitelabel/domains
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Add Domain POST /api/organization/whitelabel/domains Adds a custom domain for whitelabeling. Creates a pending DNS verification record. The first domain is automatically set as primary. Requires admin role. Request Body Field Type Required Description ------- ------ ---------- ------------- hostname string Yes Custom domain hostname (3–253 chars). No wildcards. Example (cURL) curl -X POST "$BASE URL/api/organization/whitelabel/domains" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "hostname": "app.example.com" }' Response { "domain": { "id": 2, "hostname": "app.example.com", "status": "pending", "role": "app", "isPrimary": false, "verificationToken": "xyz789-abc456", "verifiedAt": null, "createdAt": "2026-04-15T12:00:00.000Z", "updatedAt": "2026-04-15T12:00:00.000Z" }, "dns": { "txtName": " uptimeify-verify.app.example.com", "txtValue": "xyz789-abc456" } } Add a DNS TXT record with the txtName and txtValue, then call Verify Domain. Common errors 400 Invalid hostname when hostname format is wrong 400 This hostname is reserved when hostname matches the main platform 400 Wildcard domains are not supported 409 Hostname already exists

#### Delete Domain
URL: https://uptimeify.io/docs/api/whitelabel/delete-domain
Description: DELETE /api/organization/whitelabel/domains/:id
Endpoints: DELETE /api/organization/whitelabel/domains/:id
Key Sections: Example (cURL) | Response | Common errors
Summary: Delete Domain DELETE /api/organization/whitelabel/domains/:id Deletes a custom domain. If the deleted domain was primary, the next available domain is promoted to primary. Admin-only. Example (cURL) curl -X DELETE "$BASE URL/api/organization/whitelabel/domains/2" \ -H "Cookie: $SESSION COOKIE" Response { "success": true } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 404 Domain not found

#### Get Branding
URL: https://uptimeify.io/docs/api/whitelabel/get-branding
Description: GET /api/organization/whitelabel/branding
Endpoints: GET /api/organization/whitelabel/branding
Key Sections: Example (cURL) | Response | Common errors
Summary: Get Branding GET /api/organization/whitelabel/branding Returns the organization's branding configuration, including product name, theme colors, and signed URLs for logos and favicons. Requires admin role. Example (cURL) curl -X GET "$BASE URL/api/organization/whitelabel/branding" \ -H "Cookie: $SESSION COOKIE" \ -H "Accept: application/json" Response { "branding": { "productName": "Acme Monitor", "hideProductName": false, "logoObjectKey": "branding/org-1/logo/light/1710000000-logo.svg", "logoObjectKeyLight": "branding/org-1/logo/light/1710000000-logo.svg", "logoObjectKeyDark": "branding/org-1/logo/dark/1710000000-logo-dark.svg", "hideLogos": false, "faviconObjectKey": "branding/org-1/favicon/light/1710000000-favicon.ico", "faviconObjectKeyLight": "branding/org-1/favicon/light/1710000000-favicon.ico", "faviconObjectKeyDark": "branding/org-1/favicon/dark/1710000000-favicon-dark.ico", "themePrimary": "#43B1AE", "themeSecondary": null, "logoUrl": "https://s3.example.com/branding/org-1/logo/light/1710000000-logo.svg?...", "logoLightUrl": "https://s3.example.com/branding/org-1/logo/light/1710000000-logo.svg?...", "logoDarkUrl": "https://s3.example.com/branding/org-1/logo/dark/1710000000-logo-dark.svg?...", "faviconUrl": "https://s3.example.com/branding/org-1/favicon/light/1710000000-favicon.ico?...", "faviconLightUrl": "https://s3.example.com/branding/org-1/favicon/light/1710000000-favicon.ico?...", "faviconDarkUrl": "https://s3.example.com/branding/org-1/favicon/dark/1710000000-favicon-dark.ico?...", "updatedAt": "2026-03-01T10:00:00.000Z" } } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin

#### List Domains
URL: https://uptimeify.io/docs/api/whitelabel/list-domains
Description: GET /api/organization/whitelabel/domains
Endpoints: GET /api/organization/whitelabel/domains
Key Sections: Example (cURL) | Response | Common errors
Summary: List Domains GET /api/organization/whitelabel/domains Returns all custom app domains for the organization. Only domains with role app are returned. Requires admin role. Example (cURL) curl -X GET "$BASE URL/api/organization/whitelabel/domains" \ -H "Cookie: $SESSION COOKIE" \ -H "Accept: application/json" Response { "domains": [ { "id": 1, "hostname": "app.example.com", "status": "active", "role": "app", "isPrimary": true, "verificationToken": "abc123-def456", "verifiedAt": "2026-01-15T10:00:00.000Z", "createdAt": "2026-01-14T08:00:00.000Z", "updatedAt": "2026-01-15T10:00:00.000Z" } ] } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin

#### Update Branding
URL: https://uptimeify.io/docs/api/whitelabel/update-branding
Description: PATCH /api/organization/whitelabel/branding
Endpoints: PATCH /api/organization/whitelabel/branding
Key Sections: Request Body (all optional) | Example (cURL) | Response | Common errors
Summary: Update Branding PATCH /api/organization/whitelabel/branding Updates the organization's branding configuration. All fields are optional — only sent fields are updated. Setting productName or theme colors to null clears them. Requires admin role. Theme colors accept CSS custom property tokens (e.g. --color-red-500) or hex colors (e.g. #43B1AE). Invalid values are rejected. Request Body (all optional) Field Type Description ------- ------ ------------- productName string\ null Product display name (1–80 chars). null clears it. hideProductName boolean Hide the product name in the UI hideLogos boolean Hide all logos in the UI themePrimary string\ null Primary theme color (hex or CSS variable). null clears it. themeNeutral string\ null Neutral/secondary theme color (hex or CSS variable). null clears it. Example (cURL) curl -X PATCH "$BASE URL/api/organization/whitelabel/branding" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "productName": "Acme Monitor", "themePrimary": "#43B1AE", "hideProductName": false }' Response { "branding": { "productName": "Acme Monitor", "hideProductName": false, "hideLogos": false, "themePrimary": "#43B1AE", "themeSecondary": null, "updatedAt": "2026-04-15T12:00:00.000Z" } } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin

#### Upload Branding Asset
URL: https://uptimeify.io/docs/api/whitelabel/upload-branding
Description: POST /api/organization/whitelabel/branding/upload
Endpoints: POST /api/organization/whitelabel/branding/upload
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Upload Branding Asset POST /api/organization/whitelabel/branding/upload Uploads a logo or favicon as a base64 data URL. Assets are stored in S3 and the branding record is updated automatically. Requires admin role. Logo types: logo, logoLight, logoDark — accepts PNG, JPEG, WebP, SVG (max 2 MB). Favicon types: favicon, faviconLight, faviconDark — accepts PNG, SVG, ICO (max 512 KB). Legacy logo is treated as logoLight, and favicon as faviconLight. Request Body Field Type Required Description ------- ------ ---------- ------------- kind string Yes logo, logoLight, logoDark, favicon, faviconLight, faviconDark fileName string Yes Original file name (1–200 chars) dataUrl string Yes Base64 data URL (data: / ;base64,...) Example (cURL) curl -X POST "$BASE URL/api/organization/whitelabel/branding/upload" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "kind": "logoLight", "fileName": "logo.svg", "dataUrl": "data:image/svg+xml;base64,PHN2Zy..." }' Response { "success": true, "uploaded": { "kind": "logo", "objectKey": "branding/org-1/logo/light/1710000000-logo.svg", "contentType": "image/svg+xml", "bytes": 1234, "publicUrl": "https://s3.example.com/branding/org-1/logo/light/1710000000-logo.svg?..." }, "branding": { "productName": "Acme Monitor", "hideProductName": false, "logoUrl": "https://s3.example.com/...", "themePrimary": "#43B1AE", "updatedAt": "2026-04-15T12:00:00.000Z" } } Common errors 400 Invalid dataUrl when the data URL format is wrong 400 Unsupported contentType when the content type is not allowed for the asset kind 413 File too large when exceeding size limits 503 Whitelabel asset storage is not configured when S3 is not set up

#### Verify Domain
URL: https://uptimeify.io/docs/api/whitelabel/verify-domain
Description: POST /api/organization/whitelabel/domains/verify
Endpoints: POST /api/organization/whitelabel/domains/verify
Key Sections: Request Body | Example (cURL) | Response (success) | Common errors
Summary: Verify Domain POST /api/organization/whitelabel/domains/verify Verifies DNS TXT records for a custom domain. Admin-only. Request Body Field Type Required Description ------- ------ ---------- ------------- domainId number Yes The domain ID to verify Example (cURL) curl -X POST "$BASE URL/api/organization/whitelabel/domains/verify" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "domainId": 2 }' Response (success) { "verified": true, "status": "verified", "domain": { "id": 2, "hostname": "app.example.com", "status": "verified", "role": "app", "isPrimary": false, "verificationToken": "xyz789-abc456", "verifiedAt": "2026-04-15T12:30:00.000Z", "createdAt": "2026-04-15T12:00:00.000Z", "updatedAt": "2026-04-15T12:30:00.000Z" } } Common errors 400 TXT verification failed (token not found) when DNS record is missing or has wrong value 400 Domain has no verification token 404 Domain not found

### API Tokens
URL: https://uptimeify.io/docs/api/api-tokens
Description: Create and manage API tokens for programmatic access.
Key Sections: Authentication | Endpoints
Summary: API Tokens API tokens allow programmatic access to the Uptimeify API. Tokens are prefixed with wsm and can be scoped to a specific customer or organization-wide. There are two endpoint scopes: Organization tokens (/api/organization/tokens) — admin-only, full org access Customer tokens (/api/customer/tokens) — scoped to accessible customers Authentication All examples assume a session cookie (not API tokens — API tokens cannot manage other API tokens): BASE URL="https://uptimeify.io" Endpoints List Organization Tokens Create Organization Token Delete Organization Token List Customer Tokens Create Customer Token Delete Customer Token

#### Create Customer Token
URL: https://uptimeify.io/docs/api/api-tokens/create-customer-token
Description: POST /api/customer/tokens
Endpoints: POST /api/customer/tokens
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Create Customer Token POST /api/customer/tokens Creates a new API token scoped to a customer. Restricted users must specify customerId. The full token is returned only once — store it securely. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- name string Yes — Token display name (1–255 chars) expiresInDays number No null Days until expiration (1–365). Null = no expiration. customerId number No null Scope token to a specific customer. Required for restricted users. Example (cURL) curl -X POST "$BASE URL/api/customer/tokens" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp API Token", "customerId": 5, "expiresInDays": 180 }' Response { "id": 2, "name": "Acme Corp API Token", "token": "wsm f7e6d5c4b3a2...", "lastUsedAt": null, "expiresAt": "2026-10-15T08:00:00.000Z", "createdAt": "2026-04-15T08:00:00.000Z" } Common errors 400 Invalid customer ID when customerId doesn't belong to your organization 400 customerId is required when restricted user doesn't specify customerId 403 Forbidden when customer is outside user's scope

#### Create Organization Token
URL: https://uptimeify.io/docs/api/api-tokens/create-organization-token
Description: POST /api/organization/tokens
Endpoints: POST /api/organization/tokens
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Create Organization Token POST /api/organization/tokens Creates a new API token. The full token is returned only once — store it securely. Requires admin role. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- name string Yes — Token display name (1–255 chars) expiresInDays number No null Days until expiration (1–365). Null = no expiration. customerId number No null Scope token to a specific customer (must belong to your org) Example (cURL) curl -X POST "$BASE URL/api/organization/tokens" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "name": "Production API", "expiresInDays": 90 }' Response { "id": 1, "name": "Production API", "token": "wsm a1b2c3d4e5f6...", "lastUsedAt": null, "expiresAt": "2026-07-15T10:00:00.000Z", "createdAt": "2026-04-15T10:00:00.000Z" } Common errors 400 Invalid customer ID when customerId doesn't belong to your organization 401 Unauthorized when not authenticated 403 Forbidden when not an admin

#### Delete Customer Token
URL: https://uptimeify.io/docs/api/api-tokens/delete-customer-token
Description: DELETE /api/customer/tokens/:id
Endpoints: DELETE /api/customer/tokens/:id
Key Sections: Example (cURL) | Response | Common errors
Summary: Delete Customer Token DELETE /api/customer/tokens/:id Permanently revokes a customer-scoped API token. Users can only delete tokens within their customer scope. Example (cURL) curl -X DELETE "$BASE URL/api/customer/tokens/2" \ -H "Cookie: $SESSION COOKIE" Response { "success": true } Common errors 403 Forbidden when the token is outside your customer scope, or when the token is org-scoped (no customerId) 404 Token not found when the token doesn't exist or belongs to another org

#### Delete Organization Token
URL: https://uptimeify.io/docs/api/api-tokens/delete-organization-token
Description: DELETE /api/organization/tokens/:id
Endpoints: DELETE /api/organization/tokens/:id
Key Sections: Example (cURL) | Response | Common errors
Summary: Delete Organization Token DELETE /api/organization/tokens/:id Permanently revokes an API token. Requires admin role. Example (cURL) curl -X DELETE "$BASE URL/api/organization/tokens/1" \ -H "Cookie: $SESSION COOKIE" Response { "success": true } Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin 404 Token not found when the token doesn't exist or belongs to another org

#### List Customer Tokens
URL: https://uptimeify.io/docs/api/api-tokens/list-customer-tokens
Description: GET /api/customer/tokens
Endpoints: GET /api/customer/tokens
Key Sections: Example (cURL) | Response | Common errors
Summary: List Customer Tokens GET /api/customer/tokens Returns API tokens visible to the current user. Restricted users see only their customer-scoped tokens; admins see all tokens. Tokens are masked — only the first 8 characters are shown. Example (cURL) curl -X GET "$BASE URL/api/customer/tokens" \ -H "Cookie: $SESSION COOKIE" \ -H "Accept: application/json" Response [ { "id": 2, "organizationId": 1, "name": "Customer Scoped Token", "customerId": 5, "customerName": "Acme Corp", "lastUsedAt": null, "expiresAt": null, "createdAt": "2026-02-01T08:00:00.000Z", "tokenHint": "wsm f7e6d5..." } ] Common errors 401 Unauthorized when not authenticated 403 Forbidden when user lacks read access

#### List Organization Tokens
URL: https://uptimeify.io/docs/api/api-tokens/list-organization-tokens
Description: GET /api/organization/tokens
Endpoints: GET /api/organization/tokens
Key Sections: Example (cURL) | Response | Common errors
Summary: List Organization Tokens GET /api/organization/tokens Returns all API tokens for the organization. Tokens are masked — only the first 8 characters are shown. Requires admin role. Example (cURL) curl -X GET "$BASE URL/api/organization/tokens" \ -H "Cookie: $SESSION COOKIE" \ -H "Accept: application/json" Response [ { "id": 1, "organizationId": 1, "name": "Production API", "customerId": null, "customerName": null, "lastUsedAt": "2026-04-01T12:00:00.000Z", "expiresAt": null, "createdAt": "2026-01-15T10:00:00.000Z", "tokenHint": "wsm a1b2c..." } ] Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin

### Custom Fields
URL: https://uptimeify.io/docs/api/custom-fields
Description: Manage custom field definitions for customers and websites.
Key Sections: Authentication | Endpoints
Summary: Custom Fields Define custom metadata fields that can be attached to customers and websites. Custom fields support text, select, and multi-select types. Authentication All examples assume a bearer token: BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Endpoints List Custom Fields Create Custom Field Update Custom Field Delete Custom Field

#### Create Custom Field
URL: https://uptimeify.io/docs/api/custom-fields/create-custom-field
Description: POST /api/custom-fields
Endpoints: POST /api/custom-fields
Key Sections: Request Body | Example (cURL) | Common errors
Summary: Create Custom Field POST /api/custom-fields Creates a new custom field definition. Request Body Field Type Required Default Description ------- ------ ---------- --------- ------------- organizationId number Yes — Organization ID name string Yes — Display name fieldKey string No auto from name Unique key (auto-normalized: lowercase, non-alphanumeric → ) fieldType string No text text, select, or multiselect isRequired boolean No false Whether the field is required displayOrder number No 0 Sort order options array No [] Options for select/multiselect types placeholder string\ null No null Placeholder text helpText string\ null No null Help text below the field showInTable boolean No true Show in table views Example (cURL) curl -X POST "$BASE URL/api/custom-fields" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "organizationId": 1, "name": "Environment", "fieldType": "select", "options": ["production", "staging", "development"], "isRequired": true, "showInTable": true }' Common errors 409 Conflict when fieldKey already exists for the organization

#### Delete Custom Field
URL: https://uptimeify.io/docs/api/custom-fields/delete-custom-field
Description: DELETE /api/custom-fields/:id
Endpoints: DELETE /api/custom-fields/:id
Key Sections: Example (cURL) | Response
Summary: Delete Custom Field DELETE /api/custom-fields/:id Soft-deletes a custom field (sets isActive: false). Example (cURL) curl -X DELETE "$BASE URL/api/custom-fields/1" \ -H "Authorization: Bearer $TOKEN" Response { "success": true, "message": "Custom field deleted successfully" }

#### List Custom Fields
URL: https://uptimeify.io/docs/api/custom-fields/list-custom-fields
Description: GET /api/custom-fields
Endpoints: GET /api/custom-fields
Key Sections: Query Parameters | Example (cURL) | Response
Summary: List Custom Fields GET /api/custom-fields Returns all active custom field definitions for the organization. Query Parameters Parameter Type Default Description ----------- ------ --------- ------------- organizationId number session org Override organization scope Example (cURL) curl -X GET "$BASE URL/api/custom-fields" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response [ { "id": 1, "organizationId": 1, "name": "Data Center", "fieldKey": "data center", "fieldType": "text", "isRequired": false, "displayOrder": 0, "options": [], "placeholder": "e.g. fsn1", "helpText": "Primary data center location", "showInTable": true, "isActive": true, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z" } ] Only active fields (isActive: true) are returned, ordered by displayOrder.

#### Update Custom Field
URL: https://uptimeify.io/docs/api/custom-fields/update-custom-field
Description: PATCH /api/custom-fields/:id
Endpoints: PATCH /api/custom-fields/:id
Key Sections: Request Body (all optional) | Example (cURL)
Summary: Update Custom Field PATCH /api/custom-fields/:id Updates a custom field definition. All fields are optional. Request Body (all optional) Field Type Description ------- ------ ------------- name string Display name fieldType string text, select, or multiselect isRequired boolean Whether the field is required displayOrder number Sort order options array Options for select/multiselect placeholder string\ null Placeholder text helpText string\ null Help text showInTable boolean Show in table views isActive boolean Soft delete (set to false) Example (cURL) curl -X PATCH "$BASE URL/api/custom-fields/1" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Environment", "options": ["production", "staging", "development", "qa"] }'

## Organization SMTP & Monitoring Locations
Custom SMTP configuration for outgoing email, and monitoring probe location discovery.

### Organization SMTP
URL: https://uptimeify.io/docs/api/organization-smtp
Description: Configure and test custom SMTP settings for outgoing email.
Key Sections: Authentication | Endpoints
Summary: Organization SMTP Configure custom SMTP settings so your organization's notification emails are sent through your own mail server. All SMTP endpoints require admin role. Authentication All endpoints accept API bearer tokens or session cookies: BASE URL="https://uptimeify.io" TOKEN="<your-api-token " Endpoints Test SMTP Connection Get SMTP Send Logs

#### Get SMTP Send Logs
URL: https://uptimeify.io/docs/api/organization-smtp/get-smtp-logs
Description: GET /api/organization/smtp/logs
Endpoints: GET /api/organization/smtp/logs
Key Sections: Query Parameters | Example (cURL) | Response | Common errors
Summary: Get SMTP Send Logs GET /api/organization/smtp/logs Returns recent SMTP send event logs from Redis. Admin-only. Query Parameters Parameter Type Default Description ----------- ------ --------- ------------- limit number 100 Max events to return (1–500) Example (cURL) curl -X GET "$BASE URL/api/organization/smtp/logs?limit=50" \ -H "Cookie: $SESSION COOKIE" \ -H "Accept: application/json" Response { "events": [ { "type": "smtp send", "timestamp": "2026-04-15T12:00:00.000Z", "to": "admin@example.com", "subject": "Website Down: example.com", "status": "sent" } ] } Returns { "events": [] } if no logs exist or on Redis errors (fails open). Common errors 401 Unauthorized when not authenticated 403 Forbidden when not an admin

#### Test SMTP Connection
URL: https://uptimeify.io/docs/api/organization-smtp/test-smtp
Description: POST /api/organization/smtp/test
Endpoints: POST /api/organization/smtp/test
Key Sections: Request Body (all optional) | Example (cURL) — Using stored config | Example (cURL) — Testing new credentials | Response (success) | Common errors
Summary: Test SMTP Connection POST /api/organization/smtp/test Tests the SMTP configuration by sending a test email. All parameters are optional — when omitted, stored config values are used. This allows testing new credentials before saving them. Admin-only. The test also updates the SMTP config's lastTestedAt, lastTestStatus, and lastTestError fields. Request Body (all optional) Field Type Description ------- ------ ------------- toEmail string Recipient email address (max 320 chars). Defaults to current user's email. subject string Email subject (1–200 chars). Defaults to SMTP Test (<timestamp ). message string Email body (1–2000 chars). Defaults to a standard test message. host string\ null SMTP server hostname (1–255 chars). Overrides stored config. port number\ null SMTP server port (1–65535). Overrides stored config. username string\ null SMTP username (1–200 chars). Overrides stored config. password string\ null SMTP password (1–500 chars). Overrides stored config (not persisted). tlsMode string\ null ssl, starttls, or none. Overrides stored config. fromName string\ null Sender display name (1–200 chars). Overrides stored config. fromEmail string\ null Sender email address (max 320 chars). Overrides stored config. replyTo string\ null Reply-to email address (max 320 chars). Overrides stored config. Example (cURL) — Using stored config curl -X POST "$BASE URL/api/organization/smtp/test" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{}' Example (cURL) — Testing new credentials curl -X POST "$BASE URL/api/organization/smtp/test" \ -H "Cookie: $SESSION COOKIE" \ -H "Content-Type: application/json" \ -d '{ "host": "smtp.example.com", "port": 587, "tlsMode": "starttls", "username": "alerts@example.com", "password": "secret-password", "fromName": "Uptimeify Alerts", "fromEmail": "alerts@example.com", "toEmail": "admin@example.com" }' Response (success) { "success": true, "messageId": "<abc123@mail.example.com " } Common errors 400 Missing recipient email (toEmail) when no recipient and user has no email 400 SMTP config incomplete (host/port required) when host or port is missing 400 SMTP config incomplete (username required) when username is needed but missing 400 SMTP password missing (username is set) when password is needed but missing 400 SMTP config incomplete (fromEmail required) when fromEmail is missing 403 Forbidden when not an admin 502 Failed to send SMTP test email when the SMTP connection fails

### Monitoring Locations
URL: https://uptimeify.io/docs/api/monitoring-locations
Description: Retrieve available monitoring probe locations.
Key Sections: Endpoints | Available Locations
Summary: Monitoring Locations Retrieve the list of countries and locations where monitoring probes are available. Endpoints List Countries — authenticated, grouped by country List Public Locations — public, unauthenticated Available Locations Code Name Country ------ ------ --------- de-nbg Nuremberg Germany de-fsn Falkenstein Germany fr-par Paris France nl-ams Amsterdam Netherlands uk-lon London United Kingdom fi-hel Helsinki Finland

#### List Countries with Locations
URL: https://uptimeify.io/docs/api/monitoring-locations/list-countries
Description: GET /api/monitoring-locations/countries
Endpoints: GET /api/monitoring-locations/countries
Key Sections: Example (cURL) | Response
Summary: List Countries with Locations GET /api/monitoring-locations/countries Returns countries that have monitoring locations with active workers. Requires authentication. Example (cURL) curl -X GET "$BASE URL/api/monitoring-locations/countries" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" Response { "countries": [ { "code": "DE", "locations": 2, "workers": 5 }, { "code": "FR", "locations": 1, "workers": 2 }, { "code": "NL", "locations": 1, "workers": 2 }, { "code": "UK", "locations": 1, "workers": 2 }, { "code": "FI", "locations": 1, "workers": 1 } ] }

#### List Public Monitoring Locations
URL: https://uptimeify.io/docs/api/monitoring-locations/list-public-locations
Description: GET /api/public/monitoring-locations
Endpoints: GET /api/public/monitoring-locations
Key Sections: Example (cURL) | Response
Summary: List Public Monitoring Locations GET /api/public/monitoring-locations Public endpoint (no authentication required) that returns all monitoring locations with active workers. Suitable for landing pages and marketing. Example (cURL) curl -X GET "https://uptimeify.io/api/public/monitoring-locations" \ -H "Accept: application/json" Response { "locations": [ { "id": 1, "code": "de-nbg", "name": "Nuremberg", "countryCode": "DE", "activeWorkers": 3 }, { "id": 2, "code": "de-fsn", "name": "Falkenstein", "countryCode": "DE", "activeWorkers": 2 }, { "id": 3, "code": "fr-par", "name": "Paris", "countryCode": "FR", "activeWorkers": 2 }, { "id": 4, "code": "nl-ams", "name": "Amsterdam", "countryCode": "NL", "activeWorkers": 2 }, { "id": 5, "code": "uk-lon", "name": "London", "countryCode": "UK", "activeWorkers": 2 }, { "id": 6, "code": "fi-hel", "name": "Helsinki", "countryCode": "FI", "activeWorkers": 1 } ] }

## Platform Administration
Administrative and internal platform endpoints intended for elevated operators.

### Global Administration
URL: https://uptimeify.io/docs/api/admin
Description: This section covers the global administration endpoints, which are protected and only accessible to platform administrators.
Key Sections: Endpoints
Summary: This section covers the global administration endpoints, which are protected and only accessible to platform administrators. (Endpoints are still being documented) Endpoints

## Localized Docs
English is the canonical language for this expanded export. A German version of the public API docs is also available.

- German LLMS index: https://uptimeify.io/de/llms.txt
- German LLMS full: https://uptimeify.io/de/llms-full.txt
- German API docs: https://uptimeify.io/de/docs/api