Update a monitor

Path parameters

• workspacestringRequired

  Your workspace slug, e.g. dokan.

• monitorintegerRequired

  Monitor id.

• namestringmax 80

  “Give the monitor a name, like “Checkout API”.”

• typeenum

  Check type. One of http, keyword, tcp, heartbeat.

• urlstring, nullableRequiredmax 2048

  Must match ^https?://\S+$. Private and internal addresses are refused at save time.

• hoststring, nullableRequiredmax 253

  Host name or IP, no scheme or path.

• portinteger, nullableRequired

  1–65535.

• methodenumdefault GET

  HTTP method. One of HEAD, GET, POST, PUT, PATCH, DELETE, OPTIONS.

• expected_statusesstring

  1–20 codes (200) or classes (2xx). Default ["2xx","3xx"].

• keywordstring, nullableRequiredmax 200

  Word or phrase to look for.

• keyword_absentbooleandefault false

  Up when the keyword is absent.

• request_headersstring

  Up to 20. name matches ^[A-Za-z0-9-]{1,64}$ and can’t be host, content-length, transfer-encoding, connection, upgrade, te, trailer, proxy-authorization or keep-alive; value max 1000.

• request_bodystring, nullablemax 10000

  Must be valid JSON when body_is_json is true.

• body_is_jsonbooleandefault false

  Send the body as JSON.

• auth_typeenumdefault none

  none clears the stored username and secret. One of none, bearer, basic.

• auth_usernamestring, nullablemax 120

  Basic auth user.

• auth_secretstring, nullablemax 2000

  Token or password. Write-only; an empty value keeps the stored one.

• follow_redirectsbooleandefault true

• verify_sslbooleandefault true

• ssl_remindersbooleandefault true

  Email before the TLS certificate expires.

• timeout_secondsintegerdefault 10

  1–60.

• interval_secondsenumdefault 60

  Check interval. One of 60, 300, 900, 1800, 3600, 43200, 86400.

• failure_thresholdintegerdefault 2

  1–10 failed checks before it’s down.

• slow_after_msinteger, nullable

  100–60000.

• alert_emailbooleandefault true

  Email the team when it goes down or recovers.

• incident_modeenumdefault draft

  When it goes down, open a draft incident or post one straight away. One of draft, publish.

• tagsstring

  Up to 10, each max 32; stored lower-case and de-duplicated.

• metastring

  Up to 20; key max 40, value max 200.

• show_response_timebooleandefault false

  Show response time on the public status page.

• pageobject

  Status page placement: show (boolean, required with page), name (max 80; defaults to the monitor name), component_id (existing component), group_id (existing group). show: false takes it off the page and removes an unused component.

Monitor detail.

• idintegerMonitor id.
• namestringName.
• typeenumCheck type. One of http, keyword, tcp, heartbeat.
• type_labelstringLocalized (HTTPS, Keyword, Port, Heartbeat).
• targetstringURL without scheme, host:port, or “every 5 minutes” for heartbeats (localized).
• statusenumCurrent state. One of pending, up, slow, down, paused.
• status_labelstringLocalized.
• status_changed_atstring|nullISO 8601.
• uptime_90dnumber|nullAverage of daily uptime percentages over checked days.
• response_msinteger|nullLast response time.
• slow_after_msinteger|nullSlow threshold.
• interval_secondsintegerCheck interval.
• last_checked_atstring|nullISO 8601.
• last_errorstring|nullLast failure summary.
• tagsarray<string>Lower-case tags.
• component{id, name, group_id}|nullStatus page component it drives.
• barsarray90 entries, oldest first: {day: YYYY-MM-DD, uptime: percent 0–100 with 3 decimals or null if not checked that day, incident_minutes: integer}.
• paused_atstring|nullISO 8601.
• consecutive_failuresintegerFailures in a row.
• last_status_codeinteger|nullLast HTTP status.
• last_heartbeat_atstring|nullHeartbeats only.
• created_atstringISO 8601.
• ssl{expires_at, days_left, issuer}|nullTLS certificate seen on the last check.
• statsobjectincidents_90d, downtime_minutes_90d, response_median_ms and response_p95_ms (last 24 hours).
• configobjecturl, host, port, method, expected_statuses (default ["2xx","3xx"]), keyword, keyword_absent, request_headers [{name, value}], request_body, body_is_json, auth_type, auth_username, has_secret, secret_hint (last 4 characters, editors only), follow_redirects, verify_ssl, ssl_reminders, timeout_seconds, failure_threshold, alert_email, incident_mode, meta [{key, value}], show_response_time, heartbeat_path. The secret itself is never returned.
• component_detail{id, name, group, group_id}|nullIts status page component.
• recent_checks[]objectLast 20 checks: id, checked_at, ok, slow, in_maintenance, status_code, response_ms, error.
• incidents[]IncidentLast 10 incidents on this monitor or its component (without updates).
• maintenance[]MaintenanceUp to 5 open windows on its component.