# 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 ## MCP Server Uptimeify runs a stateless Model Context Protocol server. 20 check tools work with no account and no token; 23 more read your own monitors, alerting, status pages, Incident Management (incidents, on-call, teams, schedules) and account data with an API token. - Endpoint: `POST https://uptimeify.io/mcp` (Streamable HTTP, stateless) - Server card: https://uptimeify.io/.well-known/mcp/server-card.json - Registry manifest: https://uptimeify.io/.well-known/mcp/server.json - Overview: https://uptimeify.io/mcp-server - Technical reference: https://docs.uptimeify.io/api/mcp - Limits: 120 requests/minute per IP on the endpoint, plus 15-30/minute per anonymous tool and 60/minute per authenticated tool. Exceeding a limit returns HTTP 429. - Anonymous tools: check_ssl, check_dns, dns_propagation, mx_lookup, spf_check, dkim_check, dmarc_check, dnsbl_check, whois, domain_expiry, http_headers, hsts_check, redirect_check, port_check, ping_test, website_status, response_time, ip_geolocation, asn_lookup, reverse_dns - API-token tools (read-only): list_monitors, monitor_status, list_incidents, check_history, uptime_summary, list_alert_channels, alert_history, list_status_pages, list_status_page_components, list_status_page_maintenances, get_status_page_maintenance, list_maintenance_windows, list_im_incidents, get_im_incident, who_is_on_call, list_im_teams, get_im_team, list_im_schedules, get_im_schedule, get_organization, list_users, list_customers, billing_summary - 65 write tools over an OAuth connection with the matching write scope, switched on or off per deployment, never available to an API token: pause_monitor, resume_monitor, rename_monitor, set_check_interval, create_website_monitor, delete_monitor, acknowledge_incident, resolve_incident, post_incident_update, delete_incident, create_incident, update_incident, publish_postmortem, backfill_incident, create_maintenance_window, update_maintenance_window, delete_maintenance_window, create_status_page, update_status_page, update_status_page_design, delete_status_page, add_status_page_domain, verify_status_page_domain, activate_status_page_domain, delete_status_page_domain, create_status_page_component, update_status_page_component, delete_status_page_component, create_status_page_component_group, update_status_page_component_group, delete_status_page_component_group, create_status_page_maintenance, update_status_page_maintenance, complete_status_page_maintenance, cancel_status_page_maintenance, post_status_page_maintenance_update, create_notification_channel, update_notification_channel, delete_notification_channel, create_tag, update_tag, delete_tag, add_monitor_tag, remove_monitor_tag, create_custom_field, update_custom_field, delete_custom_field, create_report, update_report, delete_report, update_user, create_customer, update_customer, delete_customer, add_customer_domain, delete_customer_domain, add_customer_ip, delete_customer_ip, acknowledge_im_incident, resolve_im_incident, set_im_incident_status, comment_on_im_incident, assign_im_incident, set_im_incident_severity, snooze_im_incident ## Free Status Pages Uptimeify status pages are permanently free. They need no paid plan, no trial and no monitoring, and they stay online and free if a monitoring plan ends. They are hosted in the EU. - White-label: custom domain with automatic HTTPS, nine layouts, your own logo and colors, no Uptimeify branding, the optional "Powered by" line shows your own product name - Incidents and maintenance: updates in phases, templates, scheduled maintenance, public postmortems - Subscribers: email, Slack, Microsoft Teams, webhook, RSS and Atom - Private pages: login, SSO, password, IP allowlist and audience groups - Embeds: status badge and iframe widget - Components: from your own monitors, third-party providers, by hand or via API - Overview: https://uptimeify.io/status-pages - Pricing: https://uptimeify.io/pricing - Documentation: https://docs.uptimeify.io/status-pages ## 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. - [Agent authentication (agentic registration)](https://docs.uptimeify.io/api/agent-auth): Register an AI agent and receive a short-lived, read-only access token for the Uptimeify API. - [Claim flow (service_auth & anonymous)](https://docs.uptimeify.io/api/agent-auth/claim-flow): How an agent turns a registration into a read-only, account-scoped access token by having a signed-in user authorize it. - [Identity assertion (ID-JAG)](https://docs.uptimeify.io/api/agent-auth/identity-assertion): How an agent signed in at a trusted identity provider registers with an ID-JAG, gets a user's approval for read access and selected changes, and how the provider revokes it. - [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). - [Create Status Page Change Request](https://docs.uptimeify.io/api/change-requests/create-status-page-change-request): Asks the organization for a change to a status page, or to take a self_service page over. Read access is enough. - [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). - [Get Custom Field](https://docs.uptimeify.io/api/custom-fields/get-custom-field): Returns one active custom field definition of your organization, in the same shape as an entry of List Custom Fields. - [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. - [Bulk Actions](https://docs.uptimeify.io/api/customers/bulk-actions): Applies one action to many customers at once, for multi-select workflows. - [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. - [Delete Customer](https://docs.uptimeify.io/api/customers/delete-customer): Permanently deletes a customer and deactivates or deletes the users assigned only to it. - [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. - [Get a dependency provider](https://docs.uptimeify.io/api/dependencies/get-dependency): Public, unauthenticated detail of one tracked third-party service: current status, components with 90-day history, and recorded incidents. - [List dependency providers](https://docs.uptimeify.io/api/dependencies/list-dependencies): Public, unauthenticated list of the third-party services whose status Uptimeify tracks, with each one's current overall status. - [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 is saved yet, the inactive defaults are returned (`id`, `createdAt` and `updatedAt` are `null`) and nothing is created; the first PATCH stores them. - [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. - [Incident Management](https://docs.uptimeify.io/api/incident-management): Public REST API for Uptimeify Incident Management (IM): ingest alerts from your own monitoring systems and manage incidents programmatically. - [Acknowledge / Update Incident Status](https://docs.uptimeify.io/api/incident-management/acknowledge-incident): Acknowledges an Incident Management incident, or moves it between the open statuses (acknowledged, investigating, identified, monitoring). - [Activate Incident Management](https://docs.uptimeify.io/api/incident-management/activate): Switches Incident Management on for your organization. Idempotent: calling it again on an enabled organization changes nothing. - [Alert Source Setup Guides](https://docs.uptimeify.io/api/incident-management/alert-sources): Step-by-step guides for wiring Zabbix, Datadog, Grafana Alerting, Prometheus Alertmanager, Sentry, Beszel, or any custom webhook to Uptimeify Incident Management. - [Alert Sources API](https://docs.uptimeify.io/api/incident-management/alert-sources-api): Create, configure and test Incident Management alert sources: ingest tokens, optional HMAC or Bearer authentication, payload mapping, maintenance windows and per-source statistics. - [Beszel](https://docs.uptimeify.io/api/incident-management/alert-sources/beszel): Send Beszel server alerts to Uptimeify Incident Management through a Shoutrrr generic webhook, with host, link, severity and automatic recovery for every Beszel alert type. - [Custom webhook](https://docs.uptimeify.io/api/incident-management/alert-sources/custom-webhook): Send alerts from any tool that can POST JSON to Uptimeify Incident Management, and define your own field mapping in the dashboard. - [Datadog](https://docs.uptimeify.io/api/incident-management/alert-sources/datadog): Send Datadog Monitor alerts to Uptimeify Incident Management via a Datadog webhook integration, pre-mapped to title, alert type, and transition state. - [Email](https://docs.uptimeify.io/api/incident-management/alert-sources/email): Forward or route alert emails from any monitoring tool, ticketing system, or mailbox to a dedicated inbound address, and turn them into incidents automatically. - [Grafana Alerting](https://docs.uptimeify.io/api/incident-management/alert-sources/grafana-alerting): Send Grafana Alerting notifications to Uptimeify Incident Management via a Webhook contact point, mapped from the alert group's first alert. - [Prometheus Alertmanager](https://docs.uptimeify.io/api/incident-management/alert-sources/prometheus-alertmanager): Send Prometheus Alertmanager notifications to Uptimeify Incident Management via a webhook receiver, mapped from commonLabels and the first alert. - [Report form](https://docs.uptimeify.io/api/incident-management/alert-sources/report-form): A link that lets staff, suppliers or customers report an incident or a security concern without a login. Each report becomes an alert in Incident Management. - [Sentry](https://docs.uptimeify.io/api/incident-management/alert-sources/sentry): Send Sentry issue alerts to Uptimeify Incident Management via an internal integration webhook, mapped from the event's level, message, and environment. - [Zabbix](https://docs.uptimeify.io/api/incident-management/alert-sources/zabbix): Send Zabbix trigger alerts to Uptimeify Incident Management via a Webhook media type, using the ready-made media type Uptimeify generates for you. - [Analytics](https://docs.uptimeify.io/api/incident-management/analytics): Incident volume, MTTA and MTTR per day, the alerts-to-incidents noise ratio and on-call load per user for a date range, in one call. - [Audit Log](https://docs.uptimeify.io/api/incident-management/audit-log): Read the Incident Management audit trail: who created, changed or deleted which team, schedule, source or setting, with the recorded diff. Cursor-paginated. - [Bulk Update Incidents](https://docs.uptimeify.io/api/incident-management/bulk-update-incidents): Applies one action (acknowledge, resolve, severity, assign) to up to 200 Incident Management incidents at once, with a per-incident result. - [Channels](https://docs.uptimeify.io/api/incident-management/channels): List, create, update and delete Incident Management paging channels (webhook, Slack, email), including the write-only handling of webhook URLs and headers. - [Create Incident](https://docs.uptimeify.io/api/incident-management/create-incident): Manually creates an Incident Management incident for a team; escalation arms moments after creation, with the same paging behavior as an alert-sourced incident. - [Dismiss Merge Suggestion](https://docs.uptimeify.io/api/incident-management/dismiss-merge-suggestion): Drops a suggestion that an Incident Management incident is the same as an open incident from another source. - [Events Ingest](https://docs.uptimeify.io/api/incident-management/events-ingest): Public alert-ingest endpoint for Incident Management. Post any JSON alert payload from your own monitoring or alerting system; it is queued and processed asynchronously into an incident. - [Get Incident](https://docs.uptimeify.io/api/incident-management/get-incident): Returns the full detail of a single Incident Management incident: the incident row plus its alerts, timeline events, and role assignments. - [Assign Incident Roles](https://docs.uptimeify.io/api/incident-management/incident-assign): Sets the holder of an incident role (commander, tech lead, comms, assignee), or adds an extra responder to an Incident Management incident, optionally paging them. - [Find the Incident for a Monitoring Incident](https://docs.uptimeify.io/api/incident-management/incident-by-monitor): Resolves a monitoring incident id to the Incident Management incident it was bridged into. - [Classify Incident](https://docs.uptimeify.io/api/incident-management/incident-classification): Sets the NIS-2 category of an Incident Management incident (availability, security, other) and marks it as a near miss. - [Comment on Incident](https://docs.uptimeify.io/api/incident-management/incident-comment): Adds a comment to the timeline of an Incident Management incident. - [Count Open Incidents](https://docs.uptimeify.io/api/incident-management/incident-count): Returns the number of open, unacknowledged Incident Management incidents in your organization. - [Escalate Incident Now](https://docs.uptimeify.io/api/incident-management/incident-escalate-now): Skips the wait and pages the next escalation tier of a triggered Incident Management incident immediately. - [Set Incident Service](https://docs.uptimeify.io/api/incident-management/incident-service): Names the service an Incident Management incident affects, or removes it. - [Change Incident Severity](https://docs.uptimeify.io/api/incident-management/incident-severity): Sets the severity of an Incident Management incident by hand. The value then sticks and is no longer derived from its alerts. - [Snooze Incident](https://docs.uptimeify.io/api/incident-management/incident-snooze): Pauses escalation and reminders of an open Incident Management incident until a given time (at most 7 days ahead), or ends a snooze early. - [Update Status Page Text](https://docs.uptimeify.io/api/incident-management/incident-statuspage-update): Sets the public status page text of an Incident Management incident, shown on status pages that a status page rule switched for this incident. - [Ingest Webhook](https://docs.uptimeify.io/api/incident-management/ingest-webhook): The per-source ingest URL your monitoring tools post alerts to: authentication, limits and status codes. - [List Incidents](https://docs.uptimeify.io/api/incident-management/list-incidents): Returns a filtered, paginated list of Incident Management incidents for your organization, by cursor or by page number. - [Merge Incidents](https://docs.uptimeify.io/api/incident-management/merge-incidents): Merges one Incident Management incident into another: its alerts and timeline move over, and the merged incident stops escalating. - [My On-Call Status](https://docs.uptimeify.io/api/incident-management/my-on-call): Your own on-call duty across all teams: whether you are on call now, upcoming shifts, overrides, and your on-call hours. - [NIS-2 Settings](https://docs.uptimeify.io/api/incident-management/nis2-settings): Switch NIS-2 report cases on for your organization, set the entity classification and choose the reporting officers. - [Personal Notification Settings](https://docs.uptimeify.io/api/incident-management/notification-settings): How Incident Management reaches you: channels, notification rules per urgency, channels per severity, phone verification, test notifications and your notification log. - [Default Notifications](https://docs.uptimeify.io/api/incident-management/notification-template): The organization's default notification chain: what new users start with when their personal notification settings are first created. - [Who Is On Call](https://docs.uptimeify.io/api/incident-management/on-call): Returns who is on call right now in your organization, one entry per team, escalation tier and person, resolved exactly like the paging engine. - [Organization Settings](https://docs.uptimeify.io/api/incident-management/org-settings): Read and update the Incident Management settings of your organization: monitoring bridge, SMS/voice overage and the fallback channel. - [Outbound Integrations](https://docs.uptimeify.io/api/incident-management/outbound-integrations): Forward Incident Management events to Slack, Microsoft Teams, Discord, Jira, PagerDuty, Opsgenie or a generic webhook, and inspect or retry deliveries. - [Postmortems and Follow-up](https://docs.uptimeify.io/api/incident-management/postmortems): Record the root cause, lessons learned and actions after an incident, keep a catalog of causes, and track follow-up. - [Report Cases (NIS-2)](https://docs.uptimeify.io/api/incident-management/report-cases): Track an NIS-2 report case: criteria, the reportable decision, awareness time, deadlines, report drafts and the log of what you submitted in the BSI portal. - [Reports](https://docs.uptimeify.io/api/incident-management/reports): Incident report (volume, MTTA, MTTR by team, severity, category or month) and on-call report (minutes per user) for a date range, as JSON or CSV, and the NIS-2 management report as JSON or PDF. - [Resolve Incident](https://docs.uptimeify.io/api/incident-management/resolve-incident): Resolves an Incident Management incident from any non-closed status. This is the only endpoint that can move an incident to resolved. - [Routing Rules](https://docs.uptimeify.io/api/incident-management/routing-rules): List, create, update and delete Incident Management routing rules: which team a new incident is assigned to, and an optional severity override. - [Schedule Overrides](https://docs.uptimeify.io/api/incident-management/schedule-overrides): List, add, edit and delete on-call overrides on a schedule: one-off windows that put someone on call or take someone off call without touching the rotation. - [Preview a schedule](https://docs.uptimeify.io/api/incident-management/schedule-preview): Compute the shifts and coverage gaps a schedule's saved rotation produces over the next four weeks, without writing anything. - [Schedules](https://docs.uptimeify.io/api/incident-management/schedules): List, read, create and delete Incident Management on-call schedules, and how a schedule's rotation cadence works. - [Services](https://docs.uptimeify.io/api/incident-management/services): List, create, update and delete the services of your organization (service and asset inventory with criticality and responsible team), and how incidents are assigned to them. - [Setup Progress and Test Page](https://docs.uptimeify.io/api/incident-management/setup): Read and store the progress of the Incident Management setup, and send yourself a test page through a team. - [Status Page Rules](https://docs.uptimeify.io/api/incident-management/statuspage-rules): Couple Incident Management to your status pages: rules that flip a page to warning or degraded on incidents of a team, plus a manual override. - [Team On-Call and Statistics](https://docs.uptimeify.io/api/incident-management/team-insights): Read who is on call for a team right now, the team's on-call calendar for a time window, and the team's incident statistics. - [Team Members](https://docs.uptimeify.io/api/incident-management/team-members): Add, invite, re-role and remove the members of an Incident Management team. - [Team Overrides](https://docs.uptimeify.io/api/incident-management/team-overrides): List, add, edit and delete the on-call overrides of a team, both team-level overrides and those attached to one of the team's schedules. - [Escalation Tiers](https://docs.uptimeify.io/api/incident-management/team-tiers): Read, edit and test a team's escalation chain: ordered tiers, their auto-escalation and repeat settings, the schedules under each tier, and a dry run of who would be paged. - [Teams](https://docs.uptimeify.io/api/incident-management/teams): List, read, create, update and delete Incident Management teams, including the team-level escalation and engagement-report settings. - [Update a schedule](https://docs.uptimeify.io/api/incident-management/update-schedule): Change an on-call schedule's name, timezone, validity range, weekly windows, rotation cadence and rotation membership, in one atomic call. - [User Notification Settings](https://docs.uptimeify.io/api/incident-management/user-notification-settings): Organization admins read and set one person's notification settings: phone number, delivery channels and the whole notification chain. - [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. - [Permissions by endpoint](https://docs.uptimeify.io/api/introduction/permissions-by-endpoint): Which role, token type and token scope each endpoint needs, and which error code a refused call returns. - [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. - [Preview Tag Coverage Count](https://docs.uptimeify.io/api/maintenance-windows/preview-count): Returns how many distinct monitors a set of tags currently covers, for the tag-only (org-wide) maintenance-window mode. - [Preview Maintenance Occurrences](https://docs.uptimeify.io/api/maintenance-windows/preview-occurrences): Computes the upcoming occurrences of a (not-yet-saved) recurrence pattern, without creating a window. - [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. - [MCP Server](https://docs.uptimeify.io/api/mcp): Use Uptimeify's free check tools from any AI agent over the Model Context Protocol (MCP). - [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. - [Backfill Incident](https://docs.uptimeify.io/api/monitoring/backfill-incident): Records a past, already resolved incident with its real times on status pages, without notifying anyone. - [Create Manual Incident](https://docs.uptimeify.io/api/monitoring/create-manual-incident): Creates a manual incident on a customer's status pages or on chosen status pages and components. - [Delete Incident (Manual only)](https://docs.uptimeify.io/api/monitoring/delete-incident): Deletes a manually created (status-page) incident. Monitor-generated incidents cannot be deleted. - [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. - [Post Incident Update](https://docs.uptimeify.io/api/monitoring/post-incident-update): Posts a public update to the timeline of a manual or monitor incident and notifies status page subscribers. - [Publish Postmortem](https://docs.uptimeify.io/api/monitoring/publish-postmortem): Publishes the postmortem of a resolved incident on its status pages, optionally with one notification to their subscribers. - [Save Postmortem](https://docs.uptimeify.io/api/monitoring/save-postmortem): Saves the public postmortem (Markdown) of an incident as a draft, or replaces the text of a published one. - [Unpublish Postmortem](https://docs.uptimeify.io/api/monitoring/unpublish-postmortem): Takes a published postmortem off the status pages; the text stays as a draft. - [Update Incident](https://docs.uptimeify.io/api/monitoring/update-incident): Changes headline, severity, status and the linked status pages and components of an incident. - [Monitors](https://docs.uptimeify.io/api/monitors): Manage protocol monitors (ICMP, SMTP, SSH, TCP, 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. - [TCP Monitors](https://docs.uptimeify.io/api/monitors/tcp-monitors): Manage TCP monitors. - [Create TCP Monitor](https://docs.uptimeify.io/api/monitors/tcp-monitors/create-tcp-monitor): Creates a new TCP monitor. - [Delete TCP Monitor](https://docs.uptimeify.io/api/monitors/tcp-monitors/delete-tcp-monitor): Deletes a TCP monitor. - [Get TCP Monitor](https://docs.uptimeify.io/api/monitors/tcp-monitors/get-tcp-monitor): Returns details of a specific TCP monitor. - [Get TCP Monitor Alert History](https://docs.uptimeify.io/api/monitors/tcp-monitors/get-tcp-monitor-alert-history): Returns paginated notification/escalation attempts (alert history) for incidents of a TCP monitor. - [Get TCP Monitor Check History](https://docs.uptimeify.io/api/monitors/tcp-monitors/get-tcp-monitor-check-history): Returns paginated check results for a TCP monitor. - [Get TCP Monitor Details](https://docs.uptimeify.io/api/monitors/tcp-monitors/get-tcp-monitor-details): Consolidated endpoint that returns the TCP monitor details page data in one call. - [Get TCP Monitor Incident History](https://docs.uptimeify.io/api/monitors/tcp-monitors/get-tcp-monitor-incident-history): Returns paginated incidents for a single TCP monitor, including a computed duration. - [List TCP Monitors](https://docs.uptimeify.io/api/monitors/tcp-monitors/list-tcp-monitors): Lists TCP monitors in an organization. - [Trigger Check for TCP Monitor](https://docs.uptimeify.io/api/monitors/tcp-monitors/trigger-check-tcp-monitor): Triggers an immediate check from one eligible monitoring location. - [Update TCP Monitor](https://docs.uptimeify.io/api/monitors/tcp-monitors/update-tcp-monitor): Updates a TCP 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. - [Get Notification Channel](https://docs.uptimeify.io/api/notification-channels/get-notification-channel): Returns one notification channel, in the same shape as an entry of List Notification Channels. Secrets in config are redacted. - [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. - [Connected apps (OAuth connections)](https://docs.uptimeify.io/api/oauth-connections): List and revoke the OAuth/MCP applications connected to your account, such as Claude's remote MCP connector. - [Organization & Billing](https://docs.uptimeify.io/api/organization): Path-based organization endpoints use organizationPublicId UUIDs. - [Sender Domain](https://docs.uptimeify.io/api/organization-sender-domain): Send your organization's emails from your own domain through Uptimeify's mail infrastructure, without running your own SMTP server. Enterprise feature, enabled per organization by Uptimeify. Admin-only. - [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. - [Apply Report Default](https://docs.uptimeify.io/api/organization/apply-report-default): Writes a package's monthlyReportsDefault onto every existing customer currently on that package, once. - [Cancel Scheduled Quota Change](https://docs.uptimeify.io/api/organization/cancel-pending-quota-change): Cancels a quota reduction that was scheduled for the end of the current billing period, so the organization keeps its current plan. Answers cancelled:false, not 404, when nothing is scheduled. - [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 are currently assigned to that package. The package is resolved directly from the path parameter, so values like test1 work as long as they match the stored packageType. - [Download Data Export](https://docs.uptimeify.io/api/organization/download-data-export): Issues a short-lived download URL for a finished organization data export. - [Export Audit Log](https://docs.uptimeify.io/api/organization/export-audit-log): Downloads your organization's audit log for one period as a CSV file, sign-ins included. - [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 Audit Log](https://docs.uptimeify.io/api/organization/list-audit-events): Returns the audit log of your organization: who did what and when, filterable by period, area and outcome. - [List Data Exports](https://docs.uptimeify.io/api/organization/list-data-exports): Returns the recent data export requests of your organization with status, size, retention window and expiry. - [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): Streams the archived PDF of a report run as the response body. - [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. - [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. - [Request Data Export](https://docs.uptimeify.io/api/organization/request-data-export): Queues a complete export of your organization's content as JSON and CSV, delivered as a downloadable ZIP and announced by email. - [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. - [Validate VAT ID](https://docs.uptimeify.io/api/organization/validate-vat-id): Validates the organization's stored VAT identification number against the EU VIES register and persists the verdict. Only a valid VAT ID from another EU member state qualifies the organization for reverse-charge invoicing under AGB § 10.2. - [Service Status](https://docs.uptimeify.io/api/service-status): Public, unauthenticated endpoint that returns Uptimeify's own platform availability, check and alert delivery percentages, component states, and the hash-chained frozen monthly totals. - [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. Organization-wide: admin only; customer-bound: by the page's ownership class. - [Activate Status Page Module](https://docs.uptimeify.io/api/status-pages/activate-status-page-module): Turns the status pages module on for your organization. Idempotent. - [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. Organization-wide: admin or editor; customer-bound: by the page's ownership class. - [Cancel Status Page Maintenance](https://docs.uptimeify.io/api/status-pages/cancel-status-page-maintenance): Cancels an upcoming maintenance and tells the subscribers. - [Complete Status Page Maintenance](https://docs.uptimeify.io/api/status-pages/complete-status-page-maintenance): Ends a running maintenance now. - [Create Status Page](https://docs.uptimeify.io/api/status-pages/create-status-page): Creates a new status page. Requires the role `admin` or `editor`; customer-bound users and tokens (also `readonly`) create self-service pages of their customers. - [Create Status Page Component](https://docs.uptimeify.io/api/status-pages/create-status-page-component): Adds a monitor, a third-party provider or a manually maintained component to a status page. - [Create Status Page Component Group](https://docs.uptimeify.io/api/status-pages/create-status-page-component-group): Adds a component group to a status page. - [Schedule Status Page Maintenance](https://docs.uptimeify.io/api/status-pages/create-status-page-maintenance): Schedules maintenance for status pages and components, with announcement, reminder, start and end messages. - [Create Status Page Template](https://docs.uptimeify.io/api/status-pages/create-status-page-template): Creates an incident or update template. - [Delete Status Page](https://docs.uptimeify.io/api/status-pages/delete-status-page): Permanently deletes a status page. Requires the role `admin` or `editor`. - [Delete Status Page Component](https://docs.uptimeify.io/api/status-pages/delete-status-page-component): Removes a component from a status page. - [Delete Status Page Component Group](https://docs.uptimeify.io/api/status-pages/delete-status-page-component-group): Deletes a component group; its components stay on the page without a group. - [Delete Status Page Maintenance](https://docs.uptimeify.io/api/status-pages/delete-status-page-maintenance): Deletes a maintenance from every page and the feed. - [Delete Status Page Template](https://docs.uptimeify.io/api/status-pages/delete-status-page-template): Deletes a template. Incidents created from it stay as they are. - [Delete Status Page Subscriber](https://docs.uptimeify.io/api/status-pages/delete-subscriber): Permanently deletes a subscriber and its stored consent evidence. Organization-wide: admin or editor; customer-bound: by the page's ownership class. - [Export Subscribers of All Status Pages](https://docs.uptimeify.io/api/status-pages/export-all-subscribers): Downloads the subscribers of the status pages you select as CSV, with the same filters as the list. Organization-wide: admin or editor; customer-bound: the pages you may maintain. - [Export Status Page Subscribers](https://docs.uptimeify.io/api/status-pages/export-subscribers): Downloads every subscriber of a status page as CSV. Organization-wide: admin or editor; customer-bound: by the page's ownership class. - [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](https://docs.uptimeify.io/api/status-pages/get-status-page): Returns one status page by numeric id or publicId, in the same shape as an entry of List Status Pages. - [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 the role `admin`, `editor` or `readonly`. - [Get Status Page Domain](https://docs.uptimeify.io/api/status-pages/get-status-page-domain): Returns one status-page custom domain of your organization, in the same { domain, dns } shape as Add Status Page Domain. - [Status Page Domain Diagnostics](https://docs.uptimeify.io/api/status-pages/get-status-page-domain-diagnostics): Live DNS and certificate check of one status-page custom domain: authoritative nameservers, TXT record seen, propagation, certificate state, last failed verification. - [Get Status Page Maintenance](https://docs.uptimeify.io/api/status-pages/get-status-page-maintenance): Returns one scheduled maintenance with its pages, components and updates. - [Get Status Page Module](https://docs.uptimeify.io/api/status-pages/get-status-page-module): Returns whether the status pages module is enabled for your organization. - [Get Status Page Template](https://docs.uptimeify.io/api/status-pages/get-status-page-template): Returns one template. - [List Subscribers of All Status Pages](https://docs.uptimeify.io/api/status-pages/list-all-subscribers): Returns the subscribers of every status page you may manage in one paged list, with filters. Organization-wide: admin or editor; customer-bound: the pages you may maintain. - [List Status Page Component Groups](https://docs.uptimeify.io/api/status-pages/list-status-page-component-groups): Returns every component group of a status page, ordered by sort. - [List Status Page Components](https://docs.uptimeify.io/api/status-pages/list-status-page-components): Returns every component of a status page, ordered by sort. - [List Status Page Maintenance](https://docs.uptimeify.io/api/status-pages/list-status-page-maintenance): Lists the scheduled maintenance of your status pages. - [List Status Page Templates](https://docs.uptimeify.io/api/status-pages/list-status-page-templates): Lists the incident and update templates of your organization. - [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. - [List Status Page Subscribers](https://docs.uptimeify.io/api/status-pages/list-subscribers): Returns the email and RSS subscribers of a status page, plus exact counts by status. Organization-wide: admin or editor; customer-bound: by the page's ownership class. - [Post Status Page Maintenance Update](https://docs.uptimeify.io/api/status-pages/post-status-page-maintenance-update): Publishes an update to a maintenance on the page and to subscribers. - [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. Organization-wide: admin or editor; customer-bound: by the page's ownership class. - [Reorder Status Page Components](https://docs.uptimeify.io/api/status-pages/reorder-status-page-components): Sets position and group of many components in one call. - [Subscribe to a Status Page](https://docs.uptimeify.io/api/status-pages/subscribe-to-status-page): Public endpoint behind the subscribe form: email, SMS, browser push, webhook, Slack or Microsoft Teams, for the whole page or selected components. Double opt-in for every channel. - [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 the role `admin` or `editor`; customer-bound users and tokens (also `readonly`) update self-service pages of their customers. - [Update Status Page Component](https://docs.uptimeify.io/api/status-pages/update-status-page-component): Changes name, description, group, position, uptime bar, manual state or monitor of a component. - [Update Status Page Component Group](https://docs.uptimeify.io/api/status-pages/update-status-page-component-group): Renames, moves or collapses a component group. - [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 the role `admin` or `editor`; `readonly` can read the design but not change it. - [Update Status Page Maintenance](https://docs.uptimeify.io/api/status-pages/update-status-page-maintenance): Changes, reschedules or extends a maintenance. - [Update Status Page Template](https://docs.uptimeify.io/api/status-pages/update-status-page-template): Changes fields of a template; null clears an optional field. - [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. Organization-wide: admin only; customer-bound: by the page's ownership class. - [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. - [Get Tag](https://docs.uptimeify.io/api/tags/get-tag): Returns one tag by numeric id or publicId, in the same shape as an entry of List Tags. - [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. - [Change User Email](https://docs.uptimeify.io/api/users/change-email): Starts a change of another user's sign-in email. It takes effect once the user confirms it from the new address. - [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 single user the caller is allowed to see. - [List Users](https://docs.uptimeify.io/api/users/list-users): Lists the users of the organization that the caller is allowed to see. - [Reset User MFA](https://docs.uptimeify.io/api/users/reset-mfa): Clears another user's two-step verification, so they can set it up again from scratch. - [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. - [Rotate Heartbeat Token](https://docs.uptimeify.io/api/websites/rotate-heartbeat-token): Generates a new heartbeat token; the old one stops working immediately. - [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 Branding Asset](https://docs.uptimeify.io/api/whitelabel/delete-branding-asset): Removes an uploaded logo or favicon. Requires admin role; works with API tokens. - [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. - [Get Domain](https://docs.uptimeify.io/api/whitelabel/get-domain): Returns one custom app domain of your organization, in the same { domain, dns } shape as Add Domain. Requires the admin role. - [Domain Diagnostics](https://docs.uptimeify.io/api/whitelabel/get-domain-diagnostics): Live DNS and certificate check of one custom app domain: authoritative nameservers, TXT record seen, propagation, certificate state, last failed verification. Requires the 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. ## Incident Management - [Incident Management](https://docs.uptimeify.io/incident-management): How Incident Management works: alert sources, routing, teams, on-call schedules, escalation, notifications, status pages and reports, and how to set it up. ## 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. - [Single sign-on (OIDC and SAML)](https://docs.uptimeify.io/integrations/sso): Let your team sign in through your own identity provider (Keycloak, Microsoft Entra ID, ADFS, Google Workspace, Okta, Authentik) over OIDC or SAML 2.0 with automatic account creation and optional SSO-only enforcement. - [Webhook payload reference](https://docs.uptimeify.io/integrations/webhooks): The exact JSON Uptimeify POSTs to a generic webhook channel, the request headers it sends, and how to verify the HMAC signature. ## 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. - [Incident Management](https://docs.uptimeify.io/monitoring/incident-management): Incident Management (IM) is Uptimeify's on-call and incident-response layer: teams, on-call schedules, escalation policies, and alert ingestion from your own tools, separate from customer-facing Monitoring. - [Policies](https://docs.uptimeify.io/monitoring/incident-management/policies): An escalation policy is the ordered set of tiers that decides who gets paged when an incident opens, how many times, and when to move to the next tier. - [Quota & Overage](https://docs.uptimeify.io/monitoring/incident-management/quota-and-overage): SMS and voice paging in Incident Management draw on the same monthly quota as your customer-facing SMS alerts. Here's exactly what happens when it runs out. - [Retention](https://docs.uptimeify.io/monitoring/incident-management/retention): How long Incident Management keeps raw alert payloads, resolved alerts, outbound-delivery records and the incidents themselves, and what's kept indefinitely. - [Schedules](https://docs.uptimeify.io/monitoring/incident-management/schedules): A schedule defines a team's on-call rotation (who covers it, and when) plus one-off overrides for swaps and time off. - [Severity](https://docs.uptimeify.io/monitoring/incident-management/severity): Incident Management uses a four-level sev1-sev4 scale that drives paging urgency, escalation speed, and which notification rule chain fires. - [Teams](https://docs.uptimeify.io/monitoring/incident-management/teams): A team is Incident Management's top-level ownership unit, every schedule, escalation policy, and incident belongs to exactly one team. - [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. deinkunde.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. - [TCP Port Monitor](https://docs.uptimeify.io/monitoring/monitoring-types/tcp-port): The TCP Port Monitor checks whether a raw TCP port is open and accepting connections. It is commonly used for databases, caches, message queues, and other non-HTTP services that don't speak a protocol we have a dedicated monitor for. - [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.deinkunde.com). - [Custom Domains](https://docs.uptimeify.io/status-pages/custom-domains): Connect a hostname like status.deinkunde.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. ## Terraform - [Terraform & OpenTofu](https://docs.uptimeify.io/terraform): Manage monitors, incident management, status pages and users as code with the Uptimeify provider for OpenTofu and Terraform. - [Customer tokens](https://docs.uptimeify.io/terraform/customer-tokens): Run one OpenTofu or Terraform configuration per client, each with its own customer-scoped API token and provider alias. - [uptimeify_custom_field](https://docs.uptimeify.io/terraform/data-sources/custom_field): Look up one active custom field by id or by field_key (exactly one). - [uptimeify_customer](https://docs.uptimeify.io/terraform/data-sources/customer): Look up one customer by id or by name (exactly one). Fails when no or several visible customers carry the name. - [uptimeify_dns_monitor](https://docs.uptimeify.io/terraform/data-sources/dns_monitor): Look up one DNS monitor by numeric id or public id. Secrets are never readable. - [uptimeify_ftp_monitor](https://docs.uptimeify.io/terraform/data-sources/ftp_monitor): Look up one FTP monitor by numeric id or public id. Secrets are never readable. - [uptimeify_icmp_monitor](https://docs.uptimeify.io/terraform/data-sources/icmp_monitor): Look up one ICMP monitor by numeric id or public id. Secrets are never readable. - [uptimeify_im_alert_source](https://docs.uptimeify.io/terraform/data-sources/im_alert_source): Look up one Incident Management alert source by id or by name (exactly one). Fails when no or several sources match the name. Tokens and secrets are never returned. - [uptimeify_im_channel](https://docs.uptimeify.io/terraform/data-sources/im_channel): Look up one Incident Management paging channel by id or by name (exactly one). Fails when no or several channels match the name. Secrets are never returned. - [uptimeify_im_on_call](https://docs.uptimeify.io/terraform/data-sources/im_on_call): Who is on call right now (read at plan time, so it changes between runs). Incident Management must be active for the organization. - [uptimeify_im_outbound_integration](https://docs.uptimeify.io/terraform/data-sources/im_outbound_integration): Look up one Incident Management outbound integration by id or by name (exactly one). Fails when no or several integrations match the name. Secrets are never returned. - [uptimeify_im_routing_rule](https://docs.uptimeify.io/terraform/data-sources/im_routing_rule): Read one Incident Management routing rule by id. - [uptimeify_im_schedule](https://docs.uptimeify.io/terraform/data-sources/im_schedule): Look up one on-call schedule by id or by name (exactly one). The default schedules of different teams can share a name (Tier 1 schedule), so team_id narrows a lookup by name. Fails when no or several schedules match. - [uptimeify_im_statuspage_rule](https://docs.uptimeify.io/terraform/data-sources/im_statuspage_rule): Look up one Incident Management status page rule by numeric id. - [uptimeify_im_team](https://docs.uptimeify.io/terraform/data-sources/im_team): Look up one Incident Management team by id or by name (exactly one). Fails when no or several teams match the name. - [uptimeify_imap_pop_monitor](https://docs.uptimeify.io/terraform/data-sources/imap_pop_monitor): Look up one IMAP/POP3 monitor by numeric id or public id. Secrets are never readable. - [uptimeify_maintenance_window](https://docs.uptimeify.io/terraform/data-sources/maintenance_window): Look up one maintenance window by id. - [uptimeify_monitoring_locations](https://docs.uptimeify.io/terraform/data-sources/monitoring_locations): Countries with at least one active check worker. Use country_codes for allowed_check_country_codes. - [uptimeify_notification_channel](https://docs.uptimeify.io/terraform/data-sources/notification_channel): Look up one notification channel by id or by name (exactly one). Fails when no or several channels carry the name. Secrets are never returned (see secrets_set). Website overrides are not found by name. - [uptimeify_organization](https://docs.uptimeify.io/terraform/data-sources/organization): The token's own organization (GET /api/organization). Billing, address, quota and MFA fields are only filled for admin tokens. - [uptimeify_package_configs](https://docs.uptimeify.io/terraform/data-sources/package_configs): The organization's package configurations (GET /api/package-configs): limits, checks and alert defaults per package type, e.g. to look up the package_type of a customer. - [uptimeify_smtp_monitor](https://docs.uptimeify.io/terraform/data-sources/smtp_monitor): Look up one SMTP monitor by numeric id or public id. Secrets are never readable. - [uptimeify_ssh_monitor](https://docs.uptimeify.io/terraform/data-sources/ssh_monitor): Look up one SSH monitor by numeric id or public id. Secrets are never readable. - [uptimeify_status_page](https://docs.uptimeify.io/terraform/data-sources/status_page): Look up one status page by id, slug or name (exactly one). Fails when no or several visible pages carry the name. - [uptimeify_tag](https://docs.uptimeify.io/terraform/data-sources/tag): Look up one tag by id or by name (exactly one). Fails when no or several visible tags match the name. - [uptimeify_tcp_monitor](https://docs.uptimeify.io/terraform/data-sources/tcp_monitor): Look up one TCP monitor by numeric id or public id. Secrets are never readable. - [uptimeify_user](https://docs.uptimeify.io/terraform/data-sources/user): Look up one login of the organization by email (case-insensitive), e.g. for team members and rotations. - [uptimeify_website](https://docs.uptimeify.io/terraform/data-sources/website): Read one website monitor by id. Secrets (headers, body, auth secrets) are never returned. - [Getting started](https://docs.uptimeify.io/terraform/getting-started): Install the Uptimeify provider, authenticate with an API token and create your first website monitor with OpenTofu or Terraform. - [Import existing setup](https://docs.uptimeify.io/terraform/import): Bring monitors, status pages and incident management you created in the dashboard under OpenTofu or Terraform with import. - [uptimeify_custom_field](https://docs.uptimeify.io/terraform/resources/custom_field): A custom field of the customer master data (organization token with write access). The API never deletes a field: destroying it deactivates it, and creating a field whose field_key belongs to a deactivated one reactivates that field (same id) with the configured values, so customer values stored under the key come back. An active field with the key answers 409; import it instead. A field deactivated outside Terraform counts as gone. Import with the numeric id. - [uptimeify_customer](https://docs.uptimeify.io/terraform/resources/customer): A customer of the organization. Needs an organization token with write access (customer tokens cannot create customers). Destroying it deletes the customer with its monitors and history. Import with the numeric id or the public id. delete_user_action cannot be read back; the permission overrides are read back only with a token that may write them, otherwise they stay unset after an import. - [uptimeify_customer_domain](https://docs.uptimeify.io/terraform/resources/customer_domain): A domain of a customer whose registration expiry is watched over RDAP. The top-level domain must support RDAP. Creating one that already exists with the same values fails; import it instead. Import with the numeric id or the public id. - [uptimeify_customer_ip](https://docs.uptimeify.io/terraform/resources/customer_ip): An IP address of a customer, checked against DNS blocklists (DNSBL). Creating one that already exists with the same values fails; import it instead. Import with the numeric id or the public id. - [uptimeify_dns_monitor](https://docs.uptimeify.io/terraform/resources/dns_monitor): A DNS monitor: resolves hostname and compares the answers per record type with expected_values. Import with the numeric id or the public id. - [uptimeify_escalation_config](https://docs.uptimeify.io/terraform/resources/escalation_config): The organization's escalation webhook (one per organization; organization token with write access). Creating it adopts the stored configuration and applies the configured values. The webhook URL also drives the organization webhook channel (Organization Webhook), so do not manage that channel as uptimeify_notification_channel too. Destroying it sets is_active = false and clears the URL, which deactivates the organization-level webhook channels; the row stays. Import with the organization id. - [uptimeify_ftp_monitor](https://docs.uptimeify.io/terraform/resources/ftp_monitor): An FTP monitor: logs in (check_mode protocol) or only checks the port (tcp). The hostname must resolve to a public address. Import with the numeric id or the public id. - [uptimeify_icmp_monitor](https://docs.uptimeify.io/terraform/resources/icmp_monitor): An ICMP (ping) monitor. The hostname must resolve to a public address when it is set. Import with the numeric id or the public id. - [uptimeify_im_alert_source](https://docs.uptimeify.io/terraform/resources/im_alert_source): An Incident Management alert source (inbound integration). Incident Management must be active for the organization. Import with the numeric id; the server-minted tokens are shown by the API only once and are therefore null after an import until rotated. - [uptimeify_im_channel](https://docs.uptimeify.io/terraform/resources/im_channel): An Incident Management paging channel (Slack incoming webhook, generic webhook or email). Escalation tiers and the organization fallback page through it. Incident Management must be active for the organization. The webhook URL and header values are secrets: the API never returns them, so they are write-only here. Import with the numeric id. - [uptimeify_im_escalation_tier](https://docs.uptimeify.io/terraform/resources/im_escalation_tier): An escalation tier of an Incident Management team. Creating a tier also creates its default schedule (default_schedule_id, rotation mode none) whose single rotation is member_user_ids; further schedules of the tier are uptimeify_im_schedule. Import with /. - [uptimeify_im_org_settings](https://docs.uptimeify.io/terraform/resources/im_org_settings): Incident Management settings of the token's organization (one per organization). Creating it adopts the existing settings and applies the configured values; destroying it only removes it from the state, the settings stay. Import with any id, e.g. org. - [uptimeify_im_outbound_integration](https://docs.uptimeify.io/terraform/resources/im_outbound_integration): An Incident Management outbound integration: forwards incident events to Slack, Microsoft Teams, Discord, Jira, PagerDuty (Events v2), Opsgenie or a generic webhook. Incident Management must be active for the organization. URLs, tokens, keys and header values are secrets the API never returns, so they are write-only here; has_* tells whether one is stored. Import with the numeric id. - [uptimeify_im_routing_rule](https://docs.uptimeify.io/terraform/resources/im_routing_rule): An Incident Management routing rule: incidents whose alert matches go to team_id. Rules run in ascending priority. Incident Management must be active for the organization. Import with the numeric id. - [uptimeify_im_schedule](https://docs.uptimeify.io/terraform/resources/im_schedule): An on-call schedule on an escalation tier (created via POST /api/im/tiers/{tierId}/schedules). Rotation members must be members of the tier's team. The tier's own default schedule belongs to uptimeify_im_escalation_tier. Import with the numeric schedule id. - [uptimeify_im_schedule_override](https://docs.uptimeify.io/terraform/resources/im_schedule_override): An override (vacation, swap) on an on-call schedule. Import with /. - [uptimeify_im_service](https://docs.uptimeify.io/terraform/resources/im_service): A service of the Incident Management service catalog (\"Webshop\", \"Customer portal\") with its criticality, the responsible team and its monitors. An incident of a monitor that belongs to exactly one service is linked to that service. Needs an organization token of an organization admin. Import with the numeric id or the public id. - [uptimeify_im_statuspage_rule](https://docs.uptimeify.io/terraform/resources/im_statuspage_rule): An Incident Management status page rule: incidents of team_id at min_severity or worse set the status page to target_state. Needs team-admin rights on the team (or organization admin). Manual overrides (POST /api/im/statuspage-rules/override) are an incident-time action and not managed by Terraform. Import with the numeric id. - [uptimeify_im_team](https://docs.uptimeify.io/terraform/resources/im_team): An Incident Management team. Needs Incident Management activated for the organization. Members, escalation tiers and schedules are separate resources. Import with the numeric id. - [uptimeify_im_team_member](https://docs.uptimeify.io/terraform/resources/im_team_member): A member of an Incident Management team. Set user_id for an existing login (admin, editor or responder of the organization), or invite_email to invite by email (an unknown address gets a new account and an invitation mail). Import with /. - [uptimeify_im_team_override](https://docs.uptimeify.io/terraform/resources/im_team_override): An override (vacation, swap) owned by an Incident Management team, optionally on one of its schedules. Import with /. - [uptimeify_imap_pop_monitor](https://docs.uptimeify.io/terraform/resources/imap_pop_monitor): An IMAP or POP3 monitor: logs in (check_mode protocol) or only checks the port (tcp, needs port). The hostname must resolve to a public address. Import with the numeric id or the public id. - [uptimeify_maintenance_window](https://docs.uptimeify.io/terraform/resources/maintenance_window): A maintenance window: alerts and incidents of its targets are suppressed while it runs. Set targets and/or tag_ids, or customer_id alone for the whole customer. A window with only organization-wide tags applies organization-wide. Import with the numeric id or the public id. - [uptimeify_monitor_tag](https://docs.uptimeify.io/terraform/resources/monitor_tag): Puts one tag on one monitor. A monitor carries at most 5 tags. Import with //. - [uptimeify_notification_channel](https://docs.uptimeify.io/terraform/resources/notification_channel): A notification channel of the organization, or of one customer with customer_id. Secrets live in secret_config_wo and never enter the state. An active channel to the same recipient cannot exist twice (409). Website overrides are not managed here. Import with the numeric id. - [uptimeify_notification_template](https://docs.uptimeify.io/terraform/resources/notification_template): The organization's default Incident Management notification chain (one per organization). It is copied to a user when their personal settings are first created; existing users keep theirs. Destroying switches the template off. Import with any id, e.g. org. - [uptimeify_organization_branding](https://docs.uptimeify.io/terraform/resources/organization_branding): White-label branding of the organization (one per organization): product name, colors, legal links, logos and favicons. Organization admins only. Destroying it resets name, colors, links and both flags and deletes the four images. Import with any id, e.g. branding; the image files are not imported. - [uptimeify_organization_settings](https://docs.uptimeify.io/terraform/resources/organization_settings): Settings of the token's own organization (one per organization): name, billing address, MFA policy, SMS overage cap and notification defaults for new customers. Only the attributes you set are managed and sent, and only when they differ from the stored value. Creating it adopts the organization; destroying it only removes it from the state, nothing is reset. Plan, quota and payment are not managed here. Import with any id, e.g. org. - [uptimeify_package_config](https://docs.uptimeify.io/terraform/resources/package_config): One package of the organization, addressed by its package_type (PATCH /api/package-configs/{packageType}). Manages the limits only: monitors, status pages and self-service per customer of the package. The check and alert defaults of the package stay as they are (the server's defaults for a new package); read them with data.uptimeify_package_configs. Its enable_*_alerts switches govern only the organization's notifications about the package's customers (organization channels and the organization recipient of the email/SMS fallback), never channels a customer created in their own account; a customer's own enable_*_alerts value replaces them for that customer. SMS through a customer's own channels still counts against the package's monthly SMS limit per customer and the organization's overage limit (0 while the package SMS switch is off and no limit is set). If the package already exists, creating the resource adopts it. Destroy deletes the package and fails (packageInUse) while customers use it. Import with the package type. - [uptimeify_report](https://docs.uptimeify.io/terraform/resources/report): A scheduled fleet report of the organization (mail, optionally with PDF). Unset optional attributes take the server default on create and keep their value afterwards. Import with the report id (UUID). - [uptimeify_smtp_monitor](https://docs.uptimeify.io/terraform/resources/smtp_monitor): An SMTP monitor: connects and authenticates (check_mode protocol) or only checks the port (tcp). The hostname must resolve to a public address. Import with the numeric id or the public id. - [uptimeify_smtp_settings](https://docs.uptimeify.io/terraform/resources/smtp_settings): The organization's own SMTP server for outgoing mail (one per organization). Destroying it switches back to platform sending (disable). The host must resolve to a public address. Organization admins only. Import with any id, e.g. smtp; the password is not imported. - [uptimeify_ssh_monitor](https://docs.uptimeify.io/terraform/resources/ssh_monitor): An SSH monitor: logs in (check_mode protocol) or only checks the port (tcp). The hostname must resolve to a public address. Import with the numeric id or the public id. - [uptimeify_sso_domain_verification](https://docs.uptimeify.io/terraform/resources/sso_domain_verification): Verifies the SSO domain's DNS TXT record once (POST /api/organization/sso/verify-domain). Create fails with the expected and the found TXT values when the record is not visible yet; publish uptimeify_sso_oidc.verification_record and apply again. There is no waiting or retrying. Needs an organization admin token. Set domain = uptimeify_sso_oidc..domain, so a new domain verifies again in the same apply. A new issuer also resets the verification: the next plan shows this resource again. Destroying it changes nothing in Uptimeify. Import with the id sso. - [uptimeify_sso_oidc](https://docs.uptimeify.io/terraform/resources/sso_oidc): Single sign-on of the organization with an OpenID Connect identity provider (PUT /api/organization/sso). One per organization; needs an organization admin token. Saving runs the issuer's discovery, so the issuer must be reachable over HTTPS from Uptimeify. Register the client at your identity provider with redirect_uri and the scopes (both known before the first apply, see GET /api/organization/sso). Prove the domain with the DNS TXT record verification_record and uptimeify_sso_domain_verification. A new domain or issuer resets the verification, the first login and enforce_sso. Destroying it removes SSO. A SAML configuration is not managed here: it reads as gone, and an apply replaces it with OIDC. Import with the id sso. - [uptimeify_status_page](https://docs.uptimeify.io/terraform/resources/status_page): A status page of one customer, or of the whole organization without customer_id. It shows its explicit components (uptimeify_status_page_component, the allowlist) and, only with include_customer_monitors, also every monitor of the customer except hidden_monitors. Design, audience groups, custom domain and IM rules are separate resources (uptimeify_status_page_design, uptimeify_status_page_audience_groups, uptimeify_status_page_domain, uptimeify_im_statuspage_rule). Deleting the page also deletes its custom domain. Import with the numeric id or the public id. - [uptimeify_status_page_audience_groups](https://docs.uptimeify.io/terraform/resources/status_page_audience_groups): The audience groups of one status page (one resource per page): a component listed in a group is shown only to visitors signed in with a verified email address of one of the group's domains, and to editors of the page; components in no group stay visible to everyone who may view the page. A page with groups has no badge, widget, feeds or subscriptions. Destroying the resource removes all groups. Import with the numeric status page id. - [uptimeify_status_page_component](https://docs.uptimeify.io/terraform/resources/status_page_component): One component (row) of a status page: a monitor, a manually set status, or a third-party provider (dependency) whose published status it follows. At most 500 per page. Import with /. - [uptimeify_status_page_component_group](https://docs.uptimeify.io/terraform/resources/status_page_component_group): A group of status page components (set group_id on uptimeify_status_page_component). Destroying a group keeps its components, ungrouped. Import with /. - [uptimeify_status_page_design](https://docs.uptimeify.io/terraform/resources/status_page_design): The design of one status page (one per page). Unset arguments keep their current value; removing an argument from the configuration does not reset it. Destroying the resource resets the whole design to the defaults. Every option with examples: Status page design https://docs.uptimeify.io/status-pages/design. Import with the numeric status page id. - [uptimeify_status_page_domain](https://docs.uptimeify.io/terraform/resources/status_page_domain): A custom domain of a status page (at most one per page). Creating it registers the hostname as pending; nothing is verified or activated here. To go live: Publish the TXT record verification_record.name with the value verification_record.value in your DNS zone, and point the hostname (CNAME) at your Uptimeify status page host.Verify and activate: uptimeify_status_page_domain_activation (runs verify + activate once), or POST /api/status-pages/domains/verify and .../activate with {\"domainId\": }. status is read from the API: pending, verified or active. Deleting the status page deletes its domain. Import with the numeric domain id. - [uptimeify_status_page_domain_activation](https://docs.uptimeify.io/terraform/resources/status_page_domain_activation): Verifies a status page domain's DNS TXT record and activates the domain, once. Create fails with the API's answer when the TXT record is not visible yet; publish it (see uptimeify_status_page_domain) and apply again. There is no waiting or retrying. Needs an organization admin token. When the domain is no longer active (e.g. a later re-verification failed), the next plan runs verify + activate again. Destroying this resource does not deactivate the domain; destroy the uptimeify_status_page_domain for that. Import with the domain id. - [uptimeify_status_page_maintenance](https://docs.uptimeify.io/terraform/resources/status_page_maintenance): A planned maintenance announced on one or more status pages, optionally for some of their components. It starts and ends by itself at scheduled_for/scheduled_until and notifies subscribers as configured; creating it announces it right away when notify_on_schedule is true. It does not silence monitor alerts (that is uptimeify_maintenance_window). Ending a running maintenance early and cancelling an upcoming one are lifecycle actions outside this resource (dashboard, API or MCP); a cancelled maintenance refuses further changes, so change the configuration only after removing or replacing it. Import with the numeric id or the public id. - [uptimeify_tag](https://docs.uptimeify.io/terraform/resources/tag): A tag that groups monitors. Import with the numeric id or the public id. - [uptimeify_tcp_monitor](https://docs.uptimeify.io/terraform/resources/tcp_monitor): A TCP monitor: connects to hostname:port, optionally expecting a banner. The hostname must resolve to a public address when it is set. Import with the numeric id or the public id. - [uptimeify_user](https://docs.uptimeify.io/terraform/resources/user): A login of the organization. Creating it sends an invitation mail; the person sets their own password (Terraform never sets one). Destroying it deletes the login. Needs an organization admin token. Import with the user id. - [uptimeify_user_notification_settings](https://docs.uptimeify.io/terraform/resources/user_notification_settings): Personal Incident Management notification settings of one user of the organization, set by an organization admin (PUT /api/im/users/{userId}/notification-settings). The last write wins: the user can change them afterwards, which shows up as drift. Destroying only removes them from the state, the user keeps the chain. Import with the user id. - [uptimeify_website](https://docs.uptimeify.io/terraform/resources/website): A website monitor: HTTP(S) check (combined, http_status, ssl_check) or heartbeat (heartbeat, the monitored system pings Uptimeify). Import with the numeric id or the public id. Updates use the partial mode of PATCH /api/websites/{id} whenever every changed field is one that mode accepts (name, url, status, interval, timeout, checks, keyword, expected response, connect target, SSL/domain days, page sizes, grace period). Changes to the customer, countries, HTTP method, redirects, cookies, auth or the write-only secrets need the full mode, which resets omitted fields to defaults, so the provider then sends every attribute and re-applies any value the full mode coerced (ssl_error_days = 0, min_page_size = 0) with a partial PATCH. Secrets (custom headers, request body, authorization header, basic auth password) are write-only: the API never returns them. Bump the matching *_wo_version to send changed values. - [uptimeify_whitelabel_domain](https://docs.uptimeify.io/terraform/resources/whitelabel_domain): A custom app domain (white label) of the organization. Terraform creates it as pending and outputs the DNS TXT record that proves control. Verifying and activating are one-off actions, not managed here: POST /api/organization/whitelabel/domains/verify with { \"domainId\": } once the record is live, then POST /api/organization/whitelabel/domains/activate (optionally makePrimary). Organization admins only. Import with the numeric id. - [Secrets and updates](https://docs.uptimeify.io/terraform/secrets-and-updates): How the Uptimeify provider keeps secrets out of state, how package limits show up in plan and apply, and how updates reach the API.