# Website Monitoring API
> LLM-friendly index of the canonical REST API documentation for both customer-facing and organization-scoped workflows.

Canonical docs base: https://uptimeify.io/docs/api
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 the Customer API section for customer-safe automation. Use the Organization API section for tenant-wide management, billing, and user administration.

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

- [API Documentation](https://uptimeify.io/docs/api): Overview of the REST API. Select a resource from the left.

- [Introduction](https://uptimeify.io/docs/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://uptimeify.io/docs/api/introduction/error-response): Errors are returned with an appropriate HTTP status code and a JSON body containing details.
- [Generate API Token](https://uptimeify.io/docs/api/introduction/generate-api-token)
- [Success Response](https://uptimeify.io/docs/api/introduction/success-response): On success, the API returns a JSON body with the requested data.
- [Token Scopes (Organization vs Customer)](https://uptimeify.io/docs/api/introduction/token-scopes-organization-vs-customer): API tokens can optionally be created with a Customer Scope:

- [Auth & Session](https://uptimeify.io/docs/api/auth): Manage your current user session and retrieve profile information.
- [Get Current User](https://uptimeify.io/docs/api/auth/get-current-user): GET /api/auth/get-session

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

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

- [Website Management](https://uptimeify.io/docs/api/websites): Manage monitored websites.
- [Change Website Status](https://uptimeify.io/docs/api/websites/change-status): PATCH /api/websites/:websitePublicId (status)
- [Create Website](https://uptimeify.io/docs/api/websites/create-website): POST /api/websites
- [Delete Website](https://uptimeify.io/docs/api/websites/delete-website): DELETE /api/websites/:websitePublicId
- [Get Website](https://uptimeify.io/docs/api/websites/get-website): GET /api/websites/:websitePublicId
- [Get Website Details](https://uptimeify.io/docs/api/websites/get-website-details): GET /api/websites/:websitePublicId/details
- [List Websites](https://uptimeify.io/docs/api/websites/list-websites): GET /api/websites
- [Update Website](https://uptimeify.io/docs/api/websites/update-website): PATCH /api/websites/:websitePublicId

- [Monitoring Data & Reports](https://uptimeify.io/docs/api/monitoring)
- [Download PDF Report](https://uptimeify.io/docs/api/monitoring/download-report-pdf): GET /api/websites/:websitePublicId/report.pdf
- [Get Alert History](https://uptimeify.io/docs/api/monitoring/get-alert-history): GET /api/websites/:websitePublicId/alert-history
- [Get Check History](https://uptimeify.io/docs/api/monitoring/get-check-history): GET /api/websites/:websitePublicId/check-history
- [Get Incident Details](https://uptimeify.io/docs/api/monitoring/get-incident-details): GET /api/incidents/:incidentPublicId
- [Get Incident History](https://uptimeify.io/docs/api/monitoring/get-incident-history): GET /api/websites/:websitePublicId/incident-history
- [Get Monitoring Data](https://uptimeify.io/docs/api/monitoring/get-monitoring-data): GET /api/websites/:websitePublicId/monitoring-data
- [Get Uptime Stats](https://uptimeify.io/docs/api/monitoring/get-uptime-stats): GET /api/websites/:websitePublicId/uptime-stats
- [List Incidents (Organization)](https://uptimeify.io/docs/api/monitoring/list-incidents): GET /api/incidents?organizationId=:organizationId

- [Monitors](https://uptimeify.io/docs/api/monitors): Manage protocol monitors (ICMP, SMTP, SSH, FTP, IMAP/POP).
- [DNS Monitors](https://uptimeify.io/docs/api/monitors/dns-monitors): Manage DNS record monitors.
- [Create DNS Monitor](https://uptimeify.io/docs/api/monitors/dns-monitors/create-dns-monitor): POST /api/dns-monitors
- [Delete DNS Monitor](https://uptimeify.io/docs/api/monitors/dns-monitors/delete-dns-monitor): DELETE /api/dns-monitors/:dnsMonitorPublicId
- [Get DNS Monitor](https://uptimeify.io/docs/api/monitors/dns-monitors/get-dns-monitor): GET /api/dns-monitors/:dnsMonitorPublicId
- [Get DNS Monitor Check History](https://uptimeify.io/docs/api/monitors/dns-monitors/get-dns-monitor-check-history): GET /api/dns-monitors/:dnsMonitorPublicId/check-history
- [List DNS Monitors](https://uptimeify.io/docs/api/monitors/dns-monitors/list-dns-monitors): GET /api/dns-monitors
- [Trigger DNS Check](https://uptimeify.io/docs/api/monitors/dns-monitors/trigger-check-dns-monitor): POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check
- [Update DNS Monitor](https://uptimeify.io/docs/api/monitors/dns-monitors/update-dns-monitor): PATCH /api/dns-monitors/:dnsMonitorPublicId
- [DNSBL Monitoring (Customer IPs)](https://uptimeify.io/docs/api/monitors/dnsbl-monitoring): Manage IPs used for DNSBL blacklist monitoring.
- [Create Customer IP (Customer)](https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/create-customer-ip-for-customer): POST /api/customers/:customerId/ips
- [Delete Customer IP](https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/delete-customer-ip): DELETE /api/customer-ips/:customerIpPublicId
- [Get Customer IP](https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/get-customer-ip): GET /api/customer-ips/:customerIpPublicId
- [List Customer IPs (Org)](https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/list-customer-ips): GET /api/customer-ips
- [List Customer IPs (Customer)](https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/list-customer-ips-for-customer): GET /api/customers/:customerId/ips
- [Update Customer IP](https://uptimeify.io/docs/api/monitors/dnsbl-monitoring/update-customer-ip): PATCH /api/customer-ips/:customerIpPublicId
- [Domain Expiry Monitoring (Customer Domains)](https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring): Manage domains used for domain expiry monitoring.
- [Create Customer Domain (Customer)](https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/create-customer-domain): POST /api/customers/:customerId/domains
- [Delete Customer Domain](https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/delete-customer-domain): DELETE /api/customer-domains/:customerDomainPublicId
- [Get Customer Domain](https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/get-customer-domain): GET /api/customer-domains/:customerDomainPublicId
- [List Customer Domains (Org)](https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/list-customer-domains): GET /api/customer-domains
- [List Domain Expiry (Websites)](https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/list-domain-expiry-websites): GET /api/domains
- [Update Customer Domain](https://uptimeify.io/docs/api/monitors/domain-expiry-monitoring/update-customer-domain): PATCH /api/customer-domains/:customerDomainPublicId
- [FTP Monitors](https://uptimeify.io/docs/api/monitors/ftp-monitors): Manage FTP monitors.
- [Create FTP Monitor](https://uptimeify.io/docs/api/monitors/ftp-monitors/create-ftp-monitor): POST /api/ftp-monitors
- [Delete FTP Monitor](https://uptimeify.io/docs/api/monitors/ftp-monitors/delete-ftp-monitor): DELETE /api/ftp-monitors/:ftpMonitorPublicId
- [Get FTP Monitor](https://uptimeify.io/docs/api/monitors/ftp-monitors/get-ftp-monitor): GET /api/ftp-monitors/:ftpMonitorPublicId
- [Get FTP Monitor Check History](https://uptimeify.io/docs/api/monitors/ftp-monitors/get-ftp-monitor-check-history): GET /api/ftp-monitors/:ftpMonitorPublicId/check-history
- [Get FTP Monitor Details](https://uptimeify.io/docs/api/monitors/ftp-monitors/get-ftp-monitor-details): GET /api/ftp-monitors/:ftpMonitorPublicId/details
- [List FTP Monitors](https://uptimeify.io/docs/api/monitors/ftp-monitors/list-ftp-monitors): GET /api/ftp-monitors
- [Trigger FTP Check](https://uptimeify.io/docs/api/monitors/ftp-monitors/trigger-check-ftp-monitor): POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check
- [Update FTP Monitor (Change Status)](https://uptimeify.io/docs/api/monitors/ftp-monitors/update-ftp-monitor): PATCH /api/ftp-monitors/:ftpMonitorPublicId
- [ICMP Monitors](https://uptimeify.io/docs/api/monitors/icmp-monitors): Manage ICMP (ping) monitors.
- [Create ICMP Monitor](https://uptimeify.io/docs/api/monitors/icmp-monitors/create-icmp-monitor): POST /api/icmp-monitors
- [Delete ICMP Monitor](https://uptimeify.io/docs/api/monitors/icmp-monitors/delete-icmp-monitor): DELETE /api/icmp-monitors/:icmpMonitorPublicId
- [Get ICMP Monitor](https://uptimeify.io/docs/api/monitors/icmp-monitors/get-icmp-monitor): GET /api/icmp-monitors/:icmpMonitorPublicId
- [Get ICMP Monitor Check History](https://uptimeify.io/docs/api/monitors/icmp-monitors/get-icmp-monitor-check-history): GET /api/icmp-monitors/:icmpMonitorPublicId/check-history
- [Get ICMP Monitor Details](https://uptimeify.io/docs/api/monitors/icmp-monitors/get-icmp-monitor-details): GET /api/icmp-monitors/:icmpMonitorPublicId/details
- [List ICMP Monitors](https://uptimeify.io/docs/api/monitors/icmp-monitors/list-icmp-monitors): GET /api/icmp-monitors
- [Trigger ICMP Check](https://uptimeify.io/docs/api/monitors/icmp-monitors/trigger-check-icmp-monitor): POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check
- [Update ICMP Monitor](https://uptimeify.io/docs/api/monitors/icmp-monitors/update-icmp-monitor): PATCH /api/icmp-monitors/:icmpMonitorPublicId
- [IMAP/POP Monitors](https://uptimeify.io/docs/api/monitors/imap-pop-monitors): Manage IMAP/POP monitors.
- [Create IMAP/POP Monitor](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/create-imap-pop-monitor): POST /api/imap-pop-monitors
- [Delete IMAP/POP Monitor](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/delete-imap-pop-monitor): DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId
- [Get IMAP/POP Monitor](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/get-imap-pop-monitor): GET /api/imap-pop-monitors/:imapPopMonitorPublicId
- [Get IMAP/POP Monitor Check History](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/get-imap-pop-monitor-check-history): GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history
- [Get IMAP/POP Monitor Details](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/get-imap-pop-monitor-details): GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details
- [List IMAP/POP Monitors](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/list-imap-pop-monitors): GET /api/imap-pop-monitors
- [Trigger IMAP/POP Check](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/trigger-check-imap-pop-monitor): POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check
- [Update IMAP/POP Monitor](https://uptimeify.io/docs/api/monitors/imap-pop-monitors/update-imap-pop-monitor): PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId
- [SMTP Monitors](https://uptimeify.io/docs/api/monitors/smtp-monitors): Manage SMTP monitors via the API.
- [Create SMTP Monitor](https://uptimeify.io/docs/api/monitors/smtp-monitors/create-smtp-monitor): POST /api/smtp-monitors
- [Delete SMTP Monitor](https://uptimeify.io/docs/api/monitors/smtp-monitors/delete-smtp-monitor): DELETE /api/smtp-monitors/:smtpMonitorPublicId
- [Get SMTP Monitor](https://uptimeify.io/docs/api/monitors/smtp-monitors/get-smtp-monitor): GET /api/smtp-monitors/:smtpMonitorPublicId
- [Get SMTP Monitor Check History](https://uptimeify.io/docs/api/monitors/smtp-monitors/get-smtp-monitor-check-history): GET /api/smtp-monitors/:smtpMonitorPublicId/check-history
- [Get SMTP Monitor Details](https://uptimeify.io/docs/api/monitors/smtp-monitors/get-smtp-monitor-details): GET /api/smtp-monitors/:smtpMonitorPublicId/details
- [List SMTP Monitors](https://uptimeify.io/docs/api/monitors/smtp-monitors/list-smtp-monitors): GET /api/smtp-monitors
- [Trigger Check for SMTP Monitor](https://uptimeify.io/docs/api/monitors/smtp-monitors/trigger-check-smtp-monitor): POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check
- [Update SMTP Monitor](https://uptimeify.io/docs/api/monitors/smtp-monitors/update-smtp-monitor): PATCH /api/smtp-monitors/:smtpMonitorPublicId
- [SSH Monitors](https://uptimeify.io/docs/api/monitors/ssh-monitors): Manage SSH monitors via the API.
- [Create SSH Monitor](https://uptimeify.io/docs/api/monitors/ssh-monitors/create-ssh-monitor): POST /api/ssh-monitors
- [Delete SSH Monitor](https://uptimeify.io/docs/api/monitors/ssh-monitors/delete-ssh-monitor): DELETE /api/ssh-monitors/:sshMonitorPublicId
- [Get SSH Monitor](https://uptimeify.io/docs/api/monitors/ssh-monitors/get-ssh-monitor): GET /api/ssh-monitors/:sshMonitorPublicId
- [Get SSH Monitor Check History](https://uptimeify.io/docs/api/monitors/ssh-monitors/get-ssh-monitor-check-history): GET /api/ssh-monitors/:sshMonitorPublicId/check-history
- [Get SSH Monitor Details](https://uptimeify.io/docs/api/monitors/ssh-monitors/get-ssh-monitor-details): GET /api/ssh-monitors/:sshMonitorPublicId/details
- [List SSH Monitors](https://uptimeify.io/docs/api/monitors/ssh-monitors/list-ssh-monitors): GET /api/ssh-monitors
- [Trigger Check for SSH Monitor](https://uptimeify.io/docs/api/monitors/ssh-monitors/trigger-check-ssh-monitor): POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check
- [Update SSH Monitor](https://uptimeify.io/docs/api/monitors/ssh-monitors/update-ssh-monitor): PATCH /api/ssh-monitors/:sshMonitorPublicId

- [Configurations](https://uptimeify.io/docs/api/website-configuration): Manage check configuration, notification channels and maintenance windows.
- [Check Maintenance (Website)](https://uptimeify.io/docs/api/website-configuration/check-maintenance-window): GET /api/maintenance-windows/check/:websiteId
- [Check Maintenance (Batch)](https://uptimeify.io/docs/api/website-configuration/check-maintenance-window-batch): POST /api/maintenance-windows/check/batch
- [Create Maintenance Window](https://uptimeify.io/docs/api/website-configuration/create-maintenance-window): POST /api/maintenance-windows
- [Delete Maintenance Window](https://uptimeify.io/docs/api/website-configuration/delete-maintenance-window): DELETE /api/maintenance-windows/:id
- [Get Maintenance Window](https://uptimeify.io/docs/api/website-configuration/get-maintenance-window): GET /api/maintenance-windows/:id
- [List Maintenance Windows](https://uptimeify.io/docs/api/website-configuration/list-maintenance-windows): GET /api/maintenance-windows
- [Update Check Settings](https://uptimeify.io/docs/api/website-configuration/update-check-settings): PATCH /api/websites/:websiteId/check-config
- [Update Maintenance Window](https://uptimeify.io/docs/api/website-configuration/update-maintenance-window): PATCH /api/maintenance-windows/:id

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

- [Customer Management](https://uptimeify.io/docs/api/customers): Path-based customer endpoints use customerPublicId UUIDs.
- [Cancel Customer](https://uptimeify.io/docs/api/customers/cancel-customer): POST /api/customers/:customerPublicId/cancel
- [Change Package](https://uptimeify.io/docs/api/customers/change-package): PATCH /api/customers/:customerPublicId
- [Create Customer](https://uptimeify.io/docs/api/customers/create-customer): POST /api/customers
- [Get Customer Details](https://uptimeify.io/docs/api/customers/get-customer-details): GET /api/customers/:customerPublicId
- [List Customers](https://uptimeify.io/docs/api/customers/list-customers): GET /api/customers
- [Update Customer](https://uptimeify.io/docs/api/customers/update-customer): PATCH /api/customers/:customerPublicId

- [Organization & Billing](https://uptimeify.io/docs/api/organization): Path-based organization endpoints use organizationPublicId UUIDs.
- [Delete Package Config](https://uptimeify.io/docs/api/organization/delete-package-config): DELETE /api/package-configs/:packageType
- [Get Billing Details](https://uptimeify.io/docs/api/organization/get-billing-details): GET /api/organization/billing
- [Get Organization Details](https://uptimeify.io/docs/api/organization/get-organization-details): GET /api/organization
- [List Invoices](https://uptimeify.io/docs/api/organization/list-invoices): GET /api/mollie/invoices
- [List Package Configs](https://uptimeify.io/docs/api/organization/list-package-configs): GET /api/package-configs
- [Update Billing Details](https://uptimeify.io/docs/api/organization/update-billing-details): PATCH /api/organization/billing
- [Update Organization](https://uptimeify.io/docs/api/organization/update-organization): PATCH /api/organization
- [Upsert Package Config](https://uptimeify.io/docs/api/organization/upsert-package-config): PATCH /api/package-configs/:packageType

- [Users](https://uptimeify.io/docs/api/users): Manage users within your organization.
- [Create User](https://uptimeify.io/docs/api/users/create-user): POST /api/users
- [Delete User](https://uptimeify.io/docs/api/users/delete-user): DELETE /api/users/:id
- [Get User](https://uptimeify.io/docs/api/users/get-user): GET /api/users/:id
- [List Users](https://uptimeify.io/docs/api/users/list-users): GET /api/users
- [Update User](https://uptimeify.io/docs/api/users/update-user): PATCH /api/users/:id

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

- [Global Administration](https://uptimeify.io/docs/api/admin): This section covers the global administration endpoints, which are protected and only accessible to platform administrators.

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

- [German LLMS index](https://uptimeify.io/de/llms.txt): German compact index for the same API documentation.
- [German LLMS full](https://uptimeify.io/de/llms-full.txt): German expanded export with section summaries and endpoint hints.
- [German API docs](https://uptimeify.io/de/docs/api): German-language API reference with equivalent public documentation structure.