{"openapi":"3.1.0","info":{"title":"Observe API","version":"1.0.0","description":"Monitors, incidents, check results and maintenance windows. Send a personal access token as a bearer token. Docs: https://observe.live/docs/api"},"servers":[{"url":"https://observe.live/api/v1"}],"security":[{"bearerAuth":[]}],"paths":{"/public-metrics":{"get":{"operationId":"getPublicMetrics","summary":"Public product metrics (no token needed)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Public"]}},"/monitors":{"get":{"operationId":"listMonitors","summary":"List monitors","parameters":[{"name":"organization_id","in":"query","schema":{"type":"string"}},{"name":"team_id","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Monitor"}},"links":{"type":"object"},"meta":{"type":"object"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Monitors"]},"post":{"operationId":"createMonitor","summary":"Create a website monitor; any check type can be turned on and set up here","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","maxLength":2048},"label":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"},"maxItems":20},"team_id":{"type":["string","null"]},"critical":{"type":"boolean","description":"Down alerts skip quiet hours"},"ssl_monitoring_enabled":{"type":"boolean","description":"SSL"},"ssl_interval_minutes":{"type":["integer","null"],"minimum":15,"maximum":1440,"description":"SSL"},"ssl_expiring_soon_days":{"type":["integer","null"],"minimum":1,"maximum":90,"description":"SSL"},"ssl_alert_on_every_change":{"type":"boolean","description":"SSL"},"uptime_monitoring_enabled":{"type":"boolean","description":"Uptime"},"uptime_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":60,"description":"Uptime"},"uptime_check_method":{"type":["string","null"],"enum":["GET","POST","PUT","PATCH"],"description":"Uptime"},"uptime_check_body":{"type":["string","null"],"maxLength":10000,"description":"Uptime"},"uptime_check_headers":{"type":["object","array","string","null"],"description":"Request headers, e.g. {\"Accept\": \"text/html\"}. Objects are stored as sent; a string must be JSON."},"uptime_check_string":{"type":["string","null"],"maxLength":500,"description":"Uptime"},"uptime_check_absent_string":{"type":["string","null"],"maxLength":500,"description":"Uptime"},"uptime_check_json_assertions":{"type":["object","array","string","null"],"description":"JSON response assertions (dot paths), e.g. [{\"path\": \"status\", \"expected\": \"ok\"}]. Objects are stored as sent; a string must be JSON."},"uptime_check_header_patterns":{"type":["object","array","string","null"],"description":"Response headers that must match, a regex or substring, e.g. [{\"header\": \"Content-Type\", \"pattern\": \"text/html\"}]. Objects are stored as sent; a string must be JSON."},"uptime_expected_codes":{"type":["string","null"],"maxLength":100,"description":"Uptime"},"uptime_response_time_threshold_ms":{"type":["integer","null"],"minimum":0,"description":"Uptime"},"uptime_response_time_variance_pct":{"type":["integer","null"],"minimum":1,"maximum":1000,"description":"Uptime"},"uptime_alert_after_failures":{"type":["integer","null"],"minimum":1,"maximum":10,"description":"Uptime"},"uptime_alert_after_minutes":{"type":["integer","null"],"minimum":1,"maximum":60,"description":"Uptime"},"uptime_timeout_seconds":{"type":["integer","null"],"minimum":1,"maximum":30,"description":"Uptime"},"uptime_max_redirects":{"type":["integer","null"],"minimum":0,"maximum":10,"description":"Uptime"},"heartbeat_enabled":{"type":"boolean","description":"Heartbeat"},"heartbeat_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":1440,"description":"Heartbeat"},"heartbeat_grace_minutes":{"type":["integer","null"],"minimum":0,"maximum":60,"description":"Heartbeat"},"heartbeat_cron_expression":{"type":["string","null"],"maxLength":120,"description":"Heartbeat"},"heartbeat_timezone":{"type":["string","null"],"description":"Heartbeat: IANA timezone"},"dns_blocklist_monitoring_enabled":{"type":"boolean","description":"DNS blocklist"},"sitemap_monitoring_enabled":{"type":"boolean","description":"Sitemap"},"crawl_monitoring_enabled":{"type":"boolean","description":"Crawl"},"crawl_max_depth":{"type":["integer","null"],"minimum":1,"maximum":20,"description":"Crawl"},"crawl_max_pages":{"type":["integer","null"],"minimum":10,"maximum":50000,"description":"Crawl"},"crawl_time_limit_minutes":{"type":["integer","null"],"minimum":5,"maximum":240,"description":"Crawl: stop after this many minutes"},"crawl_interval_minutes":{"type":["integer","null"],"minimum":60,"maximum":525600,"description":"Crawl"},"crawl_alert_on_broken":{"type":"boolean","description":"Crawl"},"crawl_alert_on_mixed_content":{"type":"boolean","description":"Crawl"},"crawl_alert_on_console_errors":{"type":"boolean","description":"Crawl"},"crawl_alert_on_lighthouse_regression":{"type":"boolean","description":"Crawl"},"crawl_alert_on_screenshot_diff":{"type":"boolean","description":"Crawl"},"crawl_lighthouse_regression_threshold":{"type":["integer","null"],"minimum":0,"maximum":100,"description":"Crawl"},"crawl_screenshot_diff_threshold_pct":{"type":["integer","null"],"minimum":1,"maximum":100,"description":"Crawl"},"crawl_seed_from_sitemap":{"type":"boolean","description":"Crawl"},"crawl_respect_robots_txt":{"type":"boolean","description":"Crawl"},"crawl_check_external_links":{"type":"boolean","description":"Crawl"},"crawl_ignore_patterns":{"type":["array","string","null"],"items":{"type":"string"},"description":"Crawl: URL patterns to skip, e.g. [\"/admin/*\"] (or one per line), up to 100"},"crawl_request_headers":{"type":["object","array","string","null"],"description":"Headers the crawler sends, e.g. {\"Authorization\": \"Bearer \u2026\"}. Objects are stored as sent; a string must be JSON."},"robots_txt_monitoring_enabled":{"type":"boolean","description":"Robots.txt"},"lighthouse_monitoring_enabled":{"type":"boolean","description":"Lighthouse"},"lighthouse_strategy":{"type":"string","enum":["mobile","desktop"],"description":"Lighthouse"},"lighthouse_thresholds":{"type":"object","description":"Lighthouse thresholds; keys you leave out keep their values","properties":{"min_score":{"type":["integer","null"],"minimum":0,"maximum":100},"max_fcp_ms":{"type":["integer","null"],"minimum":100,"maximum":60000},"max_lcp_ms":{"type":["integer","null"],"minimum":100,"maximum":60000},"max_tbt_ms":{"type":["integer","null"],"minimum":0,"maximum":60000},"max_cls":{"type":["number","null"],"minimum":0,"maximum":5}}},"domain_monitoring_enabled":{"type":"boolean","description":"Domain"},"dns_record_monitoring_enabled":{"type":"boolean","description":"DNS records"},"reverse_monitoring_enabled":{"type":"boolean","description":"Reverse monitor"},"reverse_monitor_host":{"type":["string","null"],"maxLength":255,"description":"Reverse monitor"},"reverse_monitor_port":{"type":["integer","null"],"minimum":1,"maximum":65535,"description":"Reverse monitor"},"status_page_enabled":{"type":"boolean","description":"Status page"},"status_slug":{"type":["string","null"],"maxLength":64,"description":"Status page"},"status_page_title":{"type":["string","null"],"maxLength":255,"description":"Status page"},"status_page_message":{"type":["string","null"],"maxLength":500,"description":"Status page"},"status_page_show":{"type":["array","null"],"description":"Status page","items":{"type":"string","enum":["uptime","ssl","heartbeat","incidents"]}},"organization_id":{"type":["string","null"]}},"required":["url"]},"example":{"url":"https://example.com","label":"Marketing site","tags":["marketing"],"uptime_interval_minutes":1,"crawl_monitoring_enabled":true,"lighthouse_monitoring_enabled":true,"domain_monitoring_enabled":true}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Monitor"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Monitors"]}},"/monitors/{monitor_id}":{"get":{"operationId":"getMonitor","summary":"Get a monitor","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Monitor"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Monitors"]},"patch":{"operationId":"updateMonitor","summary":"Update a monitor: only the fields you send change; turning a check type on queues its first check","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","maxLength":2048},"label":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"},"maxItems":20},"team_id":{"type":["string","null"]},"critical":{"type":"boolean","description":"Down alerts skip quiet hours"},"ssl_monitoring_enabled":{"type":"boolean","description":"SSL"},"ssl_interval_minutes":{"type":["integer","null"],"minimum":15,"maximum":1440,"description":"SSL"},"ssl_expiring_soon_days":{"type":["integer","null"],"minimum":1,"maximum":90,"description":"SSL"},"ssl_alert_on_every_change":{"type":"boolean","description":"SSL"},"uptime_monitoring_enabled":{"type":"boolean","description":"Uptime"},"uptime_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":60,"description":"Uptime"},"uptime_check_method":{"type":["string","null"],"enum":["GET","POST","PUT","PATCH"],"description":"Uptime"},"uptime_check_body":{"type":["string","null"],"maxLength":10000,"description":"Uptime"},"uptime_check_headers":{"type":["object","array","string","null"],"description":"Request headers, e.g. {\"Accept\": \"text/html\"}. Objects are stored as sent; a string must be JSON."},"uptime_check_string":{"type":["string","null"],"maxLength":500,"description":"Uptime"},"uptime_check_absent_string":{"type":["string","null"],"maxLength":500,"description":"Uptime"},"uptime_check_json_assertions":{"type":["object","array","string","null"],"description":"JSON response assertions (dot paths), e.g. [{\"path\": \"status\", \"expected\": \"ok\"}]. Objects are stored as sent; a string must be JSON."},"uptime_check_header_patterns":{"type":["object","array","string","null"],"description":"Response headers that must match, a regex or substring, e.g. [{\"header\": \"Content-Type\", \"pattern\": \"text/html\"}]. Objects are stored as sent; a string must be JSON."},"uptime_expected_codes":{"type":["string","null"],"maxLength":100,"description":"Uptime"},"uptime_response_time_threshold_ms":{"type":["integer","null"],"minimum":0,"description":"Uptime"},"uptime_response_time_variance_pct":{"type":["integer","null"],"minimum":1,"maximum":1000,"description":"Uptime"},"uptime_alert_after_failures":{"type":["integer","null"],"minimum":1,"maximum":10,"description":"Uptime"},"uptime_alert_after_minutes":{"type":["integer","null"],"minimum":1,"maximum":60,"description":"Uptime"},"uptime_timeout_seconds":{"type":["integer","null"],"minimum":1,"maximum":30,"description":"Uptime"},"uptime_max_redirects":{"type":["integer","null"],"minimum":0,"maximum":10,"description":"Uptime"},"heartbeat_enabled":{"type":"boolean","description":"Heartbeat"},"heartbeat_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":1440,"description":"Heartbeat"},"heartbeat_grace_minutes":{"type":["integer","null"],"minimum":0,"maximum":60,"description":"Heartbeat"},"heartbeat_cron_expression":{"type":["string","null"],"maxLength":120,"description":"Heartbeat"},"heartbeat_timezone":{"type":["string","null"],"description":"Heartbeat: IANA timezone"},"dns_blocklist_monitoring_enabled":{"type":"boolean","description":"DNS blocklist"},"sitemap_monitoring_enabled":{"type":"boolean","description":"Sitemap"},"crawl_monitoring_enabled":{"type":"boolean","description":"Crawl"},"crawl_max_depth":{"type":["integer","null"],"minimum":1,"maximum":20,"description":"Crawl"},"crawl_max_pages":{"type":["integer","null"],"minimum":10,"maximum":50000,"description":"Crawl"},"crawl_time_limit_minutes":{"type":["integer","null"],"minimum":5,"maximum":240,"description":"Crawl: stop after this many minutes"},"crawl_interval_minutes":{"type":["integer","null"],"minimum":60,"maximum":525600,"description":"Crawl"},"crawl_alert_on_broken":{"type":"boolean","description":"Crawl"},"crawl_alert_on_mixed_content":{"type":"boolean","description":"Crawl"},"crawl_alert_on_console_errors":{"type":"boolean","description":"Crawl"},"crawl_alert_on_lighthouse_regression":{"type":"boolean","description":"Crawl"},"crawl_alert_on_screenshot_diff":{"type":"boolean","description":"Crawl"},"crawl_lighthouse_regression_threshold":{"type":["integer","null"],"minimum":0,"maximum":100,"description":"Crawl"},"crawl_screenshot_diff_threshold_pct":{"type":["integer","null"],"minimum":1,"maximum":100,"description":"Crawl"},"crawl_seed_from_sitemap":{"type":"boolean","description":"Crawl"},"crawl_respect_robots_txt":{"type":"boolean","description":"Crawl"},"crawl_check_external_links":{"type":"boolean","description":"Crawl"},"crawl_ignore_patterns":{"type":["array","string","null"],"items":{"type":"string"},"description":"Crawl: URL patterns to skip, e.g. [\"/admin/*\"] (or one per line), up to 100"},"crawl_request_headers":{"type":["object","array","string","null"],"description":"Headers the crawler sends, e.g. {\"Authorization\": \"Bearer \u2026\"}. Objects are stored as sent; a string must be JSON."},"robots_txt_monitoring_enabled":{"type":"boolean","description":"Robots.txt"},"lighthouse_monitoring_enabled":{"type":"boolean","description":"Lighthouse"},"lighthouse_strategy":{"type":"string","enum":["mobile","desktop"],"description":"Lighthouse"},"lighthouse_thresholds":{"type":"object","description":"Lighthouse thresholds; keys you leave out keep their values","properties":{"min_score":{"type":["integer","null"],"minimum":0,"maximum":100},"max_fcp_ms":{"type":["integer","null"],"minimum":100,"maximum":60000},"max_lcp_ms":{"type":["integer","null"],"minimum":100,"maximum":60000},"max_tbt_ms":{"type":["integer","null"],"minimum":0,"maximum":60000},"max_cls":{"type":["number","null"],"minimum":0,"maximum":5}}},"domain_monitoring_enabled":{"type":"boolean","description":"Domain"},"dns_record_monitoring_enabled":{"type":"boolean","description":"DNS records"},"reverse_monitoring_enabled":{"type":"boolean","description":"Reverse monitor"},"reverse_monitor_host":{"type":["string","null"],"maxLength":255,"description":"Reverse monitor"},"reverse_monitor_port":{"type":["integer","null"],"minimum":1,"maximum":65535,"description":"Reverse monitor"},"status_page_enabled":{"type":"boolean","description":"Status page"},"status_slug":{"type":["string","null"],"maxLength":64,"description":"Status page"},"status_page_title":{"type":["string","null"],"maxLength":255,"description":"Status page"},"status_page_message":{"type":["string","null"],"maxLength":500,"description":"Status page"},"status_page_show":{"type":["array","null"],"description":"Status page","items":{"type":"string","enum":["uptime","ssl","heartbeat","incidents"]}}}},"example":{"crawl_monitoring_enabled":true,"crawl_max_pages":500,"crawl_ignore_patterns":["/admin/*"],"lighthouse_strategy":"desktop","lighthouse_thresholds":{"min_score":80}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Monitor"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Monitors"]},"delete":{"operationId":"deleteMonitor","summary":"Delete a monitor","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Monitors"]}},"/monitors/{monitor_id}/status":{"get":{"operationId":"getMonitorStatus","summary":"Current up/down, incident, maintenance and snooze state","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MonitorStatus"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Monitors"]}},"/monitors/{monitor_id}/uptime":{"get":{"operationId":"listUptimeChecks","summary":"Latest 50 uptime checks with 30-day uptime and 7-day average response time","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UptimeCheck"}},"meta":{"type":"object","properties":{"uptime_percentage_30d":{"type":["number","null"]},"average_response_time_ms_7d":{"type":["number","null"]}}}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Results"]}},"/monitors/{monitor_id}/incidents":{"get":{"operationId":"listIncidents","summary":"Incidents, newest first, with private team notes","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Incident"}},"links":{"type":"object"},"meta":{"type":"object"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Incidents"]}},"/monitors/{monitor_id}/incidents/{incident_id}/acknowledge":{"post":{"operationId":"acknowledgeIncident","summary":"Acknowledge an open incident; mutes its alerts until it resolves","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"incident_id","in":"path","required":true,"schema":{"type":"string"},"description":"Incident ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Incident"}},"required":["data"]}}}},"409":{"description":"Already resolved"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Incidents"]}},"/monitors/{monitor_id}/incidents/{incident_id}/notes":{"post":{"operationId":"addIncidentNote","summary":"Add a private team note (never sent in alerts)","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"incident_id","in":"path","required":true,"schema":{"type":"string"},"description":"Incident ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","maxLength":5000}},"required":["body"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IncidentNote"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Incidents"]}},"/monitors/{monitor_id}/check":{"post":{"operationId":"runCheck","summary":"Queue a check now (uptime unless type says otherwise); a disabled type is 422","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["uptime","ssl","dns-blocklist","sitemap","crawl","robots","lighthouse","domain","dns-record","reverse-monitor"],"default":"uptime"}}}}}},"responses":{"202":{"description":"Queued","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"queued":{"type":"boolean"},"type":{"type":"string"}}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Checks and alerts"]}},"/monitors/{monitor_id}/snooze":{"post":{"operationId":"snoozeAlerts","summary":"Snooze alerts","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hours":{"type":"integer","enum":[1,4,24,168]}},"required":["hours"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"alerts_snoozed_until":{"type":["string","null"],"format":"date-time"}}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Checks and alerts"]},"delete":{"operationId":"unsnoozeAlerts","summary":"Resume alerts","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"alerts_snoozed_until":{"type":["string","null"],"format":"date-time"}}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Checks and alerts"]}},"/monitors/{monitor_id}/{type}":{"get":{"operationId":"listCheckResults","summary":"Results for one check type, newest first","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["ssl","domain","dns","lighthouse","crawls","heartbeats","sitemap","robots","blocklist","reverse"]}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"Fields per type: ssl: id, checked_at, valid, expires_at, not_before, issuer, subject, signature_algorithm, has_weak_algorithm, hostname_mismatch, tls_version, error_message; domain: id, checked_at, domain, expires_at, statuses, registrar, error_message; dns: id, checked_at, records, changes; lighthouse: id, checked_at, strategy, performance_score, accessibility_score, best_practices_score, seo_score, lcp_ms, fcp_ms, cls, tbt_ms, error_message; crawls: id, started_at, completed_at, status, total_pages, successful_pages, failed_pages, finish_reason, error_message; heartbeats: id, received_at, kind, runtime_seconds, memory_bytes, exit_code, message; sitemap: id, checked_at, sitemap_url, urls_count, ok, warnings, error_message; robots: id, checked_at, robots_txt_url, ok, error_message; blocklist: id, checked_at, listed_on; reverse: id, checked_at, reachable, connect_time_ms"}},"links":{"type":"object"},"meta":{"$ref":"#/components/schemas/PageMeta"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Results"]}},"/monitors/{monitor_id}/sla":{"get":{"operationId":"getSlaReport","summary":"Uptime (SLA) report for a range","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"range","in":"query","schema":{"type":"string","enum":["24h","7d","30d","custom"],"default":"7d"}},{"name":"start","in":"query","schema":{"type":"string","format":"date"},"description":"custom range, Y-m-d"},{"name":"end","in":"query","schema":{"type":"string","format":"date"},"description":"custom range, Y-m-d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SlaReport"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Results"]}},"/monitors/{monitor_id}/crawls/{run_id}/pages":{"get":{"operationId":"listCrawlPages","summary":"Pages a crawl visited; filter=broken for broken links","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"run_id","in":"path","required":true,"schema":{"type":"string"},"description":"Crawl ID (from /monitors/{monitor_id}/crawls)"},{"name":"filter","in":"query","schema":{"type":"string","enum":["success","failed","broken","mixed"]}},{"name":"search","in":"query","schema":{"type":"string"},"description":"Part of a URL or title"},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CrawledPage"}},"links":{"type":"object"},"meta":{"$ref":"#/components/schemas/PageMeta"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Results"]}},"/oh-dear/monitors":{"get":{"operationId":"ohDearListMonitors","summary":"Oh Dear listMonitors","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OhDearMonitor"}},"links":{"type":"object"},"meta":{"type":"object"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]},"post":{"operationId":"ohDearCreateMonitor","summary":"Oh Dear createMonitor (type http only; team_id is an organization ID, a numeric one means your own)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string","enum":["http"]},"team_id":{"type":["string","integer","null"]},"friendly_name":{"type":["string","null"]},"label":{"type":["string","null"]}},"required":["url"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OhDearMonitor"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]}},"/oh-dear/monitors/{monitor_id}":{"get":{"operationId":"ohDearGetMonitor","summary":"Oh Dear getMonitor","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OhDearMonitor"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]}},"/oh-dear/monitors/{monitor_id}/uptime":{"get":{"operationId":"ohDearGetUptime","summary":"Oh Dear getUptime (split=hour covers at most 7 days)","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"filter[started_at]","in":"query","required":true,"schema":{"type":"string"},"description":"YmdHis, UTC"},{"name":"filter[ended_at]","in":"query","required":true,"schema":{"type":"string"},"description":"YmdHis, UTC"},{"name":"split","in":"query","required":true,"schema":{"type":"string","enum":["hour","day","month"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"datetime":{"type":"string"},"uptime_percentage":{"type":"number"}}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]}},"/oh-dear/monitors/{monitor_id}/downtime":{"get":{"operationId":"ohDearGetDowntime","summary":"Oh Dear getDowntime","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"filter[started_at]","in":"query","required":true,"schema":{"type":"string"},"description":"YmdHis, UTC"},{"name":"filter[ended_at]","in":"query","required":true,"schema":{"type":"string"},"description":"YmdHis, UTC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"started_at":{"type":"string"},"ended_at":{"type":["string","null"]},"notes_html":{"type":"string"},"notes_markdown":{"type":"string"}}}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]}},"/oh-dear/checks/{check_id}/request-run":{"post":{"operationId":"ohDearRequestCheckRun","summary":"Oh Dear requestCheckRun","parameters":[{"name":"check_id","in":"path","required":true,"schema":{"type":"string"},"description":"Check ID: {monitor_id}-uptime or {monitor_id}-certificate_health"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OhDearCheck"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]}},"/oh-dear/checks/{check_id}/snooze":{"post":{"operationId":"ohDearSnoozeCheck","summary":"Oh Dear snoozeCheck (snoozes every alert for the monitor)","parameters":[{"name":"check_id","in":"path","required":true,"schema":{"type":"string"},"description":"Check ID: {monitor_id}-uptime or {monitor_id}-certificate_health"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"minutes":{"type":"integer","minimum":1,"maximum":10080}},"required":["minutes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OhDearCheck"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]}},"/oh-dear/checks/{check_id}/unsnooze":{"post":{"operationId":"ohDearUnsnoozeCheck","summary":"Oh Dear unsnoozeCheck","parameters":[{"name":"check_id","in":"path","required":true,"schema":{"type":"string"},"description":"Check ID: {monitor_id}-uptime or {monitor_id}-certificate_health"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OhDearCheck"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Oh Dear compatible"]}},"/organizations":{"get":{"operationId":"listOrganizations","summary":"Organizations you belong to, with your role, plan, usage and billing state","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Organizations"]}},"/organizations/{organization_id}/maintenance-windows":{"get":{"operationId":"listMaintenanceWindows","summary":"Maintenance windows","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceWindow"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Maintenance"]},"post":{"operationId":"createMaintenanceWindow","summary":"Schedule a maintenance window (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":255},"description":{"type":["string","null"]},"starts_at":{"type":"string","format":"date-time"},"ends_at":{"type":"string","format":"date-time"},"monitor_ids":{"type":"array","items":{"type":"string"},"description":"Specific monitors; omit monitor_ids, team_id and tags for every monitor"},"team_id":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"},"description":"Monitors with any of these tags"},"recurrence":{"type":["string","null"],"enum":["weekly","monthly",null]},"timezone":{"type":["string","null"],"description":"Keeps a repeating window's local time across DST"}},"required":["title","starts_at","ends_at"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MaintenanceWindow"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Maintenance"]}},"/organizations/{organization_id}/maintenance-windows/{window_id}":{"delete":{"operationId":"cancelMaintenanceWindow","summary":"Cancel a maintenance window (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"window_id","in":"path","required":true,"schema":{"type":"string"},"description":"Maintenance window ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MaintenanceWindow"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Maintenance"]}},"/organizations/{organization_id}/incidents":{"get":{"operationId":"listOrganizationIncidents","summary":"Incidents across the monitors you can see, open first","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"status","in":"query","schema":{"type":"string","enum":["open","resolved"]}},{"name":"monitor_id","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Incident"}},"links":{"type":"object"},"meta":{"$ref":"#/components/schemas/PageMeta"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Incidents"]}},"/organizations/{organization_id}/status-pages":{"get":{"operationId":"listStatusPages","summary":"Additional status pages","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StatusPage"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]},"post":{"operationId":"createStatusPage","summary":"Create a status page (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":255},"slug":{"type":"string","maxLength":64,"description":"Lowercase letters, digits and dashes; slugified for you"},"message":{"type":["string","null"]},"site_ids":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Monitors on the page"},"logo_url":{"type":["string","null"]},"accent_color":{"type":["string","null"],"description":"Hex colour, e.g. #0f766e"},"locale":{"type":"string","enum":["en","es","fr","de","nl","pt"],"default":"en"},"private":{"type":"boolean","description":"Only people with the private link can see it"},"auto_updates":{"type":"boolean","description":"Post an update automatically when a monitor on the page goes down and comes back"}},"required":["title","slug","site_ids"]},"example":{"title":"Acme status","slug":"acme","site_ids":["MONITOR_ID"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StatusPage"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]}},"/organizations/{organization_id}/status-pages/{status_page_id}":{"patch":{"operationId":"updateStatusPage","summary":"Edit a status page (admins); fields you leave out keep their values","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"status_page_id","in":"path","required":true,"schema":{"type":"string"},"description":"Status page ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":255},"slug":{"type":"string","maxLength":64,"description":"Lowercase letters, digits and dashes; slugified for you"},"message":{"type":["string","null"]},"site_ids":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Monitors on the page"},"logo_url":{"type":["string","null"]},"accent_color":{"type":["string","null"],"description":"Hex colour, e.g. #0f766e"},"locale":{"type":"string","enum":["en","es","fr","de","nl","pt"],"default":"en"},"private":{"type":"boolean","description":"Only people with the private link can see it"},"auto_updates":{"type":"boolean","description":"Post an update automatically when a monitor on the page goes down and comes back"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StatusPage"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]},"delete":{"operationId":"deleteStatusPage","summary":"Delete a status page (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"status_page_id","in":"path","required":true,"schema":{"type":"string"},"description":"Status page ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]}},"/organizations/{organization_id}/status-page-updates":{"get":{"operationId":"listStatusPageUpdates","summary":"Updates posted to your status pages, pinned first","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageUpdate"}},"meta":{"$ref":"#/components/schemas/PageMeta"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]},"post":{"operationId":"postStatusPageUpdate","summary":"Post an update (admins); it is public at once","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":255},"body":{"type":"string","maxLength":5000},"severity":{"type":"string","enum":["info","warning","high","resolved","scheduled"]},"pinned":{"type":"boolean"},"status_page_id":{"type":["string","null"],"description":"An additional page; omit for the main page"}},"required":["title","body","severity"]},"example":{"title":"Database maintenance","body":"Checkout will be read-only from 22:00 to 22:30 UTC.","severity":"scheduled","pinned":true}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StatusPageUpdate"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]}},"/organizations/{organization_id}/status-page-updates/{update_id}":{"patch":{"operationId":"updateStatusPageUpdate","summary":"Edit or pin an update (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"update_id","in":"path","required":true,"schema":{"type":"string"},"description":"Status page update ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":255},"body":{"type":"string","maxLength":5000},"severity":{"type":"string","enum":["info","warning","high","resolved","scheduled"]},"pinned":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StatusPageUpdate"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]},"delete":{"operationId":"deleteStatusPageUpdate","summary":"Delete an update (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"update_id","in":"path","required":true,"schema":{"type":"string"},"description":"Status page update ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Status pages"]}},"/organizations/{organization_id}/notification-channels":{"get":{"operationId":"listNotificationChannels","summary":"Where alerts go (admins). Secrets are never returned","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Notifications"]},"post":{"operationId":"createNotificationChannel","summary":"Add a destination (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","webhook","discord","telegram","pagerduty","opsgenie","jsm","teams","googlechat","pushover","ntfy"]},"label":{"type":["string","null"]},"team_id":{"type":["string","null"],"description":"Only alerts for this team's monitors"},"enabled":{"type":"boolean"},"use_org_recipients":{"type":"boolean","description":"email: send to the organization's owners and admins (default)"},"email":{"type":"string","description":"email: a fixed address when use_org_recipients is false"},"webhook_url":{"type":"string","format":"uri","description":"slack, discord, teams, googlechat and webhook"},"bot_token":{"type":"string","description":"telegram"},"chat_id":{"type":"string","description":"telegram"},"routing_key":{"type":"string","description":"pagerduty"},"api_key":{"type":"string","description":"opsgenie and jsm (Jira Service Management Operations, Opsgenie's successor): the API integration key"},"eu_region":{"type":"boolean","description":"opsgenie: api.eu.opsgenie.com"},"priority":{"type":"string","enum":["auto","P1","P2","P3","P4","P5"],"description":"opsgenie and jsm: auto (P1 for critical monitors, else P3) or a fixed priority"},"responder_team":{"type":"string","maxLength":100,"description":"opsgenie and jsm: team that receives the alert (default: the integration's team)"},"api_token":{"type":"string","description":"pushover"},"user_key":{"type":"string","description":"pushover"},"topic":{"type":"string","description":"ntfy"},"server_url":{"type":"string","description":"ntfy: your own server (default ntfy.sh)"},"event_types":{"type":"array","items":{"type":"string","enum":["uptime_incident_opened","uptime_incident_resolved","performance_budget_exceeded","performance_budget_recovered","ssl_expiring_soon","ssl_certificate_invalid","certificate_changed","sitemap_check_failed","lighthouse_scores_regressed","domain_expiring_soon","domain_expired","domain_blocklist_listed","server_health_check_failed","server_ssl_check_failed","server_ping_failed","server_heartbeat_missed","server_recovered","port_scan_anomaly","health_check_missed","health_check_failed","health_check_recovered","ai_check_failed","dns_record_changed","dns_nameservers_out_of_sync","reverse_monitor_exposed","crawl_new_issues_found","monthly_report"]},"description":"Only these events; omit (or all_events: true) for every event"},"all_events":{"type":"boolean"},"delivery_hours":{"type":"string","enum":["always","business","outside"]},"tag_filter":{"type":["array","string","null"],"items":{"type":"string"},"description":"Only monitors with any of these tags"},"category_modes":{"type":"object","additionalProperties":{"type":"string","enum":["immediate","digest","off"]},"description":"Per event category: immediate, digest or off"},"quiet_hours_start":{"type":["string","null"],"description":"H:i"},"quiet_hours_end":{"type":["string","null"],"description":"H:i"}},"required":["type"]},"example":{"type":"webhook","label":"Incident bot","webhook_url":"https://hooks.example.com/observe","event_types":["uptime_incident_opened","uptime_incident_resolved"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NotificationChannel"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Notifications"]}},"/organizations/{organization_id}/notification-channels/{channel_id}":{"patch":{"operationId":"updateNotificationChannel","summary":"Edit a destination (admins); fields you leave out keep their values","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"channel_id","in":"path","required":true,"schema":{"type":"string"},"description":"Notification channel ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","webhook","discord","telegram","pagerduty","opsgenie","jsm","teams","googlechat","pushover","ntfy"]},"label":{"type":["string","null"]},"team_id":{"type":["string","null"],"description":"Only alerts for this team's monitors"},"enabled":{"type":"boolean"},"use_org_recipients":{"type":"boolean","description":"email: send to the organization's owners and admins (default)"},"email":{"type":"string","description":"email: a fixed address when use_org_recipients is false"},"webhook_url":{"type":"string","format":"uri","description":"slack, discord, teams, googlechat and webhook"},"bot_token":{"type":"string","description":"telegram"},"chat_id":{"type":"string","description":"telegram"},"routing_key":{"type":"string","description":"pagerduty"},"api_key":{"type":"string","description":"opsgenie and jsm (Jira Service Management Operations, Opsgenie's successor): the API integration key"},"eu_region":{"type":"boolean","description":"opsgenie: api.eu.opsgenie.com"},"priority":{"type":"string","enum":["auto","P1","P2","P3","P4","P5"],"description":"opsgenie and jsm: auto (P1 for critical monitors, else P3) or a fixed priority"},"responder_team":{"type":"string","maxLength":100,"description":"opsgenie and jsm: team that receives the alert (default: the integration's team)"},"api_token":{"type":"string","description":"pushover"},"user_key":{"type":"string","description":"pushover"},"topic":{"type":"string","description":"ntfy"},"server_url":{"type":"string","description":"ntfy: your own server (default ntfy.sh)"},"event_types":{"type":"array","items":{"type":"string","enum":["uptime_incident_opened","uptime_incident_resolved","performance_budget_exceeded","performance_budget_recovered","ssl_expiring_soon","ssl_certificate_invalid","certificate_changed","sitemap_check_failed","lighthouse_scores_regressed","domain_expiring_soon","domain_expired","domain_blocklist_listed","server_health_check_failed","server_ssl_check_failed","server_ping_failed","server_heartbeat_missed","server_recovered","port_scan_anomaly","health_check_missed","health_check_failed","health_check_recovered","ai_check_failed","dns_record_changed","dns_nameservers_out_of_sync","reverse_monitor_exposed","crawl_new_issues_found","monthly_report"]},"description":"Only these events; omit (or all_events: true) for every event"},"all_events":{"type":"boolean"},"delivery_hours":{"type":"string","enum":["always","business","outside"]},"tag_filter":{"type":["array","string","null"],"items":{"type":"string"},"description":"Only monitors with any of these tags"},"category_modes":{"type":"object","additionalProperties":{"type":"string","enum":["immediate","digest","off"]},"description":"Per event category: immediate, digest or off"},"quiet_hours_start":{"type":["string","null"],"description":"H:i"},"quiet_hours_end":{"type":["string","null"],"description":"H:i"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NotificationChannel"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Notifications"]},"delete":{"operationId":"deleteNotificationChannel","summary":"Remove a destination (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"channel_id","in":"path","required":true,"schema":{"type":"string"},"description":"Notification channel ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Notifications"]}},"/organizations/{organization_id}/notification-channels/{channel_id}/test":{"post":{"operationId":"testNotificationChannel","summary":"Send a sample alert through the destination (admins, 5 a minute)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"channel_id","in":"path","required":true,"schema":{"type":"string"},"description":"Notification channel ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"sent":{"type":"boolean"}}}},"required":["data"]}}}},"422":{"description":"Delivery failed; message says why","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"sent":{"type":"boolean"}}}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Notifications"]}},"/organizations/{organization_id}/members":{"get":{"operationId":"listMembers","summary":"Members and their roles (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"meta":{"$ref":"#/components/schemas/PageMeta"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]},"post":{"operationId":"addMember","summary":"Add someone with an account, or email an invitation (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["viewer","member","admin"],"default":"member"},"team_id":{"type":["string","null"]}},"required":["email"]},"example":{"email":"sam@example.com","role":"member"}}}},"responses":{"201":{"description":"Added or invited","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"result":{"type":"string","enum":["added","invited"]},"email":{"type":"string"}}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/members/{user_id}":{"delete":{"operationId":"removeMember","summary":"Remove a member (admins; not the owner or the billing owner)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"user_id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/invitations":{"get":{"operationId":"listInvitations","summary":"Pending invitations (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/invitations/{invitation_id}":{"delete":{"operationId":"revokeInvitation","summary":"Revoke an invitation (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string"},"description":"Invitation ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/teams":{"get":{"operationId":"listTeams","summary":"Teams and their members","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]},"post":{"operationId":"createTeam","summary":"Create a team (admins); you become its owner","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255}},"required":["name"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Team"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/teams/{team_id}":{"patch":{"operationId":"renameTeam","summary":"Rename a team (admins and the team owner)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"team_id","in":"path","required":true,"schema":{"type":"string"},"description":"Team ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Team"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]},"delete":{"operationId":"deleteTeam","summary":"Delete a team (admins); its monitors stay, without a team","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"team_id","in":"path","required":true,"schema":{"type":"string"},"description":"Team ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/teams/{team_id}/members":{"post":{"operationId":"addTeamMember","summary":"Add an organization member to a team","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"team_id","in":"path","required":true,"schema":{"type":"string"},"description":"Team ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"role":{"type":"string","enum":["member","admin","owner"],"default":"member"}},"required":["user_id"]}}}},"responses":{"201":{"description":"Added","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Team"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/teams/{team_id}/members/{user_id}":{"delete":{"operationId":"removeTeamMember","summary":"Remove someone from a team (not its owner)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"team_id","in":"path","required":true,"schema":{"type":"string"},"description":"Team ID"},{"name":"user_id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Members and teams"]}},"/organizations/{organization_id}/settings":{"get":{"operationId":"getOrganizationSettings","summary":"General, monthly report, business hours, main status page and health-check settings (admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationSettings"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Organizations"]},"patch":{"operationId":"updateOrganizationSettings","summary":"Change settings (admins); fields you leave out keep their values","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"monthly_report_enabled":{"type":"boolean"},"status_page_enabled":{"type":"boolean"},"status_slug":{"type":["string","null"],"maxLength":64},"status_page_custom_domain":{"type":["string","null"],"description":"When custom domains are on: verify it on the Org settings page"},"status_page_title":{"type":["string","null"],"maxLength":255},"status_page_message":{"type":["string","null"],"maxLength":500},"status_page_logo_url":{"type":["string","null"],"maxLength":2048},"status_page_favicon_url":{"type":["string","null"],"maxLength":2048},"status_page_accent_color":{"type":["string","null"],"maxLength":32},"status_page_site_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Monitors on the main status page; empty for all of them"},"health_check_slug":{"type":["string","null"],"maxLength":64},"health_check_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":10080},"health_check_grace_minutes":{"type":["integer","null"],"minimum":0,"maximum":1440},"monthly_report_recipients":{"type":["array","string","null"],"items":{"type":"string"},"description":"Extra monthly report recipients (up to 10), as a list or one comma-separated string"},"status_page_private":{"type":"boolean","description":"Only people with the private link can see the page"},"status_page_auto_updates":{"type":"boolean"},"status_page_locale":{"type":"string"},"health_check_url":{"type":["string","null"],"maxLength":2048},"health_check_secret":{"type":["string","null"],"description":"Write-only; sent as a bearer token to health_check_url"},"timezone":{"type":"string","description":"IANA timezone"},"business_hours_start":{"type":"string"},"business_hours_end":{"type":"string"},"business_days":{"type":"array","minimum":1,"items":{"type":"integer"}}}},"example":{"status_page_enabled":true,"status_slug":"acme","status_page_title":"Acme status","business_days":[1,2,3,4,5]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationSettings"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Organizations"]}},"/organizations/{organization_id}/servers":{"get":{"operationId":"listServers","summary":"Server monitors you can see, with their checks' state","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Server"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Servers"]},"post":{"operationId":"createServer","summary":"Add a server monitor (members, not viewers); the checks it turns on run once now","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"host":{"type":"string","maxLength":255},"team_id":{"type":["string","null"],"description":"A team in this organization"},"tags":{"type":["array","string","null"],"items":{"type":"string"}},"ports_expected_open":{"type":["array","string","null"],"items":{"type":"integer"},"description":"Ports that must accept connections, e.g. [22, 443]"},"ports_expected_closed":{"type":["array","string","null"],"items":{"type":"integer"},"description":"Ports that must refuse connections"},"heartbeat_enabled":{"type":"boolean"},"full_port_scan_enabled":{"type":"boolean"},"heartbeat_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":10080},"heartbeat_grace_minutes":{"type":["integer","null"],"minimum":0,"maximum":1440},"ping_enabled":{"type":"boolean"},"ping_packet_count":{"type":["integer","null"],"minimum":1,"maximum":100},"ping_packet_size":{"type":["integer","null"],"minimum":1,"maximum":65500},"ping_max_hops":{"type":["integer","null"],"minimum":1,"maximum":255},"ping_acceptable_loss_pct":{"type":["integer","null"],"minimum":0,"maximum":100},"ssl_check_enabled":{"type":"boolean"},"ssl_check_port":{"type":["integer","null"],"minimum":1,"maximum":65535},"health_check_enabled":{"type":"boolean"},"health_check_url":{"type":["string","null"],"maxLength":2048},"health_check_expected_code":{"type":["integer","null"],"minimum":100,"maximum":599},"health_check_expected_string":{"type":["string","null"],"maxLength":255},"port_send_strings":{"type":["object","string","null"],"additionalProperties":{"type":"string"},"description":"Text to send per port, e.g. {\"6379\": \"PING\"}"},"port_expected_responses":{"type":["object","string","null"],"additionalProperties":{"type":"string"},"description":"Text each port must answer with, e.g. {\"6379\": \"PONG\"}"}},"required":["name","host"]},"example":{"name":"web-1","host":"web-1.example.com","ports_expected_open":[22,443],"ping_enabled":true,"heartbeat_enabled":true}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Server"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Servers"]}},"/organizations/{organization_id}/servers/{server_id}":{"patch":{"operationId":"updateServer","summary":"Edit a server monitor; fields you leave out keep their values","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"server_id","in":"path","required":true,"schema":{"type":"string"},"description":"Server ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"host":{"type":"string","maxLength":255},"team_id":{"type":["string","null"],"description":"A team in this organization"},"tags":{"type":["array","string","null"],"items":{"type":"string"}},"ports_expected_open":{"type":["array","string","null"],"items":{"type":"integer"},"description":"Ports that must accept connections, e.g. [22, 443]"},"ports_expected_closed":{"type":["array","string","null"],"items":{"type":"integer"},"description":"Ports that must refuse connections"},"heartbeat_enabled":{"type":"boolean"},"full_port_scan_enabled":{"type":"boolean"},"heartbeat_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":10080},"heartbeat_grace_minutes":{"type":["integer","null"],"minimum":0,"maximum":1440},"ping_enabled":{"type":"boolean"},"ping_packet_count":{"type":["integer","null"],"minimum":1,"maximum":100},"ping_packet_size":{"type":["integer","null"],"minimum":1,"maximum":65500},"ping_max_hops":{"type":["integer","null"],"minimum":1,"maximum":255},"ping_acceptable_loss_pct":{"type":["integer","null"],"minimum":0,"maximum":100},"ssl_check_enabled":{"type":"boolean"},"ssl_check_port":{"type":["integer","null"],"minimum":1,"maximum":65535},"health_check_enabled":{"type":"boolean"},"health_check_url":{"type":["string","null"],"maxLength":2048},"health_check_expected_code":{"type":["integer","null"],"minimum":100,"maximum":599},"health_check_expected_string":{"type":["string","null"],"maxLength":255},"port_send_strings":{"type":["object","string","null"],"additionalProperties":{"type":"string"},"description":"Text to send per port, e.g. {\"6379\": \"PING\"}"},"port_expected_responses":{"type":["object","string","null"],"additionalProperties":{"type":"string"},"description":"Text each port must answer with, e.g. {\"6379\": \"PONG\"}"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Server"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Servers"]},"delete":{"operationId":"deleteServer","summary":"Delete a server monitor and its history","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"server_id","in":"path","required":true,"schema":{"type":"string"},"description":"Server ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Servers"]}},"/organizations/{organization_id}/reports":{"get":{"operationId":"listReports","summary":"Saved reports","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Report"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]},"post":{"operationId":"createReport","summary":"Save a report (members and admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"scope":{"type":"string","enum":["all","monitors","groups","tags","teams"],"description":"Which monitors; default all"},"scope_ids":{"type":"array","items":{"type":"string"},"description":"Monitor, group or team IDs, or tags (wildcards allowed), for the scope"},"range":{"type":"string","enum":["7d","30d","90d","last_month","last_quarter","custom"],"description":"Default 30d"},"custom_start":{"type":["string","null"],"format":"date"},"custom_end":{"type":["string","null"],"format":"date"},"compare":{"type":"boolean","description":"Also compute the previous window of the same length; default true"},"group_by":{"type":"string","enum":["site","group","tag","team"]},"filter_tags":{"type":"array","items":{"type":"string"},"description":"Only monitors with one of these tags (wildcards allowed), whatever the breakdown"},"filter_team_ids":{"type":"array","items":{"type":"string"},"description":"Only monitors in these teams, whatever the breakdown"},"sections":{"type":"array","items":{"type":"string","enum":["uptime","response","incidents","expiry","lighthouse","crawl","heartbeats","dns"]},"description":"Default uptime, response, incidents"}},"required":["name"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Report"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]}},"/organizations/{organization_id}/reports/run":{"post":{"operationId":"runReportConfig","summary":"Run a report config without saving it","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"string","enum":["all","monitors","groups","tags","teams"],"description":"Which monitors; default all"},"scope_ids":{"type":"array","items":{"type":"string"},"description":"Monitor, group or team IDs, or tags (wildcards allowed), for the scope"},"range":{"type":"string","enum":["7d","30d","90d","last_month","last_quarter","custom"],"description":"Default 30d"},"custom_start":{"type":["string","null"],"format":"date"},"custom_end":{"type":["string","null"],"format":"date"},"compare":{"type":"boolean","description":"Also compute the previous window of the same length; default true"},"group_by":{"type":"string","enum":["site","group","tag","team"]},"filter_tags":{"type":"array","items":{"type":"string"},"description":"Only monitors with one of these tags (wildcards allowed), whatever the breakdown"},"filter_team_ids":{"type":"array","items":{"type":"string"},"description":"Only monitors in these teams, whatever the breakdown"},"sections":{"type":"array","items":{"type":"string","enum":["uptime","response","incidents","expiry","lighthouse","crawl","heartbeats","dns"]},"description":"Default uptime, response, incidents"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ReportResult"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]}},"/organizations/{organization_id}/reports/{report_id}":{"get":{"operationId":"getReport","summary":"Get a saved report's config","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"report_id","in":"path","required":true,"schema":{"type":"string"},"description":"Report ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Report"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]}},"/organizations/{organization_id}/reports/{report_id}/run":{"get":{"operationId":"runReport","summary":"Run a saved report now (non-admins see their teams' monitors)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"report_id","in":"path","required":true,"schema":{"type":"string"},"description":"Report ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ReportResult"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]}},"/organizations/{organization_id}/groups":{"get":{"operationId":"listMonitorGroups","summary":"Monitor groups","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MonitorGroup"}}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]},"post":{"operationId":"createMonitorGroup","summary":"Create a monitor group (members and admins)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"monitor_ids":{"type":"array","items":{"type":"string"}}},"required":["name"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MonitorGroup"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]}},"/organizations/{organization_id}/groups/{group_id}":{"patch":{"operationId":"updateMonitorGroup","summary":"Rename a group or replace its monitors","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"group_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor group ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"monitor_ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MonitorGroup"}},"required":["data"]}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]},"delete":{"operationId":"deleteMonitorGroup","summary":"Delete a group (its monitors are kept)","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"},"description":"Organization ID"},{"name":"group_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor group ID"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Reports"]}},"/schedule-monitor/{monitor_id}/monitors/{oh_dear_monitor_id}":{"get":{"operationId":"scheduleMonitorVerify","summary":"spatie/laravel-schedule-monitor: schedule-monitor:verify","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"oh_dear_monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Any number (OH_DEAR_MONITOR_ID, or OH_DEAR_SITE_ID on v3); the monitor comes from monitor_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"sort_url":{"type":"string"},"label":{"type":"string"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Laravel schedule monitor"]}},"/schedule-monitor/{monitor_id}/monitors/{oh_dear_monitor_id}/cron-checks/sync":{"post":{"operationId":"scheduleMonitorSync","summary":"spatie/laravel-schedule-monitor: schedule-monitor:sync (replaces the monitor's tasks)","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"oh_dear_monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Any number (OH_DEAR_MONITOR_ID, or OH_DEAR_SITE_ID on v3); the monitor comes from monitor_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cron_checks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["cron"]},"cron_expression":{"type":"string"},"grace_time_in_minutes":{"type":"integer","minimum":0,"maximum":1440},"server_timezone":{"type":["string","null"]},"description":{"type":"string"}},"required":["name","cron_expression"]},"maxItems":200}},"required":["cron_checks"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CronCheck"}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Laravel schedule monitor"]}},"/schedule-monitor/{monitor_id}/monitors/{oh_dear_monitor_id}/cron-checks":{"post":{"operationId":"scheduleMonitorAdd","summary":"spatie/laravel-schedule-monitor: schedule-monitor:sync --keep-old (adds one task)","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"oh_dear_monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Any number (OH_DEAR_MONITOR_ID, or OH_DEAR_SITE_ID on v3); the monitor comes from monitor_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["cron"]},"cron_expression":{"type":"string"},"grace_time_in_minutes":{"type":"integer","minimum":0,"maximum":1440},"server_timezone":{"type":["string","null"]},"description":{"type":"string"}},"required":["name","cron_expression"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CronCheck"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Laravel schedule monitor"]}},"/schedule-monitor/{monitor_id}/sites/{oh_dear_monitor_id}":{"get":{"operationId":"scheduleMonitorVerifyV3","summary":"spatie/laravel-schedule-monitor v3: schedule-monitor:verify","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"oh_dear_monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Any number (OH_DEAR_MONITOR_ID, or OH_DEAR_SITE_ID on v3); the monitor comes from monitor_id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"sort_url":{"type":"string"},"label":{"type":"string"}}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Laravel schedule monitor"]}},"/schedule-monitor/{monitor_id}/sites/{oh_dear_monitor_id}/cron-checks/sync":{"post":{"operationId":"scheduleMonitorSyncV3","summary":"spatie/laravel-schedule-monitor v3: schedule-monitor:sync (replaces the monitor's tasks)","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"oh_dear_monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Any number (OH_DEAR_MONITOR_ID, or OH_DEAR_SITE_ID on v3); the monitor comes from monitor_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cron_checks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["cron"]},"cron_expression":{"type":"string"},"grace_time_in_minutes":{"type":"integer","minimum":0,"maximum":1440},"server_timezone":{"type":["string","null"]},"description":{"type":"string"}},"required":["name","cron_expression"]},"maxItems":200}},"required":["cron_checks"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CronCheck"}}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Laravel schedule monitor"]}},"/schedule-monitor/{monitor_id}/sites/{oh_dear_monitor_id}/cron-checks":{"post":{"operationId":"scheduleMonitorAddV3","summary":"spatie/laravel-schedule-monitor v3: schedule-monitor:sync --keep-old (adds one task)","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Monitor ID"},{"name":"oh_dear_monitor_id","in":"path","required":true,"schema":{"type":"string"},"description":"Any number (OH_DEAR_MONITOR_ID, or OH_DEAR_SITE_ID on v3); the monitor comes from monitor_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["cron"]},"cron_expression":{"type":"string"},"grace_time_in_minutes":{"type":"integer","minimum":0,"maximum":1440},"server_timezone":{"type":["string","null"]},"description":{"type":"string"}},"required":["name","cron_expression"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CronCheck"}}}},"401":{"description":"Missing or invalid token"},"403":{"description":"Token or role not allowed (read-only tokens cannot write)"},"404":{"description":"Not found, or not visible to this token"},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"429":{"description":"Rate limited: 120 requests a minute per token (Retry-After says when to try again)"}},"tags":["Laravel schedule monitor"]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Personal access token from Profile \u2192 API & data"}},"schemas":{"Monitor":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"label":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"critical":{"type":"boolean"},"organization_id":{"type":"string"},"team_id":{"type":["string","null"]},"uptime":{"type":"object","properties":{"enabled":{"type":"boolean"},"interval_minutes":{"type":"integer"},"check_method":{"type":["string","null"]},"expected_codes":{"type":["string","null"]},"alert_after_failures":{"type":"integer"},"alert_after_minutes":{"type":["integer","null"]},"check_body":{"type":["string","null"],"description":"null unless you can edit the monitor with a read and write token"},"check_headers":{"type":["object","array","null"],"description":"null unless you can edit the monitor with a read and write token (it may hold credentials)"},"check_string":{"type":["string","null"]},"check_absent_string":{"type":["string","null"]},"json_assertions":{"type":["object","array","null"],"description":"null unless you can edit the monitor with a read and write token (it may hold credentials)"},"header_patterns":{"type":["object","array","null"],"description":"null unless you can edit the monitor with a read and write token (it may hold credentials)"},"response_time_threshold_ms":{"type":["integer","null"]},"response_time_variance_pct":{"type":["integer","null"]},"timeout_seconds":{"type":["integer","null"]},"max_redirects":{"type":["integer","null"]}}},"ssl":{"type":"object","properties":{"enabled":{"type":"boolean"},"interval_minutes":{"type":["integer","null"]},"expiring_soon_days":{"type":["integer","null"]},"alert_on_every_change":{"type":"boolean"}}},"heartbeat":{"type":"object","properties":{"enabled":{"type":"boolean"},"interval_minutes":{"type":["integer","null"]},"grace_minutes":{"type":["integer","null"]},"cron_expression":{"type":["string","null"]},"timezone":{"type":["string","null"]},"ping_url":{"type":["string","null"],"format":"uri","description":"GET or POST it from your job; append /starting or /failed"}}},"crawl":{"type":"object","properties":{"enabled":{"type":"boolean"},"max_depth":{"type":["integer","null"]},"max_pages":{"type":["integer","null"]},"time_limit_minutes":{"type":["integer","null"]},"interval_minutes":{"type":["integer","null"]},"alert_on_broken":{"type":"boolean"},"alert_on_mixed_content":{"type":"boolean"},"alert_on_console_errors":{"type":"boolean"},"alert_on_lighthouse_regression":{"type":"boolean"},"alert_on_screenshot_diff":{"type":"boolean"},"lighthouse_regression_threshold":{"type":["integer","null"]},"screenshot_diff_threshold_pct":{"type":["integer","null"]},"seed_from_sitemap":{"type":"boolean"},"respect_robots_txt":{"type":"boolean"},"check_external_links":{"type":"boolean"},"ignore_patterns":{"type":"array","items":{"type":"string"}},"request_headers":{"type":["object","array","null"],"description":"null unless you can edit the monitor with a read and write token (it may hold credentials)"}}},"lighthouse":{"type":"object","properties":{"enabled":{"type":"boolean"},"strategy":{"type":"string","enum":["mobile","desktop"]},"thresholds":{"type":["object","null"]}}},"sitemap":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"robots":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"domain":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"dns_blocklist":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"dns_records":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"reverse_monitor":{"type":"object","properties":{"enabled":{"type":"boolean"},"host":{"type":["string","null"]},"port":{"type":["integer","null"]}}},"status_page":{"type":"object","properties":{"enabled":{"type":"boolean"},"slug":{"type":["string","null"]},"title":{"type":["string","null"]},"message":{"type":["string","null"]},"show":{"type":["array","null"],"items":{"type":"string"}},"url":{"type":["string","null"]}}},"alerts_snoozed_until":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}}},"MonitorStatus":{"type":"object","properties":{"monitor_id":{"type":"string"},"url":{"type":"string"},"up":{"type":["boolean","null"]},"has_open_incident":{"type":"boolean"},"under_maintenance":{"type":"boolean"},"last_checked_at":{"type":["string","null"],"format":"date-time"},"ssl":{"type":"object","properties":{"enabled":{"type":"boolean"},"last_checked_at":{"type":["string","null"],"format":"date-time"}}},"heartbeat":{"type":"object","properties":{"enabled":{"type":"boolean"},"ok":{"type":["boolean","null"]}}},"alerts_snoozed_until":{"type":["string","null"],"format":"date-time"}}},"UptimeCheck":{"type":"object","properties":{"id":{"type":"string"},"up":{"type":"boolean"},"response_code":{"type":["integer","null"]},"response_time_ms":{"type":["integer","null"]},"failure_reason":{"type":["string","null"]},"error_message":{"type":["string","null"]},"checked_at":{"type":"string","format":"date-time"}}},"Incident":{"type":"object","properties":{"id":{"type":"string"},"monitor_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"ended_at":{"type":["string","null"],"format":"date-time"},"resolved":{"type":"boolean"},"duration_seconds":{"type":["integer","null"]},"source":{"type":["string","null"]},"reason":{"type":["string","null"]},"acknowledged_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"array","items":{"$ref":"#/components/schemas/IncidentNote"}}}},"IncidentNote":{"type":"object","properties":{"id":{"type":"string"},"body":{"type":"string"},"author":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"}}},"Organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"role":{"type":["string","null"]},"plan":{"type":"string"},"monitor_limit":{"type":"integer"},"monitor_count":{"type":"integer"},"one_minute_monitor_limit":{"type":"integer"},"one_minute_monitor_count":{"type":"integer"},"on_trial":{"type":"boolean"},"subscribed":{"type":"boolean"},"payment_past_due":{"type":"boolean"}}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"starts_at":{"type":"string","format":"date-time"},"ends_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["scheduled","active","completed","cancelled"]},"monitor_ids":{"type":["array","null"],"items":{"type":"string"}},"team_id":{"type":["string","null"]},"tags":{"type":["array","null"],"items":{"type":"string"}},"recurrence":{"type":["string","null"],"enum":["weekly","monthly",null]},"timezone":{"type":["string","null"]}}},"CronCheck":{"type":"object","properties":{"id":{"type":"integer"},"uuid":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"cron_expression":{"type":"string"},"grace_time_in_minutes":{"type":"integer"},"server_timezone":{"type":["string","null"]},"description":{"type":"string"},"ping_url":{"type":"string","format":"uri"}}},"OhDearCheck":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["uptime","certificate_health"]},"label":{"type":"string"},"enabled":{"type":"boolean"},"latest_run_ended_at":{"type":["string","null"]},"latest_run_result":{"type":"string","enum":["pending","succeeded","failed"]},"summary":{"type":"string"},"settings":{"type":"object"},"active_snooze":{"type":["object","null"]}}},"OhDearMonitor":{"type":"object","properties":{"id":{"type":"string"},"team_id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"},"uses_https":{"type":"boolean"},"sort_url":{"type":"string"},"label":{"type":"string"},"group_name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"description":{"type":["string","null"]},"notes":{"type":["string","null"]},"latest_run_date":{"type":["string","null"]},"summarized_check_result":{"type":"string","enum":["pending","succeeded","failed"]},"checks":{"type":"array","items":{"$ref":"#/components/schemas/OhDearCheck"}},"created_at":{"type":["string","null"]},"updated_at":{"type":["string","null"]}}},"Report":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"scope":{"type":"string","enum":["all","monitors","groups","tags","teams"],"description":"Which monitors; default all"},"scope_ids":{"type":"array","items":{"type":"string"},"description":"Monitor, group or team IDs, or tags (wildcards allowed), for the scope"},"range":{"type":"string","enum":["7d","30d","90d","last_month","last_quarter","custom"],"description":"Default 30d"},"custom_start":{"type":["string","null"],"format":"date"},"custom_end":{"type":["string","null"],"format":"date"},"compare":{"type":"boolean","description":"Also compute the previous window of the same length; default true"},"group_by":{"type":"string","enum":["site","group","tag","team"]},"filter_tags":{"type":"array","items":{"type":"string"},"description":"Only monitors with one of these tags (wildcards allowed), whatever the breakdown"},"filter_team_ids":{"type":"array","items":{"type":"string"},"description":"Only monitors in these teams, whatever the breakdown"},"sections":{"type":"array","items":{"type":"string","enum":["uptime","response","incidents","expiry","lighthouse","crawl","heartbeats","dns"]},"description":"Default uptime, response, incidents"},"schedule":{"type":["string","null"],"enum":["weekly","monthly",null]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}}},"ReportMetrics":{"type":"object","properties":{"checks":{"type":"integer"},"up":{"type":"integer"},"uptime":{"type":["number","null"]},"timed":{"type":"integer"},"avg_ms":{"type":["integer","null"]},"p50_ms":{"type":["integer","null"],"description":"Daily medians averaged, weighted by timed checks"},"p95_ms":{"type":["integer","null"],"description":"Daily p95s averaged, weighted by timed checks"},"downtime_seconds":{"type":"integer"},"incident_count":{"type":"integer"},"mttr_seconds":{"type":["number","null"]}}},"ReportResult":{"type":"object","properties":{"config":{"type":"object","properties":{"scope":{"type":"string","enum":["all","monitors","groups","tags","teams"],"description":"Which monitors; default all"},"scope_ids":{"type":"array","items":{"type":"string"},"description":"Monitor, group or team IDs, or tags (wildcards allowed), for the scope"},"range":{"type":"string","enum":["7d","30d","90d","last_month","last_quarter","custom"],"description":"Default 30d"},"custom_start":{"type":["string","null"],"format":"date"},"custom_end":{"type":["string","null"],"format":"date"},"compare":{"type":"boolean","description":"Also compute the previous window of the same length; default true"},"group_by":{"type":"string","enum":["site","group","tag","team"]},"filter_tags":{"type":"array","items":{"type":"string"},"description":"Only monitors with one of these tags (wildcards allowed), whatever the breakdown"},"filter_team_ids":{"type":"array","items":{"type":"string"},"description":"Only monitors in these teams, whatever the breakdown"},"sections":{"type":"array","items":{"type":"string","enum":["uptime","response","incidents","expiry","lighthouse","crawl","heartbeats","dns"]},"description":"Default uptime, response, incidents"}}},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"previous_start":{"type":["string","null"],"format":"date-time"},"previous_end":{"type":["string","null"],"format":"date-time"},"summary":{"type":"object","properties":{"sites":{"type":"integer"},"metrics":{"$ref":"#/components/schemas/ReportMetrics"},"previous":{"oneOf":[{"$ref":"#/components/schemas/ReportMetrics"},{"type":"null"}]},"heartbeats_missed":{"type":"integer"},"expiring":{"type":"integer"},"broken_links":{"type":"integer"},"mixed_content":{"type":"integer"},"dns_changes":{"type":"integer"}}},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sites":{"type":"integer"},"metrics":{"$ref":"#/components/schemas/ReportMetrics"},"previous":{"oneOf":[{"$ref":"#/components/schemas/ReportMetrics"},{"type":"null"}]}}}},"sites":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"team":{"type":["string","null"]},"team_id":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"metrics":{"$ref":"#/components/schemas/ReportMetrics"},"previous":{"oneOf":[{"$ref":"#/components/schemas/ReportMetrics"},{"type":"null"}]},"heartbeats_missed":{"type":"integer"},"expiry":{"type":["object","null"]},"lighthouse":{"type":["object","null"]},"crawl":{"type":["object","null"]},"dns":{"oneOf":[{"type":"object","properties":{"changes":{"type":"integer"},"nameserver_changes":{"type":"integer"},"email_auth_changes":{"type":"integer"},"list":{"type":"array","description":"Newest first, up to 25","items":{"type":"object","properties":{"checked_at":{"type":"string","format":"date-time"},"records":{"type":"object","description":"Record type => added and removed values"},"nameservers":{"type":"boolean"},"email_auth":{"type":"boolean","description":"DMARC, DKIM or SPF changed"}}}}}},{"type":"null"}],"description":"With the dns section"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"site":{"type":"string"},"source":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"ended_at":{"type":["string","null"],"format":"date-time"},"duration_seconds":{"type":["integer","null"]},"reason":{"type":["string","null"]}}}},"daily":{"type":"object","additionalProperties":{"type":["number","null"]},"description":"Y-m-d => uptime %"}}},"MonitorGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"monitor_ids":{"type":"array","items":{"type":"string"}}}},"ValidationError":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"PageMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"last_page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"}}},"SlaReport":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"uptime":{"type":["number","null"]},"total_checks":{"type":"integer"},"up_checks":{"type":"integer"},"down_checks":{"type":"integer"},"mttr_seconds":{"type":["number","null"]},"downtime_seconds":{"type":"integer"},"incident_count":{"type":"integer"},"resolved_incident_count":{"type":"integer"},"ongoing_incident_count":{"type":"integer"},"percentiles":{"type":"object","properties":{"p50":{"type":["integer","null"]},"p95":{"type":["integer","null"]},"p99":{"type":["integer","null"]},"max":{"type":["integer","null"]},"sample":{"type":"integer"}}},"trend":{"type":"object","properties":{"uptime":{"type":["number","null"]},"downtime_seconds":{"type":["integer","null"]},"mttr_seconds":{"type":["number","null"]}}},"periods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"ended_at":{"type":["string","null"],"format":"date-time"},"duration_seconds":{"type":["integer","null"]},"resolved":{"type":"boolean"}}}}}},"CrawledPage":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"final_url":{"type":["string","null"]},"found_on_url":{"type":["string","null"]},"status_code":{"type":["integer","null"]},"success":{"type":"boolean"},"broken":{"type":"boolean"},"title":{"type":["string","null"]},"depth":{"type":["integer","null"]},"transfer_time_ms":{"type":["integer","null"]},"mixed_content":{"type":"array","items":{"type":"object"}}}},"StatusPage":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"message":{"type":["string","null"]},"monitor_ids":{"type":["array","null"],"items":{"type":"string"}},"locale":{"type":"string"},"logo_url":{"type":["string","null"]},"accent_color":{"type":["string","null"]},"private":{"type":"boolean"},"auto_updates":{"type":"boolean"},"url":{"type":"string"}}},"StatusPageUpdate":{"type":"object","properties":{"id":{"type":"string"},"status_page_id":{"type":["string","null"]},"title":{"type":"string"},"body":{"type":"string"},"severity":{"type":"string"},"pinned":{"type":"boolean"},"published_at":{"type":["string","null"],"format":"date-time"}}},"NotificationChannel":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"label":{"type":["string","null"]},"enabled":{"type":"boolean"},"team_id":{"type":["string","null"]},"destination":{"type":["string","null"],"description":"The address, topic or host alerts go to; secrets are never returned"},"event_types":{"type":["array","null"],"items":{"type":"string"},"description":"null means every event"},"delivery_hours":{"type":"string"},"tag_filter":{"type":["array","null"],"items":{"type":"string"}},"category_modes":{"type":["object","null"]},"quiet_hours_start":{"type":["string","null"]},"quiet_hours_end":{"type":["string","null"]},"signing_secret":{"type":["string","null"],"description":"webhook: the key for Observe-Signature (HMAC-SHA256 of the raw body)"}}},"Member":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"email":{"type":"string"},"role":{"type":["string","null"]}}},"Invitation":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"role":{"type":"string"},"team_id":{"type":["string","null"]},"expires_at":{"type":"string","format":"date-time"}}},"Team":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"members":{"type":"array","items":{"$ref":"#/components/schemas/Member"}}}},"OrganizationSettings":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"monthly_report_enabled":{"type":"boolean"},"status_page_enabled":{"type":"boolean"},"status_slug":{"type":["string","null"],"maxLength":64},"status_page_custom_domain":{"type":["string","null"]},"status_page_title":{"type":["string","null"],"maxLength":255},"status_page_message":{"type":["string","null"],"maxLength":500},"status_page_logo_url":{"type":["string","null"],"maxLength":2048},"status_page_favicon_url":{"type":["string","null"],"maxLength":2048},"status_page_accent_color":{"type":["string","null"],"maxLength":32},"status_page_site_ids":{"type":["array","null"],"items":{"type":"string"}},"health_check_slug":{"type":["string","null"],"maxLength":64},"health_check_interval_minutes":{"type":["integer","null"],"minimum":1,"maximum":10080},"health_check_grace_minutes":{"type":["integer","null"],"minimum":0,"maximum":1440},"monthly_report_recipients":{"type":"array","items":{"type":"string"}},"status_page_private":{"type":"boolean"},"status_page_auto_updates":{"type":"boolean"},"status_page_locale":{"type":"string"},"health_check_url":{"type":["string","null"],"maxLength":2048},"timezone":{"type":"string"},"business_hours_start":{"type":"string"},"business_hours_end":{"type":"string"},"business_days":{"type":"array","minimum":1,"items":{"type":"integer"}},"status_page_custom_domain_verified":{"type":"boolean"},"health_check_secret_set":{"type":"boolean","description":"The secret itself is never returned"}}},"Server":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"host":{"type":"string"},"team_id":{"type":["string","null"]},"tags":{"type":["array","null"],"items":{"type":"string"}},"ports_expected_open":{"type":"array","items":{"type":"integer"}},"ports_expected_closed":{"type":"array","items":{"type":"integer"}},"full_port_scan_enabled":{"type":"boolean"},"port_send_strings":{"type":["object","null"]},"port_expected_responses":{"type":["object","null"]},"heartbeat_enabled":{"type":"boolean"},"heartbeat_interval_minutes":{"type":["integer","null"]},"heartbeat_grace_minutes":{"type":["integer","null"]},"heartbeat_url":{"type":["string","null"],"format":"uri","description":"POST to it from the server while the heartbeat is on"},"heartbeat_ok":{"type":["boolean","null"]},"last_heartbeat_at":{"type":["string","null"],"format":"date-time"},"ping_enabled":{"type":"boolean"},"ping_packet_count":{"type":["integer","null"]},"ping_packet_size":{"type":["integer","null"]},"ping_max_hops":{"type":["integer","null"]},"ping_acceptable_loss_pct":{"type":["integer","null"]},"ssl_check_enabled":{"type":"boolean"},"ssl_check_port":{"type":["integer","null"]},"health_check_enabled":{"type":"boolean"},"health_check_url":{"type":["string","null"]},"health_check_expected_code":{"type":["integer","null"]},"health_check_expected_string":{"type":["string","null"]},"alerts_snoozed_until":{"type":["string","null"],"format":"date-time"}}}}},"tags":[{"name":"Public"},{"name":"Oh Dear compatible"},{"name":"Laravel schedule monitor"},{"name":"Incidents"},{"name":"Checks and alerts"},{"name":"Monitors"},{"name":"Results"},{"name":"Maintenance"},{"name":"Status pages"},{"name":"Notifications"},{"name":"Members and teams"},{"name":"Reports"},{"name":"Servers"},{"name":"Organizations"}]}