Tools

UptimeRobot

Monitor uptime, manage incidents, maintenance windows, and status pages

Usage Instructions

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.

Tools

`uptimerobot_list_monitors`

List monitors in your UptimeRobot account, with optional filters and pagination

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`limit`	number	No	Number of monitors per page (1-200, default 50)
`status`	string	No	Comma-separated statuses to filter by (PAUSED, STARTED, UP, LOOKS_DOWN, DOWN)
`name`	string	No	Partial friendly-name filter
`url`	string	No	Partial URL filter
`tags`	string	No	Comma-separated tags to filter by (case-sensitive, OR logic)
`groupId`	number	No	Monitor group ID to filter by
`cursor`	number	No	Pagination cursor returned by a previous request

Output

Parameter	Type	Description
`monitors`	array	List of monitors
`nextLink`	string	URL for the next page of results, or null on the last page

`uptimerobot_get_monitor`

Get the details of a single UptimeRobot monitor by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`monitorId`	number	Yes	ID of the monitor to retrieve

Output

Parameter	Type	Description
`monitor`	object	The monitor details

`uptimerobot_create_monitor`

Create a new monitor in UptimeRobot

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`friendlyName`	string	Yes	Friendly name of the monitor
`type`	string	Yes	Monitor type: HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, or UDP
`url`	string	No	URL or host to monitor (not required for Heartbeat monitors)
`interval`	number	Yes	Check interval in seconds (minimum 30)
`checkTimeout`	number	No	Check timeout in seconds, 0-60 (HTTP, Keyword and Port monitors only)
`port`	number	No	Port to check, 1-65535 (required for Port and UDP monitors)
`keywordType`	string	No	Keyword match type for Keyword monitors: ALERT_EXISTS or ALERT_NOT_EXISTS
`keywordValue`	string	No	Keyword to look for (Keyword monitors only)
`keywordCaseType`	number	No	Keyword case sensitivity: 0 (case-sensitive) or 1 (case-insensitive)
`httpMethodType`	string	No	HTTP method: HEAD, GET, POST, PUT, PATCH, DELETE, or OPTIONS (defaults to HEAD)
`authType`	string	No	HTTP authentication: NONE, HTTP_BASIC, DIGEST, or BEARER
`httpUsername`	string	No	Username for HTTP authentication
`httpPassword`	string	No	Password for HTTP authentication
`gracePeriod`	number	No	Grace period in seconds, 0-86400 (Heartbeat monitors only)
`successHttpResponseCodes`	string	No	Comma-separated success HTTP response codes (e.g. "2xx,3xx")
`checkSSLErrors`	boolean	No	Whether to check for SSL and domain expiration errors
`followRedirections`	boolean	No	Whether to follow redirects
`sslExpirationReminder`	boolean	No	Whether to send SSL certificate expiration reminders
`domainExpirationReminder`	boolean	No	Whether to send domain expiration reminders
`responseTimeThreshold`	number	No	Response time threshold in milliseconds, 0-60000
`tagNames`	string	No	Comma-separated tag names to assign to the monitor
`assignedAlertContacts`	string	No	JSON array of alert-contact assignments, e.g. [{"alertContactId":123,"threshold":0,"recurrence":0}]
`customHttpHeaders`	string	No	JSON object of custom HTTP headers to send with the request
`groupId`	number	No	Monitor group ID to assign the monitor to (0 for no group)

Output

Parameter	Type	Description
`monitor`	object	The created monitor

`uptimerobot_update_monitor`

Update an existing UptimeRobot monitor. Only the provided fields are changed.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`monitorId`	number	Yes	ID of the monitor to update
`friendlyName`	string	No	New friendly name
`url`	string	No	New URL or host to monitor
`interval`	number	No	New check interval in seconds (minimum 30)
`checkTimeout`	number	No	New check timeout in seconds, 0-60
`port`	number	No	New port, 1-65535 (Port and UDP monitors)
`keywordType`	string	No	Keyword match type: ALERT_EXISTS or ALERT_NOT_EXISTS
`keywordValue`	string	No	New keyword to look for
`httpMethodType`	string	No	HTTP method: HEAD, GET, POST, PUT, PATCH, DELETE, or OPTIONS
`authType`	string	No	HTTP authentication: NONE, HTTP_BASIC, DIGEST, or BEARER
`httpUsername`	string	No	Username for HTTP authentication
`httpPassword`	string	No	Password for HTTP authentication
`successHttpResponseCodes`	string	No	Comma-separated success HTTP response codes (e.g. "2xx,3xx")
`checkSSLErrors`	boolean	No	Whether to check for SSL and domain expiration errors
`followRedirections`	boolean	No	Whether to follow redirects
`sslExpirationReminder`	boolean	No	Whether to send SSL certificate expiration reminders
`domainExpirationReminder`	boolean	No	Whether to send domain expiration reminders
`responseTimeThreshold`	number	No	Response time threshold in milliseconds, 0-60000
`tagNames`	string	No	Comma-separated tag names to assign to the monitor
`assignedAlertContacts`	string	No	JSON array of alert-contact assignments, e.g. [{"alertContactId":123,"threshold":0,"recurrence":0}]
`customHttpHeaders`	string	No	JSON object of custom HTTP headers to send with the request
`groupId`	number	No	Monitor group ID to assign the monitor to (0 for no group)

Output

Parameter	Type	Description
`monitor`	object	The updated monitor

`uptimerobot_delete_monitor`

Permanently delete an UptimeRobot monitor by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`monitorId`	number	Yes	ID of the monitor to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the monitor was deleted
`id`	number	ID of the deleted monitor

`uptimerobot_pause_monitor`

Pause an UptimeRobot monitor so it stops running checks

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`monitorId`	number	Yes	ID of the monitor to pause

Output

Parameter	Type	Description
`monitor`	object	The paused monitor

`uptimerobot_start_monitor`

Resume a paused UptimeRobot monitor so it starts running checks again

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`monitorId`	number	Yes	ID of the monitor to start

Output

Parameter	Type	Description
`monitor`	object	The started monitor

`uptimerobot_list_incidents`

List incidents across your UptimeRobot account (last 24 hours by default), with optional filters

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`monitorId`	number	No	Filter incidents by monitor ID
`monitorName`	string	No	Filter incidents by monitor name
`startedAfter`	string	No	Only include incidents started after this ISO 8601 timestamp
`startedBefore`	string	No	Only include incidents started before this ISO 8601 timestamp
`cursor`	string	No	Pagination cursor (incident ID) returned by a previous request

Output

Parameter	Type	Description
`incidents`	array	List of incidents
`nextLink`	string	URL for the next page of results, or null on the last page

`uptimerobot_get_incident`

Get the details of a single UptimeRobot incident by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`incidentId`	string	Yes	ID of the incident to retrieve

Output

Parameter	Type	Description
`incident`	object	The incident details

`uptimerobot_list_maintenance_windows`

List maintenance windows in your UptimeRobot account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`cursor`	string	No	Pagination cursor returned by a previous request

Output

Parameter	Type	Description
`maintenanceWindows`	array	List of maintenance windows
`nextLink`	string	URL for the next page of results, or null on the last page

`uptimerobot_get_maintenance_window`

Get the details of a single UptimeRobot maintenance window by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`maintenanceWindowId`	number	Yes	ID of the maintenance window to retrieve

Output

Parameter	Type	Description
`maintenanceWindow`	object	The maintenance window details

`uptimerobot_create_maintenance_window`

Create a new maintenance window to suppress alerts during planned downtime

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`name`	string	Yes	Name of the maintenance window
`interval`	string	Yes	Recurrence interval: once, daily, weekly, or monthly
`date`	string	Yes	Start date in YYYY-MM-DD format
`time`	string	Yes	Start time in HH:mm:ss format
`duration`	number	Yes	Duration in minutes (minimum 1)
`autoAddMonitors`	boolean	No	Whether to automatically add all monitors to this window
`days`	string	No	Comma-separated days for weekly (1-7) or monthly (day-of-month, -1 for last day) windows
`monitorIds`	string	No	Comma-separated monitor IDs to assign to the window

Output

Parameter	Type	Description
`maintenanceWindow`	object	The created maintenance window

`uptimerobot_update_maintenance_window`

Update an existing maintenance window. Only the provided fields are changed.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`maintenanceWindowId`	number	Yes	ID of the maintenance window to update
`name`	string	No	New name of the maintenance window
`interval`	string	No	Recurrence interval: once, daily, weekly, or monthly
`date`	string	No	Start date in YYYY-MM-DD format
`time`	string	No	Start time in HH:mm:ss format
`duration`	number	No	Duration in minutes (minimum 1)
`days`	string	No	Comma-separated days for weekly (1-7) or monthly (day-of-month, -1 for last day) windows
`monitorIds`	string	No	Comma-separated monitor IDs to assign to the window
`status`	string	No	Set to "active" to enable or "paused" to disable the maintenance window

Output

Parameter	Type	Description
`maintenanceWindow`	object	The updated maintenance window

`uptimerobot_delete_maintenance_window`

Permanently delete an UptimeRobot maintenance window by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`maintenanceWindowId`	number	Yes	ID of the maintenance window to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the maintenance window was deleted
`id`	number	ID of the deleted maintenance window

`uptimerobot_list_alert_contacts`

List the personal alert contacts in your UptimeRobot account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`cursor`	number	No	Pagination cursor returned by a previous request

Output

Parameter	Type	Description
`alertContacts`	array	List of alert contacts
`nextLink`	string	URL for the next page of results, or null on the last page

`uptimerobot_get_alert_contact`

Get the details of a single UptimeRobot alert contact by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`alertContactId`	number	Yes	ID of the alert contact to retrieve

Output

Parameter	Type	Description
`alertContact`	object	The alert contact details

`uptimerobot_create_alert_contact`

Create an email alert contact in UptimeRobot. The contact must be confirmed via email before it can receive alerts.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`value`	string	Yes	Email address for the alert contact
`friendlyName`	string	No	Display name for the alert contact
`enableNotificationsFor`	number	No	Which monitor events to notify for: 0, 1, 2, or 3

Output

Parameter	Type	Description
`alertContact`	object	The created alert contact

`uptimerobot_delete_alert_contact`

Permanently delete an UptimeRobot alert contact by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`alertContactId`	number	Yes	ID of the alert contact to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the alert contact was deleted
`id`	number	ID of the deleted alert contact

`uptimerobot_list_psps`

List the public status pages in your UptimeRobot account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`cursor`	number	No	Pagination cursor returned by a previous request

Output

Parameter	Type	Description
`psps`	array	List of public status pages
`nextLink`	string	URL for the next page of results, or null on the last page

`uptimerobot_get_psp`

Get the details of a single UptimeRobot public status page by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`pspId`	number	Yes	ID of the status page to retrieve

Output

Parameter	Type	Description
`psp`	object	The status page details

`uptimerobot_create_psp`

Create a public status page in UptimeRobot, optionally with a logo and icon image

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`friendlyName`	string	Yes	Name of the public status page
`monitorIds`	string	No	Comma-separated monitor IDs to display on the page
`status`	string	No	Status of the page: ENABLED (published) or PAUSED (unpublished)
`password`	string	No	Optional password protection for the page
`customDomain`	string	No	Custom domain for the page (e.g. status.your-domain.com)
`hideUrlLinks`	boolean	No	Whether to hide the "Powered by UptimeRobot" footer link
`noIndex`	boolean	No	Whether to prevent search engines from indexing the page
`logo`	file	No	Logo image (JPG/JPEG/PNG, max 150 KB)
`icon`	file	No	Icon image (JPG/JPEG/PNG, max 150 KB)

Output

Parameter	Type	Description
`psp`	object	The created status page

`uptimerobot_update_psp`

Update a public status page in UptimeRobot. Only the provided fields are changed; logo and icon images can be replaced.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`pspId`	number	Yes	ID of the status page to update
`friendlyName`	string	No	New name of the public status page
`monitorIds`	string	No	Comma-separated monitor IDs to display on the page
`status`	string	No	Status of the page: ENABLED (published) or PAUSED (unpublished)
`password`	string	No	Optional password protection for the page
`customDomain`	string	No	Custom domain for the page (e.g. status.your-domain.com)
`hideUrlLinks`	boolean	No	Whether to hide the "Powered by UptimeRobot" footer link
`noIndex`	boolean	No	Whether to prevent search engines from indexing the page
`logo`	file	No	Logo image (JPG/JPEG/PNG, max 150 KB)
`icon`	file	No	Icon image (JPG/JPEG/PNG, max 150 KB)

Output

Parameter	Type	Description
`psp`	object	The updated status page

`uptimerobot_delete_psp`

Permanently delete an UptimeRobot public status page by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key
`pspId`	number	Yes	ID of the status page to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the status page was deleted
`id`	number	ID of the deleted status page

`uptimerobot_get_account`

Get details about the authenticated UptimeRobot account, including plan and limits

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	UptimeRobot API key

Output

Parameter	Type	Description
`account`	object	The account details

Notes

Category: tools
Type: uptimerobot

On this page

On this page

Usage Instructions

uptimerobot_list_monitors

uptimerobot_get_monitor

uptimerobot_create_monitor

uptimerobot_update_monitor

uptimerobot_delete_monitor

uptimerobot_pause_monitor

uptimerobot_start_monitor

uptimerobot_list_incidents

uptimerobot_get_incident

uptimerobot_list_maintenance_windows

uptimerobot_get_maintenance_window

uptimerobot_create_maintenance_window

uptimerobot_update_maintenance_window

uptimerobot_delete_maintenance_window

uptimerobot_list_alert_contacts

uptimerobot_get_alert_contact

uptimerobot_create_alert_contact

uptimerobot_delete_alert_contact

uptimerobot_list_psps

uptimerobot_get_psp

uptimerobot_create_psp

uptimerobot_update_psp

uptimerobot_delete_psp

uptimerobot_get_account

UptimeRobot