Headers
Bearer $TOKEN
application/json
Body parameters
Required if using global API token to specify the team which should own the resource
Valid values:status
— We will check your website for a 2XX HTTP status code.expected_status_code
— We will check if your website returned one of the values in expected_status_codes
.keyword
— We will check if your website contains the required_keyword
.keyword_absence
— We will check if your website doesn't contain the required_keyword
.ping
— We will ping your host specified in the url
parameter.tcp
— We will test a TCP port at your host specified in the url parameter (port
is required).udp
— We will test a UDP port at your host specified in the url parameter (port
and required_keyword
are required).smtp
— We will check for a SMTP server at the host specified in the url parameter (port
is required, and can be one of 25
, 465
, 587
, or a combination of those ports separated by a comma).pop
— We will check for a POP3 server at the host specified in the url
parameter (port
is required, and can be 110
, 995
, or both).imap
— We will check for an IMAP server at the host specified in the url parameter (port
is required, and can be 143, 993, or both).dns
— We will check for a DNS server at the host specified in the url parameter (request_body
is required, and should contain the domain to query the DNS server with).playwright
— We will run the scenario defined by playwright_script
, identified in the UI by scenario_name
.
The URL of your website or the host you want to ping. See monitor_type
below.
The name of the monitor
Send email alerts
Send SMS alerts
Phone call alerts
Should we send a push notification to the on-call person?
Check frequency (in seconds)
The request headers that will be send with the check
An array of status codes you expect to receive from your website. These status codes are considered only if the monitor_type
is expected_status_code
.
How many days before the domain expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60.
How many days before the SSL certificate expires do you want to be alerted? Valid values are 1, 2, 3, 7, 14, 30, and 60.
Set the escalation policy for the monitor.
Should we automatically follow redirects when sending the HTTP request?
Required if monitor_type is set to keyword or udp. We will create a new incident if this keyword is missing on your page.
How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. In seconds.
Set to true to pause monitoring — we won't notify you about downtime. Set to false to resume monitoring.
Required if monitor_type
is set to tcp
, udp
, smtp
, pop
, or imap
. tcp
and udp
monitors accept any ports, while smtp, pop, and imap accept only the specified ports corresponding with their servers (e.g. 25
,465
,587
for smtp
).
An array of regions to set. Allowed values are ['us', 'eu', 'as', 'au']
or any subset of these regions.
Set this attribute if you want to add this monitor to a monitor group.
How long the monitor must be up to automatically mark an incident as resolved after being down. In seconds.
Should we verify SSL certificate validity?
How long should we wait after observing a failure before we start a new incident? In seconds.
HTTP Method used to make a request. Valid options: GET, HEAD, POST, PUT, PATCH
How long to wait before timing out the request? In seconds.
Request body for POST, PUT, PATCH requests. Required if monitor_type
is set to dns
(domain to query the DNS server with).
Basic HTTP authentication username to include with the request.
Basic HTTP authentication password to include with the request.
An array of maintenance days to set. If a maintenance window is overnight both affected days should be set. Allowed values are ['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun']
or any subset of these days.
Start of the maintenance window each day. We won't check your website during this window. Example: '01:00:00'
End of the maintenance window each day. Example: '03:00:00'
The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
Do you want to keep cookies when redirecting?
For Playwright monitors, the JavaScript source code of the scenario.
For Playwright monitors, the scenario name identifying the monitor in the UI.