# Uptimeify Documentation
> LLM-friendly index of the Uptimeify documentation: monitoring guides, REST API reference, status pages, integrations and more.

Docs site: https://docs.uptimeify.io
Full export: https://docs.uptimeify.io/llms-full.txt
German index: https://docs.uptimeify.io/de/llms.txt

## Overview

- [Welcome to Uptimeify](https://docs.uptimeify.io): White-label uptime, SSL & synthetic monitoring for agencies — hosted in the EU.

## API Reference

- [API Documentation](https://docs.uptimeify.io/api): Overview of the REST API. Select a resource from the left.
- [Global Administration](https://docs.uptimeify.io/api/admin): This section covers the global administration endpoints, which are protected and only accessible to platform administrators.
- [API Tokens](https://docs.uptimeify.io/api/api-tokens): API tokens allow programmatic access to the Uptimeify API. Tokens are prefixed with wsm_ and can be scoped to a specific customer or organization-wide.
- [Create Customer Token](https://docs.uptimeify.io/api/api-tokens/create-customer-token): Creates a new API token scoped to a customer. Restricted users must specify customerId. The full token is returned only once — store it securely.
- [Create Organization Token](https://docs.uptimeify.io/api/api-tokens/create-organization-token): Creates a new API token. The full token is returned only once — store it securely. Requires admin role.
- [Delete Customer Token](https://docs.uptimeify.io/api/api-tokens/delete-customer-token): Permanently revokes a customer-scoped API token. Users can only delete tokens within their customer scope.
- [Delete Organization Token](https://docs.uptimeify.io/api/api-tokens/delete-organization-token): Permanently revokes an API token. Requires admin role.
- [List Customer Tokens](https://docs.uptimeify.io/api/api-tokens/list-customer-tokens): Returns API tokens visible to the current user. Restricted users see only their customer-scoped tokens; admins see all tokens. Tokens are masked — only the first 8 characters are shown.
- [List Organization Tokens](https://docs.uptimeify.io/api/api-tokens/list-organization-tokens): Returns all API tokens for the organization. Tokens are masked — only the first 8 characters are shown. Requires admin role.
- [Auth & Session](https://docs.uptimeify.io/api/auth): Manage your current user session and retrieve profile information.
- [Get Current User](https://docs.uptimeify.io/api/auth/get-current-user): Returns a reduced view of the currently authenticated user and their session.
- [Change Requests](https://docs.uptimeify.io/api/change-requests): How customers request changes to managed monitors and how organizations resolve them.
- [Create Change Request](https://docs.uptimeify.io/api/change-requests/create-change-request): Opens a change request against any monitor (all monitor types).
- [List Change Requests](https://docs.uptimeify.io/api/change-requests/list-change-requests): Lists the organization's change-request inbox.
- [Resolve Change Request](https://docs.uptimeify.io/api/change-requests/resolve-change-request): Accepts or rejects an open change request.
- [Custom Fields](https://docs.uptimeify.io/api/custom-fields): Define custom metadata fields that can be attached to customers and websites. Custom fields support text, select, and multi-select types.
- [Create Custom Field](https://docs.uptimeify.io/api/custom-fields/create-custom-field): Creates a new custom field definition.
- [Delete Custom Field](https://docs.uptimeify.io/api/custom-fields/delete-custom-field): Soft-deletes a custom field (sets isActive: false).
- [List Custom Fields](https://docs.uptimeify.io/api/custom-fields/list-custom-fields): Returns all active custom field definitions for the organization.
- [Update Custom Field](https://docs.uptimeify.io/api/custom-fields/update-custom-field): Updates a custom field definition. All fields are optional.
- [Customer Management](https://docs.uptimeify.io/api/customers): Path-based customer endpoints use customerPublicId UUIDs.
- [Change Package](https://docs.uptimeify.io/api/customers/change-package): Changes the customer's package assignment.
- [Create Customer](https://docs.uptimeify.io/api/customers/create-customer): Creates a new customer and assigns an organization-defined package via packageType.
- [Get Customer Details](https://docs.uptimeify.io/api/customers/get-customer-details): Returns details of a specific customer.
- [List Customers](https://docs.uptimeify.io/api/customers/list-customers): Lists all customers of the organization.
- [SMS Usage](https://docs.uptimeify.io/api/customers/sms-usage): Returns the SMS usage for the current calendar month across all customers of the organization, sorted by usage descending.
- [Update Customer](https://docs.uptimeify.io/api/customers/update-customer): Updates customer details.
- [Error codes and known API pitfalls](https://docs.uptimeify.io/api/error-codes-and-known-pitfalls): This page documents real integration issues that have occurred in production or testing.
- [Escalation Config](https://docs.uptimeify.io/api/escalation): Manage organization-level webhook escalation settings and default notification channels.
- [Get Escalation Config](https://docs.uptimeify.io/api/escalation/get-escalation-config): Returns the escalation config for an organization. The :id parameter is the organization ID. If no config exists, one is auto-created with defaults.
- [Test Escalation Config](https://docs.uptimeify.io/api/escalation/test-escalation-config): Tests the escalation config by sending a test webhook, PagerDuty event, or Pushover notification. All body fields are optional and override DB values for testing.
- [Update Escalation Config](https://docs.uptimeify.io/api/escalation/update-escalation-config): Updates the escalation config. The :id parameter is the organization ID. If no config exists, one is upserted.
- [Examples](https://docs.uptimeify.io/api/examples): Here you’ll find step-by-step examples for common API workflows.
- [Create a customer + all monitor types](https://docs.uptimeify.io/api/examples/create-customer-and-all-monitors): This example is useful if you want to bootstrap a customer with a complete monitoring baseline.
- [Create a customer + multiple monitors](https://docs.uptimeify.io/api/examples/create-customer-and-multiple-monitors): This example shows how to set up multiple monitors for a single customer, e.g.:
- [Create a customer + website](https://docs.uptimeify.io/api/examples/create-customer-and-website): This example shows a typical onboarding flow:
- [Delete a customer including all websites](https://docs.uptimeify.io/api/examples/delete-customer-and-all-websites): This example focuses on a safe, explicit deletion flow.
- [Introduction](https://docs.uptimeify.io/api/introduction): Welcome to the Uptimeify API documentation. With this REST API, you can programmatically manage your monitoring infrastructure – e.g., organizations, customers, websites, and alerts.
- [Error Response](https://docs.uptimeify.io/api/introduction/error-response): Errors are returned with an appropriate HTTP status code and a JSON body containing details.
- [Generate API Token](https://docs.uptimeify.io/api/introduction/generate-api-token): Step-by-step guide to generating an Uptimeify API token from the dashboard Settings > API page.
- [Success Response](https://docs.uptimeify.io/api/introduction/success-response): On success, the API returns a JSON body with the requested data.
- [Token Scopes (Organization vs Customer)](https://docs.uptimeify.io/api/introduction/token-scopes-organization-vs-customer): API tokens can optionally be created with a Customer Scope:
- [Maintenance Windows](https://docs.uptimeify.io/api/maintenance-windows): Create and manage maintenance windows to suppress alerts during planned work. Windows can target a single monitor, multiple monitors, an entire customer, or any monitor carrying a given tag.
- [Create Maintenance Window](https://docs.uptimeify.io/api/maintenance-windows/create): Creates a new maintenance window. Accepts a single monitor (legacy), multiple monitors, tag-based (including org-wide), or customer-level targeting.
- [Delete Maintenance Window](https://docs.uptimeify.io/api/maintenance-windows/delete): Permanently deletes a maintenance window. Active alert suppression ends immediately.
- [Get Maintenance Window](https://docs.uptimeify.io/api/maintenance-windows/get): Returns a single maintenance window by ID, including its full target and tag selection.
- [List Maintenance Windows](https://docs.uptimeify.io/api/maintenance-windows/list): Returns all maintenance windows visible to the authenticated user, scoped by organization and optional customer filter.
- [Update Maintenance Window](https://docs.uptimeify.io/api/maintenance-windows/update): Partially updates a maintenance window. All fields are optional; only supplied fields are changed. When targets or tagIds are provided they replace the existing selection entirely.
- [Monitoring Data & Reports](https://docs.uptimeify.io/api/monitoring): API endpoints for retrieving monitoring data, check history, incident details, uptime stats, and PDF reports.
- [Monitoring Locations](https://docs.uptimeify.io/api/monitoring-locations): Retrieve the list of countries and locations where monitoring probes are available.
- [List Countries with Locations](https://docs.uptimeify.io/api/monitoring-locations/list-countries): Returns countries that have monitoring locations with active workers. Requires authentication.
- [List Public Monitoring Locations](https://docs.uptimeify.io/api/monitoring-locations/list-public-locations): Public endpoint (no authentication required) that returns all monitoring locations with active workers. Suitable for landing pages and marketing.
- [Download PDF Report](https://docs.uptimeify.io/api/monitoring/download-report-pdf): Downloads a PDF report for a website.
- [Get Alert History](https://docs.uptimeify.io/api/monitoring/get-alert-history): Returns notification/escalation attempts (alert history) for incidents of a website.
- [Get Check History](https://docs.uptimeify.io/api/monitoring/get-check-history): Returns the latest monitoring checks for a website.
- [Get Incident Details](https://docs.uptimeify.io/api/monitoring/get-incident-details): Returns detailed incident data, including a timeline of failed/recovery checks and alert events.
- [Get Incident History](https://docs.uptimeify.io/api/monitoring/get-incident-history): Returns incidents for a single website (latest 100), including a computed duration.
- [Get Monitoring Data](https://docs.uptimeify.io/api/monitoring/get-monitoring-data): Returns time series data used for charts (response times, status tracker, uptime percentage).
- [Get Uptime Stats](https://docs.uptimeify.io/api/monitoring/get-uptime-stats): Returns uptime percentages and average response times for the last day, month and year.
- [List Incidents (Organization)](https://docs.uptimeify.io/api/monitoring/list-incidents): Lists incidents for an organization. If organizationId is omitted, the API falls back to the organization from your session.
- [Monitors](https://docs.uptimeify.io/api/monitors): Manage protocol monitors (ICMP, SMTP, SSH, FTP, IMAP/POP).
- [DNS Monitors](https://docs.uptimeify.io/api/monitors/dns-monitors): Manage DNS monitors that check DNS resolution/records for a hostname.
- [Create DNS Monitor](https://docs.uptimeify.io/api/monitors/dns-monitors/create-dns-monitor): Creates a new DNS monitor for a customer.
- [Delete DNS Monitor](https://docs.uptimeify.io/api/monitors/dns-monitors/delete-dns-monitor): Deletes a DNS monitor.
- [Get DNS Monitor](https://docs.uptimeify.io/api/monitors/dns-monitors/get-dns-monitor): Returns a single DNS monitor.
- [Get DNS Monitor Alert History](https://docs.uptimeify.io/api/monitors/dns-monitors/get-dns-monitor-alert-history): Returns notification/escalation attempts (alert history) for incidents of a DNS monitor.
- [Get DNS Monitor Check History](https://docs.uptimeify.io/api/monitors/dns-monitors/get-dns-monitor-check-history): Returns recent DNS check results for a monitor.
- [Get DNS Monitor Incident History](https://docs.uptimeify.io/api/monitors/dns-monitors/get-dns-monitor-incident-history): Returns incidents for a single DNS monitor (latest 100), including a computed duration.
- [List DNS Monitors](https://docs.uptimeify.io/api/monitors/dns-monitors/list-dns-monitors): Lists DNS monitors for an organization (with pagination).
- [Trigger DNS Check](https://docs.uptimeify.io/api/monitors/dns-monitors/trigger-check-dns-monitor): Triggers an immediate DNS check across eligible monitoring locations.
- [Update DNS Monitor](https://docs.uptimeify.io/api/monitors/dns-monitors/update-dns-monitor): Updates a DNS monitor.
- [DNSBL Monitoring (Customer IPs)](https://docs.uptimeify.io/api/monitors/dnsbl-monitoring): DNSBL monitoring is configured via customer IPs. These IPs are periodically checked against DNS-based blacklists.
- [Create Customer Ip For Customer](https://docs.uptimeify.io/api/monitors/dnsbl-monitoring/create-customer-ip-for-customer)
- [Delete Customer IP](https://docs.uptimeify.io/api/monitors/dnsbl-monitoring/delete-customer-ip): Deletes a customer IP.
- [Get Customer IP](https://docs.uptimeify.io/api/monitors/dnsbl-monitoring/get-customer-ip): Returns a customer IP including DNSBL status (if available).
- [List Customer IPs (Org)](https://docs.uptimeify.io/api/monitors/dnsbl-monitoring/list-customer-ips): Lists customer IPs within an organization (pagination + search). This is the primary API for DNSBL monitoring configuration.
- [List Customer Ips For Customer](https://docs.uptimeify.io/api/monitors/dnsbl-monitoring/list-customer-ips-for-customer)
- [Update Customer IP](https://docs.uptimeify.io/api/monitors/dnsbl-monitoring/update-customer-ip): Updates a customer IP (e.g. label or status).
- [Domain Expiry Monitoring (Customer Domains)](https://docs.uptimeify.io/api/monitors/domain-expiry-monitoring): Domain expiry monitoring is configured via customer domains.
- [Create Customer Domain](https://docs.uptimeify.io/api/monitors/domain-expiry-monitoring/create-customer-domain)
- [Delete Customer Domain](https://docs.uptimeify.io/api/monitors/domain-expiry-monitoring/delete-customer-domain): Deletes a customer domain.
- [Get Customer Domain](https://docs.uptimeify.io/api/monitors/domain-expiry-monitoring/get-customer-domain): Returns a single customer domain.
- [List Customer Domains (Org)](https://docs.uptimeify.io/api/monitors/domain-expiry-monitoring/list-customer-domains): Lists customer domains within an organization (pagination + search).
- [List Domain Expiry (Websites)](https://docs.uptimeify.io/api/monitors/domain-expiry-monitoring/list-domain-expiry-websites): Lists websites with latest known domain expiry information.
- [Update Customer Domain](https://docs.uptimeify.io/api/monitors/domain-expiry-monitoring/update-customer-domain): Updates a customer domain (e.g. label, status, expiry thresholds).
- [FTP Monitors](https://docs.uptimeify.io/api/monitors/ftp-monitors): Manage FTP monitors.
- [Create FTP Monitor](https://docs.uptimeify.io/api/monitors/ftp-monitors/create-ftp-monitor): Creates a new FTP monitor.
- [Delete FTP Monitor](https://docs.uptimeify.io/api/monitors/ftp-monitors/delete-ftp-monitor): Deletes an FTP monitor.
- [Get FTP Monitor](https://docs.uptimeify.io/api/monitors/ftp-monitors/get-ftp-monitor): Returns details of a specific FTP monitor.
- [Get FTP Monitor Alert History](https://docs.uptimeify.io/api/monitors/ftp-monitors/get-ftp-monitor-alert-history): Returns notification/escalation attempts (alert history) for incidents of a FTP monitor.
- [Get FTP Monitor Check History](https://docs.uptimeify.io/api/monitors/ftp-monitors/get-ftp-monitor-check-history): Returns recent FTP check results for a monitor.
- [Get FTP Monitor Details](https://docs.uptimeify.io/api/monitors/ftp-monitors/get-ftp-monitor-details): Returns the FTP monitor detail page data in one call (mega endpoint).
- [Get FTP Monitor Incident History](https://docs.uptimeify.io/api/monitors/ftp-monitors/get-ftp-monitor-incident-history): Returns incidents for a single FTP monitor (latest 100), including a computed duration.
- [List FTP Monitors](https://docs.uptimeify.io/api/monitors/ftp-monitors/list-ftp-monitors): Lists FTP monitors in an organization.
- [Trigger FTP Check](https://docs.uptimeify.io/api/monitors/ftp-monitors/trigger-check-ftp-monitor): Triggers an immediate check from all eligible monitoring locations.
- [Update FTP Monitor (Change Status)](https://docs.uptimeify.io/api/monitors/ftp-monitors/update-ftp-monitor): Updates an FTP monitor and/or changes its status.
- [ICMP Monitors](https://docs.uptimeify.io/api/monitors/icmp-monitors): Manage ICMP (ping) monitors.
- [Create ICMP Monitor](https://docs.uptimeify.io/api/monitors/icmp-monitors/create-icmp-monitor): Creates a new ICMP monitor.
- [Delete ICMP Monitor](https://docs.uptimeify.io/api/monitors/icmp-monitors/delete-icmp-monitor): Deletes an ICMP monitor.
- [Get ICMP Monitor](https://docs.uptimeify.io/api/monitors/icmp-monitors/get-icmp-monitor): Returns details of a specific ICMP monitor.
- [Get ICMP Monitor Alert History](https://docs.uptimeify.io/api/monitors/icmp-monitors/get-icmp-monitor-alert-history): Returns notification/escalation attempts (alert history) for incidents of a ICMP monitor.
- [Get ICMP Monitor Check History](https://docs.uptimeify.io/api/monitors/icmp-monitors/get-icmp-monitor-check-history): Returns recent check results for the ICMP monitor.
- [Get ICMP Monitor Details](https://docs.uptimeify.io/api/monitors/icmp-monitors/get-icmp-monitor-details): Returns a consolidated payload used by the monitor details page, including the monitor, customer, and aggregated check data for a given time range.
- [Get ICMP Monitor Incident History](https://docs.uptimeify.io/api/monitors/icmp-monitors/get-icmp-monitor-incident-history): Returns incidents for a single ICMP monitor (latest 100), including a computed duration.
- [List ICMP Monitors](https://docs.uptimeify.io/api/monitors/icmp-monitors/list-icmp-monitors): Lists ICMP monitors in an organization.
- [Trigger ICMP Check](https://docs.uptimeify.io/api/monitors/icmp-monitors/trigger-check-icmp-monitor): Triggers an immediate check from all eligible monitoring locations.
- [Update ICMP Monitor](https://docs.uptimeify.io/api/monitors/icmp-monitors/update-icmp-monitor): Updates an ICMP monitor. This endpoint is also used to change the monitor status.
- [IMAP/POP Monitors](https://docs.uptimeify.io/api/monitors/imap-pop-monitors): Manage IMAP/POP monitors.
- [Create IMAP/POP Monitor](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/create-imap-pop-monitor): Creates a new IMAP/POP monitor.
- [Delete IMAP/POP Monitor](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/delete-imap-pop-monitor): Deletes an IMAP/POP monitor.
- [Get IMAP/POP Monitor](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/get-imap-pop-monitor): Returns details of a specific IMAP/POP monitor.
- [Get IMAP/POP Monitor Alert History](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/get-imap-pop-monitor-alert-history): Returns notification/escalation attempts (alert history) for incidents of a IMAP/POP monitor.
- [Get IMAP/POP Monitor Check History](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/get-imap-pop-monitor-check-history): Returns recent check results for the IMAP/POP monitor.
- [Get IMAP/POP Monitor Details](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/get-imap-pop-monitor-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.).
- [Get IMAP/POP Monitor Incident History](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/get-imap-pop-monitor-incident-history): Returns incidents for a single IMAP/POP monitor (latest 100), including a computed duration.
- [List IMAP/POP Monitors](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/list-imap-pop-monitors): Lists IMAP/POP monitors in an organization.
- [Trigger IMAP/POP Check](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/trigger-check-imap-pop-monitor): Triggers an immediate check from all eligible monitoring locations.
- [Update IMAP/POP Monitor](https://docs.uptimeify.io/api/monitors/imap-pop-monitors/update-imap-pop-monitor): Updates an IMAP/POP monitor and/or changes its status.
- [SMTP Monitors](https://docs.uptimeify.io/api/monitors/smtp-monitors): Manage SMTP monitors.
- [Create SMTP Monitor](https://docs.uptimeify.io/api/monitors/smtp-monitors/create-smtp-monitor): Creates a new SMTP monitor.
- [Delete SMTP Monitor](https://docs.uptimeify.io/api/monitors/smtp-monitors/delete-smtp-monitor): Deletes an SMTP monitor.
- [Get SMTP Monitor](https://docs.uptimeify.io/api/monitors/smtp-monitors/get-smtp-monitor): Returns details of a specific SMTP monitor.
- [Get SMTP Monitor Alert History](https://docs.uptimeify.io/api/monitors/smtp-monitors/get-smtp-monitor-alert-history): Returns notification/escalation attempts (alert history) for incidents of a SMTP monitor.
- [Get SMTP Monitor Check History](https://docs.uptimeify.io/api/monitors/smtp-monitors/get-smtp-monitor-check-history): Returns recent check results for an SMTP monitor.
- [Get SMTP Monitor Details](https://docs.uptimeify.io/api/monitors/smtp-monitors/get-smtp-monitor-details): Consolidated endpoint that returns the SMTP monitor details page data in one call.
- [Get SMTP Monitor Incident History](https://docs.uptimeify.io/api/monitors/smtp-monitors/get-smtp-monitor-incident-history): Returns incidents for a single SMTP monitor (latest 100), including a computed duration.
- [List SMTP Monitors](https://docs.uptimeify.io/api/monitors/smtp-monitors/list-smtp-monitors): Lists SMTP monitors in an organization.
- [Trigger Check for SMTP Monitor](https://docs.uptimeify.io/api/monitors/smtp-monitors/trigger-check-smtp-monitor): Triggers an immediate check from all eligible monitoring locations.
- [Update SMTP Monitor](https://docs.uptimeify.io/api/monitors/smtp-monitors/update-smtp-monitor): Updates an SMTP monitor.
- [SSH Monitors](https://docs.uptimeify.io/api/monitors/ssh-monitors): Manage SSH monitors.
- [Create SSH Monitor](https://docs.uptimeify.io/api/monitors/ssh-monitors/create-ssh-monitor): Creates a new SSH monitor.
- [Delete SSH Monitor](https://docs.uptimeify.io/api/monitors/ssh-monitors/delete-ssh-monitor): Deletes an SSH monitor.
- [Get SSH Monitor](https://docs.uptimeify.io/api/monitors/ssh-monitors/get-ssh-monitor): Returns details of a specific SSH monitor.
- [Get SSH Monitor Alert History](https://docs.uptimeify.io/api/monitors/ssh-monitors/get-ssh-monitor-alert-history): Returns notification/escalation attempts (alert history) for incidents of a SSH monitor.
- [Get SSH Monitor Check History](https://docs.uptimeify.io/api/monitors/ssh-monitors/get-ssh-monitor-check-history): Returns recent check results for an SSH monitor.
- [Get SSH Monitor Details](https://docs.uptimeify.io/api/monitors/ssh-monitors/get-ssh-monitor-details): Consolidated endpoint that returns the SSH monitor details page data in one call.
- [Get SSH Monitor Incident History](https://docs.uptimeify.io/api/monitors/ssh-monitors/get-ssh-monitor-incident-history): Returns incidents for a single SSH monitor (latest 100), including a computed duration.
- [List SSH Monitors](https://docs.uptimeify.io/api/monitors/ssh-monitors/list-ssh-monitors): Lists SSH monitors in an organization.
- [Trigger Check for SSH Monitor](https://docs.uptimeify.io/api/monitors/ssh-monitors/trigger-check-ssh-monitor): Triggers an immediate check from all eligible monitoring locations.
- [Update SSH Monitor](https://docs.uptimeify.io/api/monitors/ssh-monitors/update-ssh-monitor): Updates an SSH monitor.
- [Notification Channels](https://docs.uptimeify.io/api/notification-channels): Manage how and where alerts are delivered. Channels can be organization-level (default for all customers), customer-level (override for a specific customer), or website-level (override for a specific monitor).
- [Create Notification Channel](https://docs.uptimeify.io/api/notification-channels/create-notification-channel): Creates a new notification channel. Secrets in config are encrypted server-side.
- [Delete Notification Channel](https://docs.uptimeify.io/api/notification-channels/delete-notification-channel): Deletes a notification channel. If the channel was an org-level default, organization defaults are automatically synced.
- [List Notification Channels](https://docs.uptimeify.io/api/notification-channels/list-notification-channels): Returns notification channels scoped by organization, customer, or website.
- [Test Notification Channel](https://docs.uptimeify.io/api/notification-channels/test-notification-channel): Tests a notification channel configuration. Optionally sends a real test message.
- [Update Notification Channel](https://docs.uptimeify.io/api/notification-channels/update-notification-channel): Updates a notification channel.
- [Organization & Billing](https://docs.uptimeify.io/api/organization): Path-based organization endpoints use organizationPublicId UUIDs.
- [Organization SMTP](https://docs.uptimeify.io/api/organization-smtp): Configure custom SMTP settings so your organization's notification emails are sent through your own mail server. All SMTP endpoints require admin role.
- [Get SMTP Send Logs](https://docs.uptimeify.io/api/organization-smtp/get-smtp-logs): Returns recent SMTP send event logs from Redis. Admin-only.
- [Test SMTP Connection](https://docs.uptimeify.io/api/organization-smtp/test-smtp): Tests the SMTP configuration by sending a test email. All parameters are optional — when omitted, stored config values are used. This allows testing new credentials before saving them. Admin-only.
- [Delete Package Config](https://docs.uptimeify.io/api/organization/delete-package-config): 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.
- [Get Billing Details](https://docs.uptimeify.io/api/organization/get-billing-details): Returns billing information and payment methods for the organization in your authenticated session.
- [Get Organization Details](https://docs.uptimeify.io/api/organization/get-organization-details): Returns details of the organization from your authenticated session.
- [List Invoices](https://docs.uptimeify.io/api/organization/list-invoices): Lists all invoices for the organization (Mollie).
- [List Package Configs](https://docs.uptimeify.io/api/organization/list-package-configs): Returns all package configurations for the organization in your authenticated session. Each config also includes a usedByCustomerCount field.
- [Create Report](https://docs.uptimeify.io/api/organization/reports/create-report): Creates an organization-level report configuration. Requires a plan that includes organization reports and available report quota.
- [Delete Report](https://docs.uptimeify.io/api/organization/reports/delete-report): Permanently deletes an organization report configuration and its scheduling. Past report runs are not deleted.
- [Download Report PDF](https://docs.uptimeify.io/api/organization/reports/download-report-pdf): Redirects to a short-lived signed URL for the archived PDF of a report run.
- [Get Report](https://docs.uptimeify.io/api/organization/reports/get-report): Returns a single organization report configuration by its public id.
- [List Report Runs](https://docs.uptimeify.io/api/organization/reports/list-report-runs): Returns the organization's report generation/delivery history, optionally filtered to a single report.
- [List Reports](https://docs.uptimeify.io/api/organization/reports/list-reports): Returns all organization report configurations plus the organization's report entitlement (plan feature flag and quota).
- [Send Report Now](https://docs.uptimeify.io/api/organization/reports/send-report-now): Queues an immediate, out-of-schedule generation and delivery of an organization report.
- [Update Report](https://docs.uptimeify.io/api/organization/reports/update-report): Updates an organization report configuration. All fields are optional; at least one must be provided.
- [Update Billing Details](https://docs.uptimeify.io/api/organization/update-billing-details): Updates billing information for the organization in your authenticated session.
- [Update Organization](https://docs.uptimeify.io/api/organization/update-organization): Updates the organization from your authenticated session.
- [Upsert Package Config](https://docs.uptimeify.io/api/organization/upsert-package-config): 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.
- [Status Pages](https://docs.uptimeify.io/api/status-pages): Create and manage public status pages that display the operational status of your monitored websites, recent incidents, and maintenance windows.
- [Activate Status Page Domain](https://docs.uptimeify.io/api/status-pages/activate-status-page-domain): Activates a verified custom domain for a status page. Admin-only.
- [Add Custom Domain to Status Page](https://docs.uptimeify.io/api/status-pages/add-status-page-domain): Adds a custom hostname to an existing status page and returns the DNS TXT record needed for verification. Admin-only.
- [Create Status Page](https://docs.uptimeify.io/api/status-pages/create-status-page): Creates a new status page. Requires admin role.
- [Delete Status Page](https://docs.uptimeify.io/api/status-pages/delete-status-page): Permanently deletes a status page. Requires admin role.
- [Get Public Status Page](https://docs.uptimeify.io/api/status-pages/get-public-status-page): Two endpoints serve the public status page view:
- [Get Status Page Design](https://docs.uptimeify.io/api/status-pages/get-status-page-design): Returns the current visual design configuration for a status page. Requires admin role.
- [List Status Pages](https://docs.uptimeify.io/api/status-pages/list-status-pages): Returns all status pages for the organization. Each page includes its custom domain info if configured.
- [Remove Custom Domain from Status Page](https://docs.uptimeify.io/api/status-pages/remove-status-page-domain): Removes a custom domain from a status page. Deletes the domain record; the status page's customDomainId is automatically set to null. Admin-only.
- [Update Status Page](https://docs.uptimeify.io/api/status-pages/update-status-page): Updates a status page. At least one field must be provided. Requires admin role.
- [Update Status Page Design](https://docs.uptimeify.io/api/status-pages/update-status-page-design): Updates the visual design configuration of a status page. Only the fields you provide are changed — all other settings keep their current values. Requires admin role.
- [Verify Status Page Domain](https://docs.uptimeify.io/api/status-pages/verify-status-page-domain): Verifies DNS TXT records for a custom status page domain. Admin-only.
- [Tags](https://docs.uptimeify.io/api/tags): Organize your monitors with tags — create, assign, filter, and manage across all monitor types.
- [Assign Tag to Monitor](https://docs.uptimeify.io/api/tags/assign-tag): Assigns an existing tag to a monitor. The caller needs read access to the monitor and visibility of the tag. The operation is idempotent.
- [Create Tag](https://docs.uptimeify.io/api/tags/create-tag): Creates a new tag in your organization. Readonly members may create tags that are visible only to themselves.
- [Delete Tag](https://docs.uptimeify.io/api/tags/delete-tag): Deletes a tag and removes it from all monitors it was assigned to. Only the tag owner or an admin may delete a tag.
- [List Monitor Tags](https://docs.uptimeify.io/api/tags/list-monitor-tags): Returns all tags assigned to a specific monitor. Readonly members see only their own tags.
- [List Tags](https://docs.uptimeify.io/api/tags/list-tags): Returns all tags visible to the caller. Readonly members see only tags they created themselves.
- [Remove Tag from Monitor](https://docs.uptimeify.io/api/tags/remove-tag): Removes a tag assignment from a monitor. The caller must have read access to the monitor.
- [Update Tag](https://docs.uptimeify.io/api/tags/update-tag): Updates an existing tag's name or color. Only the tag owner or an admin may update a tag.
- [Users](https://docs.uptimeify.io/api/users): Manage users within your organization.
- [Create User](https://docs.uptimeify.io/api/users/create-user): Creates a new user in the organization.
- [Delete User](https://docs.uptimeify.io/api/users/delete-user): Removes a user from the organization.
- [Get User](https://docs.uptimeify.io/api/users/get-user): Returns the details of a specific user.
- [List Users](https://docs.uptimeify.io/api/users/list-users): Lists all users in the organization.
- [Update User](https://docs.uptimeify.io/api/users/update-user): Updates the details and permissions of a user.
- [Configurations](https://docs.uptimeify.io/api/website-configuration): Manage advanced monitoring settings for your websites.
- [Check Maintenance (Website)](https://docs.uptimeify.io/api/website-configuration/check-maintenance-window): Checks if a website is currently in an active maintenance window.
- [Check Maintenance (Batch)](https://docs.uptimeify.io/api/website-configuration/check-maintenance-window-batch): Batch-check multiple websites for active maintenance windows.
- [Create Maintenance Window](https://docs.uptimeify.io/api/website-configuration/create-maintenance-window): Creates a new maintenance window.
- [Delete Maintenance Window](https://docs.uptimeify.io/api/website-configuration/delete-maintenance-window): Deletes a maintenance window.
- [Get Maintenance Window](https://docs.uptimeify.io/api/website-configuration/get-maintenance-window): Returns a single maintenance window by ID (including its target relation).
- [List Maintenance Windows](https://docs.uptimeify.io/api/website-configuration/list-maintenance-windows): Returns maintenance windows scoped to your organization by default.
- [Update Check Settings](https://docs.uptimeify.io/api/website-configuration/update-check-settings): Configure which aspects of the website should be monitored.
- [Update Maintenance Window](https://docs.uptimeify.io/api/website-configuration/update-maintenance-window): Updates an existing maintenance window.
- [Website Management](https://docs.uptimeify.io/api/websites): Manage monitored websites.
- [Change Website Status](https://docs.uptimeify.io/api/websites/change-status): Changes the monitoring status of a website.
- [Create Website](https://docs.uptimeify.io/api/websites/create-website): Creates a new website monitor for a customer.
- [Delete Website](https://docs.uptimeify.io/api/websites/delete-website): Irrevocably removes a website and its monitoring history.
- [Get Website](https://docs.uptimeify.io/api/websites/get-website): Returns a single website (basic/sanitized). Sensitive fields like encrypted credentials are removed.
- [Get Website Details](https://docs.uptimeify.io/api/websites/get-website-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.
- [List Websites](https://docs.uptimeify.io/api/websites/list-websites): Lists websites within an organization (paginated). Results are scoped by your session/permissions.
- [Trigger Website Check](https://docs.uptimeify.io/api/websites/trigger-check): Triggers an immediate check of a website across eligible monitoring locations.
- [Update Website](https://docs.uptimeify.io/api/websites/update-website): Updates a website. Supports both partial updates (only sent fields are changed) and full updates (all required fields must be present).
- [Whitelabel & Branding](https://docs.uptimeify.io/api/whitelabel): Customize your organization's product name, theme colors, logos, favicons, and custom domains. All whitelabel endpoints require admin or global admin role.
- [Activate Domain](https://docs.uptimeify.io/api/whitelabel/activate-domain): Activates a verified custom domain. Optionally sets it as the primary domain. Admin-only.
- [Add Domain](https://docs.uptimeify.io/api/whitelabel/add-domain): Adds a custom domain for whitelabeling. Creates a pending DNS verification record. The first domain is automatically set as primary. Requires admin role.
- [Delete Domain](https://docs.uptimeify.io/api/whitelabel/delete-domain): Deletes a custom domain. If the deleted domain was primary, the next available domain is promoted to primary. Admin-only.
- [Get Branding](https://docs.uptimeify.io/api/whitelabel/get-branding): Returns the organization's branding configuration, including product name, theme colors, and signed URLs for logos and favicons. Requires admin role.
- [List Domains](https://docs.uptimeify.io/api/whitelabel/list-domains): Returns all custom app domains for the organization. Only domains with role app are returned. Requires admin role.
- [Update Branding](https://docs.uptimeify.io/api/whitelabel/update-branding): Updates the organization's branding configuration. All fields are optional — only sent fields are updated. Setting productName or theme colors to null clears them. Requires admin role.
- [Upload Branding Asset](https://docs.uptimeify.io/api/whitelabel/upload-branding): Uploads a logo or favicon as a base64 data URL. Assets are stored in S3 and the branding record is updated automatically. Requires admin role.
- [Verify Domain](https://docs.uptimeify.io/api/whitelabel/verify-domain): Verifies DNS TXT records for a custom domain. Admin-only.

## Examples

- [Examples](https://docs.uptimeify.io/examples): Practical examples for common workflows with customers, websites, and monitors.
- [Create a customer + all monitor types](https://docs.uptimeify.io/examples/create-customer-and-all-monitors): Example automation: create one website and then create one monitor of each type.
- [Create a customer + multiple monitors](https://docs.uptimeify.io/examples/create-customer-and-multiple-monitors): Example: create a customer and set up multiple monitors (same type and mixed types).
- [Create a customer + website](https://docs.uptimeify.io/examples/create-customer-and-website): End-to-end example: create a customer and then create the first website.
- [Delete a customer including all websites](https://docs.uptimeify.io/examples/delete-customer-and-all-websites): Safe deletion flow: remove websites first, then delete the customer.

## Incidents

- [Incidents](https://docs.uptimeify.io/incidents): Incidents are created automatically when monitoring detects a problem with a website or service. They are the foundation for alerting, reporting, and the public Status Pages.

## Integrations

- [Integrations](https://docs.uptimeify.io/integrations): Uptimeify delivers alerts to the tools you already use — chat, on-call, issue trackers and more — plus firewall allowlisting and a full REST API.
- [Firewall allowlisting (Monitoring node IPs)](https://docs.uptimeify.io/integrations/firewall): If your website is protected by a firewall or WAF, you may need to allowlist our monitoring nodes so we can reach your endpoint reliably.

## Maintenance

- [Maintenance](https://docs.uptimeify.io/maintenance): Maintenance windows let you plan work (deployments, updates, migrations) without triggering noisy alerts. During an active window the affected target is treated as in maintenance — alerts are suppressed and, if the customer has a status page, the service is shown as Maintenance instead of Degraded.

## Monitoring

- [Monitoring](https://docs.uptimeify.io/monitoring): Monitor the availability and performance of your websites and services.
- [Managed vs. Self-Service Monitors](https://docs.uptimeify.io/monitoring/managed-vs-self-service): Every monitor has an ownership class that controls who may edit it and who receives its alerts.
- [Monitoring Types](https://docs.uptimeify.io/monitoring/monitoring-types): Uptimeify supports a wide range of monitor types — from HTTP uptime, keyword, and SSL checks to DNS, network services, and synthetic browser flows. Pick the type that matches what you need to watch.
- [DNS Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/dns): The DNS Monitor checks DNS responses for a hostname (e.g. example.com) on a fixed interval. This helps you detect unexpected record changes (A/AAAA), missing MX records, or TXT changes (SPF/DMARC / domain verification).
- [DNSBL Monitoring](https://docs.uptimeify.io/monitoring/monitoring-types/dnsbl): Monitor the reputation of your IP addresses on blocklists.
- [Used RBL Lists](https://docs.uptimeify.io/monitoring/monitoring-types/dnsbl/lists): We currently monitor your IP addresses against the following lists. This selection covers the most important and reliable international anti-spam databases.
- [Domain Expiry Monitoring](https://docs.uptimeify.io/monitoring/monitoring-types/domain-expiry): An expired domain is one of the most severe incidents that can happen to a website. Once a domain expires, the entire online presence becomes unreachable — and in the worst case, the domain is registered by a third party. Our Domain Expiry Monitoring helps you proactively prevent this.
- [FTP Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/ftp): The FTP Monitor checks whether your FTP service is reachable and responsive. This helps detect outages on file transfer infrastructure used by legacy integrations, batch exports, or partner uploads.
- [Heartbeat Monitoring (Cron)](https://docs.uptimeify.io/monitoring/monitoring-types/heartbeat): Heartbeat monitoring (also known as Cron Monitoring) works in reverse: instead of us checking your server, your server (or script) notifies us that it is alive.
- [HTTPS Redirect Check](https://docs.uptimeify.io/monitoring/monitoring-types/https-redirect): Security and SEO are indispensable today. The HTTPS Redirect Check ensures that visitors accessing your website unencrypted via http:// are automatically redirected to the secure https:// version.
- [ICMP Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/icmp): The ICMP Monitor checks whether a host is reachable on the network. This is ideal for infrastructure components that do not expose HTTP endpoints (e.g. routers, firewalls, VPN gateways, databases, or internal services).
- [IMAP/POP Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/imap-pop): The IMAP/POP Monitor verifies that your mail server is reachable for clients. This is useful for detecting authentication and connectivity issues that impact inbox access.
- [Keyword Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/keyword): Sometimes a page is technically \\\"online\\\" (Status Code 200) but doesn't show the desired content – for example, a white page, a database error message, or \\\"Out of Stock\\\". The Keyword Monitor (also called \\\"Content Monitor\\\") solves this problem.
- [Page Size Check](https://docs.uptimeify.io/monitoring/monitoring-types/page-size): The Page Size Check monitors the size of your website's HTML response content (body) in bytes. Unexpected changes in file size can indicate serious issues that are missed by a pure status code check (200 OK).
- [Playwright Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/playwright): For critical processes like Login, Checkout, or Registration, a simple HTTP check is often insufficient. The Playwright Monitor loads your website in a real browser (Headless Chromium) and executes a script defined by you.
- [Response Time Check](https://docs.uptimeify.io/monitoring/monitoring-types/response-time): In addition to pure availability, speed is crucial for user experience. The Response Time Check measures how long your server takes to respond to a request.
- [SMTP Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/smtp): The SMTP Monitor verifies that your SMTP server is reachable and responsive. This helps you detect outages of outbound mail gateways and mail delivery infrastructure before users report missing emails.
- [SSH Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/ssh): The SSH Monitor checks whether your SSH service is reachable. It is commonly used to detect firewall issues, network outages, or server crashes affecting administrative access.
- [SSL Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/ssl): Expired SSL certificates are a common cause of downtime and loss of user trust. Browsers display warnings like \\\"Connection not secure\\\". Our SSL Monitor helps you proactively prevent this.
- [Uptime Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/uptime): The Uptime Monitor is the core of your monitoring strategy. It regularly checks if your website or API endpoint is accessible to your customers. We recommend setting up at least one Uptime Monitor for every publicly accessible page.
- [Using Tags](https://docs.uptimeify.io/monitoring/tags): Organize and filter monitors with color-coded tags across all monitor types.

## Status Pages

- [Status Pages](https://docs.uptimeify.io/status-pages): Status pages let you communicate service health to your customers transparently — live overall state, a per-service breakdown, and a short history of recent incidents and maintenance. Each page is fully brandable and can run on your own domain (e.g. status.example.com).
- [Custom Domains](https://docs.uptimeify.io/status-pages/custom-domains): Connect a hostname like status.example.com to a status page so it runs entirely under your own brand. A hostname can be bound to exactly one status page, and the certificate is issued automatically once the domain is verified and active.
- [Design & Branding](https://docs.uptimeify.io/status-pages/design): Every status page has a visual design configuration. Edit it in the app under Dashboard → Status Pages → (page) → Design, or via the design API. Changes are merged — you only send the fields you want to change, and the rest keep their current values.