monitors

Get a monitor by id

get/monitors/{monitorId}

Path parameters

monitorIdstring required

Response

successtrue required

msgstring required

Example response

{
  "data": {
    "_id": "65f1c2a4d8b9e0123456789a",
    "name": "Marketing site",
    "description": "Production marketing site monitored from the EU region",
    "type": "http",
    "url": "https://www.example.com",
    "port": 443,
    "isActive": true,
    "interval": 60000,
    "status": "up",
    "statusWindowSize": 5,
    "statusWindowThreshold": 3,
    "ignoreTlsErrors": false,
    "useAdvancedMatching": false,
    "notifications": [
      "65f1c2a4d8b9e0123456789b"
    ],
    "cpuAlertThreshold": 90,
    "memoryAlertThreshold": 90,
    "diskAlertThreshold": 90,
    "tempAlertThreshold": 80,
    "selectedDisks": [],
    "geoCheckEnabled": false,
    "geoCheckLocations": [],
    "geoCheckInterval": 300000,
    "teamId": "65f1c2a4d8b9e01234567890",
    "userId": "65f1c2a4d8b9e01234567891",
    "createdAt": "2026-04-01T10:00:00.000Z",
    "updatedAt": "2026-04-15T14:30:00.000Z"
  }
}

Changes

Changed in 9 of the 38 revisions of this API.351932

Aug 28, 2026a9ac59e12c591See the full diff
- ○
  added the optional property data/sshPrivateKey to the response with the 200 status
  response-optional-property-added
Aug 25, 20261f334de2d5592See the full diff
- ○
  added the optional property data/proxyId to the response with the 200 status
  response-optional-property-added
- ○
  added the required property data/proxyMode to the response with the 200 status
  response-required-property-added
Jun 24, 2026648dc5ab47612See the full diff
- ○
  added the required property data/lastEvaluatedAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/method to the response with the 200 status
  response-required-property-added
Jun 9, 2026ca827e5b975f1See the full diff
- ○
  added the optional property data/customUpCodes to the response with the 200 status
  response-optional-property-added
May 27, 2026dd1708803c7c1See the full diff
- ○
  added the required property data/tags to the response with the 200 status
  response-required-property-added
May 11, 202659d86e7d383112See the full diff
- ●
  added the new dns enum value to the data/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property data/dnsRecordType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/dnsServer to the response with the 200 status
  response-optional-property-added
May 1, 202639082d385dda228See the full diff
- ▲
  for the path request parameter monitorId, the minLength was increased from 0 to 1
  request-parameter-min-length-increased
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
- ●
  added the new false enum value to the success response property for the response status 500
  response-property-enum-value-added
- ○
  removed SuccessResponse subschema #2 from the response body allOf list for the response status 200
  response-body-all-of-removed
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  removed the non-success response with the status 404
  response-non-success-status-removed
- ○
  added the optional property data to the response with the 500 status
  response-optional-property-added
- ○
  added the required property data to the response with the 200 status
  response-required-property-added
- ○
  added the required property msg to the response with the 200 status
  response-required-property-added
- ○
  added the required property success to the response with the 200 status
  response-required-property-added
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 11, 2025db719f9e3d34137See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 200
  response-body-type-changed
- ●
  removed the optional property data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property msg from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 200 status
  response-optional-property-removed
- ○
  added SuccessResponse subschema #2 to the response body allOf list for the response status 200
  response-body-all-of-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  removed the non-success response with the status 422
  response-non-success-status-removed
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  the response property msg became required for the status 500
  response-property-became-required
- ○
  the response property success became required for the status 500
  response-property-became-required
- ○
  the success response's property default value false was removed for the status 500
  response-property-default-value-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 20, 2025b97ec6888b3c32138See the full diff
- ▲
  the response property data became optional for the status 200
  response-property-became-optional
- ▲
  the response property msg became optional for the status 200
  response-property-became-optional
- ▲
  the response property msg became optional for the status 500
  response-property-became-optional
- ▲
  the response property success became optional for the status 200
  response-property-became-optional
- ▲
  the response property success became optional for the status 500
  response-property-became-optional
- ▲
  removed the required property data/_id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/cpuAlertThreshold from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/createdAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/diskAlertThreshold from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/geoCheckEnabled from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/geoCheckInterval from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/geoCheckLocations from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/ignoreTlsErrors from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/interval from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/isActive from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/lastEvaluatedAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/memoryAlertThreshold from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/method from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/notifications from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/selectedDisks from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/status from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/statusWindowSize from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/statusWindowThreshold from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/tags from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/teamId from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/tempAlertThreshold from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/type from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/updatedAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/url from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/useAdvancedMatching from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/userId from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property data from the response with the 500 status
  response-optional-property-removed
- ●
  removed the optional property data/customUpCodes from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/description from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/dnsRecordType from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/dnsServer from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/expectedValue from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/gameId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/group from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/grpcServiceName from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/jsonPath from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/matchMethod from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/port from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/secret from the response with the 200 status
  response-optional-property-removed
- ○
  for the path request parameter monitorId, the minLength was decreased from 1 to 0
  request-parameter-min-length-decreased
- ○
  added the non-success response with the status 422
  response-non-success-status-added
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  the success response's property default value false was added for the status 500
  response-property-default-value-added
- ○
  the success response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  removed the false enum value from the success response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the true enum value from the success response property for the response status 200
  response-property-enum-value-removed
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history