UPuptimerobot
Monitors

Create a monitor

Changed on

New monitors of any type can be created using this endpoint. The request body is documented as one schema per monitor type — pick the one matching the type you are creating.

post/monitors

Request

  • Base URL
    https://api.uptimerobot.com/v3
  • URL
    https://api.uptimerobot.com/v3/monitors
  • Auth
    HTTP bearer

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "friendlyName": "My monitor",
  "interval": 60,
  "assignedAlertContacts": [
    {
      "alertContactId": 12345,
      "threshold": 5,
      "recurrence": 30
    }
  ],
  "tagNames": [
    "tag1",
    "tag2"
  ],
  "maintenanceWindowsIds": [
    123,
    234
  ],
  "regionData": {
    "THRESHOLD": {
      "na": 5000,
      "eu": 6000,
      "as": 7000,
      "oc": 8000
    }
  },
  "regionalData": "na",
  "customFields": {
    "environment": "production",
    "team": "platform"
  },
  "httpMethodType": "HEAD",
  "authType": "NONE",
  "httpUsername": "admin",
  "httpPassword": "password",
  "postValueType": "RAW_JSON",
  "customHttpHeaders": {
    "X-Custom-Header": "value"
  },
  "successHttpResponseCodes": [
    "2xx",
    "3xx"
  ],
  "type": "HTTP",
  "url": "https://example.com",
  "timeout": 30,
  "config": {
    "sslExpirationPeriodDays": [
      7,
      14,
      30
    ],
    "ipVersion": "ipv4Only",
    "applicationErrorRetries": 1
  }
}

Response

typeunknown required
intervalnumber required
sslBrandstring nullable required
checkSSLErrorsboolean required
sslExpirationReminderboolean nullable required
domainExpirationReminderboolean nullable required
followRedirectionsboolean required
authTypeunknown required
httpUsernamestring
httpPasswordstring
customHttpHeadersobject nullable required
httpMethodTypeunknown required
successHttpResponseCodesstring[] required
timeoutnumber nullable required
postValueType'KEY_VALUE' | 'RAW_JSON' nullable required
portnumber nullable required
portAlertConditionunknown
gracePeriodnumber nullable required
keywordValuestring nullable required
keywordTypeunknown required
responseTimeThresholdnumber required
heartbeatUrlstring nullable required

Complete heartbeat ping URL for HEARTBEAT monitors; null for every other type

idnumber required
friendlyNamestring required
statusunknown required
urlstring nullable required
currentStateDurationnumber required
lastIncidentIdstring nullable required
userIdnumber required
apiKeystring nullable required
groupIdnumber nullable
customFieldsobject nullable

Changes

  • 191b37343aa3Revision changes
    • warning

      added the new 027-016 enum value to the response property for the response status

  • 8c686e2fe60aRevision changes
    • warning

      added the new 004-048 enum value to the response property for the response status

    • warning

      added the new 011-034 enum value to the response property for the response status

    • warning

      added the new 031-001 enum value to the response property for the response status

    • warning

      added the new 031-002 enum value to the response property for the response status

    • warning

      added the new 031-003 enum value to the response property for the response status

    • warning

      added the new 031-004 enum value to the response property for the response status

    • warning

      added the new 031-005 enum value to the response property for the response status