Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
      1. List all existing monitors GET
      2. Get a single monitor GET
      3. Get a monitor's response times GET
      4. Get a monitor's availability summary GET
      5. Create a new monitor POST
      6. Update an existing monitor PATCH
      7. Delete an existing monitor DELETE
      8. Monitors API response params
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. Escalation policies
    3. Severities
    4. Incidents
    5. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Splunk On-Call integrations
    11. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Monitors API response params

Response body params

Namespace data

Parameter Type Values
id String The id of the monitor. (string representation of a number)
type String Valid values: monitor
attributes Object Attributes object - contains all the Monitor attributes. See below
attributes.url String The URL of your website or the host you want to ping (see attributes.monitor_type below).
attributes.pronounceable_name String The pronounceable name of the monitor. We will use this when we call you, so no tongue-twisters, please. :)
attributes.monitor_type String 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)
attributes.monitor_group_id String 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.
attributes.last_checked_at String (ISO DateTime format) When was the last check performed. Example value 2020-09-01T14:17:46.000Z
attributes.status String - paused: the monitor was paused - pending: the monitor was just created and it's waiting for the first check - maintenance: the monitor is paused because it is currently in its maintenance period - up: checks are passing - validating: the service seems to be back up, but the recovery_period since the last failed check still hasn't passed - down: checks are failing
attributes.required_keyword String Required if monitor_type is set to keyword or udp. We will create a new incident if this keyword is missing on your page.
attributes.verify_ssl Boolean Should we verify SSL certificate validity?
attributes.check_frequency Integer How often should we check your website? In seconds.
attributes.call Boolean Should we call the on-call person?
attributes.sms Boolean Should we send an SMS to the on-call person?
attributes.email Boolean Should we send an email to the on-call person?
attributes.push Boolean Should we send a push notification to the on-call person?
attributes.team_wait Integer How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. In seconds.
attributes.http_method String HTTP Method used to make a request. Valid options: GET, HEAD, POST, PUT, PATCH
attributes.request_timeout Integer How long to wait before timing out the request? In seconds.
attributes.recovery_period Integer How long the monitor must be up to automatically mark an incident as resolved after being down. In seconds.
attributes.request_headers Array of objects An optional array of custom HTTP headers for the request. Set the name and value properties to form a complete header
attributes.request_headers[header_index].id String The Id of the header. Do not set this parameter; it is generated automatically.
attributes.request_headers[header_index].name String The name of the header. Example value: Application-type
attributes.request_headers[header_index].value String The value of the header. Example value: application/json
attributes.request_body String Request body for POST, PUT, PATCH requests.
attributes.paused_at String (ISO DateTime format) When was the monitor paused. null if the monitor is not paused.
attributes.created_at String (ISO DateTime format) When was the monitor created.
attributes.updated_at String (ISO DateTime format) When was the monitor last updated
attributes.ssl_expiration Integer How many days in advance of your SSL certificate expiration date you want to be alerted. "Don't check for SSL expiration" = null Allowed values are: null, 1, 2, 3, 7, 14, 30, 60
attributes.domain_expiration Integer How many days in advance of your domain's expiration date you want to be alerted. = null Allowed values are: null, 1, 2, 3, 7, 14, 30, 60
attributes.regions Array of strings An array of regions to set. Allowed values are ["us", "eu", "as", "au"] or any subset of these regions.
attributes.port String 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).
attributes.confirmation_period Integer How long should we wait after observing a failure before we start a new incident? In seconds.
attributes.expected_status_codes Array of integers 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.
attributes.maintenance_days Array of strings 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.
attributes.maintenance_from String Start of the maintenance window each day. We won't check your website during this window. Example: 01:00:00
attributes.maintenance_to String End of the maintenance window each day. Example: 03:00:00
attributes.maintenance_timezone String 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

Previous article

Delete an existing monitor

Next article

List all existing monitor groups