Sign in

v3

latestOpenAPI 3.0.02026-07-2759120262.8 KB
Monitors

Create a monitor

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 body

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

{"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