MetriBeacon
Menü
Deutsch

POST Monitorentwurf testen

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

Führen Sie die eingerichtete Prüfung einmal an einem ausgewählten berechtigten Standort aus, ohne Monitor, Messreihen oder Alarme anzulegen. Verwenden Sie nach einer ungewissen Antwort dieselbe request_id. Geschützte Zugangsdaten und private Ergebnisse verfallen nach 15 Minuten. Browser- und Mailaktionen verlangen actions_confirmed; Browseraufzeichnungen sind deaktiviert, visuelle Referenzen benötigen einen gespeicherten Monitor. Ausführungen teilen die regulären Netzwerk-/Browserkontingente.

Auf dieser Seite

Zugriff und Rechte

Führen Sie die eingerichtete Prüfung einmal an einem ausgewählten berechtigten Standort aus, ohne Monitor, Messreihen oder Alarme anzulegen. Verwenden Sie nach einer ungewissen Antwort dieselbe request_id. Geschützte Zugangsdaten und private Ergebnisse verfallen nach 15 Minuten. Browser- und Mailaktionen verlangen actions_confirmed; Browseraufzeichnungen sind deaktiviert, visuelle Referenzen benötigen einen gespeicherten Monitor. Ausführungen teilen die regulären Netzwerk-/Browserkontingente.

Browsersitzung: Cookie __Host-mb_session.

Maschinen-Verwaltungszugang in Authorization: Bearer. Beachten Sie die von der Operation benötigten Berechtigungen (Scopes).

Senden Sie bei einer Änderung mit Browsersitzung das aktuelle CSRF-Token in X-CSRF-Token zusammen mit dem Same-Site-Cookie. OAuth-Zustimmung verwendet ihr dokumentiertes Formularfeld.

Parameter und Header

FeldPositionTyp und GrenzenErforderlichBedeutung
OriginHeaderstring; {"format":"uri"}NeinMuss, falls vorhanden, dem kanonischen HTTPS-Origin entsprechen. Sec-Fetch-Site cross-site wird abgewiesen.
X-CSRF-TokenHeaderstringNeinWert des Browser-CSRF-Cookies. Bei einem zulässigen Maschinen-Verwaltungszugang nicht erforderlich.

Anfragekörper

FeldTyp und GrenzenErforderlichBedeutung
$CheckDraftInputJa—
$.workspace_idstring; {"format":"uuid"}Ja—
$.typeJSON; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]}Ja—
$.configCheckConfig | HTTPMonitorConfigJa—
$.config (anyOf 1)CheckConfigNein—
$.config (anyOf 1).confirm_failuresinteger; {"maximum":10,"minimum":1}Ja—
$.config (anyOf 1).confirm_successesinteger; {"maximum":10,"minimum":1}Ja—
$.config (anyOf 1).interval_secondsinteger; {"maximum":604800,"minimum":10}Ja—
$.config (anyOf 1).location_idsarray<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1}Ja—
$.config (anyOf 1).location_ids[]string; {"format":"uuid"}Ja—
$.config (anyOf 1).metricsarray<string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}>; {"maxItems":64,"minItems":1}Ja—
$.config (anyOf 1).metrics[]string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.config (anyOf 1).policyJSON; {"enum":["any","all","quorum"],"default":"quorum"}JaStandard ist Quorum mit zwei unterschiedlichen Standorten. Wählen Sie mindestens zwei geeignete Standorte. Explizite any/all-Regeln bleiben verfügbar; standardmäßig sind zwei Fehlbestätigungen je Standort erforderlich. Bei Ping mit N Standorten und Ausfallquorum Q bestätigen N−Q+1 frisch bestätigte gesunde Standorte die Verfügbarkeit; Q bestätigt ausgefallene Standorte bestätigen einen Ausfall. Andere Ergebnisse bleiben unbestätigt oder unbekannt. Unklare Ping-Ergebnisse können eine schnelle Nachprüfung am selben Standort auslösen, begrenzt auf zwei je Monitor und eine je Standort und Minute innerhalb des bestehenden Prüfkontingents. Manuelle Tests beeinflussen die Verfügbarkeit nicht. Frühere Abdeckungslücken bleiben unverändert.
$.config (anyOf 1).quoruminteger; {"maximum":4096,"minimum":1,"default":2}Nein—
$.config (anyOf 1).targetCheckTargetJa—
$.config (anyOf 1).target (anyOf 1)CheckNetworkTargetNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1)CheckTCPTargetNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).portinteger; {"minimum":1,"maximum":65535}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expectedstring; {"enum":["reachable","unreachable"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).sendCheckPayload | nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1)CheckPayloadNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1).encodingstring; {"enum":["text","hex",""]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 1).valuestring; {"maxLength":8192}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).send (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expectCheckMatch | nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1)CheckMatchNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1).kindstring; {"enum":["text","regex","hex"]}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 1).valuestring; {"maxLength":4096}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).expect (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).max_bytesinteger; {"minimum":1,"maximum":65536}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tlsCheckTLSOptions | nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1)CheckTLSOptionsNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).server_namestring; {"maxLength":253}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_versionstring; {"enum":["1.2","1.3"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).ca_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).certificate_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).key_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).sha256string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).minimum_daysnumber; {"minimum":0,"maximum":3660}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).revocationstring; {"enum":["observe","require_good","off"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 1).crlbooleanNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 1).tls (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2)CheckUDPTargetNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).portinteger; {"minimum":1,"maximum":65535}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).presetstring; {"enum":["dns","ntp","custom"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).sendCheckPayload | nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1)CheckPayloadNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1).encodingstring; {"enum":["text","hex",""]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 1).valuestring; {"maxLength":8192}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).send (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expectCheckMatch | nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1)CheckMatchNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1).kindstring; {"enum":["text","regex","hex"]}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 1).valuestring; {"maxLength":4096}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).expect (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).dns_namestring; {"maxLength":253}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 2).max_bytesinteger; {"minimum":48,"maximum":65535}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3)CheckTLSTargetNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).portinteger; {"minimum":1,"maximum":65535}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tlsCheckTLSOptionsNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.server_namestring; {"maxLength":253}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.minimum_versionstring; {"enum":["1.2","1.3"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.ca_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.certificate_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.key_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.sha256string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.minimum_daysnumber; {"minimum":0,"maximum":3660}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.revocationstring; {"enum":["observe","require_good","off"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).tls.crlbooleanNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 3).starttlsstring; {"enum":["","smtp","imap","pop","ftp","postgres","ldap"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 4)CheckPingTargetNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).countinteger; {"minimum":1,"maximum":10}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).sizeinteger; {"minimum":16,"maximum":1472}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).maximum_loss_percentnumber; {"minimum":0,"maximum":100}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 4).maximum_latency_msnumber; {"minimum":0,"maximum":30000}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5)CheckDNSTargetNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).namestring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).recordstring; {"enum":["A","AAAA","CNAME","MX","TXT","NS","SOA","SRV","CAA","PTR"]}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolverCheckEndpoint | nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1)CheckEndpointNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).portinteger; {"minimum":1,"maximum":65535}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 1).familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).resolver (oneOf 2)nullNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).transportstring; {"enum":["udp","tcp","dot","doh"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).doh_urlstring; {"maxLength":2048}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).authoritativebooleanNein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).conditionstring; {"enum":["present","exact","subset","absent"]}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).expectedarray | null; {"maxItems":64}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).expected[]string; {"maxLength":4096}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).response_codestring; {"maxLength":32}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).minimum_ttlinteger | null; {"minimum":0,"maximum":4294967295}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).maximum_ttlinteger | null; {"minimum":0,"maximum":4294967295}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).baselinearray | null; {"maxItems":64}Nein—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).baseline[]string; {"maxLength":4096}Ja—
$.config (anyOf 1).target (anyOf 1) (anyOf 5).dnssecstring; {"enum":["observe","require_valid","off"]}Nein—
$.config (anyOf 1).target (anyOf 2)CheckServiceTargetNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1)CheckNativeServiceTargetNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).portinteger; {"minimum":1,"maximum":65535}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).protocolstring; {"enum":["ssh","smtp","imap","pop","ftp","postgres","mysql","redis","mqtt","ldap","ntp","websocket"]}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).username_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).password_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tlsCheckTLSOptions | nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1)CheckTLSOptionsNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).server_namestring; {"maxLength":253}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_versionstring; {"enum":["1.2","1.3"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).ca_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).certificate_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).key_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).sha256string; {"pattern":"^(?:|[0-9a-fA-F]{64})$"}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).minimum_daysnumber; {"minimum":0,"maximum":3660}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).revocationstring; {"enum":["observe","require_good","off"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 1).crlbooleanNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).tls_modestring; {"enum":["","implicit","starttls"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).databasestring; {"maxLength":128}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).queryCheckServiceQuery | nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1)CheckServiceQueryNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).sqlstring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).read_account_confirmedbooleanNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).maximum_rowsinteger; {"minimum":1,"maximum":200}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).timeout_msinteger; {"minimum":100,"maximum":30000}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).minimum_rowsinteger; {"minimum":0,"maximum":200}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 1).conditionsarray | null; {"maxItems":8}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).query (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ssh_host_keystring; {"pattern":"^(?:|SHA256:[A-Za-z0-9+/]{43})$"}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mailboxstring; {"maxLength":1024}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ftp_directorystring; {"maxLength":1024}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).redis_keystring; {"maxLength":512}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).redis_expectedstring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqttCheckMQTTOptions | nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1)CheckMQTTOptionsNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).topicstring; {"maxLength":256}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).expectstring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 1).round_tripbooleanNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).mqtt (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldapCheckLDAPSearch | nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1)CheckLDAPSearchNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).base_dnstring; {"maxLength":1024}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).scopestring; {"enum":["base","one","subtree"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).attributestring; {"maxLength":64}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).valuestring; {"maxLength":1024}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).presentbooleanNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).maximum_entriesinteger; {"minimum":1,"maximum":200}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).minimum_entriesinteger; {"minimum":0,"maximum":200}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_attributestring; {"maxLength":64}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 1).expected_valuestring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).ldap (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocketCheckWebSocketOptions | nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1)CheckWebSocketOptionsNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).subprotocolstring; {"maxLength":128}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).sendstring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 1).expectstring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).websocket (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).request_pathstring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).header_secretsobject | nullNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 1).maximum_offset_msnumber; {"minimum":0,"maximum":86400000}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2)CheckMailServiceTargetNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).protocolJSON; {"const":"mail_delivery"}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_deliveryCheckMailDeliveryConfigJaRichten Sie eigene SMTP- und IMAP-Testpostfächer mit TLS und Secretreferenzen ein und bestätigen Sie deren Eigentum. Erst tatsächlicher Empfang bestätigt die Zustellung. Eine konsistente Postfach-Ankunftszeit bestimmt delivery_ms; andernfalls kennzeichnet delivery_time_source=observed die Bestätigungszeit als obere Grenze. Standardintervall: 30 Minuten, Mindestintervall: 15 Minuten.
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtpCheckMailEndpointJa—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.portinteger; {"minimum":1,"maximum":65535}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.tlsCheckTLSOptionsNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.tls_modestring; {"enum":["implicit","starttls"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.username_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.smtp.password_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imapCheckMailEndpointJa—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.hoststring; {"maxLength":253}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.portinteger; {"minimum":1,"maximum":65535}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.familystring; {"enum":["ipv4","ipv6","dual"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.tlsCheckTLSOptionsNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.tls_modestring; {"enum":["implicit","starttls"]}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.username_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.imap.password_secretstring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.fromstring; {"maxLength":254}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.tostring; {"maxLength":254}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.mailboxstring; {"maxLength":255}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.owned_mailboxes_confirmedJSON; {"const":true}Ja—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.remove_receivedbooleanNein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.maximum_wait_secondsinteger; {"minimum":30,"maximum":900}Nein—
$.config (anyOf 1).target (anyOf 2) (oneOf 2).mail_delivery.languagestring; {"enum":["en","de"]}Nein—
$.config (anyOf 1).target (anyOf 3)CheckBrowserTargetNein—
$.config (anyOf 1).target (anyOf 3).urlstring; {"maxLength":2048}Ja—
$.config (anyOf 1).target (anyOf 3).allowed_originsarray<string; {"maxLength":2048}>; {"maxItems":16,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).allowed_origins[]string; {"maxLength":2048}Ja—
$.config (anyOf 1).target (anyOf 3).enginesarray<string; {"enum":["chromium","firefox","webkit"]}>; {"maxItems":3,"minItems":1}Nein—
$.config (anyOf 1).target (anyOf 3).engines[]string; {"enum":["chromium","firefox","webkit"]}Ja—
$.config (anyOf 1).target (anyOf 3).modestring; {"enum":["guided","script"]}Nein—
$.config (anyOf 1).target (anyOf 3).stepsarray<BrowserStep>; {"maxItems":64,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).steps[]BrowserStepJa—
$.config (anyOf 1).target (anyOf 3).steps[].sessionstring; {"maxLength":64}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].pagestring; {"maxLength":64}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].selectorstring; {"maxLength":512}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].urlstring; {"maxLength":2048}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].valuestring; {"maxLength":4096}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].json_pointerstring; {"maxLength":512}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].aliasstring; {"maxLength":64}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].filestring; {"maxLength":64}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].sha256string; {"maxLength":64}Nein—
$.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"]}Ja—
$.config (anyOf 1).target (anyOf 3).steps[].framearray<string; {"maxLength":512}>; {"maxItems":4,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].frame[]string; {"maxLength":512}Ja—
$.config (anyOf 1).target (anyOf 3).steps[].value_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].valuesarray<string; {"maxLength":512}>; {"maxItems":32,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].values[]string; {"maxLength":512}Ja—
$.config (anyOf 1).target (anyOf 3).steps[].timeout_msinteger; {"minimum":0,"maximum":30000}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].millisecondsinteger; {"minimum":0,"maximum":30000}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].xinteger; {"minimum":-100000,"maximum":100000}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].yinteger; {"minimum":-100000,"maximum":100000}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].statusinteger; {"minimum":0,"maximum":599}Nein—
$.config (anyOf 1).target (anyOf 3).steps[].expectedJSONNein—
$.config (anyOf 1).target (anyOf 3).steps[].dialogstring; {"enum":["","accept","dismiss"]}Nein—
$.config (anyOf 1).target (anyOf 3).scriptstring; {"maxLength":32768}Nein—
$.config (anyOf 1).target (anyOf 3).script_languagestring; {"enum":["","javascript","typescript"]}Nein—
$.config (anyOf 1).target (anyOf 3).script_sha256string; {"pattern":"^(?:|[a-f0-9]{64})$"}Nein—
$.config (anyOf 1).target (anyOf 3).variablesobject | nullNein—
$.config (anyOf 1).target (anyOf 3).header_secretsobject | nullNein—
$.config (anyOf 1).target (anyOf 3).http_authBrowserAuth | nullNein—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1)BrowserAuthNein—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1).username_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Ja—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 1).password_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Ja—
$.config (anyOf 1).target (anyOf 3).http_auth (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 3).cookiesarray<BrowserCookie>; {"maxItems":16,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).cookies[]BrowserCookieJa—
$.config (anyOf 1).target (anyOf 3).cookies[].namestring; {"maxLength":128}Ja—
$.config (anyOf 1).target (anyOf 3).cookies[].value_secretstring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Ja—
$.config (anyOf 1).target (anyOf 3).cookies[].urlstring; {"maxLength":2048}Ja—
$.config (anyOf 1).target (anyOf 3).cookies[].http_onlybooleanNein—
$.config (anyOf 1).target (anyOf 3).cookies[].securebooleanNein—
$.config (anyOf 1).target (anyOf 3).cookies[].same_sitestring; {"enum":["Strict","Lax","None"]}Nein—
$.config (anyOf 1).target (anyOf 3).filesarray<BrowserFile>; {"maxItems":8,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).files[]BrowserFileJa—
$.config (anyOf 1).target (anyOf 3).files[].namestring; {"pattern":"^(?:|[a-z][a-z0-9_]{0,63})$"}Ja—
$.config (anyOf 1).target (anyOf 3).files[].mimestring; {"maxLength":128}Nein—
$.config (anyOf 1).target (anyOf 3).files[].content_base64string; {"maxLength":43692}Ja—
$.config (anyOf 1).target (anyOf 3).viewportBrowserViewportNein—
$.config (anyOf 1).target (anyOf 3).viewport.widthinteger; {"minimum":240,"maximum":3840}Nein—
$.config (anyOf 1).target (anyOf 3).viewport.heightinteger; {"minimum":240,"maximum":2160}Nein—
$.config (anyOf 1).target (anyOf 3).viewport.device_scale_factornumber; {"minimum":1,"maximum":3}Nein—
$.config (anyOf 1).target (anyOf 3).viewport.mobilebooleanNein—
$.config (anyOf 1).target (anyOf 3).viewport.touchbooleanNein—
$.config (anyOf 1).target (anyOf 3).localestring; {"maxLength":32}Nein—
$.config (anyOf 1).target (anyOf 3).timezonestring; {"maxLength":128}Nein—
$.config (anyOf 1).target (anyOf 3).user_agentstring; {"maxLength":512}Nein—
$.config (anyOf 1).target (anyOf 3).recordingBrowserRecordingNein—
$.config (anyOf 1).target (anyOf 3).recording.screenshotsstring; {"enum":["off","errors","all"]}Nein—
$.config (anyOf 1).target (anyOf 3).recording.tracesstring; {"enum":["off","errors","all"]}Nein—
$.config (anyOf 1).target (anyOf 3).recording.retention_daysinteger; {"minimum":1,"maximum":7}Nein—
$.config (anyOf 1).target (anyOf 3).recording.content_confirmedbooleanNein—
$.config (anyOf 1).target (anyOf 3).recording.masksarray<string; {"maxLength":512}>; {"maxItems":32,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).recording.masks[]string; {"maxLength":512}Ja—
$.config (anyOf 1).target (anyOf 3).recording.videosstring; {"enum":["off","errors","all"]}Nein—
$.config (anyOf 1).target (anyOf 3).visualBrowserVisual | nullNein—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1)BrowserVisualNein—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).reference_idstring; {"format":"uuid"}Ja—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).reference_sha256string; {"pattern":"^[a-f0-9]{64}$"}Ja—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).confirmedboolean; {"const":true}Ja—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).maximum_diff_rationumber; {"minimum":0,"maximum":1}Nein—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).pixel_thresholdnumber; {"minimum":0,"maximum":1}Nein—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).masksarray<string; {"maxLength":512}>; {"maxItems":32,"minItems":0}Nein—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 1).masks[]string; {"maxLength":512}Ja—
$.config (anyOf 1).target (anyOf 3).visual (anyOf 2)nullNein—
$.config (anyOf 1).target (anyOf 3).script_formatstring; {"enum":["module","playwright_test"]}Nein—
$.config (anyOf 1).target (anyOf 3).templatestring; {"maxLength":64}Nein—
$.config (anyOf 1).target (anyOf 3).confirmationbooleanNein—
$.config (anyOf 1).target (anyOf 4)CheckHTTPTargetNeinTypfunktion nur bei Freigabe verfügbar. Zugangsdaten-Header werden über diesen Pfad nicht angenommen.
$.config (anyOf 1).target (anyOf 4).expected_statusJSON; {"const":0} | JSON; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).target (anyOf 4).expected_status (anyOf 1)JSON; {"const":0}Nein—
$.config (anyOf 1).target (anyOf 4).expected_status (anyOf 2)JSON; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).target (anyOf 4).expected_textstring; {"maxLength":256}Nein—
$.config (anyOf 1).target (anyOf 4).interval_secondsinteger; {"default":300,"maximum":86400,"minimum":60}NeinAbtast- oder Prüfintervall in Sekunden innerhalb der angegebenen Grenzen.
$.config (anyOf 1).target (anyOf 4).json_fieldstring; {"maxLength":64}NeinEin JSON-Feld auf oberster Ebene; alternativ zu expected_text.
$.config (anyOf 1).target (anyOf 4).json_valuestring; {"maxLength":256}Nein—
$.config (anyOf 1).target (anyOf 4).methodstring; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]}Nein—
$.config (anyOf 1).target (anyOf 4).urlstring; {"format":"uri","maxLength":2048}JaHTTP/HTTPS, nur Port 80/443; DNS und Ziel-IP werden bei jeder Prüfung kontrolliert.
$.config (anyOf 1).target (anyOf 4).location_idsarray<string; {"format":"uuid"}>; {"maxItems":5,"minItems":1}Nein—
$.config (anyOf 1).target (anyOf 4).location_ids[]string; {"format":"uuid"}Ja—
$.config (anyOf 1).target (anyOf 4).policyJSON; {"enum":["any","all","quorum"]}Nein—
$.config (anyOf 1).target (anyOf 4).quoruminteger; {"maximum":5,"minimum":1}Nein—
$.config (anyOf 1).target (anyOf 4).confirm_failuresinteger; {"maximum":10,"minimum":1}Nein—
$.config (anyOf 1).target (anyOf 4).confirm_successesinteger; {"maximum":10,"minimum":1}Nein—
$.config (anyOf 1).target (anyOf 4).familystring; {"enum":["ipv4","ipv6","dual"],"default":"dual"}Nein—
$.config (anyOf 1).target (anyOf 4).timeout_secondsinteger; {"minimum":1,"maximum":30,"default":8}Nein—
$.config (anyOf 1).target (anyOf 4).expected_status_mininteger; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).target (anyOf 4).expected_status_maxinteger; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).target (anyOf 4).follow_redirectsboolean; {"default":true}Nein—
$.config (anyOf 1).target (anyOf 4).content_as_downbooleanNein—
$.config (anyOf 1).target (anyOf 4).actions_confirmedbooleanNein—
$.config (anyOf 1).target (anyOf 4).request_body_presentbooleanNein—
$.config (anyOf 1).timeout_secondsinteger; {"maximum":120,"minimum":1}Ja—
$.config (anyOf 1).versionJSON; {"const":1}Ja—
$.config (anyOf 1).form_versioninteger; {"enum":[2]}Nein—
$.config (anyOf 2)HTTPMonitorConfigNeinTypfunktion nur bei Freigabe verfügbar. Zugangsdaten-Header werden über diesen Pfad nicht angenommen.
$.config (anyOf 2).expected_statusJSON; {"const":0} | JSON; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 2).expected_status (anyOf 1)JSON; {"const":0}Nein—
$.config (anyOf 2).expected_status (anyOf 2)JSON; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 2).expected_textstring; {"maxLength":256}Nein—
$.config (anyOf 2).interval_secondsinteger; {"default":300,"maximum":86400,"minimum":10}NeinAbtast- oder Prüfintervall in Sekunden innerhalb der angegebenen Grenzen.
$.config (anyOf 2).json_fieldstring; {"maxLength":64}NeinEin JSON-Feld auf oberster Ebene; alternativ zu expected_text.
$.config (anyOf 2).json_valuestring; {"maxLength":256}Nein—
$.config (anyOf 2).methodstring; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]}Nein—
$.config (anyOf 2).urlstring; {"format":"uri","maxLength":2048}JaHTTP/HTTPS, nur Port 80/443; DNS und Ziel-IP werden bei jeder Prüfung kontrolliert.
$.config (anyOf 2).location_idsarray<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1}Ja—
$.config (anyOf 2).location_ids[]string; {"format":"uuid"}Ja—
$.config (anyOf 2).policyJSON; {"enum":["any","all","quorum"],"default":"quorum"}NeinStandard ist Quorum mit zwei unterschiedlichen Standorten. Wählen Sie mindestens zwei geeignete Standorte. Explizite any/all-Regeln bleiben verfügbar; standardmäßig sind zwei Fehlbestätigungen je Standort erforderlich. Bei Ping mit N Standorten und Ausfallquorum Q bestätigen N−Q+1 frisch bestätigte gesunde Standorte die Verfügbarkeit; Q bestätigt ausgefallene Standorte bestätigen einen Ausfall. Andere Ergebnisse bleiben unbestätigt oder unbekannt. Unklare Ping-Ergebnisse können eine schnelle Nachprüfung am selben Standort auslösen, begrenzt auf zwei je Monitor und eine je Standort und Minute innerhalb des bestehenden Prüfkontingents. Manuelle Tests beeinflussen die Verfügbarkeit nicht. Frühere Abdeckungslücken bleiben unverändert.
$.config (anyOf 2).quoruminteger; {"maximum":4096,"minimum":1,"default":2}Nein—
$.config (anyOf 2).confirm_failuresinteger; {"maximum":10,"minimum":1}Nein—
$.config (anyOf 2).confirm_successesinteger; {"maximum":10,"minimum":1}Nein—
$.config (anyOf 2).familystring; {"enum":["ipv4","ipv6","dual"],"default":"dual"}Nein—
$.config (anyOf 2).timeout_secondsinteger; {"minimum":1,"maximum":30,"default":8}Nein—
$.config (anyOf 2).expected_status_mininteger; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 2).expected_status_maxinteger; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 2).follow_redirectsboolean; {"default":true}Nein—
$.config (anyOf 2).content_as_downbooleanNein—
$.config (anyOf 2).actions_confirmedbooleanNein—
$.config (anyOf 2).request_body_presentbooleanNein—
$.location_idstring; {"format":"uuid"}Ja—
$.request_idstring; {"format":"uuid"}Ja—
$.valuesobjectNein—
$.actions_confirmedboolean; {"default":false}Nein—
$.monitor_idstring; {"format":"uuid"}Nein—
$.expected_revisioninteger; {"minimum":1}Nein—

Antworten

Stabile Fehlercodes
invalid_credential
unauthorized
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
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"
}
Stabile Fehlercodes
csrf
insufficient_scope
invalid_origin
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
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"
}
Stabile Fehlercodes
not_found
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
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"
}
Stabile Fehlercodes
invalid_selection
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
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"
}
Stabile Fehlercodes
creation_quota
rule_limit
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
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"
}
Stabile Fehlercodes
feature_unavailable
unavailable
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
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"
}
Stabile Fehlercodes
stale_check
result_conflict
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/json

FeldTyp und GrenzenErforderlichBedeutung
$CheckDraftRunJa—
$.idstring; {"format":"uuid"}Ja—
$.location_idstring; {"format":"uuid"}Ja—
$.statusstring; {"enum":["pending","running","completed","cancelled","expired"]}Ja—
$.pause_reasonstring | null; {"enum":["network_quota","browser_quota",null]}Ja—
$.created_atstring; {"format":"date-time"}Ja—
$.deadline_atstring; {"format":"date-time"}Ja—
$.finished_atstring | null; {"format":"date-time"}Ja—
$.resultCheckResult | nullJa—
$.result (oneOf 1)CheckResultNein—
$.result (oneOf 1).codestring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.result (oneOf 1).duration_msnumber; {"maximum":360000,"minimum":0}Ja—
$.result (oneOf 1).metricsobject | nullNein—
$.result (oneOf 1).statusJSON; {"enum":["up","down","unknown"]}Ja—
$.result (oneOf 1).statesobject | nullNein—
$.result (oneOf 1).detailsCheckPublicDiagnosticsNein—
$.result (oneOf 1).details.addressstring; {"maxLength":45}Nein—
$.result (oneOf 1).details.certificate_sha256string; {"pattern":"^[a-f0-9]{64}$"}Nein—
$.result (oneOf 1).details.certificate_not_beforestring; {"format":"date-time"}Nein—
$.result (oneOf 1).details.certificate_not_afterstring; {"format":"date-time"}Nein—
$.result (oneOf 1).details.response_codestring; {"pattern":"^[A-Z0-9_]{1,32}$"}Nein—
$.result (oneOf 1).details.answersarray<string; {"maxLength":1024}>; {"maxItems":64}Nein—
$.result (oneOf 1).details.answers[]string; {"maxLength":1024}Ja—
$.result (oneOf 1).details.certificate_chainarray<object; {"additionalProperties":false}>; {"maxItems":16}Nein—
$.result (oneOf 1).details.certificate_chain[]object; {"additionalProperties":false}Ja—
$.result (oneOf 1).details.certificate_chain[].sha256string; {"pattern":"^[a-f0-9]{64}$"}Ja—
$.result (oneOf 1).details.certificate_chain[].not_beforestring; {"format":"date-time"}Ja—
$.result (oneOf 1).details.certificate_chain[].not_afterstring; {"format":"date-time"}Ja—
$.result (oneOf 1).details.certificate_chain[].is_cabooleanJa—
$.result (oneOf 1).details.ssh_host_key_sha256string; {"pattern":"^SHA256:[A-Za-z0-9+/]{43}$"}Nein—
$.result (oneOf 1).details.domainCheckDomainRegistrationNein—
$.result (oneOf 1).details.domain.domainstring; {"maxLength":253}Ja—
$.result (oneOf 1).details.domain.expires_atstring; {"format":"date-time"} | nullJa—
$.result (oneOf 1).details.domain.expires_at (anyOf 1)string; {"format":"date-time"}Nein—
$.result (oneOf 1).details.domain.expires_at (anyOf 2)nullNein—
$.result (oneOf 1).details.domain.registrarstring; {"maxLength":256} | nullJa—
$.result (oneOf 1).details.domain.registrar (anyOf 1)string; {"maxLength":256}Nein—
$.result (oneOf 1).details.domain.registrar (anyOf 2)nullNein—
$.result (oneOf 1).details.domain.nameserversarray | null; {"maxItems":32}Ja—
$.result (oneOf 1).details.domain.nameservers[]string; {"maxLength":253}Ja—
$.result (oneOf 1).details.domain.nameservers_knownbooleanJa—
$.result (oneOf 1).details.domain.statusarray | null; {"maxItems":32}Ja—
$.result (oneOf 1).details.domain.status[]string; {"maxLength":128}Ja—
$.result (oneOf 1).details.domain.status_knownbooleanJa—
$.result (oneOf 1).details.domain.sourcestring; {"enum":["rdap","whois"]}Ja—
$.result (oneOf 1).details.domain.observed_atstring; {"format":"date-time"}Ja—
$.result (oneOf 1).details.domain.registry_updated_atstring; {"format":"date-time"} | nullJa—
$.result (oneOf 1).details.domain.registry_updated_at (anyOf 1)string; {"format":"date-time"}Nein—
$.result (oneOf 1).details.domain.registry_updated_at (anyOf 2)nullNein—
$.result (oneOf 1).details.domain.expiration_conflictbooleanJa—
$.result (oneOf 1).details.retry_atstring; {"format":"date-time"}Nein—
$.result (oneOf 1).details.certificateTLSSnapshotNein—
$.result (oneOf 1).details.certificate.hoststring; {"maxLength":253}Ja—
$.result (oneOf 1).details.certificate.tls_versionstringJa—
$.result (oneOf 1).details.certificate.chainarray<TLSCertificate>; {"minItems":1,"maxItems":16}Ja—
$.result (oneOf 1).details.certificate.chain[]TLSCertificateJa—
$.result (oneOf 1).details.certificate.chain[].sha256string; {"pattern":"^[a-f0-9]{64}$"}Ja—
$.result (oneOf 1).details.certificate.chain[].common_namestring; {"maxLength":256}Ja—
$.result (oneOf 1).details.certificate.chain[].issuerstring; {"maxLength":256}Ja—
$.result (oneOf 1).details.certificate.chain[].serialstring; {"maxLength":128}Ja—
$.result (oneOf 1).details.certificate.chain[].not_beforestring; {"format":"date-time"}Ja—
$.result (oneOf 1).details.certificate.chain[].not_afterstring; {"format":"date-time"}Ja—
$.result (oneOf 1).details.certificate.chain[].namesarray<string; {"maxLength":253}>; {"maxItems":128}Ja—
$.result (oneOf 1).details.certificate.chain[].names[]string; {"maxLength":253}Ja—
$.result (oneOf 1).details.certificate.chain[].is_cabooleanJa—
$.result (oneOf 1).details.certificate.chain[].sentbooleanJa—
$.result (oneOf 1).details.certificate.chain[].signaturestringJa—
$.result (oneOf 1).details.certificate.chain[].keystringJa—
$.result (oneOf 1).details.certificate.checksarray<object; {"additionalProperties":false}>; {"minItems":7,"maxItems":7}Ja—
$.result (oneOf 1).details.certificate.checks[]object; {"additionalProperties":false}Ja—
$.result (oneOf 1).details.certificate.checks[].keystring; {"enum":["validity","hostname","authority","chain","revocation","tls","strength"]}Ja—
$.result (oneOf 1).details.certificate.checks[].statusstring; {"enum":["passed","failed","unknown"]}Ja—
$.result (oneOf 1).details.certificate.checks[].reasonstring; {"maxLength":64}Ja—
$.result (oneOf 1).details.certificate.revocation_valid_untilstring; {"format":"date-time"}Nein—
$.result (oneOf 1).details.certificate.truncatedbooleanNein—
$.result (oneOf 1).details.certificate.portinteger; {"minimum":1,"maximum":65535}Nein—
$.result (oneOf 1).mail_deliveryCheckMailObservationNein—
$.result (oneOf 1).mail_delivery.phasestring; {"enum":["smtp","imap"]}Ja—
$.result (oneOf 1).mail_delivery.acceptedbooleanJa—
$.result (oneOf 1).mail_delivery.uncertainbooleanJa—
$.result (oneOf 1).mail_delivery.receivedbooleanJa—
$.result (oneOf 1).mail_delivery.removedbooleanJa—
$.result (oneOf 1).mail_delivery.cleanup_unavailablebooleanJa—
$.result (oneOf 1).mail_delivery.received_atstring; {"format":"date-time"}Nein—
$.result (oneOf 1).browserBrowserObservationNein—
$.result (oneOf 1).browser.enginesarray<BrowserEngineResult>; {"maxItems":3,"minItems":1}Ja—
$.result (oneOf 1).browser.engines[]BrowserEngineResultJa—
$.result (oneOf 1).browser.engines[].enginestring; {"enum":["chromium","firefox","webkit"]}Ja—
$.result (oneOf 1).browser.engines[].statusstring; {"enum":["up","down","unknown"]}Ja—
$.result (oneOf 1).browser.engines[].codestring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.result (oneOf 1).browser.engines[].duration_msnumber; {"minimum":0,"maximum":120000}Ja—
$.result (oneOf 1).browser.engines[].wall_msnumber; {"minimum":0,"maximum":120000}Ja—
$.result (oneOf 1).browser.engines[].stepsarray<BrowserStepResult>; {"maxItems":128,"minItems":0}Ja—
$.result (oneOf 1).browser.engines[].steps[]BrowserStepResultJa—
$.result (oneOf 1).browser.engines[].steps[].indexinteger; {"minimum":0,"maximum":127}Ja—
$.result (oneOf 1).browser.engines[].steps[].statusstring; {"enum":["up","down","skipped"]}Ja—
$.result (oneOf 1).browser.engines[].steps[].codestring; {"pattern":"^[a-z][a-z0-9_]{0,63}$"}Ja—
$.result (oneOf 1).browser.engines[].steps[].duration_msnumber; {"minimum":0,"maximum":120000}Ja—
$.result (oneOf 1).browser.engines[].steps[].parentinteger; {"minimum":0,"maximum":126}Nein—
$.result (oneOf 1).browser.engines[].steps[].namestring; {"maxLength":160}Nein—
$.result (oneOf 1).browser.engines[].steps[].kindstring; {"enum":["test","step","hook"]}Nein—
$.result (oneOf 1).browser.engines[].steps[].sourceobject; {"additionalProperties":false}Nein—
$.result (oneOf 1).browser.engines[].metricsobject; {"additionalProperties":false} | nullJa—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1)object; {"additionalProperties":false}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).network_errorsnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).javascript_errorsnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).requestsnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).page_load_msnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).visual_diff_rationumber; {"minimum":0,"maximum":1}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).lcp_msnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).fcp_msnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).tbt_msnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).ttfb_msnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 1).clsnumber; {"minimum":0,"maximum":1000000000.0}Nein—
$.result (oneOf 1).browser.engines[].metrics (anyOf 2)nullNein—
$.result (oneOf 1).browser.engines[].artifact_codestring; {"enum":["","recording_unavailable"]}Nein—
$.result (oneOf 1).browser.engines[].runtimestring; {"enum":["journey-2"]}Nein—
$.result (oneOf 1).browser.engines[].navigationsarray<BrowserNavigation>; {"maxItems":64}Nein—
$.result (oneOf 1).browser.engines[].navigations[]BrowserNavigationJa—
$.result (oneOf 1).browser.engines[].navigations[].pageinteger; {"minimum":1,"maximum":16}Ja—
$.result (oneOf 1).browser.engines[].navigations[].indexinteger; {"minimum":1,"maximum":64}Ja—
$.result (oneOf 1).browser.engines[].navigations[].started_msnumber; {"minimum":0,"maximum":120000}Ja—
$.result (oneOf 1).browser.engines[].navigations[].completebooleanJa—
$.result (oneOf 1).browser.engines[].navigations[].vitalsobject; {"additionalProperties":false}Ja—
$.result (oneOf 1).httpobjectNein—
$.result (oneOf 1).http.attemptsarray<object>; {"maxItems":1}Ja—
$.result (oneOf 1).http.attempts[]objectJaReine Statusprüfungen enden nach Empfang der Antwortheader, ohne den Inhalt herunterzuladen. Text- und JSON-Prüfungen lesen bis zu 1 MiB (1.048.576 Byte). Größere Antworten erzeugen response_body_too_large und content_match unknown; nur bei content_as_down false richtet sich die Verfügbarkeit weiter allein nach dem HTTP-Status. Andernfalls bleibt ein erwarteter HTTP-Status mit nicht prüfbarem Inhalt unbekannt. Ein unerwarteter HTTP-Status gilt weiterhin als Fehler. Lesefehler verwenden response_body_read_error. Historische response_body-Diagnosen behalten ihre ursprüngliche Bedeutung. Der empfangene HTTP-Status bleibt in allen Fällen erhalten.
$.result (oneOf 1).http.attempts[].body_matchedbooleanNein—
$.result (oneOf 1).http.attempts[].certificate_daysintegerNein—
$.result (oneOf 1).http.attempts[].checked_atstring; {"format":"date-time"}Nein—
$.result (oneOf 1).http.attempts[].duration_msintegerJaMillisekunden bis zum Empfang der Antwortheader bei reinen Statusprüfungen beziehungsweise bis zum begrenzten Einlesen des Inhalts bei Text- und JSON-Prüfungen.
$.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"]}Nein—
$.result (oneOf 1).http.attempts[].healthybooleanNein—
$.result (oneOf 1).http.attempts[].hopsarray<object>; {"maxItems":4}Nein—
$.result (oneOf 1).http.attempts[].hops[]objectJa—
$.result (oneOf 1).http.attempts[].hops[].connect_msnumberNein—
$.result (oneOf 1).http.attempts[].hops[].dns_msnumberJa—
$.result (oneOf 1).http.attempts[].hops[].duration_msnumberJa—
$.result (oneOf 1).http.attempts[].hops[].familystring; {"enum":["ipv4","ipv6"]}Nein—
$.result (oneOf 1).http.attempts[].hops[].statusintegerNein—
$.result (oneOf 1).http.attempts[].hops[].tls_msnumberNein—
$.result (oneOf 1).http.attempts[].hops[].ttfb_msnumberNein—
$.result (oneOf 1).http.attempts[].initial_statusintegerNein—
$.result (oneOf 1).http.attempts[].redirectsintegerJa—
$.result (oneOf 1).http.attempts[].statusintegerJa—
$.result (oneOf 1).http.attempts[].methodstring; {"enum":["GET","HEAD"]}Nein—
$.result (oneOf 1).http.attempts[].certificateTLSSnapshotNein—
$.result (oneOf 1).http.attempts[].certificate.hoststring; {"maxLength":253}Ja—
$.result (oneOf 1).http.attempts[].certificate.tls_versionstringJa—
$.result (oneOf 1).http.attempts[].certificate.chainarray<TLSCertificate>; {"minItems":1,"maxItems":16}Ja—
$.result (oneOf 1).http.attempts[].certificate.chain[]TLSCertificateJa—
$.result (oneOf 1).http.attempts[].certificate.checksarray<object; {"additionalProperties":false}>; {"minItems":7,"maxItems":7}Ja—
$.result (oneOf 1).http.attempts[].certificate.checks[]object; {"additionalProperties":false}Ja—
$.result (oneOf 1).http.attempts[].certificate.revocation_valid_untilstring; {"format":"date-time"}Nein—
$.result (oneOf 1).http.attempts[].certificate.truncatedbooleanNein—
$.result (oneOf 1).http.attempts[].certificate.portinteger; {"minimum":1,"maximum":65535}Nein—
$.result (oneOf 2)nullNein—
$.workspace_idstring; {"format":"uuid"}Ja—
$.typeJSON; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]}Ja—
$.progressobjectNein—

Wiederholungen und asynchrone Aufträge

Behalten Sie die dokumentierten Kennungen bei Wiederholungen. Ersetzen Sie sie nach einer unklaren Antwort nicht durch neue Kennungen, die eine weitere Ressource oder Messung erzeugen könnten.

HTTP 202 bedeutet, dass der Hintergrundauftrag angenommen wurde. Prüfen Sie seinen Status mit der zurückgegebenen Auftragskennung. Laden Sie Ergebnisse nach dem Abschluss herunter oder lesen Sie den Fehler- beziehungsweise Abbruchstatus.

Anfragebeispiele

Ersetzen Sie Demokennungen, Zeitstempel und Platzhalter durch eigene Werte. Behalten Sie bei Wiederholungen Kennungen, Zeit und Inhalt bei. Diese Beispiele führen auf der Seite keine Anfragen aus.

Halten Sie Anmeldelinks, Codes, Cookies und Schlüssel privat. Schreiben Sie sie nicht in Logs und teilen Sie sie nicht in Hilfeanfragen.

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)
}