MetriBeacon
Menu

POST Test a monitor draft

/api/v1/monitors/checks/test-runs

Run the configured check once at a selected authorized location without creating a monitor, series or alerts. Reuse the same request_id after an uncertain response. Protected credentials and private results expire after 15 minutes. Browser and mail actions require actions_confirmed; browser recordings are disabled and visual baselines require a saved monitor. Executions share regular network/browser budgets.

On this page

Access and permissions

Run the configured check once at a selected authorized location without creating a monitor, series or alerts. Reuse the same request_id after an uncertain response. Protected credentials and private results expire after 15 minutes. Browser and mail actions require actions_confirmed; browser recordings are disabled and visual baselines require a saved monitor. Executions share regular network/browser budgets.

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

FieldLocationType and limitsRequiredMeaning
OriginHeaderstring; {"format":"uri"}NoIf present, must match the canonical HTTPS origin. Sec-Fetch-Site cross-site is rejected.
X-CSRF-TokenHeaderstringNoBrowser CSRF cookie value. Not required when an allowed machine management credential is used.

Request body

FieldType and limitsRequiredMeaning
$CheckDraftInputYes—
$.workspace_idstring; {"format":"uuid"}Yes—
$.typeJSON; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]}Yes—
$.configCheckConfig | HTTPMonitorConfigYes—
$.config (anyOf 1)CheckConfigNo—
$.config (anyOf 1).confirm_failuresinteger; {"maximum":10,"minimum":1}Yes—
$.config (anyOf 1).confirm_successesinteger; {"maximum":10,"minimum":1}Yes—
$.config (anyOf 1).interval_secondsinteger; {"maximum":604800,"minimum":10}Yes—
$.config (anyOf 1).location_idsarray<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1}Yes—
$.config (anyOf 1).location_ids[]string; {"format":"uuid"}Yes—
$.config (anyOf 1).metricsarray<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).policyJSON; {"enum":["any","all","quorum"],"default":"quorum"}YesDefaults 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).quoruminteger; {"maximum":4096,"minimum":1,"default":2}No—
$.config (anyOf 1).targetCheckTargetYes—
$.config (anyOf 1).target (anyOf 1)CheckNetworkTargetNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1)CheckTCPTargetNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).portinteger; {"minimum":1,"maximum":65535}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expectedstring; {"enum":["reachable","unreachable"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).sendCheckPayload | nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1)CheckPayloadNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1).encodingstring; {"enum":["text","hex",""]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1).valuestring; {"maxLength":8192}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expectCheckMatch | nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1)CheckMatchNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1).kindstring; {"enum":["text","regex","hex"]}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1).valuestring; {"maxLength":4096}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).max_bytesinteger; {"minimum":1,"maximum":65536}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tlsCheckTLSOptions | nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1)CheckTLSOptionsNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).server_namestring; {"maxLength":253}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_versionstring; {"enum":["1.2","1.3"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).ca_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).certificate_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).key_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).sha256string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_daysnumber; {"minimum":0,"maximum":3660}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).revocationstring; {"enum":["observe","require_good","off"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).crlbooleanNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2)CheckUDPTargetNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).portinteger; {"minimum":1,"maximum":65535}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).presetstring; {"enum":["dns","ntp","custom"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).sendCheckPayload | nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1)CheckPayloadNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1).encodingstring; {"enum":["text","hex",""]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1).valuestring; {"maxLength":8192}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expectCheckMatch | nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1)CheckMatchNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1).kindstring; {"enum":["text","regex","hex"]}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1).valuestring; {"maxLength":4096}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).dns_namestring; {"maxLength":253}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).max_bytesinteger; {"minimum":48,"maximum":65535}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3)CheckTLSTargetNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).portinteger; {"minimum":1,"maximum":65535}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tlsCheckTLSOptionsNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.server_namestring; {"maxLength":253}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.minimum_versionstring; {"enum":["1.2","1.3"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.ca_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.certificate_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.key_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.sha256string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.minimum_daysnumber; {"minimum":0,"maximum":3660}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.revocationstring; {"enum":["observe","require_good","off"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.crlbooleanNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).starttlsstring; {"enum":["","smtp","imap","pop","ftp","postgres","ldap"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 4)CheckPingTargetNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).countinteger; {"minimum":1,"maximum":10}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).sizeinteger; {"minimum":16,"maximum":1472}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).maximum_loss_percentnumber; {"minimum":0,"maximum":100}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).maximum_latency_msnumber; {"minimum":0,"maximum":30000}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5)CheckDNSTargetNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).namestring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).recordstring; {"enum":["A","AAAA","CNAME","MX","TXT","NS","SOA","SRV","CAA","PTR"]}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolverCheckEndpoint | nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1)CheckEndpointNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).portinteger; {"minimum":1,"maximum":65535}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 2)nullNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).transportstring; {"enum":["udp","tcp","dot","doh"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).doh_urlstring; {"maxLength":2048}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).authoritativebooleanNo—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).conditionstring; {"enum":["present","exact","subset","absent"]}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).expectedarray | 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_codestring; {"maxLength":32}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).minimum_ttlinteger | null; {"minimum":0,"maximum":4294967295}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).maximum_ttlinteger | null; {"minimum":0,"maximum":4294967295}No—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).baselinearray | 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).dnssecstring; {"enum":["observe","require_valid","off"]}No—
$.config (anyOf 1).target (anyOf 2)CheckServiceTargetNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1)CheckNativeServiceTargetNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).portinteger; {"minimum":1,"maximum":65535}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).protocolstring; {"enum":["ssh","smtp","imap","pop","ftp","postgres","mysql","redis","mqtt","ldap","ntp","websocket"]}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).username_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).password_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tlsCheckTLSOptions | nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1)CheckTLSOptionsNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).server_namestring; {"maxLength":253}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_versionstring; {"enum":["1.2","1.3"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).ca_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).certificate_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).key_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).sha256string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_daysnumber; {"minimum":0,"maximum":3660}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).revocationstring; {"enum":["observe","require_good","off"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).crlbooleanNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls_modestring; {"enum":["","implicit","starttls"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).databasestring; {"maxLength":128}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).queryCheckServiceQuery | nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1)CheckServiceQueryNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).sqlstring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).read_account_confirmedbooleanNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).maximum_rowsinteger; {"minimum":1,"maximum":200}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).timeout_msinteger; {"minimum":100,"maximum":30000}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).minimum_rowsinteger; {"minimum":0,"maximum":200}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).conditionsarray | null; {"maxItems":8}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ssh_host_keystring; {"pattern":"^(?:|SHA256:[A-Za-z0-9+/]{43})$"}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mailboxstring; {"maxLength":1024}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ftp_directorystring; {"maxLength":1024}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).redis_keystring; {"maxLength":512}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).redis_expectedstring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqttCheckMQTTOptions | nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1)CheckMQTTOptionsNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).topicstring; {"maxLength":256}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).expectstring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).round_tripbooleanNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldapCheckLDAPSearch | nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1)CheckLDAPSearchNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).base_dnstring; {"maxLength":1024}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).scopestring; {"enum":["base","one","subtree"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).attributestring; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).valuestring; {"maxLength":1024}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).presentbooleanNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).maximum_entriesinteger; {"minimum":1,"maximum":200}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).minimum_entriesinteger; {"minimum":0,"maximum":200}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_attributestring; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_valuestring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocketCheckWebSocketOptions | nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1)CheckWebSocketOptionsNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).subprotocolstring; {"maxLength":128}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).sendstring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).expectstring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).request_pathstring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).header_secretsobject | nullNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).maximum_offset_msnumber; {"minimum":0,"maximum":86400000}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2)CheckMailServiceTargetNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).protocolJSON; {"const":"mail_delivery"}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_deliveryCheckMailDeliveryConfigYesConfigure 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.smtpCheckMailEndpointYes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.portinteger; {"minimum":1,"maximum":65535}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.tlsCheckTLSOptionsNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls_modestring; {"enum":["implicit","starttls"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.username_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.password_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imapCheckMailEndpointYes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.hoststring; {"maxLength":253}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.portinteger; {"minimum":1,"maximum":65535}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.familystring; {"enum":["ipv4","ipv6","dual"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.tlsCheckTLSOptionsNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.tls_modestring; {"enum":["implicit","starttls"]}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.username_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.password_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.fromstring; {"maxLength":254}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.tostring; {"maxLength":254}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.mailboxstring; {"maxLength":255}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.owned_mailboxes_confirmedJSON; {"const":true}Yes—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.remove_receivedbooleanNo—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.maximum_wait_secondsinteger; {"minimum":30,"maximum":900}No—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.languagestring; {"enum":["en","de"]}No—
$.config (anyOf 1).target (anyOf 3)CheckBrowserTargetNo—
$.config (anyOf 1).target (anyOf 3).urlstring; {"maxLength":2048}Yes—
$.config (anyOf 1).target (anyOf 3).allowed_originsarray<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).enginesarray<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).modestring; {"enum":["guided","script"]}No—
$.config (anyOf 1).target (anyOf 3).stepsarray<BrowserStep>; {"maxItems":64,"minItems":0}No—
$.config (anyOf 1).target (anyOf 3).steps[]BrowserStepYes—
$.config (anyOf 1).target (anyOf 3).steps[].sessionstring; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 3).steps[].pagestring; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 3).steps[].selectorstring; {"maxLength":512}No—
$.config (anyOf 1).target (anyOf 3).steps[].urlstring; {"maxLength":2048}No—
$.config (anyOf 1).target (anyOf 3).steps[].valuestring; {"maxLength":4096}No—
$.config (anyOf 1).target (anyOf 3).steps[].json_pointerstring; {"maxLength":512}No—
$.config (anyOf 1).target (anyOf 3).steps[].aliasstring; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 3).steps[].filestring; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 3).steps[].sha256string; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 3).steps[].actionstring; {"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[].framearray<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_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}No—
$.config (anyOf 1).target (anyOf 3).steps[].valuesarray<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_msinteger; {"minimum":0,"maximum":30000}No—
$.config (anyOf 1).target (anyOf 3).steps[].millisecondsinteger; {"minimum":0,"maximum":30000}No—
$.config (anyOf 1).target (anyOf 3).steps[].xinteger; {"minimum":-100000,"maximum":100000}No—
$.config (anyOf 1).target (anyOf 3).steps[].yinteger; {"minimum":-100000,"maximum":100000}No—
$.config (anyOf 1).target (anyOf 3).steps[].statusinteger; {"minimum":0,"maximum":599}No—
$.config (anyOf 1).target (anyOf 3).steps[].expectedJSONNo—
$.config (anyOf 1).target (anyOf 3).steps[].dialogstring; {"enum":["","accept","dismiss"]}No—
$.config (anyOf 1).target (anyOf 3).scriptstring; {"maxLength":32768}No—
$.config (anyOf 1).target (anyOf 3).script_languagestring; {"enum":["","javascript","typescript"]}No—
$.config (anyOf 1).target (anyOf 3).script_sha256string; {"pattern":"^(?:|[a-f0-9]{64})$"}No—
$.config (anyOf 1).target (anyOf 3).variablesobject | nullNo—
$.config (anyOf 1).target (anyOf 3).header_secretsobject | nullNo—
$.config (anyOf 1).target (anyOf 3).http_authBrowserAuth | nullNo—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1)BrowserAuthNo—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1).username_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Yes—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1).password_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Yes—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 2)nullNo—
$.config (anyOf 1).target (anyOf 3).cookiesarray<BrowserCookie>; {"maxItems":16,"minItems":0}No—
$.config (anyOf 1).target (anyOf 3).cookies[]BrowserCookieYes—
$.config (anyOf 1).target (anyOf 3).cookies[].namestring; {"maxLength":128}Yes—
$.config (anyOf 1).target (anyOf 3).cookies[].value_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Yes—
$.config (anyOf 1).target (anyOf 3).cookies[].urlstring; {"maxLength":2048}Yes—
$.config (anyOf 1).target (anyOf 3).cookies[].http_onlybooleanNo—
$.config (anyOf 1).target (anyOf 3).cookies[].securebooleanNo—
$.config (anyOf 1).target (anyOf 3).cookies[].same_sitestring; {"enum":["Strict","Lax","None"]}No—
$.config (anyOf 1).target (anyOf 3).filesarray<BrowserFile>; {"maxItems":8,"minItems":0}No—
$.config (anyOf 1).target (anyOf 3).files[]BrowserFileYes—
$.config (anyOf 1).target (anyOf 3).files[].namestring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Yes—
$.config (anyOf 1).target (anyOf 3).files[].mimestring; {"maxLength":128}No—
$.config (anyOf 1).target (anyOf 3).files[].content_base64string; {"maxLength":43692}Yes—
$.config (anyOf 1).target (anyOf 3).viewportBrowserViewportNo—
$.config (anyOf 1).target (anyOf 3).viewport.widthinteger; {"minimum":240,"maximum":3840}No—
$.config (anyOf 1).target (anyOf 3).viewport.heightinteger; {"minimum":240,"maximum":2160}No—
$.config (anyOf 1).target (anyOf 3).viewport.device_scale_factornumber; {"minimum":1,"maximum":3}No—
$.config (anyOf 1).target (anyOf 3).viewport.mobilebooleanNo—
$.config (anyOf 1).target (anyOf 3).viewport.touchbooleanNo—
$.config (anyOf 1).target (anyOf 3).localestring; {"maxLength":32}No—
$.config (anyOf 1).target (anyOf 3).timezonestring; {"maxLength":128}No—
$.config (anyOf 1).target (anyOf 3).user_agentstring; {"maxLength":512}No—
$.config (anyOf 1).target (anyOf 3).recordingBrowserRecordingNo—
$.config (anyOf 1).target (anyOf 3).recording.screenshotsstring; {"enum":["off","errors","all"]}No—
$.config (anyOf 1).target (anyOf 3).recording.tracesstring; {"enum":["off","errors","all"]}No—
$.config (anyOf 1).target (anyOf 3).recording.retention_daysinteger; {"minimum":1,"maximum":7}No—
$.config (anyOf 1).target (anyOf 3).recording.content_confirmedbooleanNo—
$.config (anyOf 1).target (anyOf 3).recording.masksarray<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.videosstring; {"enum":["off","errors","all"]}No—
$.config (anyOf 1).target (anyOf 3).visualBrowserVisual | nullNo—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1)BrowserVisualNo—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).reference_idstring; {"format":"uuid"}Yes—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).reference_sha256string; {"pattern":"^[a-f0-9]{64}$"}Yes—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).confirmedboolean; {"const":true}Yes—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).maximum_diff_rationumber; {"minimum":0,"maximum":1}No—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).pixel_thresholdnumber; {"minimum":0,"maximum":1}No—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).masksarray<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)nullNo—
$.config (anyOf 1).target (anyOf 3).script_formatstring; {"enum":["module","playwright_test"]}No—
$.config (anyOf 1).target (anyOf 3).templatestring; {"maxLength":64}No—
$.config (anyOf 1).target (anyOf 3).confirmationbooleanNo—
$.config (anyOf 1).target (anyOf 4)CheckHTTPTargetNoThe type feature is available only when enabled. Credential headers are not accepted through this path.
$.config (anyOf 1).target (anyOf 4).expected_statusJSON; {"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_textstring; {"maxLength":256}No—
$.config (anyOf 1).target (anyOf 4).interval_secondsinteger; {"default":300,"maximum":86400,"minimum":60}NoSampling or check interval in seconds within the stated bounds.
$.config (anyOf 1).target (anyOf 4).json_fieldstring; {"maxLength":64}NoA top-level JSON field; alternative to expected_text.
$.config (anyOf 1).target (anyOf 4).json_valuestring; {"maxLength":256}No—
$.config (anyOf 1).target (anyOf 4).methodstring; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]}No—
$.config (anyOf 1).target (anyOf 4).urlstring; {"format":"uri","maxLength":2048}YesHTTP/HTTPS, ports 80/443 only; DNS and destination IP are checked on every attempt.
$.config (anyOf 1).target (anyOf 4).location_idsarray<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).policyJSON; {"enum":["any","all","quorum"]}No—
$.config (anyOf 1).target (anyOf 4).quoruminteger; {"maximum":5,"minimum":1}No—
$.config (anyOf 1).target (anyOf 4).confirm_failuresinteger; {"maximum":10,"minimum":1}No—
$.config (anyOf 1).target (anyOf 4).confirm_successesinteger; {"maximum":10,"minimum":1}No—
$.config (anyOf 1).target (anyOf 4).familystring; {"enum":["ipv4","ipv6","dual"],"default":"dual"}No—
$.config (anyOf 1).target (anyOf 4).timeout_secondsinteger; {"minimum":1,"maximum":30,"default":8}No—
$.config (anyOf 1).target (anyOf 4).expected_status_mininteger; {"minimum":100,"maximum":599}No—
$.config (anyOf 1).target (anyOf 4).expected_status_maxinteger; {"minimum":100,"maximum":599}No—
$.config (anyOf 1).target (anyOf 4).follow_redirectsboolean; {"default":true}No—
$.config (anyOf 1).target (anyOf 4).content_as_downbooleanNo—
$.config (anyOf 1).target (anyOf 4).actions_confirmedbooleanNo—
$.config (anyOf 1).target (anyOf 4).request_body_presentbooleanNo—
$.config (anyOf 1).timeout_secondsinteger; {"maximum":120,"minimum":1}Yes—
$.config (anyOf 1).versionJSON; {"const":1}Yes—
$.config (anyOf 1).form_versioninteger; {"enum":[2]}No—
$.config (anyOf 2)HTTPMonitorConfigNoThe type feature is available only when enabled. Credential headers are not accepted through this path.
$.config (anyOf 2).expected_statusJSON; {"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_textstring; {"maxLength":256}No—
$.config (anyOf 2).interval_secondsinteger; {"default":300,"maximum":86400,"minimum":10}NoSampling or check interval in seconds within the stated bounds.
$.config (anyOf 2).json_fieldstring; {"maxLength":64}NoA top-level JSON field; alternative to expected_text.
$.config (anyOf 2).json_valuestring; {"maxLength":256}No—
$.config (anyOf 2).methodstring; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]}No—
$.config (anyOf 2).urlstring; {"format":"uri","maxLength":2048}YesHTTP/HTTPS, ports 80/443 only; DNS and destination IP are checked on every attempt.
$.config (anyOf 2).location_idsarray<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1}Yes—
$.config (anyOf 2).location_ids[]string; {"format":"uuid"}Yes—
$.config (anyOf 2).policyJSON; {"enum":["any","all","quorum"],"default":"quorum"}NoDefaults 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).quoruminteger; {"maximum":4096,"minimum":1,"default":2}No—
$.config (anyOf 2).confirm_failuresinteger; {"maximum":10,"minimum":1}No—
$.config (anyOf 2).confirm_successesinteger; {"maximum":10,"minimum":1}No—
$.config (anyOf 2).familystring; {"enum":["ipv4","ipv6","dual"],"default":"dual"}No—
$.config (anyOf 2).timeout_secondsinteger; {"minimum":1,"maximum":30,"default":8}No—
$.config (anyOf 2).expected_status_mininteger; {"minimum":100,"maximum":599}No—
$.config (anyOf 2).expected_status_maxinteger; {"minimum":100,"maximum":599}No—
$.config (anyOf 2).follow_redirectsboolean; {"default":true}No—
$.config (anyOf 2).content_as_downbooleanNo—
$.config (anyOf 2).actions_confirmedbooleanNo—
$.config (anyOf 2).request_body_presentbooleanNo—
$.location_idstring; {"format":"uuid"}Yes—
$.request_idstring; {"format":"uuid"}Yes—
$.valuesobjectNo—
$.actions_confirmedboolean; {"default":false}No—
$.monitor_idstring; {"format":"uuid"}No—
$.expected_revisioninteger; {"minimum":1}No—

Responses

Stable error codes
invalid_credential
unauthorized
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 401,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
csrf
insufficient_scope
invalid_origin
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 403,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
not_found
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 404,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
invalid_selection
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 422,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
creation_quota
rule_limit
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 429,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
feature_unavailable
unavailable
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 503,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
stale_check
result_conflict
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/json

FieldType and limitsRequiredMeaning
$CheckDraftRunYes—
$.idstring; {"format":"uuid"}Yes—
$.location_idstring; {"format":"uuid"}Yes—
$.statusstring; {"enum":["pending","running","completed","cancelled","expired"]}Yes—
$.pause_reasonstring | null; {"enum":["network_quota","browser_quota",null]}Yes—
$.created_atstring; {"format":"date-time"}Yes—
$.deadline_atstring; {"format":"date-time"}Yes—
$.finished_atstring | null; {"format":"date-time"}Yes—
$.resultCheckResult | nullYes—
$.result (oneOf 1)CheckResultNo—
$.result (oneOf 1).codestring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Yes—
$.result (oneOf 1).duration_msnumber; {"maximum":360000,"minimum":0}Yes—
$.result (oneOf 1).metricsobject | nullNo—
$.result (oneOf 1).statusJSON; {"enum":["up","down","unknown"]}Yes—
$.result (oneOf 1).statesobject | nullNo—
$.result (oneOf 1).detailsCheckPublicDiagnosticsNo—
$.result (oneOf 1).details.addressstring; {"maxLength":45}No—
$.result (oneOf 1).details.certificate_sha256string; {"pattern":"^[a-f0-9]{64}$"}No—
$.result (oneOf 1).details.certificate_not_beforestring; {"format":"date-time"}No—
$.result (oneOf 1).details.certificate_not_afterstring; {"format":"date-time"}No—
$.result (oneOf 1).details.response_codestring; {"pattern":"^[A-Z0-9_]{1,32}$"}No—
$.result (oneOf 1).details.answersarray<string; {"maxLength":1024}>; {"maxItems":64}No—
$.result (oneOf 1).details.answers[]string; {"maxLength":1024}Yes—
$.result (oneOf 1).details.certificate_chainarray<object; {"additionalProperties":false}>; {"maxItems":16}No—
$.result (oneOf 1).details.certificate_chain[]object; {"additionalProperties":false}Yes—
$.result (oneOf 1).details.certificate_chain[].sha256string; {"pattern":"^[a-f0-9]{64}$"}Yes—
$.result (oneOf 1).details.certificate_chain[].not_beforestring; {"format":"date-time"}Yes—
$.result (oneOf 1).details.certificate_chain[].not_afterstring; {"format":"date-time"}Yes—
$.result (oneOf 1).details.certificate_chain[].is_cabooleanYes—
$.result (oneOf 1).details.ssh_host_key_sha256string; {"pattern":"^SHA256:[A-Za-z0-9+/]{43}$"}No—
$.result (oneOf 1).details.domainCheckDomainRegistrationNo—
$.result (oneOf 1).details.domain.domainstring; {"maxLength":253}Yes—
$.result (oneOf 1).details.domain.expires_atstring; {"format":"date-time"} | nullYes—
$.result (oneOf 1).details.domain.expires_at (anyOf 1)string; {"format":"date-time"}No—
$.result (oneOf 1).details.domain.expires_at (anyOf 2)nullNo—
$.result (oneOf 1).details.domain.registrarstring; {"maxLength":256} | nullYes—
$.result (oneOf 1).details.domain.registrar (anyOf 1)string; {"maxLength":256}No—
$.result (oneOf 1).details.domain.registrar (anyOf 2)nullNo—
$.result (oneOf 1).details.domain.nameserversarray | null; {"maxItems":32}Yes—
$.result (oneOf 1).details.domain.nameservers[]string; {"maxLength":253}Yes—
$.result (oneOf 1).details.domain.nameservers_knownbooleanYes—
$.result (oneOf 1).details.domain.statusarray | null; {"maxItems":32}Yes—
$.result (oneOf 1).details.domain.status[]string; {"maxLength":128}Yes—
$.result (oneOf 1).details.domain.status_knownbooleanYes—
$.result (oneOf 1).details.domain.sourcestring; {"enum":["rdap","whois"]}Yes—
$.result (oneOf 1).details.domain.observed_atstring; {"format":"date-time"}Yes—
$.result (oneOf 1).details.domain.registry_updated_atstring; {"format":"date-time"} | nullYes—
$.result (oneOf 1).details.domain.registry_updated_at (anyOf 1)string; {"format":"date-time"}No—
$.result (oneOf 1).details.domain.registry_updated_at (anyOf 2)nullNo—
$.result (oneOf 1).details.domain.expiration_conflictbooleanYes—
$.result (oneOf 1).details.retry_atstring; {"format":"date-time"}No—
$.result (oneOf 1).details.certificateTLSSnapshotNo—
$.result (oneOf 1).details.certificate.hoststring; {"maxLength":253}Yes—
$.result (oneOf 1).details.certificate.tls_versionstringYes—
$.result (oneOf 1).details.certificate.chainarray<TLSCertificate>; {"minItems":1,"maxItems":16}Yes—
$.result (oneOf 1).details.certificate.chain[]TLSCertificateYes—
$.result (oneOf 1).details.certificate.chain[].sha256string; {"pattern":"^[a-f0-9]{64}$"}Yes—
$.result (oneOf 1).details.certificate.chain[].common_namestring; {"maxLength":256}Yes—
$.result (oneOf 1).details.certificate.chain[].issuerstring; {"maxLength":256}Yes—
$.result (oneOf 1).details.certificate.chain[].serialstring; {"maxLength":128}Yes—
$.result (oneOf 1).details.certificate.chain[].not_beforestring; {"format":"date-time"}Yes—
$.result (oneOf 1).details.certificate.chain[].not_afterstring; {"format":"date-time"}Yes—
$.result (oneOf 1).details.certificate.chain[].namesarray<string; {"maxLength":253}>; {"maxItems":128}Yes—
$.result (oneOf 1).details.certificate.chain[].names[]string; {"maxLength":253}Yes—
$.result (oneOf 1).details.certificate.chain[].is_cabooleanYes—
$.result (oneOf 1).details.certificate.chain[].sentbooleanYes—
$.result (oneOf 1).details.certificate.chain[].signaturestringYes—
$.result (oneOf 1).details.certificate.chain[].keystringYes—
$.result (oneOf 1).details.certificate.checksarray<object; {"additionalProperties":false}>; {"minItems":7,"maxItems":7}Yes—
$.result (oneOf 1).details.certificate.checks[]object; {"additionalProperties":false}Yes—
$.result (oneOf 1).details.certificate.checks[].keystring; {"enum":["validity","hostname","authority","chain","revocation","tls","strength"]}Yes—
$.result (oneOf 1).details.certificate.checks[].statusstring; {"enum":["passed","failed","unknown"]}Yes—
$.result (oneOf 1).details.certificate.checks[].reasonstring; {"maxLength":64}Yes—
$.result (oneOf 1).details.certificate.revocation_valid_untilstring; {"format":"date-time"}No—
$.result (oneOf 1).details.certificate.truncatedbooleanNo—
$.result (oneOf 1).details.certificate.portinteger; {"minimum":1,"maximum":65535}No—
$.result (oneOf 1).mail_deliveryCheckMailObservationNo—
$.result (oneOf 1).mail_delivery.phasestring; {"enum":["smtp","imap"]}Yes—
$.result (oneOf 1).mail_delivery.acceptedbooleanYes—
$.result (oneOf 1).mail_delivery.uncertainbooleanYes—
$.result (oneOf 1).mail_delivery.receivedbooleanYes—
$.result (oneOf 1).mail_delivery.removedbooleanYes—
$.result (oneOf 1).mail_delivery.cleanup_unavailablebooleanYes—
$.result (oneOf 1).mail_delivery.received_atstring; {"format":"date-time"}No—
$.result (oneOf 1).browserBrowserObservationNo—
$.result (oneOf 1).browser.enginesarray<BrowserEngineResult>; {"maxItems":3,"minItems":1}Yes—
$.result (oneOf 1).browser.engines[]BrowserEngineResultYes—
$.result (oneOf 1).browser.engines[].enginestring; {"enum":["chromium","firefox","webkit"]}Yes—
$.result (oneOf 1).browser.engines[].statusstring; {"enum":["up","down","unknown"]}Yes—
$.result (oneOf 1).browser.engines[].codestring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Yes—
$.result (oneOf 1).browser.engines[].duration_msnumber; {"minimum":0,"maximum":120000}Yes—
$.result (oneOf 1).browser.engines[].wall_msnumber; {"minimum":0,"maximum":120000}Yes—
$.result (oneOf 1).browser.engines[].stepsarray<BrowserStepResult>; {"maxItems":128,"minItems":0}Yes—
$.result (oneOf 1).browser.engines[].steps[]BrowserStepResultYes—
$.result (oneOf 1).browser.engines[].steps[].indexinteger; {"minimum":0,"maximum":127}Yes—
$.result (oneOf 1).browser.engines[].steps[].statusstring; {"enum":["up","down","skipped"]}Yes—
$.result (oneOf 1).browser.engines[].steps[].codestring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Yes—
$.result (oneOf 1).browser.engines[].steps[].duration_msnumber; {"minimum":0,"maximum":120000}Yes—
$.result (oneOf 1).browser.engines[].steps[].parentinteger; {"minimum":0,"maximum":126}No—
$.result (oneOf 1).browser.engines[].steps[].namestring; {"maxLength":160}No—
$.result (oneOf 1).browser.engines[].steps[].kindstring; {"enum":["test","step","hook"]}No—
$.result (oneOf 1).browser.engines[].steps[].sourceobject; {"additionalProperties":false}No—
$.result (oneOf 1).browser.engines[].metricsobject; {"additionalProperties":false} | nullYes—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1)object; {"additionalProperties":false}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).network_errorsnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).javascript_errorsnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).requestsnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).page_load_msnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).visual_diff_rationumber; {"minimum":0,"maximum":1}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).lcp_msnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).fcp_msnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).tbt_msnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).ttfb_msnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).clsnumber; {"minimum":0,"maximum":1000000000.0}No—
$.result (oneOf 1).browser.engines[].metrics (anyOf 2)nullNo—
$.result (oneOf 1).browser.engines[].artifact_codestring; {"enum":["","recording_unavailable"]}No—
$.result (oneOf 1).browser.engines[].runtimestring; {"enum":["journey-2"]}No—
$.result (oneOf 1).browser.engines[].navigationsarray<BrowserNavigation>; {"maxItems":64}No—
$.result (oneOf 1).browser.engines[].navigations[]BrowserNavigationYes—
$.result (oneOf 1).browser.engines[].navigations[].pageinteger; {"minimum":1,"maximum":16}Yes—
$.result (oneOf 1).browser.engines[].navigations[].indexinteger; {"minimum":1,"maximum":64}Yes—
$.result (oneOf 1).browser.engines[].navigations[].started_msnumber; {"minimum":0,"maximum":120000}Yes—
$.result (oneOf 1).browser.engines[].navigations[].completebooleanYes—
$.result (oneOf 1).browser.engines[].navigations[].vitalsobject; {"additionalProperties":false}Yes—
$.result (oneOf 1).httpobjectNo—
$.result (oneOf 1).http.attemptsarray<object>; {"maxItems":1}Yes—
$.result (oneOf 1).http.attempts[]objectYesStatus-only checks finish at the response headers without downloading the body. Text and JSON checks read up to 1 MiB (1,048,576 bytes). A larger response produces response_body_too_large and an unknown content_match; availability remains based on HTTP status only when content_as_down is false. Otherwise, an expected HTTP status with unverifiable content is unknown. An unexpected HTTP status still fails. Response-body read errors use response_body_read_error. Historical response_body diagnoses retain their original meaning. The received HTTP status is preserved in all cases.
$.result (oneOf 1).http.attempts[].body_matchedbooleanNo—
$.result (oneOf 1).http.attempts[].certificate_daysintegerNo—
$.result (oneOf 1).http.attempts[].checked_atstring; {"format":"date-time"}No—
$.result (oneOf 1).http.attempts[].duration_msintegerYesMilliseconds through the response headers for status-only checks, or through the bounded body read for text and JSON checks.
$.result (oneOf 1).http.attempts[].failure_codestring; {"enum":["","dns","target_denied","connection","tls","timeout","response_body","response_body_too_large","response_body_read_error","redirect","http_status","body_mismatch"]}No—
$.result (oneOf 1).http.attempts[].healthybooleanNo—
$.result (oneOf 1).http.attempts[].hopsarray<object>; {"maxItems":4}No—
$.result (oneOf 1).http.attempts[].hops[]objectYes—
$.result (oneOf 1).http.attempts[].hops[].connect_msnumberNo—
$.result (oneOf 1).http.attempts[].hops[].dns_msnumberYes—
$.result (oneOf 1).http.attempts[].hops[].duration_msnumberYes—
$.result (oneOf 1).http.attempts[].hops[].familystring; {"enum":["ipv4","ipv6"]}No—
$.result (oneOf 1).http.attempts[].hops[].statusintegerNo—
$.result (oneOf 1).http.attempts[].hops[].tls_msnumberNo—
$.result (oneOf 1).http.attempts[].hops[].ttfb_msnumberNo—
$.result (oneOf 1).http.attempts[].initial_statusintegerNo—
$.result (oneOf 1).http.attempts[].redirectsintegerYes—
$.result (oneOf 1).http.attempts[].statusintegerYes—
$.result (oneOf 1).http.attempts[].methodstring; {"enum":["GET","HEAD"]}No—
$.result (oneOf 1).http.attempts[].certificateTLSSnapshotNo—
$.result (oneOf 1).http.attempts[].certificate.hoststring; {"maxLength":253}Yes—
$.result (oneOf 1).http.attempts[].certificate.tls_versionstringYes—
$.result (oneOf 1).http.attempts[].certificate.chainarray<TLSCertificate>; {"minItems":1,"maxItems":16}Yes—
$.result (oneOf 1).http.attempts[].certificate.chain[]TLSCertificateYes—
$.result (oneOf 1).http.attempts[].certificate.checksarray<object; {"additionalProperties":false}>; {"minItems":7,"maxItems":7}Yes—
$.result (oneOf 1).http.attempts[].certificate.checks[]object; {"additionalProperties":false}Yes—
$.result (oneOf 1).http.attempts[].certificate.revocation_valid_untilstring; {"format":"date-time"}No—
$.result (oneOf 1).http.attempts[].certificate.truncatedbooleanNo—
$.result (oneOf 1).http.attempts[].certificate.portinteger; {"minimum":1,"maximum":65535}No—
$.result (oneOf 2)nullNo—
$.workspace_idstring; {"format":"uuid"}Yes—
$.typeJSON; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]}Yes—
$.progressobjectNo—

Retries and asynchronous work

Keep the documented IDs for retries. After an unclear response, do not replace them with new IDs, which could create another resource or reading.

HTTP 202 means the background job was accepted. Use the returned job ID to check its status. Download results when the job is complete, or inspect its error or cancellation status.

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.

shell
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
  --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}},"location_id":"00000000-0000-4000-8000-000000000002","request_id":"00000000-0000-4000-8000-000000000003","values":{},"actions_confirmed":false}' \
  "https://metribeacon.com/api/v1/monitors/checks/test-runs"
python
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError

headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
headers["Content-Type"] = "application/json"
request = Request("https://metribeacon.com/api/v1/monitors/checks/test-runs", 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}},\"location_id\":\"00000000-0000-4000-8000-000000000002\",\"request_id\":\"00000000-0000-4000-8000-000000000003\",\"values\":{},\"actions_confirmed\":false}".encode("utf-8"), headers=headers, method="POST")
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, request, fp, code, message, headers, target):
        return None

opener = build_opener(NoRedirect())
try:
    with opener.open(request, timeout=10) as response:
        print(response.status)
except HTTPError as error:
    print(error.code)
    error.close()
javascript
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/test-runs", {
  method: "POST", headers, redirect: "manual",
  signal: AbortSignal.timeout(10000), body: "{\"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}},\"location_id\":\"00000000-0000-4000-8000-000000000002\",\"request_id\":\"00000000-0000-4000-8000-000000000003\",\"values\":{},\"actions_confirmed\":false}",
});
console.log(response.status);
await response.body?.cancel();
go
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/test-runs", 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}},\"location_id\":\"00000000-0000-4000-8000-000000000002\",\"request_id\":\"00000000-0000-4000-8000-000000000003\",\"values\":{},\"actions_confirmed\":false}"))
  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)
}