Sign in

v3

latestOpenAPI 3.0.02026-07-2759120262.8 KB
Monitors

Update a monitor

patch/monitors/{id}

Path parameters

idnumber required

Request body

friendlyNamestring

Friendly name of the monitor

urlstring

URL of the monitor. For DNS monitors: DNS server IP or hostname. Not required for Heartbeat monitor

type'HTTP' | 'KEYWORD' | 'PING' | 'PORT' | 'HEARTBEAT' | 'DNS' | 'API' | 'UDP' | 'VISUAL_COMPARISON'
portnumber

Required for Port and UDP monitors

keywordType'ALERT_EXISTS' | 'ALERT_NOT_EXISTS'

Required for Keyword monitor

keywordCaseType0 | 1

Required for Keyword monitor

keywordValuestring nullable

Required for Keyword monitor

intervalnumber

Interval of check in seconds. Heartbeat monitors support at most 2678400 seconds (31 days).

timeoutnumber

Timeout of check in seconds. Only for Http, Keyword and Port monitors

gracePeriodnumber

Grace period of check in seconds. Only for Heartbeat monitor

httpUsernamestring

Username for HTTP Basic authentication

httpPasswordstring

Password for HTTP Basic authentication

httpMethodType'HEAD' | 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'QUERY' nullable

HTTP method to use for the request. For HTTP and Keyword monitors it defaults to HEAD if omitted; API monitors default to GET and do not allow HEAD

authType'NONE' | 'HTTP_BASIC' | 'DIGEST' | 'BEARER'

Authentication method to use for the request. Only applicable for HTTP and Keyword monitors

postValueDataobject

Data to be sent in the request. Not applicable for HTTP method type = HEAD. Can be JSON string or string

postValueType'KEY_VALUE' | 'RAW_JSON'

Type of data payload to be sent in the request. Affects what data is accepted by "postValueData" field

customHttpHeadersobject

Custom HTTP headers to be sent in the request. Must be sent as JSON object with key-value pairs

successHttpResponseCodesstring[]

Success HTTP response codes. Can contain specific codes or ranges like 2xx. Default is [2xx, 3xx]

checkSSLErrorsboolean

Whether to check for SSL and domain expiration errors

tagNamesstring[]

Tags to be assigned to the monitor

maintenanceWindowsIdsnumber[]

Maintenance windows to be assigned to the monitor

domainExpirationReminderboolean

Whether to send a notification when the domain is about to expire

sslExpirationReminderboolean

Whether to send a notification when the SSL certificate is about to expire

followRedirectionsboolean

Whether to follow redirections

responseTimeThresholdnumber

Response time threshold in milliseconds. When provided, the value is applied to all active regions as regionData.THRESHOLD. Always returns 0 — use regionData.THRESHOLD for per-region control.

regionalData'na' | 'eu' | 'as' | 'oc'

Region for monitoring: na (North America), eu (Europe), as (Asia), oc (Oceania). Note: If both regionalData and regionData are provided, regionData takes priority.

groupIdnumber

Monitor group ID to assign the monitor to. Use 0 for the default group.

customFieldsobject

Custom key-value metadata for the monitor. Max 20 keys. Keys: alphanumeric + underscore + hyphen, max 64 chars. Values: max 255 chars. Paid plans only.

configobject

Monitor configuration patch. Top-level shallow merge with existing config: omit keys to leave unchanged, set a key to null to remove it, or send config: null to clear all config.

Example request

{
  "friendlyName": "My monitor",
  "url": "http://test.com",
  "type": "HTTP",
  "keywordType": "ALERT_EXISTS",
  "interval": 60,
  "timeout": 30,
  "gracePeriod": 300,
  "httpUsername": "admin",
  "httpPassword": "password",
  "httpMethodType": "HEAD",
  "authType": "NONE",
  "assignedAlertContacts": [
    {
      "alertContactId": 12345,
      "threshold": 5,
      "recurrence": 30
    }
  ],
  "successHttpResponseCodes": [
    "2xx",
    "3xx"
  ],
  "tagNames": [
    "tag1",
    "tag2"
  ],
  "maintenanceWindowsIds": [
    123,
    234
  ],
  "regionalData": "na",
  "regionData": {
    "THRESHOLD": {
      "na": 5000,
      "eu": 6000,
      "as": 7000,
      "oc": 8000
    }
  },
  "groupId": 10,
  "customFields": {
    "environment": "production",
    "team": "platform"
  }
}

Response

{"stackTrail":"components:schemas:MonitorDto:properties:type","oasType":"schema","type":"unknown"}
intervalnumber required
sslBrandstring nullable required
checkSSLErrorsboolean required
sslExpirationReminderboolean nullable required
domainExpirationReminderboolean nullable required
followRedirectionsboolean required
{"stackTrail":"components:schemas:MonitorDto:properties:authType","oasType":"schema","type":"unknown","nullable":true}
httpUsernamestring
httpPasswordstring
customHttpHeadersobject nullable required
{"stackTrail":"components:schemas:MonitorDto:properties:httpMethodType","oasType":"schema","type":"unknown","nullable":true}
successHttpResponseCodesstring[] required
timeoutnumber nullable required
postValueType'KEY_VALUE' | 'RAW_JSON' nullable required
portnumber nullable required
gracePeriodnumber nullable required
keywordValuestring nullable required
{"stackTrail":"components:schemas:MonitorDto:properties:keywordType","oasType":"schema","type":"unknown","nullable":true}
responseTimeThresholdnumber required
idnumber required
friendlyNamestring required
{"stackTrail":"components:schemas:MonitorDto:properties:status","oasType":"schema","type":"unknown"}
urlstring required
currentStateDurationnumber required
lastIncidentIdstring nullable required
userIdnumber required
apiKeystring nullable required
groupIdnumber nullable
customFieldsobject nullable