Type alias MonitorAttributes

Type declaration

• auth_password: string | null

  HTTP Basic Auth password.

• auth_username: string | null

  HTTP Basic Auth username.

• call: boolean

  Should we call the on-call person?

• check_frequency: number

  How often should we check your website? In seconds.

• confirmation_period: number

  How long should we wait after observing a failure before we start a new incident? In seconds.

• created_at: string

  When was the monitor created. ISO date string.

• domain_expiration: null | 1 | 2 | 3 | 7 | 14 | 30 | 60

  How many days in advance of your domain's expiration date you want to be alerted. = null

• email: boolean

  Should we email the on-call person?

• expected_status_codes: number[]

  An array of status codes you expect to receive from your website.

• follow_redirects: boolean

  Should we automatically follow redirects when sending the HTTP request?

• http_method: HTTPMethod

  HTTP Method used to make a request.

• last_checked_at: string | null

  When was the last check performed. ISO date string.

• maintenance_from: string | null

  Start of the maintenance window each day. We won't check your website during this window. Example: '01:00:00'

• maintenance_timezone: string | null

  The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails TimeZone documentation.

  See

  https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html

• maintenance_to: string | null

  End of the maintenance window each day. Example: '03:00:00'

• monitor_group_id: string | null

  The Id of the monitor group that your monitor is part of. Set this attribute if you want to add this monitor to a monitor group.

• paused_at: string | null

  When was the monitor paused. ISO date string.

• playwright_script: string | null

  For Playwright monitors, the JavaScript source code of the scenario.

• policy_id: string | null

  Escalation policy ID.

• port: string | null

  The port to ping.

• pronounceable_name: string

  The pronounceable name of the monitor. We will use this when we call you, so no tongue-twisters, please. :)

• push: boolean

  Should we send an a push notification to the on-call person?

• recovery_period: number

  How long to wait before timing out the request? In seconds.

• regions: string[] | null

  An array of regions to set. Options: us, eu, as, au

  Param: regions

  Regions to allow

• remember_cookies: boolean

  Do you want to keep cookies when redirecting?

• request_body: string | null

  Request body for POST, PUT, PATCH requests.

• request_headers: ResponseMonitorHTTPHeader[]

  An optional array of custom HTTP headers for the request.

• request_timeout: number

  How long to wait before timing out the request? In seconds.

• required_keyword: string | null

  We will create a new incident if this keyword is (missing) on your page.

• sms: boolean

  Should we send an SMS to the on-call person?

• ssl_expiration: null | 1 | 2 | 3 | 7 | 14 | 30 | 60

  How many days in advance of your SSL certificate expiration date you want to be alerted. "Don't check for SSL expiration" = null

• status: MonitorStatus

  The status of the monitor.

• team_wait: number | null

  How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. In seconds.

• updated_at: string

  When was the monitor last updated. ISO date string.

• url: string

  The URL of your website or the host you want to ping

  See

  monitor_type

• verify_ssl: boolean

  Should we verify SSL certificate validity?