UptimeRobot is a website and API monitoring service that tracks the availability of servers, endpoints, and heartbeat checks, alerting you when something goes down. It supports HTTP, keyword, ping, port, heartbeat, DNS, API, and UDP monitors, and can publish public status pages to keep users informed during incidents.
With UptimeRobot, you can:
Monitor uptime : Create, update, pause, resume, and delete monitors across multiple check typesTrack incidents : List and inspect incidents, including root cause details like HTTP response codesSchedule maintenance windows : Suppress alerts during planned downtime, with one-time or recurring schedulesManage alert contacts : Create, retrieve, and delete email alert contacts for notificationsPublish status pages : Create and update public status pages, optionally with a custom domain, logo, and icon
In Sim, the UptimeRobot integration allows your agents to check monitor status, list and investigate incidents, create or update monitors and maintenance windows, manage alert contacts, and publish status pages—all through the UptimeRobot v3 API. This enables workflows that react to downtime, automate incident triage, schedule maintenance around deployments, and keep public status pages current without manual intervention.
Integrate UptimeRobot into your workflow. Create and manage monitors, inspect incidents, schedule maintenance windows, manage alert contacts, and publish public status pages using the UptimeRobot v3 API.
List monitors in your UptimeRobot account, with optional filters and pagination
Parameter Type Required Description apiKeystring Yes UptimeRobot API key limitnumber No Number of monitors per page (1-200, default 50) statusstring No Comma-separated statuses to filter by (PAUSED, STARTED, UP, LOOKS_DOWN, DOWN) namestring No Partial friendly-name filter urlstring No Partial URL filter tagsstring No Comma-separated tags to filter by (case-sensitive, OR logic) groupIdnumber No Monitor group ID to filter by cursornumber No Pagination cursor returned by a previous request
Parameter Type Description monitorsarray List of monitors ↳ id number Monitor ID ↳ friendlyName string Friendly name of the monitor ↳ url string Monitored URL or host ↳ type string Monitor type (HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, UDP) ↳ status string Current status (UP, DOWN, PAUSED, etc.) ↳ interval number Check interval in seconds ↳ timeout number Check timeout in seconds ↳ port number Port for Port/UDP monitors ↳ keywordType string Keyword match type for Keyword monitors ↳ keywordValue string Keyword to match for Keyword monitors ↳ httpMethodType string HTTP method used for the check ↳ authType string HTTP authentication method ↳ successHttpResponseCodes array HTTP response codes treated as success ↳ checkSSLErrors boolean Whether SSL/domain expiration errors are checked ↳ followRedirections boolean Whether redirects are followed ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled ↳ domainExpirationReminder boolean Whether domain expiration reminders are enabled ↳ responseTimeThreshold number Response time threshold in milliseconds ↳ currentStateDuration number Seconds spent in the current state ↳ lastIncidentId string ID of the most recent incident ↳ groupId number Monitor group ID (0 if ungrouped) ↳ createDateTime string When the monitor was created ↳ tags array Tags assigned to the monitor ↳ id number Tag ID ↳ name string Tag name ↳ color string Tag color ↳ assignedAlertContacts array Alert contacts assigned to the monitor ↳ alertContactId number Alert contact ID ↳ threshold number Notification delay threshold in minutes ↳ recurrence number Repeat notification interval in minutes ↳ lastIncident object Details of the most recent incident ↳ id string Incident ID ↳ status string Incident status ↳ cause number Incident cause code ↳ reason string Incident reason ↳ startedAt string When the incident started ↳ duration number Incident duration in seconds nextLinkstring URL for the next page of results, or null on the last page
Get the details of a single UptimeRobot monitor by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key monitorIdnumber Yes ID of the monitor to retrieve
Parameter Type Description monitorobject The monitor details ↳ id number Monitor ID ↳ friendlyName string Friendly name of the monitor ↳ url string Monitored URL or host ↳ type string Monitor type (HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, UDP) ↳ status string Current status (UP, DOWN, PAUSED, etc.) ↳ interval number Check interval in seconds ↳ timeout number Check timeout in seconds ↳ port number Port for Port/UDP monitors ↳ keywordType string Keyword match type for Keyword monitors ↳ keywordValue string Keyword to match for Keyword monitors ↳ httpMethodType string HTTP method used for the check ↳ authType string HTTP authentication method ↳ successHttpResponseCodes array HTTP response codes treated as success ↳ checkSSLErrors boolean Whether SSL/domain expiration errors are checked ↳ followRedirections boolean Whether redirects are followed ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled ↳ domainExpirationReminder boolean Whether domain expiration reminders are enabled ↳ responseTimeThreshold number Response time threshold in milliseconds ↳ currentStateDuration number Seconds spent in the current state ↳ lastIncidentId string ID of the most recent incident ↳ groupId number Monitor group ID (0 if ungrouped) ↳ createDateTime string When the monitor was created ↳ tags array Tags assigned to the monitor ↳ id number Tag ID ↳ name string Tag name ↳ color string Tag color ↳ assignedAlertContacts array Alert contacts assigned to the monitor ↳ alertContactId number Alert contact ID ↳ threshold number Notification delay threshold in minutes ↳ recurrence number Repeat notification interval in minutes ↳ lastIncident object Details of the most recent incident ↳ id string Incident ID ↳ status string Incident status ↳ cause number Incident cause code ↳ reason string Incident reason ↳ startedAt string When the incident started ↳ duration number Incident duration in seconds
Create a new monitor in UptimeRobot
Parameter Type Required Description apiKeystring Yes UptimeRobot API key friendlyNamestring Yes Friendly name of the monitor typestring Yes Monitor type: HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, or UDP urlstring No URL or host to monitor (not required for Heartbeat monitors) intervalnumber Yes Check interval in seconds (minimum 30) checkTimeoutnumber No Check timeout in seconds, 0-60 (HTTP, Keyword and Port monitors only) portnumber No Port to check, 1-65535 (required for Port and UDP monitors) keywordTypestring No Keyword match type for Keyword monitors: ALERT_EXISTS or ALERT_NOT_EXISTS keywordValuestring No Keyword to look for (Keyword monitors only) keywordCaseTypenumber No Keyword case sensitivity: 0 (case-sensitive) or 1 (case-insensitive) httpMethodTypestring No HTTP method: HEAD, GET, POST, PUT, PATCH, DELETE, or OPTIONS (defaults to HEAD) authTypestring No HTTP authentication: NONE, HTTP_BASIC, DIGEST, or BEARER httpUsernamestring No Username for HTTP authentication httpPasswordstring No Password for HTTP authentication gracePeriodnumber No Grace period in seconds, 0-86400 (Heartbeat monitors only) successHttpResponseCodesstring No Comma-separated success HTTP response codes (e.g. "2xx,3xx") checkSSLErrorsboolean No Whether to check for SSL and domain expiration errors followRedirectionsboolean No Whether to follow redirects sslExpirationReminderboolean No Whether to send SSL certificate expiration reminders domainExpirationReminderboolean No Whether to send domain expiration reminders responseTimeThresholdnumber No Response time threshold in milliseconds, 0-60000 tagNamesstring No Comma-separated tag names to assign to the monitor assignedAlertContactsstring No JSON array of alert-contact assignments, e.g. [{"alertContactId":123,"threshold":0,"recurrence":0}] customHttpHeadersstring No JSON object of custom HTTP headers to send with the request groupIdnumber No Monitor group ID to assign the monitor to (0 for no group)
Parameter Type Description monitorobject The created monitor ↳ id number Monitor ID ↳ friendlyName string Friendly name of the monitor ↳ url string Monitored URL or host ↳ type string Monitor type (HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, UDP) ↳ status string Current status (UP, DOWN, PAUSED, etc.) ↳ interval number Check interval in seconds ↳ timeout number Check timeout in seconds ↳ port number Port for Port/UDP monitors ↳ keywordType string Keyword match type for Keyword monitors ↳ keywordValue string Keyword to match for Keyword monitors ↳ httpMethodType string HTTP method used for the check ↳ authType string HTTP authentication method ↳ successHttpResponseCodes array HTTP response codes treated as success ↳ checkSSLErrors boolean Whether SSL/domain expiration errors are checked ↳ followRedirections boolean Whether redirects are followed ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled ↳ domainExpirationReminder boolean Whether domain expiration reminders are enabled ↳ responseTimeThreshold number Response time threshold in milliseconds ↳ currentStateDuration number Seconds spent in the current state ↳ lastIncidentId string ID of the most recent incident ↳ groupId number Monitor group ID (0 if ungrouped) ↳ createDateTime string When the monitor was created ↳ tags array Tags assigned to the monitor ↳ id number Tag ID ↳ name string Tag name ↳ color string Tag color ↳ assignedAlertContacts array Alert contacts assigned to the monitor ↳ alertContactId number Alert contact ID ↳ threshold number Notification delay threshold in minutes ↳ recurrence number Repeat notification interval in minutes ↳ lastIncident object Details of the most recent incident ↳ id string Incident ID ↳ status string Incident status ↳ cause number Incident cause code ↳ reason string Incident reason ↳ startedAt string When the incident started ↳ duration number Incident duration in seconds
Update an existing UptimeRobot monitor. Only the provided fields are changed.
Parameter Type Required Description apiKeystring Yes UptimeRobot API key monitorIdnumber Yes ID of the monitor to update friendlyNamestring No New friendly name urlstring No New URL or host to monitor intervalnumber No New check interval in seconds (minimum 30) checkTimeoutnumber No New check timeout in seconds, 0-60 portnumber No New port, 1-65535 (Port and UDP monitors) keywordTypestring No Keyword match type: ALERT_EXISTS or ALERT_NOT_EXISTS keywordValuestring No New keyword to look for httpMethodTypestring No HTTP method: HEAD, GET, POST, PUT, PATCH, DELETE, or OPTIONS authTypestring No HTTP authentication: NONE, HTTP_BASIC, DIGEST, or BEARER httpUsernamestring No Username for HTTP authentication httpPasswordstring No Password for HTTP authentication successHttpResponseCodesstring No Comma-separated success HTTP response codes (e.g. "2xx,3xx") checkSSLErrorsboolean No Whether to check for SSL and domain expiration errors followRedirectionsboolean No Whether to follow redirects sslExpirationReminderboolean No Whether to send SSL certificate expiration reminders domainExpirationReminderboolean No Whether to send domain expiration reminders responseTimeThresholdnumber No Response time threshold in milliseconds, 0-60000 tagNamesstring No Comma-separated tag names to assign to the monitor assignedAlertContactsstring No JSON array of alert-contact assignments, e.g. [{"alertContactId":123,"threshold":0,"recurrence":0}] customHttpHeadersstring No JSON object of custom HTTP headers to send with the request groupIdnumber No Monitor group ID to assign the monitor to (0 for no group)
Parameter Type Description monitorobject The updated monitor ↳ id number Monitor ID ↳ friendlyName string Friendly name of the monitor ↳ url string Monitored URL or host ↳ type string Monitor type (HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, UDP) ↳ status string Current status (UP, DOWN, PAUSED, etc.) ↳ interval number Check interval in seconds ↳ timeout number Check timeout in seconds ↳ port number Port for Port/UDP monitors ↳ keywordType string Keyword match type for Keyword monitors ↳ keywordValue string Keyword to match for Keyword monitors ↳ httpMethodType string HTTP method used for the check ↳ authType string HTTP authentication method ↳ successHttpResponseCodes array HTTP response codes treated as success ↳ checkSSLErrors boolean Whether SSL/domain expiration errors are checked ↳ followRedirections boolean Whether redirects are followed ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled ↳ domainExpirationReminder boolean Whether domain expiration reminders are enabled ↳ responseTimeThreshold number Response time threshold in milliseconds ↳ currentStateDuration number Seconds spent in the current state ↳ lastIncidentId string ID of the most recent incident ↳ groupId number Monitor group ID (0 if ungrouped) ↳ createDateTime string When the monitor was created ↳ tags array Tags assigned to the monitor ↳ id number Tag ID ↳ name string Tag name ↳ color string Tag color ↳ assignedAlertContacts array Alert contacts assigned to the monitor ↳ alertContactId number Alert contact ID ↳ threshold number Notification delay threshold in minutes ↳ recurrence number Repeat notification interval in minutes ↳ lastIncident object Details of the most recent incident ↳ id string Incident ID ↳ status string Incident status ↳ cause number Incident cause code ↳ reason string Incident reason ↳ startedAt string When the incident started ↳ duration number Incident duration in seconds
Permanently delete an UptimeRobot monitor by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key monitorIdnumber Yes ID of the monitor to delete
Parameter Type Description deletedboolean Whether the monitor was deleted idnumber ID of the deleted monitor
Pause an UptimeRobot monitor so it stops running checks
Parameter Type Required Description apiKeystring Yes UptimeRobot API key monitorIdnumber Yes ID of the monitor to pause
Parameter Type Description monitorobject The paused monitor ↳ id number Monitor ID ↳ friendlyName string Friendly name of the monitor ↳ url string Monitored URL or host ↳ type string Monitor type (HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, UDP) ↳ status string Current status (UP, DOWN, PAUSED, etc.) ↳ interval number Check interval in seconds ↳ timeout number Check timeout in seconds ↳ port number Port for Port/UDP monitors ↳ keywordType string Keyword match type for Keyword monitors ↳ keywordValue string Keyword to match for Keyword monitors ↳ httpMethodType string HTTP method used for the check ↳ authType string HTTP authentication method ↳ successHttpResponseCodes array HTTP response codes treated as success ↳ checkSSLErrors boolean Whether SSL/domain expiration errors are checked ↳ followRedirections boolean Whether redirects are followed ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled ↳ domainExpirationReminder boolean Whether domain expiration reminders are enabled ↳ responseTimeThreshold number Response time threshold in milliseconds ↳ currentStateDuration number Seconds spent in the current state ↳ lastIncidentId string ID of the most recent incident ↳ groupId number Monitor group ID (0 if ungrouped) ↳ createDateTime string When the monitor was created ↳ tags array Tags assigned to the monitor ↳ id number Tag ID ↳ name string Tag name ↳ color string Tag color ↳ assignedAlertContacts array Alert contacts assigned to the monitor ↳ alertContactId number Alert contact ID ↳ threshold number Notification delay threshold in minutes ↳ recurrence number Repeat notification interval in minutes ↳ lastIncident object Details of the most recent incident ↳ id string Incident ID ↳ status string Incident status ↳ cause number Incident cause code ↳ reason string Incident reason ↳ startedAt string When the incident started ↳ duration number Incident duration in seconds
Resume a paused UptimeRobot monitor so it starts running checks again
Parameter Type Required Description apiKeystring Yes UptimeRobot API key monitorIdnumber Yes ID of the monitor to start
Parameter Type Description monitorobject The started monitor ↳ id number Monitor ID ↳ friendlyName string Friendly name of the monitor ↳ url string Monitored URL or host ↳ type string Monitor type (HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, UDP) ↳ status string Current status (UP, DOWN, PAUSED, etc.) ↳ interval number Check interval in seconds ↳ timeout number Check timeout in seconds ↳ port number Port for Port/UDP monitors ↳ keywordType string Keyword match type for Keyword monitors ↳ keywordValue string Keyword to match for Keyword monitors ↳ httpMethodType string HTTP method used for the check ↳ authType string HTTP authentication method ↳ successHttpResponseCodes array HTTP response codes treated as success ↳ checkSSLErrors boolean Whether SSL/domain expiration errors are checked ↳ followRedirections boolean Whether redirects are followed ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled ↳ domainExpirationReminder boolean Whether domain expiration reminders are enabled ↳ responseTimeThreshold number Response time threshold in milliseconds ↳ currentStateDuration number Seconds spent in the current state ↳ lastIncidentId string ID of the most recent incident ↳ groupId number Monitor group ID (0 if ungrouped) ↳ createDateTime string When the monitor was created ↳ tags array Tags assigned to the monitor ↳ id number Tag ID ↳ name string Tag name ↳ color string Tag color ↳ assignedAlertContacts array Alert contacts assigned to the monitor ↳ alertContactId number Alert contact ID ↳ threshold number Notification delay threshold in minutes ↳ recurrence number Repeat notification interval in minutes ↳ lastIncident object Details of the most recent incident ↳ id string Incident ID ↳ status string Incident status ↳ cause number Incident cause code ↳ reason string Incident reason ↳ startedAt string When the incident started ↳ duration number Incident duration in seconds
List incidents across your UptimeRobot account (last 24 hours by default), with optional filters
Parameter Type Required Description apiKeystring Yes UptimeRobot API key monitorIdnumber No Filter incidents by monitor ID monitorNamestring No Filter incidents by monitor name startedAfterstring No Only include incidents started after this ISO 8601 timestamp startedBeforestring No Only include incidents started before this ISO 8601 timestamp cursorstring No Pagination cursor (incident ID) returned by a previous request
Parameter Type Description incidentsarray List of incidents ↳ id string Incident ID ↳ status string Incident status ↳ type string Incident type ↳ cause number Incident cause code ↳ reason string Incident reason ↳ monitorId number Affected monitor ID ↳ monitorName string Affected monitor name ↳ commentsCount number Number of comments ↳ startedAt string When the incident started ↳ resolvedAt string When the incident resolved ↳ duration number Incident duration in seconds ↳ includeInReports boolean Whether the incident is included in reports nextLinkstring URL for the next page of results, or null on the last page
Get the details of a single UptimeRobot incident by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key incidentIdstring Yes ID of the incident to retrieve
Parameter Type Description incidentobject The incident details ↳ id string Incident ID ↳ status string Incident status ↳ cause number Incident cause code ↳ reason string Incident reason ↳ duration number Incident duration in seconds ↳ startedAt string When the incident started ↳ resolvedAt string When the incident resolved ↳ rootCause object Root cause details for the incident ↳ url string Checked URL ↳ httpResponseCode number HTTP response code observed ↳ responseDownloadUrl string URL to download the captured response body
List maintenance windows in your UptimeRobot account
Parameter Type Required Description apiKeystring Yes UptimeRobot API key cursorstring No Pagination cursor returned by a previous request
Parameter Type Description maintenanceWindowsarray List of maintenance windows ↳ id number Maintenance window ID ↳ userId number Owner user ID ↳ name string Maintenance window name ↳ interval string Recurrence interval (once, daily, weekly, monthly) ↳ date string Start date (YYYY-MM-DD) ↳ time string Start time (HH:mm:ss) ↳ duration number Duration in minutes ↳ autoAddMonitors boolean Whether all monitors are auto-added ↳ monitorIds array Assigned monitor IDs ↳ days array Days for weekly/monthly recurrence ↳ status string Status (active or paused) ↳ created string When the maintenance window was created nextLinkstring URL for the next page of results, or null on the last page
Get the details of a single UptimeRobot maintenance window by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key maintenanceWindowIdnumber Yes ID of the maintenance window to retrieve
Parameter Type Description maintenanceWindowobject The maintenance window details ↳ id number Maintenance window ID ↳ userId number Owner user ID ↳ name string Maintenance window name ↳ interval string Recurrence interval (once, daily, weekly, monthly) ↳ date string Start date (YYYY-MM-DD) ↳ time string Start time (HH:mm:ss) ↳ duration number Duration in minutes ↳ autoAddMonitors boolean Whether all monitors are auto-added ↳ monitorIds array Assigned monitor IDs ↳ days array Days for weekly/monthly recurrence ↳ status string Status (active or paused) ↳ created string When the maintenance window was created
Create a new maintenance window to suppress alerts during planned downtime
Parameter Type Required Description apiKeystring Yes UptimeRobot API key namestring Yes Name of the maintenance window intervalstring Yes Recurrence interval: once, daily, weekly, or monthly datestring Yes Start date in YYYY-MM-DD format timestring Yes Start time in HH:mm:ss format durationnumber Yes Duration in minutes (minimum 1) autoAddMonitorsboolean No Whether to automatically add all monitors to this window daysstring No Comma-separated days for weekly (1-7) or monthly (day-of-month, -1 for last day) windows monitorIdsstring No Comma-separated monitor IDs to assign to the window
Parameter Type Description maintenanceWindowobject The created maintenance window ↳ id number Maintenance window ID ↳ userId number Owner user ID ↳ name string Maintenance window name ↳ interval string Recurrence interval (once, daily, weekly, monthly) ↳ date string Start date (YYYY-MM-DD) ↳ time string Start time (HH:mm:ss) ↳ duration number Duration in minutes ↳ autoAddMonitors boolean Whether all monitors are auto-added ↳ monitorIds array Assigned monitor IDs ↳ days array Days for weekly/monthly recurrence ↳ status string Status (active or paused) ↳ created string When the maintenance window was created
Update an existing maintenance window. Only the provided fields are changed.
Parameter Type Required Description apiKeystring Yes UptimeRobot API key maintenanceWindowIdnumber Yes ID of the maintenance window to update namestring No New name of the maintenance window intervalstring No Recurrence interval: once, daily, weekly, or monthly datestring No Start date in YYYY-MM-DD format timestring No Start time in HH:mm:ss format durationnumber No Duration in minutes (minimum 1) daysstring No Comma-separated days for weekly (1-7) or monthly (day-of-month, -1 for last day) windows monitorIdsstring No Comma-separated monitor IDs to assign to the window statusstring No Set to "active" to enable or "paused" to disable the maintenance window
Parameter Type Description maintenanceWindowobject The updated maintenance window ↳ id number Maintenance window ID ↳ userId number Owner user ID ↳ name string Maintenance window name ↳ interval string Recurrence interval (once, daily, weekly, monthly) ↳ date string Start date (YYYY-MM-DD) ↳ time string Start time (HH:mm:ss) ↳ duration number Duration in minutes ↳ autoAddMonitors boolean Whether all monitors are auto-added ↳ monitorIds array Assigned monitor IDs ↳ days array Days for weekly/monthly recurrence ↳ status string Status (active or paused) ↳ created string When the maintenance window was created
Permanently delete an UptimeRobot maintenance window by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key maintenanceWindowIdnumber Yes ID of the maintenance window to delete
Parameter Type Description deletedboolean Whether the maintenance window was deleted idnumber ID of the deleted maintenance window
List the personal alert contacts in your UptimeRobot account
Parameter Type Required Description apiKeystring Yes UptimeRobot API key cursornumber No Pagination cursor returned by a previous request
Parameter Type Description alertContactsarray List of alert contacts ↳ id number Alert contact ID ↳ friendlyName string Display name ↳ type string Alert contact type ↳ value string Contact value (e.g. email address) ↳ customValue string Custom value for webhook-style contacts ↳ status string Activation status ↳ enableNotificationsFor string Which monitor events trigger notifications ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled nextLinkstring URL for the next page of results, or null on the last page
Get the details of a single UptimeRobot alert contact by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key alertContactIdnumber Yes ID of the alert contact to retrieve
Parameter Type Description alertContactobject The alert contact details ↳ id number Alert contact ID ↳ friendlyName string Display name ↳ type string Alert contact type ↳ value string Contact value (e.g. email address) ↳ customValue string Custom value for webhook-style contacts ↳ status string Activation status ↳ enableNotificationsFor string Which monitor events trigger notifications ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled
Create an email alert contact in UptimeRobot. The contact must be confirmed via email before it can receive alerts.
Parameter Type Required Description apiKeystring Yes UptimeRobot API key valuestring Yes Email address for the alert contact friendlyNamestring No Display name for the alert contact enableNotificationsFornumber No Which monitor events to notify for: 0, 1, 2, or 3
Parameter Type Description alertContactobject The created alert contact ↳ id number Alert contact ID ↳ friendlyName string Display name ↳ type string Alert contact type ↳ value string Contact value (e.g. email address) ↳ customValue string Custom value for webhook-style contacts ↳ status string Activation status ↳ enableNotificationsFor string Which monitor events trigger notifications ↳ sslExpirationReminder boolean Whether SSL expiration reminders are enabled
Permanently delete an UptimeRobot alert contact by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key alertContactIdnumber Yes ID of the alert contact to delete
Parameter Type Description deletedboolean Whether the alert contact was deleted idnumber ID of the deleted alert contact
List the public status pages in your UptimeRobot account
Parameter Type Required Description apiKeystring Yes UptimeRobot API key cursornumber No Pagination cursor returned by a previous request
Parameter Type Description pspsarray List of public status pages ↳ id number Public status page ID ↳ friendlyName string Status page name ↳ customDomain string Custom domain ↳ isPasswordSet boolean Whether the page is password protected ↳ monitorIds array Monitor IDs shown on the page ↳ tagIds array Tag IDs shown on the page ↳ monitorsCount number Number of monitors on the page ↳ status string Status (ENABLED or PAUSED) ↳ urlKey string Public URL key ↳ homepageLink string Homepage link target ↳ gaCode string Google Analytics code ↳ icon string Icon URL ↳ logo string Logo URL ↳ noIndex boolean Whether search engine indexing is disabled ↳ hideUrlLinks boolean Whether the "Powered by" footer link is hidden ↳ subscription boolean Whether the subscribe feature is enabled nextLinkstring URL for the next page of results, or null on the last page
Get the details of a single UptimeRobot public status page by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key pspIdnumber Yes ID of the status page to retrieve
Parameter Type Description pspobject The status page details ↳ id number Public status page ID ↳ friendlyName string Status page name ↳ customDomain string Custom domain ↳ isPasswordSet boolean Whether the page is password protected ↳ monitorIds array Monitor IDs shown on the page ↳ tagIds array Tag IDs shown on the page ↳ monitorsCount number Number of monitors on the page ↳ status string Status (ENABLED or PAUSED) ↳ urlKey string Public URL key ↳ homepageLink string Homepage link target ↳ gaCode string Google Analytics code ↳ icon string Icon URL ↳ logo string Logo URL ↳ noIndex boolean Whether search engine indexing is disabled ↳ hideUrlLinks boolean Whether the "Powered by" footer link is hidden ↳ subscription boolean Whether the subscribe feature is enabled
Create a public status page in UptimeRobot, optionally with a logo and icon image
Parameter Type Required Description apiKeystring Yes UptimeRobot API key friendlyNamestring Yes Name of the public status page monitorIdsstring No Comma-separated monitor IDs to display on the page statusstring No Status of the page: ENABLED (published) or PAUSED (unpublished) passwordstring No Optional password protection for the page customDomainstring No Custom domain for the page (e.g. status.your-domain.com) hideUrlLinksboolean No Whether to hide the "Powered by UptimeRobot" footer link noIndexboolean No Whether to prevent search engines from indexing the page logofile No Logo image (JPG/JPEG/PNG, max 150 KB) iconfile No Icon image (JPG/JPEG/PNG, max 150 KB)
Parameter Type Description pspobject The created status page ↳ id number Public status page ID ↳ friendlyName string Status page name ↳ customDomain string Custom domain ↳ isPasswordSet boolean Whether the page is password protected ↳ monitorIds array Monitor IDs shown on the page ↳ tagIds array Tag IDs shown on the page ↳ monitorsCount number Number of monitors on the page ↳ status string Status (ENABLED or PAUSED) ↳ urlKey string Public URL key ↳ homepageLink string Homepage link target ↳ gaCode string Google Analytics code ↳ icon string Icon URL ↳ logo string Logo URL ↳ noIndex boolean Whether search engine indexing is disabled ↳ hideUrlLinks boolean Whether the "Powered by" footer link is hidden ↳ subscription boolean Whether the subscribe feature is enabled
Update a public status page in UptimeRobot. Only the provided fields are changed; logo and icon images can be replaced.
Parameter Type Required Description apiKeystring Yes UptimeRobot API key pspIdnumber Yes ID of the status page to update friendlyNamestring No New name of the public status page monitorIdsstring No Comma-separated monitor IDs to display on the page statusstring No Status of the page: ENABLED (published) or PAUSED (unpublished) passwordstring No Optional password protection for the page customDomainstring No Custom domain for the page (e.g. status.your-domain.com) hideUrlLinksboolean No Whether to hide the "Powered by UptimeRobot" footer link noIndexboolean No Whether to prevent search engines from indexing the page logofile No Logo image (JPG/JPEG/PNG, max 150 KB) iconfile No Icon image (JPG/JPEG/PNG, max 150 KB)
Parameter Type Description pspobject The updated status page ↳ id number Public status page ID ↳ friendlyName string Status page name ↳ customDomain string Custom domain ↳ isPasswordSet boolean Whether the page is password protected ↳ monitorIds array Monitor IDs shown on the page ↳ tagIds array Tag IDs shown on the page ↳ monitorsCount number Number of monitors on the page ↳ status string Status (ENABLED or PAUSED) ↳ urlKey string Public URL key ↳ homepageLink string Homepage link target ↳ gaCode string Google Analytics code ↳ icon string Icon URL ↳ logo string Logo URL ↳ noIndex boolean Whether search engine indexing is disabled ↳ hideUrlLinks boolean Whether the "Powered by" footer link is hidden ↳ subscription boolean Whether the subscribe feature is enabled
Permanently delete an UptimeRobot public status page by ID
Parameter Type Required Description apiKeystring Yes UptimeRobot API key pspIdnumber Yes ID of the status page to delete
Parameter Type Description deletedboolean Whether the status page was deleted idnumber ID of the deleted status page
Get details about the authenticated UptimeRobot account, including plan and limits
Parameter Type Required Description apiKeystring Yes UptimeRobot API key
Parameter Type Description accountobject The account details ↳ email string Account email ↳ fullName string Account holder name ↳ monitorsCount number Number of monitors in the account ↳ monitorLimit number Maximum number of monitors allowed ↳ smsCredits number Remaining SMS credits ↳ plan string Subscription plan name ↳ subscriptionStatus string Subscription status ↳ subscriptionExpiresAt string Subscription expiration date