# 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.

## 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,...

### 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
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 :...

#### 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 : 100 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":...

#### 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":...

#### 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:...

#### 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...

## 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 | Response | Common errors
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 { "customerId": "059e1469-0f05-4c93-bd4d-89c45bb2afd9", "name": "New Landing Page", "url": "https://landing.example.com", "checkInterval": 60 // Optional, default is package limit } customerId accepts the customer public ID (preferred) and legacy numeric IDs. Response Returns the created website record. { "id": 103, "customerId": 1, "name": "New Landing Page", "url": "https://landing.example.com", "status":...

#### 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...

#### 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":...

#### 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":...

#### 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) | Request Body (common fields) | Response | Common errors
Summary: Update Website PATCH /api/websites/:websitePublicId Updates a website. This endpoint supports partial updates (only fields you send are changed). 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 '{ "name": "Updated Website Name", "checkInterval": 5, "timeoutSeconds": 10 }' Request Body (common fields) customerId (optional for PATCH, required for full update): accepts customer public ID (preferred) or legacy numeric ID name (optional) url (optional) status (optional): active inactive maintenance (paused is accepted and mapped to inactive) checkInterval (optional) timeoutSeconds (optional) expectedStatusCodes (optional) searchTerm (optional, nullable) checkExpectedResponseEnabled...

### 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
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...

#### 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":...

#### 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":...

#### 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)....

#### 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":...

#### 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:...

### 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...

#### 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...

#### 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": {},...

#### 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...

#### 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 (Customer)
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/create-customer-ip-for-customer
Description: POST /api/customers/:customerId/ips
Endpoints: POST /api/customers/:customerId/ips
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Create Customer IP (Customer) POST /api/customers/:customerId/ips Creates a new customer IP for DNSBL monitoring. Request Body { "ipAddress": "203.0.113.10", "label": "Mail Server", "ipFamily": "v4", "status": "active" } Notes: 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/10/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 Customer ID required when :customerId is missing/invalid 400 Invalid IP address when ipAddress is invalid 400 IP family mismatch... when...

#### 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":...

#### 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) 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...

#### List Customer IPs (Customer)
URL: https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/list-customer-ips-for-customer
Description: GET /api/customers/:customerId/ips
Endpoints: GET /api/customers/:customerId/ips
Key Sections: Path Parameters | Example (cURL) | Response | Common errors
Summary: List Customer IPs (Customer) GET /api/customers/:customerId/ips Lists IPs for a single customer, including DNSBL status. Path Parameters customerId (required): Customer ID Example (cURL) BASE URL="https://uptimeify.io" TOKEN="<your-api-token " curl -X GET "$BASE URL/api/customers/10/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 Customer ID required when :customerId 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...

#### 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 (Customer)
URL: https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/create-customer-domain
Description: POST /api/customers/:customerId/domains
Endpoints: POST /api/customers/:customerId/domains
Key Sections: Request Body | Example (cURL) | Response | Common errors
Summary: Create Customer Domain (Customer) POST /api/customers/:customerId/domains Creates a customer domain for expiry monitoring. Request Body { "domainName": "example.com", "label": "Main Domain", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7 } Notes: 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/10/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 Customer ID required when :customerId is missing/invalid 400 Invalid domain name... when domainName is...

#### 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":...

#### 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) 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":...

#### 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":...

#### 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...

#### 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...

#### 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": {...

#### 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...

#### 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,...

#### 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...

#### 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...

#### 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...

#### 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
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...

#### 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,...

#### 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...

#### 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....

#### 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 },...

#### 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...

#### 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
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...

#### 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",...

#### 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...

#### 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...

#### 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":...

#### 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":...

#### 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
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,...

#### 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":...

#### 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...

#### 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...

#### 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,...

#### 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
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...

#### 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
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...

#### 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)...

#### 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...

#### 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,...

#### 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
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....

### 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
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...

#### 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...

#### 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":...

#### 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...

#### 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":...

#### 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"...

#### 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...

#### 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...

## 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": {...

#### 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,...

#### 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...

#### 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...

#### 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...

#### 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:...

### 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...

#### 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...

#### 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":...

#### 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":...

#### 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,...

#### 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...

#### 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...

#### 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,...

### 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.

## 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