Monitors

Update monitor

put/monitors/{monitorId}

Request

  • Base URL: https://api.pulsetic.com/api/public
  • URL: https://api.pulsetic.com/api/public/monitors/{monitorId}
  • Auth: API key in header Authorization

Path parameters

monitorIdinteger required
Example:2

Request body

urlstring
namestring
uptime_check_frequencystring
offline_notification_delaystring
ssl_checkboolean
is_runningboolean

Pause (false) or unpause (true) the monitor.

tagsstring[]

Replaces the monitor's tags with this list (existing tags with the same name are reused, unknown names are created automatically). Send an empty array to remove all tags; omit this field to leave existing tags untouched.

Example request

{
  "url": "https://mozilla.org",
  "name": "Mozilla Page",
  "uptime_check_frequency": "600",
  "offline_notification_delay": "10",
  "ssl_check": true,
  "is_running": true,
  "request": {
    "body_json": "{\"hello\":\"world\"}",
    "headers": [
      {
        "name": "Accept",
        "value": "application/json"
      }
    ]
  },
  "response": {
    "headers": [
      {
        "name": "Accept",
        "value": "application/json"
      }
    ]
  },
  "tags": [
    "production",
    "critical"
  ]
}

Response

successful operation

idinteger
latest_check_idinteger
namestring
urlstring
statusstring
ssl_certificate_statestring
ssl_checkinteger
ipstring
latitudeinteger
longitudestring
is_runningboolean
is_negativeinteger
uptime_check_frequencyinteger
offline_notification_delayinteger
request_typestring
tcp_portsstring
request_methodstring
request_body_typestring
request_body_rawstring
request_body_jsonstring
request_timeoutinteger
response_bodystring
response_codestring
response_expected_codestring
snapshots_average_uptimestring
uptimestring
response_timeinteger
lighthouse_audit_enabledboolean
mobile_performance_scorestring
mobile_seo_scorestring
mobile_pwa_scorestring
mobile_accessibility_scorestring
mobile_best_practices_scorestring
desktop_performance_scorestring
desktop_seo_scorestring
desktop_pwa_scorestring
desktop_accessibility_scorestring
desktop_best_practices_scorestring
total_checksinteger
unpaid_checksinteger
billed_checksinteger
telegram_hashstring
checked_atstring date-time
positioninteger
disabledinteger
status_changed_atstring date-time
fast_checkedstring date-time nullable
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time

Example response

{
  "id": 2,
  "status": "online",
  "ssl_certificate_state": "valid",
  "ssl_check": 1,
  "uptime_check_frequency": 3600,
  "offline_notification_delay": 12,
  "request_type": "http",
  "tcp_ports": "89, 7345",
  "request_headers": [
    {
      "name": "Accept",
      "value": "application/json"
    }
  ],
  "request_timeout": 10,
  "snapshots_average_uptime": "0.9376842",
  "uptime": "1.0000000",
  "ssl_certificate": {
    "is_valid": 1
  },
  "tags": [
    {
      "name": "production"
    },
    {
      "name": "critical"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.