POST API: Preview check settings and consumption
/api/v1/monitors/checks/preview
Validate a check configuration, authorized healthy locations and selectable measurement series before creating or changing a monitor. The preview shows new and retained series, remaining account capacity and estimated checks per minute. It neither creates resources nor reserves quota. Creation checks current permissions and capacity again; measurements per day are an upper bound, not actual usage. A location outage or a disabled type does not produce an invented successful preview.
On this page
Access and permissions
Validate a check configuration, authorized healthy locations and selectable measurement series before creating or changing a monitor. The preview shows new and retained series, remaining account capacity and estimated checks per minute. It neither creates resources nor reserves quota. Creation checks current permissions and capacity again; measurements per day are an upper bound, not actual usage. A location outage or a disabled type does not produce an invented successful preview.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
When using a browser session for a mutation, send the current CSRF token in X-CSRF-Token with the same-site cookie. OAuth consent uses its documented form field.
Parameters and headers
No path, query or additional request-header parameters.
Request body
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | CheckPreviewInput | Yes | — |
| $.workspace_id | string; {"format":"uuid"} | Yes | — |
| $.monitor_id | string; {"format":"uuid"} | No | — |
| $.type | JSON; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]} | Yes | — |
| $.config | CheckConfig | HTTPMonitorConfig | Yes | — |
| $.config (anyOf 1) | CheckConfig | No | — |
| $.config (anyOf 1).confirm_failures | integer; {"maximum":10,"minimum":1} | Yes | — |
| $.config (anyOf 1).confirm_successes | integer; {"maximum":10,"minimum":1} | Yes | — |
| $.config (anyOf 1).interval_seconds | integer; {"maximum":604800,"minimum":10} | Yes | — |
| $.config (anyOf 1).location_ids | array<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1} | Yes | — |
| $.config (anyOf 1).location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.config (anyOf 1).metrics | array<string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}>; {"maxItems":64,"minItems":1} | Yes | — |
| $.config (anyOf 1).metrics[] | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config (anyOf 1).policy | JSON; {"enum":["any","all","quorum"],"default":"quorum"} | Yes | Defaults to quorum with two distinct locations. Select at least two compatible locations. Explicit any/all policies remain available; two failed confirmations per location are required by default. For Ping quorum checks with N locations and failure quorum Q, N−Q+1 freshly confirmed healthy locations establish availability; Q confirmed failed locations establish an outage. Other results remain unconfirmed or unknown. Ambiguous Ping results can trigger a fast follow-up at the same location, limited to two per monitor and one per location per minute, within the existing check budget. Manual tests never affect availability. Earlier coverage gaps remain unchanged. |
| $.config (anyOf 1).quorum | integer; {"maximum":4096,"minimum":1,"default":2} | No | — |
| $.config (anyOf 1).target | CheckTarget | Yes | — |
| $.config (anyOf 1).target (anyOf 1) | CheckNetworkTarget | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1) | CheckTCPTarget | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).port | integer; {"minimum":1,"maximum":65535} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).expected | string; {"enum":["reachable","unreachable"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).send | CheckPayload | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1) | CheckPayload | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1).encoding | string; {"enum":["text","hex",""]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1).value | string; {"maxLength":8192} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).expect | CheckMatch | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1) | CheckMatch | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1).kind | string; {"enum":["text","regex","hex"]} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1).value | string; {"maxLength":4096} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).max_bytes | integer; {"minimum":1,"maximum":65536} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls | CheckTLSOptions | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1) | CheckTLSOptions | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).server_name | string; {"maxLength":253} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).crl | boolean | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2) | CheckUDPTarget | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).preset | string; {"enum":["dns","ntp","custom"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).send | CheckPayload | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1) | CheckPayload | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1).encoding | string; {"enum":["text","hex",""]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1).value | string; {"maxLength":8192} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).expect | CheckMatch | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1) | CheckMatch | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1).kind | string; {"enum":["text","regex","hex"]} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1).value | string; {"maxLength":4096} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).dns_name | string; {"maxLength":253} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 2).max_bytes | integer; {"minimum":48,"maximum":65535} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3) | CheckTLSTarget | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls | CheckTLSOptions | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.server_name | string; {"maxLength":253} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.crl | boolean | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 3).starttls | string; {"enum":["","smtp","imap","pop","ftp","postgres","ldap"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 4) | CheckPingTarget | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 4).host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 4).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 4).count | integer; {"minimum":1,"maximum":10} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 4).size | integer; {"minimum":16,"maximum":1472} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 4).maximum_loss_percent | number; {"minimum":0,"maximum":100} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 4).maximum_latency_ms | number; {"minimum":0,"maximum":30000} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5) | CheckDNSTarget | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).name | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).record | string; {"enum":["A","AAAA","CNAME","MX","TXT","NS","SOA","SRV","CAA","PTR"]} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver | CheckEndpoint | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1) | CheckEndpoint | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).transport | string; {"enum":["udp","tcp","dot","doh"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).doh_url | string; {"maxLength":2048} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).authoritative | boolean | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).condition | string; {"enum":["present","exact","subset","absent"]} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).expected | array | null; {"maxItems":64} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).expected[] | string; {"maxLength":4096} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).response_code | string; {"maxLength":32} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).minimum_ttl | integer | null; {"minimum":0,"maximum":4294967295} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).maximum_ttl | integer | null; {"minimum":0,"maximum":4294967295} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).baseline | array | null; {"maxItems":64} | No | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).baseline[] | string; {"maxLength":4096} | Yes | — |
| $.config (anyOf 1).target (anyOf 1) (anyOf 5).dnssec | string; {"enum":["observe","require_valid","off"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) | CheckServiceTarget | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1) | CheckNativeServiceTarget | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).protocol | string; {"enum":["ssh","smtp","imap","pop","ftp","postgres","mysql","redis","mqtt","ldap","ntp","websocket"]} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).username_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).password_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls | CheckTLSOptions | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1) | CheckTLSOptions | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).server_name | string; {"maxLength":253} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).crl | boolean | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).tls_mode | string; {"enum":["","implicit","starttls"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).database | string; {"maxLength":128} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query | CheckServiceQuery | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1) | CheckServiceQuery | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).sql | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).read_account_confirmed | boolean | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).maximum_rows | integer; {"minimum":1,"maximum":200} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).timeout_ms | integer; {"minimum":100,"maximum":30000} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).minimum_rows | integer; {"minimum":0,"maximum":200} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).conditions | array | null; {"maxItems":8} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ssh_host_key | string; {"pattern":"^(?:|SHA256:[A-Za-z0-9+/]{43})$"} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).mailbox | string; {"maxLength":1024} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ftp_directory | string; {"maxLength":1024} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).redis_key | string; {"maxLength":512} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).redis_expected | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt | CheckMQTTOptions | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1) | CheckMQTTOptions | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).topic | string; {"maxLength":256} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).expect | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).round_trip | boolean | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap | CheckLDAPSearch | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1) | CheckLDAPSearch | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).base_dn | string; {"maxLength":1024} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).scope | string; {"enum":["base","one","subtree"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).attribute | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).value | string; {"maxLength":1024} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).present | boolean | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).maximum_entries | integer; {"minimum":1,"maximum":200} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).minimum_entries | integer; {"minimum":0,"maximum":200} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_attribute | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_value | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket | CheckWebSocketOptions | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1) | CheckWebSocketOptions | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).subprotocol | string; {"maxLength":128} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).send | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).expect | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).request_path | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).header_secrets | object | null | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 1).maximum_offset_ms | number; {"minimum":0,"maximum":86400000} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2) | CheckMailServiceTarget | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).protocol | JSON; {"const":"mail_delivery"} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery | CheckMailDeliveryConfig | Yes | Configure your own SMTP and IMAP test mailboxes with TLS and secret references, and confirm ownership. Actual receipt confirms delivery. A consistent mailbox arrival time measures delivery_ms; otherwise delivery_time_source=observed marks the confirmation time as an upper bound. Default interval: 30 minutes, minimum 15 minutes. |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp | CheckMailEndpoint | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls | CheckTLSOptions | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls_mode | string; {"enum":["implicit","starttls"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.username_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.password_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap | CheckMailEndpoint | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.host | string; {"maxLength":253} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.tls | CheckTLSOptions | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.tls_mode | string; {"enum":["implicit","starttls"]} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.username_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.password_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.from | string; {"maxLength":254} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.to | string; {"maxLength":254} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.mailbox | string; {"maxLength":255} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.owned_mailboxes_confirmed | JSON; {"const":true} | Yes | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.remove_received | boolean | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.maximum_wait_seconds | integer; {"minimum":30,"maximum":900} | No | — |
| $.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.language | string; {"enum":["en","de"]} | No | — |
| $.config (anyOf 1).target (anyOf 3) | CheckBrowserTarget | No | — |
| $.config (anyOf 1).target (anyOf 3).url | string; {"maxLength":2048} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).allowed_origins | array<string; {"maxLength":2048}>; {"maxItems":16,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).allowed_origins[] | string; {"maxLength":2048} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).engines | array<string; {"enum":["chromium","firefox","webkit"]}>; {"maxItems":3,"minItems":1} | No | — |
| $.config (anyOf 1).target (anyOf 3).engines[] | string; {"enum":["chromium","firefox","webkit"]} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).mode | string; {"enum":["guided","script"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps | array<BrowserStep>; {"maxItems":64,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[] | BrowserStep | Yes | — |
| $.config (anyOf 1).target (anyOf 3).steps[].session | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].page | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].selector | string; {"maxLength":512} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].url | string; {"maxLength":2048} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].value | string; {"maxLength":4096} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].json_pointer | string; {"maxLength":512} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].alias | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].file | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].sha256 | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].action | string; {"enum":["open","click","fill","select","wait","scroll","assert_visible","assert_text","assert_url","assert_status","assert_json","new_session","dialog","popup","upload","download"]} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).steps[].frame | array<string; {"maxLength":512}>; {"maxItems":4,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].frame[] | string; {"maxLength":512} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).steps[].value_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].values | array<string; {"maxLength":512}>; {"maxItems":32,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].values[] | string; {"maxLength":512} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).steps[].timeout_ms | integer; {"minimum":0,"maximum":30000} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].milliseconds | integer; {"minimum":0,"maximum":30000} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].x | integer; {"minimum":-100000,"maximum":100000} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].y | integer; {"minimum":-100000,"maximum":100000} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].status | integer; {"minimum":0,"maximum":599} | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].expected | JSON | No | — |
| $.config (anyOf 1).target (anyOf 3).steps[].dialog | string; {"enum":["","accept","dismiss"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).script | string; {"maxLength":32768} | No | — |
| $.config (anyOf 1).target (anyOf 3).script_language | string; {"enum":["","javascript","typescript"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).script_sha256 | string; {"pattern":"^(?:|[a-f0-9]{64})$"} | No | — |
| $.config (anyOf 1).target (anyOf 3).variables | object | null | No | — |
| $.config (anyOf 1).target (anyOf 3).header_secrets | object | null | No | — |
| $.config (anyOf 1).target (anyOf 3).http_auth | BrowserAuth | null | No | — |
| $.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1) | BrowserAuth | No | — |
| $.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1).username_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1).password_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).http_auth (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 3).cookies | array<BrowserCookie>; {"maxItems":16,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).cookies[] | BrowserCookie | Yes | — |
| $.config (anyOf 1).target (anyOf 3).cookies[].name | string; {"maxLength":128} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).cookies[].value_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).cookies[].url | string; {"maxLength":2048} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).cookies[].http_only | boolean | No | — |
| $.config (anyOf 1).target (anyOf 3).cookies[].secure | boolean | No | — |
| $.config (anyOf 1).target (anyOf 3).cookies[].same_site | string; {"enum":["Strict","Lax","None"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).files | array<BrowserFile>; {"maxItems":8,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).files[] | BrowserFile | Yes | — |
| $.config (anyOf 1).target (anyOf 3).files[].name | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).files[].mime | string; {"maxLength":128} | No | — |
| $.config (anyOf 1).target (anyOf 3).files[].content_base64 | string; {"maxLength":43692} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).viewport | BrowserViewport | No | — |
| $.config (anyOf 1).target (anyOf 3).viewport.width | integer; {"minimum":240,"maximum":3840} | No | — |
| $.config (anyOf 1).target (anyOf 3).viewport.height | integer; {"minimum":240,"maximum":2160} | No | — |
| $.config (anyOf 1).target (anyOf 3).viewport.device_scale_factor | number; {"minimum":1,"maximum":3} | No | — |
| $.config (anyOf 1).target (anyOf 3).viewport.mobile | boolean | No | — |
| $.config (anyOf 1).target (anyOf 3).viewport.touch | boolean | No | — |
| $.config (anyOf 1).target (anyOf 3).locale | string; {"maxLength":32} | No | — |
| $.config (anyOf 1).target (anyOf 3).timezone | string; {"maxLength":128} | No | — |
| $.config (anyOf 1).target (anyOf 3).user_agent | string; {"maxLength":512} | No | — |
| $.config (anyOf 1).target (anyOf 3).recording | BrowserRecording | No | — |
| $.config (anyOf 1).target (anyOf 3).recording.screenshots | string; {"enum":["off","errors","all"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).recording.traces | string; {"enum":["off","errors","all"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).recording.retention_days | integer; {"minimum":1,"maximum":7} | No | — |
| $.config (anyOf 1).target (anyOf 3).recording.content_confirmed | boolean | No | — |
| $.config (anyOf 1).target (anyOf 3).recording.masks | array<string; {"maxLength":512}>; {"maxItems":32,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).recording.masks[] | string; {"maxLength":512} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).recording.videos | string; {"enum":["off","errors","all"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).visual | BrowserVisual | null | No | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1) | BrowserVisual | No | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1).reference_id | string; {"format":"uuid"} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1).reference_sha256 | string; {"pattern":"^[a-f0-9]{64}$"} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1).confirmed | boolean; {"const":true} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1).maximum_diff_ratio | number; {"minimum":0,"maximum":1} | No | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1).pixel_threshold | number; {"minimum":0,"maximum":1} | No | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1).masks | array<string; {"maxLength":512}>; {"maxItems":32,"minItems":0} | No | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 1).masks[] | string; {"maxLength":512} | Yes | — |
| $.config (anyOf 1).target (anyOf 3).visual (anyOf 2) | null | No | — |
| $.config (anyOf 1).target (anyOf 3).script_format | string; {"enum":["module","playwright_test"]} | No | — |
| $.config (anyOf 1).target (anyOf 3).template | string; {"maxLength":64} | No | — |
| $.config (anyOf 1).target (anyOf 3).confirmation | boolean | No | — |
| $.config (anyOf 1).target (anyOf 4) | CheckHTTPTarget | No | The type feature is available only when enabled. Credential headers are not accepted through this path. |
| $.config (anyOf 1).target (anyOf 4).expected_status | JSON; {"const":0} | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).target (anyOf 4).expected_status (anyOf 1) | JSON; {"const":0} | No | — |
| $.config (anyOf 1).target (anyOf 4).expected_status (anyOf 2) | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).target (anyOf 4).expected_text | string; {"maxLength":256} | No | — |
| $.config (anyOf 1).target (anyOf 4).interval_seconds | integer; {"default":300,"maximum":86400,"minimum":60} | No | Sampling or check interval in seconds within the stated bounds. |
| $.config (anyOf 1).target (anyOf 4).json_field | string; {"maxLength":64} | No | A top-level JSON field; alternative to expected_text. |
| $.config (anyOf 1).target (anyOf 4).json_value | string; {"maxLength":256} | No | — |
| $.config (anyOf 1).target (anyOf 4).method | string; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]} | No | — |
| $.config (anyOf 1).target (anyOf 4).url | string; {"format":"uri","maxLength":2048} | Yes | HTTP/HTTPS, ports 80/443 only; DNS and destination IP are checked on every attempt. |
| $.config (anyOf 1).target (anyOf 4).location_ids | array<string; {"format":"uuid"}>; {"maxItems":5,"minItems":1} | No | — |
| $.config (anyOf 1).target (anyOf 4).location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.config (anyOf 1).target (anyOf 4).policy | JSON; {"enum":["any","all","quorum"]} | No | — |
| $.config (anyOf 1).target (anyOf 4).quorum | integer; {"maximum":5,"minimum":1} | No | — |
| $.config (anyOf 1).target (anyOf 4).confirm_failures | integer; {"maximum":10,"minimum":1} | No | — |
| $.config (anyOf 1).target (anyOf 4).confirm_successes | integer; {"maximum":10,"minimum":1} | No | — |
| $.config (anyOf 1).target (anyOf 4).family | string; {"enum":["ipv4","ipv6","dual"],"default":"dual"} | No | — |
| $.config (anyOf 1).target (anyOf 4).timeout_seconds | integer; {"minimum":1,"maximum":30,"default":8} | No | — |
| $.config (anyOf 1).target (anyOf 4).expected_status_min | integer; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).target (anyOf 4).expected_status_max | integer; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).target (anyOf 4).follow_redirects | boolean; {"default":true} | No | — |
| $.config (anyOf 1).target (anyOf 4).content_as_down | boolean | No | — |
| $.config (anyOf 1).target (anyOf 4).actions_confirmed | boolean | No | — |
| $.config (anyOf 1).target (anyOf 4).request_body_present | boolean | No | — |
| $.config (anyOf 1).timeout_seconds | integer; {"maximum":120,"minimum":1} | Yes | — |
| $.config (anyOf 1).version | JSON; {"const":1} | Yes | — |
| $.config (anyOf 1).form_version | integer; {"enum":[2]} | No | — |
| $.config (anyOf 2) | HTTPMonitorConfig | No | The type feature is available only when enabled. Credential headers are not accepted through this path. |
| $.config (anyOf 2).expected_status | JSON; {"const":0} | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 2).expected_status (anyOf 1) | JSON; {"const":0} | No | — |
| $.config (anyOf 2).expected_status (anyOf 2) | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 2).expected_text | string; {"maxLength":256} | No | — |
| $.config (anyOf 2).interval_seconds | integer; {"default":300,"maximum":86400,"minimum":10} | No | Sampling or check interval in seconds within the stated bounds. |
| $.config (anyOf 2).json_field | string; {"maxLength":64} | No | A top-level JSON field; alternative to expected_text. |
| $.config (anyOf 2).json_value | string; {"maxLength":256} | No | — |
| $.config (anyOf 2).method | string; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]} | No | — |
| $.config (anyOf 2).url | string; {"format":"uri","maxLength":2048} | Yes | HTTP/HTTPS, ports 80/443 only; DNS and destination IP are checked on every attempt. |
| $.config (anyOf 2).location_ids | array<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1} | Yes | — |
| $.config (anyOf 2).location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.config (anyOf 2).policy | JSON; {"enum":["any","all","quorum"],"default":"quorum"} | No | Defaults to quorum with two distinct locations. Select at least two compatible locations. Explicit any/all policies remain available; two failed confirmations per location are required by default. For Ping quorum checks with N locations and failure quorum Q, N−Q+1 freshly confirmed healthy locations establish availability; Q confirmed failed locations establish an outage. Other results remain unconfirmed or unknown. Ambiguous Ping results can trigger a fast follow-up at the same location, limited to two per monitor and one per location per minute, within the existing check budget. Manual tests never affect availability. Earlier coverage gaps remain unchanged. |
| $.config (anyOf 2).quorum | integer; {"maximum":4096,"minimum":1,"default":2} | No | — |
| $.config (anyOf 2).confirm_failures | integer; {"maximum":10,"minimum":1} | No | — |
| $.config (anyOf 2).confirm_successes | integer; {"maximum":10,"minimum":1} | No | — |
| $.config (anyOf 2).family | string; {"enum":["ipv4","ipv6","dual"],"default":"dual"} | No | — |
| $.config (anyOf 2).timeout_seconds | integer; {"minimum":1,"maximum":30,"default":8} | No | — |
| $.config (anyOf 2).expected_status_min | integer; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 2).expected_status_max | integer; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 2).follow_redirects | boolean; {"default":true} | No | — |
| $.config (anyOf 2).content_as_down | boolean | No | — |
| $.config (anyOf 2).actions_confirmed | boolean | No | — |
| $.config (anyOf 2).request_body_present | boolean | No | — |
| $.alerting | MonitorAlertingSettings | No | — |
| $.alerting.enabled | boolean | Yes | — |
| $.alerting.reminders_enabled | boolean | Yes | — |
| $.alerting.include_target_url | boolean | Yes | — |
| $.alerting.certificate_enabled | boolean | Yes | — |
| $.alerting.expiry_reminders | boolean | Yes | — |
| $.alerting.certificate_changes | boolean | Yes | — |
| $.alerting.domain_enabled | boolean | Yes | — |
| $.alerting.delay_seconds | integer; {"minimum":0,"maximum":86400} | Yes | — |
| $.alerting.repeat_seconds | integer; {"minimum":1800,"maximum":86400} | Yes | — |
| $.alerting.reminder_limit | integer; {"minimum":1,"maximum":4} | Yes | — |
| $.alerting.certificate_days | integer; {"minimum":1,"maximum":3660} | Yes | — |
| $.alerting.domain_days | integer; {"minimum":1,"maximum":3660} | Yes | — |
| $.alerting.notification_mode | string; {"enum":["all_active","selected"]} | Yes | — |
| $.alerting.notification_destination_ids | array<string; {"format":"uuid"}>; {"maxItems":20} | Yes | — |
| $.alerting.notification_destination_ids[] | string; {"format":"uuid"} | Yes | — |
| $.alerting.escalation_policy_id | string | null; {"format":"uuid"} | Yes | — |
| $.alerting.severity | string; {"enum":["info","warning","critical"]} | Yes | — |
| $.alerting.domain | string; {"maxLength":253} | Yes | — |
| $.alerting.warning_notification_mode | string; {"enum":["inherit","all_active","selected"]} | Yes | — |
| $.alerting.warning_destination_ids | array<string; {"format":"uuid"}>; {"maxItems":20} | Yes | — |
| $.alerting.warning_destination_ids[] | string; {"format":"uuid"} | Yes | — |
Responses
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | CheckPreview | Yes | — |
| $.type | JSON; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]} | Yes | — |
| $.config | CheckConfig | Yes | — |
| $.config.confirm_failures | integer; {"maximum":10,"minimum":1} | Yes | — |
| $.config.confirm_successes | integer; {"maximum":10,"minimum":1} | Yes | — |
| $.config.interval_seconds | integer; {"maximum":604800,"minimum":10} | Yes | — |
| $.config.location_ids | array<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1} | Yes | — |
| $.config.location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.config.metrics | array<string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}>; {"maxItems":64,"minItems":1} | Yes | — |
| $.config.metrics[] | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config.policy | JSON; {"enum":["any","all","quorum"],"default":"quorum"} | Yes | Defaults to quorum with two distinct locations. Select at least two compatible locations. Explicit any/all policies remain available; two failed confirmations per location are required by default. For Ping quorum checks with N locations and failure quorum Q, N−Q+1 freshly confirmed healthy locations establish availability; Q confirmed failed locations establish an outage. Other results remain unconfirmed or unknown. Ambiguous Ping results can trigger a fast follow-up at the same location, limited to two per monitor and one per location per minute, within the existing check budget. Manual tests never affect availability. Earlier coverage gaps remain unchanged. |
| $.config.quorum | integer; {"maximum":4096,"minimum":1,"default":2} | No | — |
| $.config.target | CheckTarget | Yes | — |
| $.config.target (anyOf 1) | CheckNetworkTarget | No | — |
| $.config.target (anyOf 1) (anyOf 1) | CheckTCPTarget | No | — |
| $.config.target (anyOf 1) (anyOf 1).host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 1) (anyOf 1).port | integer; {"minimum":1,"maximum":65535} | Yes | — |
| $.config.target (anyOf 1) (anyOf 1).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 1) (anyOf 1).expected | string; {"enum":["reachable","unreachable"]} | No | — |
| $.config.target (anyOf 1) (anyOf 1).send | CheckPayload | null | No | — |
| $.config.target (anyOf 1) (anyOf 1).send (anyOf 1) | CheckPayload | No | — |
| $.config.target (anyOf 1) (anyOf 1).send (anyOf 1).encoding | string; {"enum":["text","hex",""]} | No | — |
| $.config.target (anyOf 1) (anyOf 1).send (anyOf 1).value | string; {"maxLength":8192} | Yes | — |
| $.config.target (anyOf 1) (anyOf 1).send (anyOf 2) | null | No | — |
| $.config.target (anyOf 1) (anyOf 1).expect | CheckMatch | null | No | — |
| $.config.target (anyOf 1) (anyOf 1).expect (anyOf 1) | CheckMatch | No | — |
| $.config.target (anyOf 1) (anyOf 1).expect (anyOf 1).kind | string; {"enum":["text","regex","hex"]} | Yes | — |
| $.config.target (anyOf 1) (anyOf 1).expect (anyOf 1).value | string; {"maxLength":4096} | Yes | — |
| $.config.target (anyOf 1) (anyOf 1).expect (anyOf 2) | null | No | — |
| $.config.target (anyOf 1) (anyOf 1).max_bytes | integer; {"minimum":1,"maximum":65536} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls | CheckTLSOptions | null | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1) | CheckTLSOptions | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).server_name | string; {"maxLength":253} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 1).crl | boolean | No | — |
| $.config.target (anyOf 1) (anyOf 1).tls (anyOf 2) | null | No | — |
| $.config.target (anyOf 1) (anyOf 2) | CheckUDPTarget | No | — |
| $.config.target (anyOf 1) (anyOf 2).host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 1) (anyOf 2).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config.target (anyOf 1) (anyOf 2).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 1) (anyOf 2).preset | string; {"enum":["dns","ntp","custom"]} | No | — |
| $.config.target (anyOf 1) (anyOf 2).send | CheckPayload | null | No | — |
| $.config.target (anyOf 1) (anyOf 2).send (anyOf 1) | CheckPayload | No | — |
| $.config.target (anyOf 1) (anyOf 2).send (anyOf 1).encoding | string; {"enum":["text","hex",""]} | No | — |
| $.config.target (anyOf 1) (anyOf 2).send (anyOf 1).value | string; {"maxLength":8192} | Yes | — |
| $.config.target (anyOf 1) (anyOf 2).send (anyOf 2) | null | No | — |
| $.config.target (anyOf 1) (anyOf 2).expect | CheckMatch | null | No | — |
| $.config.target (anyOf 1) (anyOf 2).expect (anyOf 1) | CheckMatch | No | — |
| $.config.target (anyOf 1) (anyOf 2).expect (anyOf 1).kind | string; {"enum":["text","regex","hex"]} | Yes | — |
| $.config.target (anyOf 1) (anyOf 2).expect (anyOf 1).value | string; {"maxLength":4096} | Yes | — |
| $.config.target (anyOf 1) (anyOf 2).expect (anyOf 2) | null | No | — |
| $.config.target (anyOf 1) (anyOf 2).dns_name | string; {"maxLength":253} | No | — |
| $.config.target (anyOf 1) (anyOf 2).max_bytes | integer; {"minimum":48,"maximum":65535} | No | — |
| $.config.target (anyOf 1) (anyOf 3) | CheckTLSTarget | No | — |
| $.config.target (anyOf 1) (anyOf 3).host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 1) (anyOf 3).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config.target (anyOf 1) (anyOf 3).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls | CheckTLSOptions | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.server_name | string; {"maxLength":253} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config.target (anyOf 1) (anyOf 3).tls.crl | boolean | No | — |
| $.config.target (anyOf 1) (anyOf 3).starttls | string; {"enum":["","smtp","imap","pop","ftp","postgres","ldap"]} | No | — |
| $.config.target (anyOf 1) (anyOf 4) | CheckPingTarget | No | — |
| $.config.target (anyOf 1) (anyOf 4).host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 1) (anyOf 4).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 1) (anyOf 4).count | integer; {"minimum":1,"maximum":10} | No | — |
| $.config.target (anyOf 1) (anyOf 4).size | integer; {"minimum":16,"maximum":1472} | No | — |
| $.config.target (anyOf 1) (anyOf 4).maximum_loss_percent | number; {"minimum":0,"maximum":100} | No | — |
| $.config.target (anyOf 1) (anyOf 4).maximum_latency_ms | number; {"minimum":0,"maximum":30000} | No | — |
| $.config.target (anyOf 1) (anyOf 5) | CheckDNSTarget | No | — |
| $.config.target (anyOf 1) (anyOf 5).name | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 1) (anyOf 5).record | string; {"enum":["A","AAAA","CNAME","MX","TXT","NS","SOA","SRV","CAA","PTR"]} | Yes | — |
| $.config.target (anyOf 1) (anyOf 5).resolver | CheckEndpoint | null | No | — |
| $.config.target (anyOf 1) (anyOf 5).resolver (oneOf 1) | CheckEndpoint | No | — |
| $.config.target (anyOf 1) (anyOf 5).resolver (oneOf 1).host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 1) (anyOf 5).resolver (oneOf 1).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config.target (anyOf 1) (anyOf 5).resolver (oneOf 1).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 1) (anyOf 5).resolver (oneOf 2) | null | No | — |
| $.config.target (anyOf 1) (anyOf 5).transport | string; {"enum":["udp","tcp","dot","doh"]} | No | — |
| $.config.target (anyOf 1) (anyOf 5).doh_url | string; {"maxLength":2048} | No | — |
| $.config.target (anyOf 1) (anyOf 5).authoritative | boolean | No | — |
| $.config.target (anyOf 1) (anyOf 5).condition | string; {"enum":["present","exact","subset","absent"]} | No | — |
| $.config.target (anyOf 1) (anyOf 5).expected | array | null; {"maxItems":64} | No | — |
| $.config.target (anyOf 1) (anyOf 5).expected[] | string; {"maxLength":4096} | Yes | — |
| $.config.target (anyOf 1) (anyOf 5).response_code | string; {"maxLength":32} | No | — |
| $.config.target (anyOf 1) (anyOf 5).minimum_ttl | integer | null; {"minimum":0,"maximum":4294967295} | No | — |
| $.config.target (anyOf 1) (anyOf 5).maximum_ttl | integer | null; {"minimum":0,"maximum":4294967295} | No | — |
| $.config.target (anyOf 1) (anyOf 5).baseline | array | null; {"maxItems":64} | No | — |
| $.config.target (anyOf 1) (anyOf 5).baseline[] | string; {"maxLength":4096} | Yes | — |
| $.config.target (anyOf 1) (anyOf 5).dnssec | string; {"enum":["observe","require_valid","off"]} | No | — |
| $.config.target (anyOf 2) | CheckServiceTarget | No | — |
| $.config.target (anyOf 2) (oneOf 1) | CheckNativeServiceTarget | No | — |
| $.config.target (anyOf 2) (oneOf 1).host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 2) (oneOf 1).port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config.target (anyOf 2) (oneOf 1).family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 2) (oneOf 1).protocol | string; {"enum":["ssh","smtp","imap","pop","ftp","postgres","mysql","redis","mqtt","ldap","ntp","websocket"]} | Yes | — |
| $.config.target (anyOf 2) (oneOf 1).username_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 1).password_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls | CheckTLSOptions | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1) | CheckTLSOptions | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).server_name | string; {"maxLength":253} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 1).crl | boolean | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls (anyOf 2) | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).tls_mode | string; {"enum":["","implicit","starttls"]} | No | — |
| $.config.target (anyOf 2) (oneOf 1).database | string; {"maxLength":128} | No | — |
| $.config.target (anyOf 2) (oneOf 1).query | CheckServiceQuery | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1) | CheckServiceQuery | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1).sql | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1).read_account_confirmed | boolean | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1).maximum_rows | integer; {"minimum":1,"maximum":200} | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1).timeout_ms | integer; {"minimum":100,"maximum":30000} | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1).minimum_rows | integer; {"minimum":0,"maximum":200} | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1).conditions | array | null; {"maxItems":8} | No | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 1).conditions[] | CheckQueryCondition | Yes | — |
| $.config.target (anyOf 2) (oneOf 1).query (anyOf 2) | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).ssh_host_key | string; {"pattern":"^(?:|SHA256:[A-Za-z0-9+/]{43})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 1).mailbox | string; {"maxLength":1024} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ftp_directory | string; {"maxLength":1024} | No | — |
| $.config.target (anyOf 2) (oneOf 1).redis_key | string; {"maxLength":512} | No | — |
| $.config.target (anyOf 2) (oneOf 1).redis_expected | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 2) (oneOf 1).mqtt | CheckMQTTOptions | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).mqtt (anyOf 1) | CheckMQTTOptions | No | — |
| $.config.target (anyOf 2) (oneOf 1).mqtt (anyOf 1).topic | string; {"maxLength":256} | Yes | — |
| $.config.target (anyOf 2) (oneOf 1).mqtt (anyOf 1).expect | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 2) (oneOf 1).mqtt (anyOf 1).round_trip | boolean | No | — |
| $.config.target (anyOf 2) (oneOf 1).mqtt (anyOf 2) | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap | CheckLDAPSearch | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1) | CheckLDAPSearch | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).base_dn | string; {"maxLength":1024} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).scope | string; {"enum":["base","one","subtree"]} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).attribute | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).value | string; {"maxLength":1024} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).present | boolean | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).maximum_entries | integer; {"minimum":1,"maximum":200} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).minimum_entries | integer; {"minimum":0,"maximum":200} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_attribute | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_value | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 2) (oneOf 1).ldap (anyOf 2) | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).websocket | CheckWebSocketOptions | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).websocket (anyOf 1) | CheckWebSocketOptions | No | — |
| $.config.target (anyOf 2) (oneOf 1).websocket (anyOf 1).subprotocol | string; {"maxLength":128} | No | — |
| $.config.target (anyOf 2) (oneOf 1).websocket (anyOf 1).send | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 2) (oneOf 1).websocket (anyOf 1).expect | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 2) (oneOf 1).websocket (anyOf 2) | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).request_path | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 2) (oneOf 1).header_secrets | object | null | No | — |
| $.config.target (anyOf 2) (oneOf 1).maximum_offset_ms | number; {"minimum":0,"maximum":86400000} | No | — |
| $.config.target (anyOf 2) (oneOf 2) | CheckMailServiceTarget | No | — |
| $.config.target (anyOf 2) (oneOf 2).protocol | JSON; {"const":"mail_delivery"} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery | CheckMailDeliveryConfig | Yes | Configure your own SMTP and IMAP test mailboxes with TLS and secret references, and confirm ownership. Actual receipt confirms delivery. A consistent mailbox arrival time measures delivery_ms; otherwise delivery_time_source=observed marks the confirmation time as an upper bound. Default interval: 30 minutes, minimum 15 minutes. |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp | CheckMailEndpoint | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls | CheckTLSOptions | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.server_name | string; {"maxLength":253} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls.crl | boolean | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls_mode | string; {"enum":["implicit","starttls"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.username_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.smtp.password_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap | CheckMailEndpoint | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.host | string; {"maxLength":253} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.family | string; {"enum":["ipv4","ipv6","dual"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls | CheckTLSOptions | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.server_name | string; {"maxLength":253} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.minimum_version | string; {"enum":["1.2","1.3"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.ca_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.certificate_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.key_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.sha256 | string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.minimum_days | number; {"minimum":0,"maximum":3660} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.revocation | string; {"enum":["observe","require_good","off"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls.crl | boolean | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.tls_mode | string; {"enum":["implicit","starttls"]} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.username_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.imap.password_secret | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.from | string; {"maxLength":254} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.to | string; {"maxLength":254} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.mailbox | string; {"maxLength":255} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.owned_mailboxes_confirmed | JSON; {"const":true} | Yes | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.remove_received | boolean | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.maximum_wait_seconds | integer; {"minimum":30,"maximum":900} | No | — |
| $.config.target (anyOf 2) (oneOf 2).mail_delivery.language | string; {"enum":["en","de"]} | No | — |
| $.config.target (anyOf 3) | CheckBrowserTarget | No | — |
| $.config.target (anyOf 3).url | string; {"maxLength":2048} | Yes | — |
| $.config.target (anyOf 3).allowed_origins | array<string; {"maxLength":2048}>; {"maxItems":16,"minItems":0} | No | — |
| $.config.target (anyOf 3).allowed_origins[] | string; {"maxLength":2048} | Yes | — |
| $.config.target (anyOf 3).engines | array<string; {"enum":["chromium","firefox","webkit"]}>; {"maxItems":3,"minItems":1} | No | — |
| $.config.target (anyOf 3).engines[] | string; {"enum":["chromium","firefox","webkit"]} | Yes | — |
| $.config.target (anyOf 3).mode | string; {"enum":["guided","script"]} | No | — |
| $.config.target (anyOf 3).steps | array<BrowserStep>; {"maxItems":64,"minItems":0} | No | — |
| $.config.target (anyOf 3).steps[] | BrowserStep | Yes | — |
| $.config.target (anyOf 3).steps[].session | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 3).steps[].page | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 3).steps[].selector | string; {"maxLength":512} | No | — |
| $.config.target (anyOf 3).steps[].url | string; {"maxLength":2048} | No | — |
| $.config.target (anyOf 3).steps[].value | string; {"maxLength":4096} | No | — |
| $.config.target (anyOf 3).steps[].json_pointer | string; {"maxLength":512} | No | — |
| $.config.target (anyOf 3).steps[].alias | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 3).steps[].file | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 3).steps[].sha256 | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 3).steps[].action | string; {"enum":["open","click","fill","select","wait","scroll","assert_visible","assert_text","assert_url","assert_status","assert_json","new_session","dialog","popup","upload","download"]} | Yes | — |
| $.config.target (anyOf 3).steps[].frame | array<string; {"maxLength":512}>; {"maxItems":4,"minItems":0} | No | — |
| $.config.target (anyOf 3).steps[].frame[] | string; {"maxLength":512} | Yes | — |
| $.config.target (anyOf 3).steps[].value_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | No | — |
| $.config.target (anyOf 3).steps[].values | array<string; {"maxLength":512}>; {"maxItems":32,"minItems":0} | No | — |
| $.config.target (anyOf 3).steps[].values[] | string; {"maxLength":512} | Yes | — |
| $.config.target (anyOf 3).steps[].timeout_ms | integer; {"minimum":0,"maximum":30000} | No | — |
| $.config.target (anyOf 3).steps[].milliseconds | integer; {"minimum":0,"maximum":30000} | No | — |
| $.config.target (anyOf 3).steps[].x | integer; {"minimum":-100000,"maximum":100000} | No | — |
| $.config.target (anyOf 3).steps[].y | integer; {"minimum":-100000,"maximum":100000} | No | — |
| $.config.target (anyOf 3).steps[].status | integer; {"minimum":0,"maximum":599} | No | — |
| $.config.target (anyOf 3).steps[].expected | JSON | No | — |
| $.config.target (anyOf 3).steps[].dialog | string; {"enum":["","accept","dismiss"]} | No | — |
| $.config.target (anyOf 3).script | string; {"maxLength":32768} | No | — |
| $.config.target (anyOf 3).script_language | string; {"enum":["","javascript","typescript"]} | No | — |
| $.config.target (anyOf 3).script_sha256 | string; {"pattern":"^(?:|[a-f0-9]{64})$"} | No | — |
| $.config.target (anyOf 3).variables | object | null | No | — |
| $.config.target (anyOf 3).header_secrets | object | null | No | — |
| $.config.target (anyOf 3).http_auth | BrowserAuth | null | No | — |
| $.config.target (anyOf 3).http_auth (anyOf 1) | BrowserAuth | No | — |
| $.config.target (anyOf 3).http_auth (anyOf 1).username_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config.target (anyOf 3).http_auth (anyOf 1).password_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config.target (anyOf 3).http_auth (anyOf 2) | null | No | — |
| $.config.target (anyOf 3).cookies | array<BrowserCookie>; {"maxItems":16,"minItems":0} | No | — |
| $.config.target (anyOf 3).cookies[] | BrowserCookie | Yes | — |
| $.config.target (anyOf 3).cookies[].name | string; {"maxLength":128} | Yes | — |
| $.config.target (anyOf 3).cookies[].value_secret | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config.target (anyOf 3).cookies[].url | string; {"maxLength":2048} | Yes | — |
| $.config.target (anyOf 3).cookies[].http_only | boolean | No | — |
| $.config.target (anyOf 3).cookies[].secure | boolean | No | — |
| $.config.target (anyOf 3).cookies[].same_site | string; {"enum":["Strict","Lax","None"]} | No | — |
| $.config.target (anyOf 3).files | array<BrowserFile>; {"maxItems":8,"minItems":0} | No | — |
| $.config.target (anyOf 3).files[] | BrowserFile | Yes | — |
| $.config.target (anyOf 3).files[].name | string; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"} | Yes | — |
| $.config.target (anyOf 3).files[].mime | string; {"maxLength":128} | No | — |
| $.config.target (anyOf 3).files[].content_base64 | string; {"maxLength":43692} | Yes | — |
| $.config.target (anyOf 3).viewport | BrowserViewport | No | — |
| $.config.target (anyOf 3).viewport.width | integer; {"minimum":240,"maximum":3840} | No | — |
| $.config.target (anyOf 3).viewport.height | integer; {"minimum":240,"maximum":2160} | No | — |
| $.config.target (anyOf 3).viewport.device_scale_factor | number; {"minimum":1,"maximum":3} | No | — |
| $.config.target (anyOf 3).viewport.mobile | boolean | No | — |
| $.config.target (anyOf 3).viewport.touch | boolean | No | — |
| $.config.target (anyOf 3).locale | string; {"maxLength":32} | No | — |
| $.config.target (anyOf 3).timezone | string; {"maxLength":128} | No | — |
| $.config.target (anyOf 3).user_agent | string; {"maxLength":512} | No | — |
| $.config.target (anyOf 3).recording | BrowserRecording | No | — |
| $.config.target (anyOf 3).recording.screenshots | string; {"enum":["off","errors","all"]} | No | — |
| $.config.target (anyOf 3).recording.traces | string; {"enum":["off","errors","all"]} | No | — |
| $.config.target (anyOf 3).recording.retention_days | integer; {"minimum":1,"maximum":7} | No | — |
| $.config.target (anyOf 3).recording.content_confirmed | boolean | No | — |
| $.config.target (anyOf 3).recording.masks | array<string; {"maxLength":512}>; {"maxItems":32,"minItems":0} | No | — |
| $.config.target (anyOf 3).recording.masks[] | string; {"maxLength":512} | Yes | — |
| $.config.target (anyOf 3).recording.videos | string; {"enum":["off","errors","all"]} | No | — |
| $.config.target (anyOf 3).visual | BrowserVisual | null | No | — |
| $.config.target (anyOf 3).visual (anyOf 1) | BrowserVisual | No | — |
| $.config.target (anyOf 3).visual (anyOf 1).reference_id | string; {"format":"uuid"} | Yes | — |
| $.config.target (anyOf 3).visual (anyOf 1).reference_sha256 | string; {"pattern":"^[a-f0-9]{64}$"} | Yes | — |
| $.config.target (anyOf 3).visual (anyOf 1).confirmed | boolean; {"const":true} | Yes | — |
| $.config.target (anyOf 3).visual (anyOf 1).maximum_diff_ratio | number; {"minimum":0,"maximum":1} | No | — |
| $.config.target (anyOf 3).visual (anyOf 1).pixel_threshold | number; {"minimum":0,"maximum":1} | No | — |
| $.config.target (anyOf 3).visual (anyOf 1).masks | array<string; {"maxLength":512}>; {"maxItems":32,"minItems":0} | No | — |
| $.config.target (anyOf 3).visual (anyOf 1).masks[] | string; {"maxLength":512} | Yes | — |
| $.config.target (anyOf 3).visual (anyOf 2) | null | No | — |
| $.config.target (anyOf 3).script_format | string; {"enum":["module","playwright_test"]} | No | — |
| $.config.target (anyOf 3).template | string; {"maxLength":64} | No | — |
| $.config.target (anyOf 3).confirmation | boolean | No | — |
| $.config.target (anyOf 4) | CheckHTTPTarget | No | The type feature is available only when enabled. Credential headers are not accepted through this path. |
| $.config.target (anyOf 4).expected_status | JSON; {"const":0} | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config.target (anyOf 4).expected_status (anyOf 1) | JSON; {"const":0} | No | — |
| $.config.target (anyOf 4).expected_status (anyOf 2) | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config.target (anyOf 4).expected_text | string; {"maxLength":256} | No | — |
| $.config.target (anyOf 4).interval_seconds | integer; {"default":300,"maximum":86400,"minimum":60} | No | Sampling or check interval in seconds within the stated bounds. |
| $.config.target (anyOf 4).json_field | string; {"maxLength":64} | No | A top-level JSON field; alternative to expected_text. |
| $.config.target (anyOf 4).json_value | string; {"maxLength":256} | No | — |
| $.config.target (anyOf 4).method | string; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]} | No | — |
| $.config.target (anyOf 4).url | string; {"format":"uri","maxLength":2048} | Yes | HTTP/HTTPS, ports 80/443 only; DNS and destination IP are checked on every attempt. |
| $.config.target (anyOf 4).location_ids | array<string; {"format":"uuid"}>; {"maxItems":5,"minItems":1} | No | — |
| $.config.target (anyOf 4).location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.config.target (anyOf 4).policy | JSON; {"enum":["any","all","quorum"]} | No | — |
| $.config.target (anyOf 4).quorum | integer; {"maximum":5,"minimum":1} | No | — |
| $.config.target (anyOf 4).confirm_failures | integer; {"maximum":10,"minimum":1} | No | — |
| $.config.target (anyOf 4).confirm_successes | integer; {"maximum":10,"minimum":1} | No | — |
| $.config.target (anyOf 4).family | string; {"enum":["ipv4","ipv6","dual"],"default":"dual"} | No | — |
| $.config.target (anyOf 4).timeout_seconds | integer; {"minimum":1,"maximum":30,"default":8} | No | — |
| $.config.target (anyOf 4).expected_status_min | integer; {"minimum":100,"maximum":599} | No | — |
| $.config.target (anyOf 4).expected_status_max | integer; {"minimum":100,"maximum":599} | No | — |
| $.config.target (anyOf 4).follow_redirects | boolean; {"default":true} | No | — |
| $.config.target (anyOf 4).content_as_down | boolean | No | — |
| $.config.target (anyOf 4).actions_confirmed | boolean | No | — |
| $.config.target (anyOf 4).request_body_present | boolean | No | — |
| $.config.timeout_seconds | integer; {"maximum":120,"minimum":1} | Yes | — |
| $.config.version | JSON; {"const":1} | Yes | — |
| $.config.form_version | integer; {"enum":[2]} | No | — |
| $.metrics | array<CheckMetric> | Yes | — |
| $.metrics[] | CheckMetric | Yes | — |
| $.metrics[].key | string | Yes | — |
| $.metrics[].kind | JSON; {"enum":["gauge","enum"]} | Yes | — |
| $.metrics[].unit | string | Yes | — |
| $.metrics[].values | array<string> | No | — |
| $.metrics[].values[] | string | Yes | — |
| $.locations | array<CheckPreviewLocation> | Yes | — |
| $.locations[] | CheckPreviewLocation | Yes | — |
| $.locations[].id | string; {"format":"uuid"} | Yes | — |
| $.locations[].name | string | Yes | — |
| $.locations[].region | string | Yes | — |
| $.locations[].private | boolean | Yes | — |
| $.locations[].capabilities | array<string> | Yes | — |
| $.locations[].capabilities[] | string | Yes | — |
| $.secret_names | array<string> | Yes | — |
| $.secret_names[] | string | Yes | — |
| $.budget | CheckPreviewBudget | Yes | — |
| $.budget.selected_series | integer; {"minimum":0} | Yes | — |
| $.budget.new_series | integer; {"minimum":0} | Yes | — |
| $.budget.retained_series | integer; {"minimum":0} | Yes | — |
| $.budget.account_series | integer; {"minimum":0} | Yes | — |
| $.budget.series_limit | integer; {"minimum":0} | Yes | — |
| $.budget.remaining_series | integer; {"minimum":0} | Yes | — |
| $.budget.remaining_series_30_days | integer; {"minimum":0} | Yes | — |
| $.budget.creation_tokens | integer; {"minimum":0} | Yes | — |
| $.budget.creation_per_minute | integer; {"minimum":0} | Yes | — |
| $.budget.checks_per_minute_limit | integer; {"minimum":0} | Yes | — |
| $.budget.maximum_objects_per_day | integer; {"minimum":0} | Yes | — |
| $.budget.estimated_checks_per_minute | number; {"minimum":0} | Yes | — |
| $.budget.account_checks_per_minute | number; {"minimum":0} | Yes | — |
| $.budget.can_create_now | boolean | Yes | — |
| $.budget.engine_count | integer; {"minimum":0} | Yes | — |
| $.budget.maximum_seconds_per_run | integer; {"minimum":0} | Yes | — |
| $.budget.browser_seconds_per_day_limit | integer; {"minimum":0} | Yes | — |
| $.budget.remaining_browser_seconds | integer; {"minimum":0} | Yes | — |
| $.budget.active_browser_monitors | integer; {"minimum":0} | Yes | — |
| $.budget.browser_monitor_limit | integer; {"minimum":0} | Yes | — |
| $.budget.maximum_browser_seconds_per_day | integer; {"minimum":0} | Yes | — |
| $.budget.new_alarm_rules | integer; {"minimum":0} | No | — |
| $.budget.remaining_alarm_rules | integer; {"minimum":0} | No | — |
| $.observed_at | string; {"format":"date-time"} | Yes | — |
| $.alarm_suggestions | array<CheckDraftAlarm> | Yes | — |
| $.alarm_suggestions[] | CheckDraftAlarm | Yes | — |
| $.alarm_suggestions[].key | string; {"maxLength":128} | Yes | — |
| $.alarm_suggestions[].metric | string | Yes | — |
| $.alarm_suggestions[].location_id | string | null; {"format":"uuid"} | Yes | — |
| $.alarm_suggestions[].kind | string; {"enum":["state","numeric"]} | Yes | — |
| $.alarm_suggestions[].target_state | string | null | Yes | — |
| $.alarm_suggestions[].trigger_value | number | null | Yes | — |
| $.alarm_suggestions[].clear_value | number | null | Yes | — |
| $.alarm_suggestions[].title_key | string | Yes | — |
| $.notification_channels | array<string> | Yes | — |
| $.notification_channels[] | string | Yes | — |
| $.suggested_domain | string | No | — |
| Stable error codes |
|---|
| invalid_credential |
| unauthorized |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| operator_required |
| forbidden |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| invalid_workspace |
| not_found |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| invalid_workspace |
| stale_check |
| result_conflict |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| invalid_config |
| invalid_monitor |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| invalid_workspace |
| check_capacity |
| Header | Type and limits | Meaning |
|---|---|---|
| Retry-After | string; {"pattern":"^[0-9]+$"} | Temporary server error; retry unchanged with Retry-After and the same idempotency identifier |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| unavailable |
| feature_unavailable |
| check_location_unavailable |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
Retries and asynchronous work
This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --silent --show-error --request POST --header @"$HOME/.config/metribeacon/headers.txt" --header "Content-Type: application/json" --data-binary '{"workspace_id":"00000000-0000-4000-8000-000000000001","type":"tcp","config":{"version":1,"interval_seconds":300,"timeout_seconds":5,"location_ids":["00000000-0000-4000-8000-000000000002"],"policy":"any","confirm_failures":2,"confirm_successes":2,"metrics":["availability","duration_ms"],"target":{"host":"example.com","port":443}}}' \
"https://metribeacon.com/api/v1/monitors/checks/preview"
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
headers["Content-Type"] = "application/json"
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, target):
return None
request = Request('https://metribeacon.com/api/v1/monitors/checks/preview', data='{"workspace_id":"00000000-0000-4000-8000-000000000001","type":"tcp","config":{"version":1,"interval_seconds":300,"timeout_seconds":5,"location_ids":["00000000-0000-4000-8000-000000000002"],"policy":"any","confirm_failures":2,"confirm_successes":2,"metrics":["availability","duration_ms"],"target":{"host":"example.com","port":443}}}'.encode("utf-8"), headers=headers, method="POST")
with build_opener(NoRedirect()).open(request, timeout=10) as response:
print(response.status)
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";
const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
headers["Content-Type"] = "application/json";
const response = await fetch("https://metribeacon.com/api/v1/monitors/checks/preview", {method:"POST", headers, body:JSON.stringify({"workspace_id":"00000000-0000-4000-8000-000000000001","type":"tcp","config":{"version":1,"interval_seconds":300,"timeout_seconds":5,"location_ids":["00000000-0000-4000-8000-000000000002"],"policy":"any","confirm_failures":2,"confirm_successes":2,"metrics":["availability","duration_ms"],"target":{"host":"example.com","port":443}}}), redirect:"manual", signal:AbortSignal.timeout(10000)});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
"strings"
)
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
var headers map[string]string
if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
request, err := http.NewRequest("POST", "https://metribeacon.com/api/v1/monitors/checks/preview", strings.NewReader("{\"workspace_id\":\"00000000-0000-4000-8000-000000000001\",\"type\":\"tcp\",\"config\":{\"version\":1,\"interval_seconds\":300,\"timeout_seconds\":5,\"location_ids\":[\"00000000-0000-4000-8000-000000000002\"],\"policy\":\"any\",\"confirm_failures\":2,\"confirm_successes\":2,\"metrics\":[\"availability\",\"duration_ms\"],\"target\":{\"host\":\"example.com\",\"port\":443}}}"))
if err != nil { panic("request failed; credentials and response omitted") }
for name, value := range headers { request.Header.Set(name, value) }
request.Header.Set("Content-Type", "application/json")
client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { panic("request failed; credentials and response omitted") }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- GET Read a draft test result
Read your private draft test in its authorized workspace before its 15-minute expiry. Pending, running, unknown and confirmed target failures remain distinct.
- GET List draft browser recordings
List completed recordings belonging to your private draft test. Recordings expire with the draft, no later than fifteen minutes after its creation.
- GET Download draft browser recording
Download a completed, authorized draft recording before it expires. Videos contain masked frames and no audio.