Freigeben über


Checkly (Independent Publisher) (Vorschau)

Checkly ist die Überwachungsplattform für den modernen Stapel: programmierbares, flexibles und liebevolles JavaScript. Überwachen und Überprüfen Ihrer wichtigen Websitetransaktionen. Automatisches Sammeln von Fehlerablaufverfolgungen, Screenshots und Leistungsmetriken bei jeder ausgeführten Prüfung.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connectormetadaten
Herausgeber Troy Taylor
Webseite https://www.checklyhq.com/
Datenschutzrichtlinie https://www.checklyhq.com/privacy
Kategorien IT-Vorgänge

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Konto-ID securestring Die Konto-ID für diese API. Richtig
API-Schlüssel (im Format 'Bearer apiKey') securestring Der API-Schlüssel (im Format 'Bearer apiKey') für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen aller Prüfungen in einer bestimmten Gruppe mit angewendeten Gruppeneinstellungen

Listet alle Prüfungen in einer bestimmten Prüfgruppe auf, auf die die Gruppeneinstellungen angewendet wurden.

Abrufen des Check-Triggers

Sucht den Check-Trigger.

Abrufen des Prüfgruppentriggers

Sucht den Häkchengruppentrigger.

Abrufen des Statussignals "Überprüfen"

Abrufen des Statussignals "Überprüfen".

Abrufen einer Prüfgruppe

Details einer bestimmten Prüfgruppe anzeigen.

Abrufen einer Prüfung

Zeigen Sie Details einer bestimmten API- oder Browserüberprüfung an.

Abrufen einer Umgebungsvariable

Details einer bestimmten Umgebungsvariable anzeigen. Verwendet das Schlüsselfeld für die Auswahl.

Abrufen einer Überprüfung in einer bestimmten Gruppe mit angewendeten Gruppeneinstellungen

Zeigen Sie Details einer Überprüfung in einer bestimmten Prüfgruppe mit den angewendeten Gruppeneinstellungen an.

Abrufen eines Codeausschnitts

Details eines bestimmten Codeausschnitts anzeigen.

Abrufen eines privaten Speicherorts

Details eines bestimmten privaten Standorts anzeigen.

Abrufen eines Prüfergebnisses

Details eines bestimmten Prüfergebnisses anzeigen.

Abrufen eines Warnungskanals

Zeigen Sie Details eines bestimmten Warnungskanals an.

Abrufen eines Wartungsfensters

Zeigen Sie Details eines bestimmten Wartungsfensters an.

Abrufen privater Standortintegritätsmetriken aus einem Zeitfenster

Rufen Sie Integritätsmetriken des privaten Standorts aus einem Zeitfenster ab.

Abrufen von Statusdetails für überprüfungen

Zeigen Sie die aktuellen Statusinformationen für eine bestimmte Überprüfung an.

Aktualisieren der Abonnements eines Warnungskanals

Aktualisieren Sie die Abonnements eines Warnungskanals. Verwenden Sie diese Option, um einem Warnungskanal eine Überprüfung hinzuzufügen, sodass Fehler- und Wiederherstellungswarnungen für diese Überprüfung gesendet werden. Hinweis: Beim Übergeben des Abonnementobjekts können Sie nur eine CheckId oder eine groupId angeben, nicht beide.

Aktualisieren einer API-Überprüfung

Aktualisiert eine API-Überprüfung.

Aktualisieren einer Browserüberprüfung

Aktualisiert eine Browserüberprüfung.

Aktualisieren einer Prüfgruppe

Aktualisiert eine Prüfgruppe.

Aktualisieren einer Umgebungsvariable

Aktualisiert eine Umgebungsvariable. Verwendet das Schlüsselfeld als Bezeichner für die Aktualisierung. Aktualisiert nur den Wert und die gesperrte Eigenschaft.

Aktualisieren einer Überprüfung [VERALTET]

[VERALTET] Dieser Endpunkt wird am Montag, dem 4. Juli 2022, entfernt. Verwenden Sie stattdessen PUT /checks/api/{id} oder PUT /checks/browser/{id}. Aktualisiert eine neue API- oder Browserüberprüfung.

Aktualisieren eines Codeausschnitts

Aktualisiert einen Codeausschnitt.

Aktualisieren eines Dashboards

Aktualisiert ein Dashboard. Gibt einen Wert vom Typ 409 zurück, wenn versucht wird, ein Dashboard mit einer benutzerdefinierten URL oder benutzerdefinierten Domäne zu erstellen, die bereits verwendet wird.

Aktualisieren eines privaten Speicherorts

Aktualisiert einen privaten Speicherort.

Aktualisieren eines Warnungskanals

Aktualisieren eines Warnungskanals.

Aktualisieren eines Wartungsfensters

Aktualisiert ein Wartungsfenster.

Alle Codeausschnitte auflisten

Listet alle aktuellen Codeausschnitte in Ihrem Konto auf.

Alle Dashboards auflisten

Listet alle aktuellen Dashboards in Ihrem Konto auf.

Alle privaten Speicherorte auflisten

Listet alle privaten Speicherorte in Ihrem Konto auf.

Alle Prüfgruppen auflisten

Listet alle aktuellen Check-Gruppen in Ihrem Konto auf. Die Check-Eigenschaft ist ein Array von Check UUIDs für die praktische Referenzierung. Sie ist schreibgeschützt und kann nicht zum Hinzufügen von Prüfungen zu einer Gruppe verwendet werden.

Alle Prüfungen auflisten

Listet alle aktuellen Prüfungen in Ihrem Konto auf.

Alle Umgebungsvariablen auflisten

Listet alle aktuellen Umgebungsvariablen in Ihrem Konto auf.

Alle Warnungskanäle auflisten

Listet alle konfigurierten Warnungskanäle und ihre abonnierten Prüfungen auf.

Alle Wartungsfenster auflisten

Listet alle Wartungsfenster in Ihrem Konto auf.

Alle Überprüfungsstatus auflisten

Zeigt die aktuellen Statusinformationen für alle Prüfungen in Ihrem Konto an. Die Statusdatensätze für die Überprüfung werden kontinuierlich aktualisiert, wenn neue Prüfergebnisse eingecheckt werden.

Auflisten aller Benachrichtigungen für Ihr Konto

Listet alle Benachrichtigungen für Ihr Konto auf.

Auflisten von Warnungen für eine bestimmte Überprüfung

Listet alle Warnungen für eine bestimmte Überprüfung auf.

Ein Dashboard erstellen

Erstellt ein neues Dashboard. Gibt einen Wert vom Typ 409 zurück, wenn versucht wird, ein Dashboard mit einer benutzerdefinierten URL oder benutzerdefinierten Domäne zu erstellen, die bereits verwendet wird.

Entfernen eines privaten Speicherorts

Entfernt dauerhaft einen privaten Speicherort.

Entfernen eines vorhandenen API-Schlüssels für einen privaten Speicherort

Entfernt dauerhaft einen API-Schlüssel von einem privaten Speicherort.

Erstellen des Check-Triggers

Erstellt den Check-Trigger.

Erstellen des Prüfgruppentriggers

Erstellt den Häkchengruppentrigger.

Erstellen einer API-Prüfung

Erstellt eine neue API-Prüfung. Gibt einen 402 Wert zurück, wenn Sie den Grenzwert Ihres Plans überschreiten. Bei Verwendung der globalAlertSettingalertSettingnull

Erstellen einer Browserüberprüfung

Erstellt eine neue Browserüberprüfung. Gibt einen 402 Wert zurück, wenn Sie den Grenzwert Ihres Plans überschreiten. Bei Verwendung der globalAlertSettingalertSettingnull

Erstellen einer Prüfgruppe

Erstellt eine neue Prüfgruppe. Sie können der Gruppe Überprüfungen hinzufügen, indem Sie die groupId-Eigenschaft einzelner Prüfungen festlegen.

Erstellen einer Umgebungsvariable

Erstellt eine neue Umgebungsvariable.

Erstellen eines Codeausschnitts

Erstellt einen neuen Codeausschnitt.

Erstellen eines Häkchens [VERALTET]

[VERALTET] Dieser Endpunkt wird am Montag, dem 4. Juli 2022, entfernt. Verwenden Sie stattdessen POST /checks/api oder POST /checks/browser. Erstellt eine neue API- oder Browserüberprüfung. Gibt einen 402 Wert zurück, wenn Sie den Grenzwert Ihres Plans überschreiten. Bei Verwendung der globalAlertSettingsalertSettingsnull

Erstellen eines privaten Speicherorts

Erstellt einen neuen privaten Speicherort.

Erstellen eines Warnungskanals

Erstellt einen neuen Warnungskanal.

Erstellen eines Wartungsfensters

Erstellt ein neues Wartungsfenster.

Generieren eines neuen API-Schlüssels für einen privaten Speicherort

Erstellt einen API-Schlüssel am privaten Speicherort.

Generiert einen anpassbaren Bericht für alle Browserüberprüfungsmetriken.

Generiert einen Bericht mit aggregierten oder nicht aggregierten Statistiken für eine bestimmte Browserüberprüfung über ein bestimmtes Zeitfenster.

Generiert einen Bericht mit aggregierter Statistik für Überprüfungen und Überprüfungsgruppen.

Generiert einen Bericht mit aggregierter Statistik für alle Prüfungen oder einen gefilterten Satz von Prüfungen über ein bestimmtes Zeitfenster.

Gruppenstatussignal abrufen

Abrufen des Gruppenstatussignals.

Listet alle Prüfergebnisse auf

Listet die vollständigen, unformatierten Überprüfungsergebnisse für eine bestimmte Überprüfung auf. Wir behalten rohe Ergebnisse für 30 Tage bei. Nach 30 Tagen werden sie gelöscht. Wir behalten jedoch die Rollupergebnisse für eine unbestimmte Zeit bei. Sie können filtern, indem Sie den Typ und den Ergebnistyp überprüfen, um die Liste einzugrenzen. Verwenden Sie die to Parameter und from die Parameter, um einen Datumsbereich (UNIX-Zeitstempel in Sekunden) anzugeben. Je nach Überprüfungstyp sind einige Felder möglicherweise NULL. Dieser Endpunkt gibt Daten innerhalb eines Zeitraums von sechs Stunden zurück. Wenn von und zu Params festgelegt werden, müssen sie höchstens sechs Stunden auseinander liegen. Wenn keine festgelegt ist, betrachten wir den Param jetzt und von Param bis zu sechs Stunden früher. Wenn nur der Param festgelegt ist, werden wir von sechs Stunden früher festgelegt. Im Gegenteil, wenn nur der von Param festgelegt ist, werden wir den Param für sechs Stunden später betrachten. Die Rate-Limitierung wird auf diesen Endpunkt angewendet, Sie können höchstens 5 Anforderungen / 10 Sekunden senden.

Listet alle unterstützten Laufzeiten auf.

Listet alle unterstützten Laufzeiten und die enthaltenen NPM-Pakete für Browserüberprüfungen und Setup- und Teardownskripts für API-Prüfungen auf.

Listet alle unterstützten Speicherorte auf

Listet alle unterstützten Speicherorte auf.

Löschen des Check-Triggers

Löscht den Check-Trigger.

Löschen des Häkchengruppentriggers

Löscht den Auslöser der Prüfgruppen.

Löschen einer Prüfgruppe

Entfernt eine Prüfgruppe dauerhaft. Sie können eine Prüfgruppe nicht löschen, wenn sie weiterhin Prüfungen enthält.

Löschen einer Prüfung

Entfernt eine API oder einen Browser sowie alle zugehörigen Status- und Ergebnisdaten dauerhaft.

Löschen einer Umgebungsvariable

Entfernt dauerhaft eine Umgebungsvariable. Verwendet das Schlüsselfeld als Bezeichner für das Löschen.

Löschen eines Codeausschnitts

Entfernt einen Codeausschnitt dauerhaft.

Löschen eines Dashboards

Entfernt dauerhaft ein Dashboard.

Löschen eines Warnungskanals

Entfernt dauerhaft einen Warnungskanal.

Löschen eines Wartungsfensters

Entfernt dauerhaft ein Wartungsfenster.

Zeigt Details für eine bestimmte Laufzeit an.

Zeigt die Details aller enthaltenen NPM-Pakete und deren Version für eine bestimmte Laufzeit an.

Abrufen aller Prüfungen in einer bestimmten Gruppe mit angewendeten Gruppeneinstellungen

Listet alle Prüfungen in einer bestimmten Prüfgruppe auf, auf die die Gruppeneinstellungen angewendet wurden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Gibt zurück

Gegenstände
Model8

Abrufen des Check-Triggers

Sucht den Check-Trigger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Gibt zurück

Abrufen des Prüfgruppentriggers

Sucht den Häkchengruppentrigger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
groupId True integer

Der Gruppenbezeichner.

Gibt zurück

Abrufen des Statussignals "Überprüfen"

Abrufen des Statussignals "Überprüfen".

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Stil
style string

Die Formatvorlage.

Design
theme string

Das Design.

Antwortzeit
responseTime boolean

Die Antwortzeit.

Gibt zurück

response
string

Abrufen einer Prüfgruppe

Details einer bestimmten Prüfgruppe anzeigen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Gibt zurück

Body
CheckGroup

Abrufen einer Prüfung

Zeigen Sie Details einer bestimmten API- oder Browserüberprüfung an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Gibt zurück

Body
Check

Abrufen einer Umgebungsvariable

Details einer bestimmten Umgebungsvariable anzeigen. Verwendet das Schlüsselfeld für die Auswahl.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Key
key True string

Der Schlüssel.

Gibt zurück

Abrufen einer Überprüfung in einer bestimmten Gruppe mit angewendeten Gruppeneinstellungen

Zeigen Sie Details einer Überprüfung in einer bestimmten Prüfgruppe mit den angewendeten Gruppeneinstellungen an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
groupId True integer

Der Gruppenbezeichner.

Id überprüfen
checkId True string

Der Prüfbezeichner.

Gibt zurück

Abrufen eines Codeausschnitts

Details eines bestimmten Codeausschnitts anzeigen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Gibt zurück

Body
Snippet

Abrufen eines privaten Speicherorts

Details eines bestimmten privaten Standorts anzeigen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Gibt zurück

Abrufen eines Prüfergebnisses

Details eines bestimmten Prüfergebnisses anzeigen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Ergebnis-ID überprüfen
checkResultId True string

Der Prüfergebnisbezeichner.

Gibt zurück

Abrufen eines Warnungskanals

Zeigen Sie Details eines bestimmten Warnungskanals an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Gibt zurück

Abrufen eines Wartungsfensters

Zeigen Sie Details eines bestimmten Wartungsfensters an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Gibt zurück

Abrufen privater Standortintegritätsmetriken aus einem Zeitfenster

Rufen Sie Integritätsmetriken des privaten Standorts aus einem Zeitfenster ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Von
from True date

Wählen Sie Metriken aus, die mit diesem UNIX-Zeitstempel beginnen. Muss vor weniger als 15 Tagen liegen.

Bis
to True date

Wählen Sie Metriken bis zu diesem UNIX-Zeitstempel aus.

Gibt zurück

Abrufen von Statusdetails für überprüfungen

Zeigen Sie die aktuellen Statusinformationen für eine bestimmte Überprüfung an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Gibt zurück

Aktualisieren der Abonnements eines Warnungskanals

Aktualisieren Sie die Abonnements eines Warnungskanals. Verwenden Sie diese Option, um einem Warnungskanal eine Überprüfung hinzuzufügen, sodass Fehler- und Wiederherstellungswarnungen für diese Überprüfung gesendet werden. Hinweis: Beim Übergeben des Abonnementobjekts können Sie nur eine CheckId oder eine groupId angeben, nicht beide.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Id überprüfen
checkId guid

Sie können entweder eine CheckId oder eine groupId übergeben, aber nicht beide.

Gruppen-ID
groupId number

Sie können entweder eine CheckId oder eine groupId übergeben, aber nicht beide.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Gibt zurück

Aktualisieren einer API-Überprüfung

Aktualisiert eine API-Überprüfung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name string

Der Name der Prüfung.

Aktiviert
activated boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

method
method True string
URL
url True string

Die URL-Adresse.

Follow Redirects
followRedirects boolean

Gibt an, ob Umleitungen befolgt werden sollen.

SSL überspringen
skipSSL boolean

Gibt an, ob SSL übersprungen werden soll.

Body
body string

Der Körper.

Körpertyp
bodyType string

Der Textkörpertyp.

Key
key True string

Der Schlüssel.

Wert
value True string

Der Wert.

Gesperrt
locked boolean

Gibt an, ob gesperrt.

Quelle
source string

Die Quelle.

Eigentum
property string

Die Eigenschaft.

Vergleich
comparison string

Der Vergleich.

Ziel
target string

Das Ziel.

Nutzername
username True string

Der Benutzername.

Kennwort
password True string

Das Kennwort.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung verwendet werden soll.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung verwendet werden soll.

Frequenzversatz
frequencyOffset integer

Wird für das Festlegen von Sekunden für Die Überprüfungsfrequenzen unter 1 Minuten und die Verteilung von Prüfungen über einen Zeitraum für Frequenzen über 1 Minute verwendet. Dies funktioniert wie folgt: Prüfungen mit einer Häufigkeit von 0 können eine Häufigkeit von 10, 20 oder 30 aufweisen, was bedeutet, dass sie alle 10, 20 oder 30 Sekunden ausgeführt werden. Prüfungen mit einer Häufigkeit niedriger als und gleich 60 können einen FrequencyOffset zwischen 1 und einem maximalen Wert basierend auf der Formel Math.floor(Häufigkeit * 10) aufweisen, d. h. für eine Prüfung, die alle 5 Minuten ausgeführt wird, beträgt die maximale HäufigkeitOffset 50. Überprüfungen mit einer Häufigkeit, die höher als 60 ist, können eine häufigkeitoffset zwischen 1 und einem höchstwert basierend auf der Formel Math.ceil(frequency / 60) aufweisen, d. h. für eine Überprüfung, die alle 720 Minuten ausgeführt wird, ist das max. frequencyOffset 12.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase ausgeführt werden soll.

Herabgestufte Reaktionszeit
degradedResponseTime number

Die Reaktionszeit in Millisekunden, bei der eine Überprüfung als herabgestuft betrachtet werden sollte.

Maximale Reaktionszeit
maxResponseTime number

Die Antwortzeit in Millisekunden, bei der eine Überprüfung als fehlschlägt.

Private Speicherorte
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Gibt zurück

Body
CheckAPI

Aktualisieren einer Browserüberprüfung

Aktualisiert eine Browserüberprüfung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name string

Der Name der Prüfung.

Aktiviert
activated boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Key
key True string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Skript
script string

Ein gültiger Teil Node.js Javascript-Code, der eine Browserinteraktion mit den Puppeteer- oder Playwright-Frameworks beschreibt.

Private Speicherorte
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Gibt zurück

Aktualisieren einer Prüfgruppe

Aktualisiert eine Prüfgruppe.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name string

Der Name der Prüfgruppe.

Aktiviert
activated boolean

Bestimmt, ob die Prüfungen in der Gruppe ausgeführt werden oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn ein Einchecken dieser Gruppe fehlschlägt und/oder wiederhergestellt wird.

Gruppentagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Überprüfen der Gruppenspeicherortliste
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem die Prüfungen ausgeführt werden sollen.

Konkurrenz
concurrency number

Bestimmt, wie viele Prüfungen gleichzeitig aufgerufen werden, wenn eine Prüfgruppe von CI/CD oder über die API ausgelöst wird.

URL
url string

Die Basis-URL für diese Gruppe, auf die Sie in allen Gruppenüberprüfungen mit der Variablen {{GROUP_BASE_URL}} verweisen können.

Key
key True string

Der Schlüssel.

Wert
value True string

Der Wert.

Gesperrt
locked boolean

Gibt an, ob gesperrt.

Quelle
source string

Die Quelle.

Eigentum
property string

Die Eigenschaft.

Vergleich
comparison string

Der Vergleich.

Ziel
target string

Das Ziel.

Nutzername
username True string

Der Benutzername.

Kennwort
password True string

Das Kennwort.

Überprüfen der Standardeinstellungen für die Browsererstellung für Gruppen
browserCheckDefaults object

Die Standardeinstellungen für die Überprüfungsgruppe zum Erstellen von Browserüberprüfungen.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen von Überprüfungen in dieser Gruppe verwendet werden.

Key
key True string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Prüfgruppe definierte Warnungseinstellung.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung in dieser Gruppe verwendet werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung in dieser Gruppe verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase einer API-Überprüfung in dieser Gruppe ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase einer API-Überprüfung in dieser Gruppe ausgeführt werden soll.

Private Speicherorte überprüfen
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Prüfungen ausgeführt werden sollen.

Gibt zurück

Body
CheckGroup

Aktualisieren einer Umgebungsvariable

Aktualisiert eine Umgebungsvariable. Verwendet das Schlüsselfeld als Bezeichner für die Aktualisierung. Aktualisiert nur den Wert und die gesperrte Eigenschaft.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Key
key True string

Der Schlüssel.

Key
key string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Gibt zurück

Aktualisieren einer Überprüfung [VERALTET]

[VERALTET] Dieser Endpunkt wird am Montag, dem 4. Juli 2022, entfernt. Verwenden Sie stattdessen PUT /checks/api/{id} oder PUT /checks/browser/{id}. Aktualisiert eine neue API- oder Browserüberprüfung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name string

Der Name der Prüfung.

Aktiviert
activated boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Überprüfen des Typs
checkType string

Der Typ der Prüfung.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Frequenzversatz
frequencyOffset integer

Wird für das Festlegen von Sekunden für Überprüfungsfrequenzen unter 1 Minuten (nur für API-Prüfungen) und die Verteilung von Prüfungen über einen Zeitraum für Frequenzen über 1 Minute verwendet. Dies funktioniert wie folgt: Prüfungen mit einer Häufigkeit von 0 können eine Häufigkeit von 10, 20 oder 30 aufweisen, was bedeutet, dass sie alle 10, 20 oder 30 Sekunden ausgeführt werden. Prüfungen mit einer Häufigkeit niedriger als und gleich 60 können einen FrequencyOffset zwischen 1 und einem maximalen Wert basierend auf der Formel Math.floor(Häufigkeit * 10) aufweisen, d. h. für eine Prüfung, die alle 5 Minuten ausgeführt wird, beträgt die maximale HäufigkeitOffset 50. Überprüfungen mit einer Häufigkeit, die höher als 60 ist, können eine häufigkeitoffset zwischen 1 und einem höchstwert basierend auf der Formel Math.ceil(frequency / 60) aufweisen, d. h. für eine Überprüfung, die alle 720 Minuten ausgeführt wird, ist das max. frequencyOffset 12.

Anforderung überprüfen
request True object

Die Check-Anforderung.

Skript
script True string

Das Skript.

Key
key True string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung verwendet werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase ausgeführt werden soll.

Herabgestufte Reaktionszeit
degradedResponseTime number

Die Reaktionszeit in Millisekunden, bei der eine Überprüfung als herabgestuft betrachtet werden sollte.

Maximale Reaktionszeit
maxResponseTime number

Die Antwortzeit in Millisekunden, bei der eine Überprüfung als fehlschlägt.

Private Speicherorte
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Gibt zurück

Body
Check

Aktualisieren eines Codeausschnitts

Aktualisiert einen Codeausschnitt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Name
name True string

Der Codeausschnittname.

Skript
script True string

Ihr Node.js Code, der mit dem API-Prüflebenszyklus interagiert, oder fungiert als Teil für Browserüberprüfungen.

Gibt zurück

Body
Snippet

Aktualisieren eines Dashboards

Aktualisiert ein Dashboard. Gibt einen Wert vom Typ 409 zurück, wenn versucht wird, ein Dashboard mit einer benutzerdefinierten URL oder benutzerdefinierten Domäne zu erstellen, die bereits verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
dashboardId True string

Der Dashboardbezeichner.

Benutzerdefinierte URL
customUrl string

Ein Unterdomänenname unter checklyhq.com. Muss für alle Benutzer eindeutig sein.

Benutzerdefinierte Domäne
customDomain string

Eine benutzerdefinierte Benutzerdomäne, z. B. status.example.com. Informationen zum Aktualisieren Ihrer DNS- und SSL-Verwendung finden Sie in den Dokumenten.

Logo
logo string

Eine URL, die auf eine Bilddatei zeigt.

Favicon
favicon string

Eine URL, die auf eine Bilddatei zeigt, die als Dashboard-Favicon verwendet wird.

Link
link string

Ein URL-Link zum Umleiten, wenn auf das Dashboardlogo geklickt wird.

Header
header string

Ein Textabschnitt, der oben im Dashboard angezeigt wird.

Description
description string

Ein Textabschnitt, der unterhalb der Kopfzeile oder des Titels Ihres Dashboards angezeigt wird.

Breite
width string

Bestimmt, ob der Vollbildmodus oder der Fokus in der Mitte verwendet werden soll.

Aktualisierungsrate
refreshRate number

Wie oft das Dashboard in Sekunden aktualisiert werden soll.

Paginieren
paginate boolean

Bestimmt, dass die Paginierung aktiviert oder deaktiviert ist.

Paginierungsrate
paginationRate number

Wie oft die Paginierung in Sekunden ausgelöst wird.

Prüfungen pro Seite
checksPerPage number

Anzahl der pro Seite angezeigten Prüfungen.

Verwenden und Operator
useTagsAndOperator boolean

Gründe für die Verwendung des AND-Operators für die Nachschlagevorgang von Tags.

Tags ausblenden
hideTags boolean

Blenden Sie die Tags im Dashboard ein oder aus.

Dashboard-Tagliste
tags array of string

Eine Liste mit einem oder mehreren Tags, die filtern, die auf dem Dashboard angezeigt werden sollen.

Gibt zurück

Body
Dashboard

Aktualisieren eines privaten Speicherorts

Aktualisiert einen privaten Speicherort.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Name
name True string

Der Name, der dem privaten Speicherort zugewiesen ist.

Ikone
icon string

Das Symbol.

Gibt zurück

Aktualisieren eines Warnungskanals

Aktualisieren eines Warnungskanals.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

ID
id number

Der Bezeichner.

Id überprüfen
checkId guid

Der Prüfbezeichner.

Gruppen-ID
groupId number

Der Gruppenbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Typ
type True string

Der Typ.

Konfigurationskonfiguration für Den Warnungskanal erstellen
config True object

Die Konfiguration des Warnungskanals wird erstellt.

Wiederherstellung senden
sendRecovery boolean

Gibt an, ob die Wiederherstellung gesendet wird.

Sendefehler
sendFailure boolean

Gibt an, ob sendefehler.

Herabgestuft senden
sendDegraded boolean

Gibt an, ob das Senden herabgestuft wurde.

SSL-Ablauf
sslExpiry boolean

Bestimmt, ob eine Warnung für ablaufende SSL-Zertifikate gesendet werden soll.

SSL-Ablaufschwellenwert
sslExpiryThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Gibt zurück

Aktualisieren eines Wartungsfensters

Aktualisiert ein Wartungsfenster.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Name
name True string

Der Name des Wartungsfensters.

Wartungsfenster-Tagliste
tags array of string

Die Namen des Wartungsfensters für Prüfungen und Gruppen sollten angewendet werden.

Beginnt bei
startsAt True date

Das Startdatum des Wartungsfensters.

Endet am
endsAt True date

Das Enddatum des Wartungsfensters.

Wiederholungsintervall
repeatInterval number

Das Wiederholungsintervall des Wartungsfensters vom ersten Vorkommen.

Wiederholungseinheit
repeatUnit True string

Die Wiederholungsstrategie für das Wartungsfenster.

Wiederholte Enden bei
repeatEndsAt date

Das Enddatum, an dem das Wartungsfenster nicht mehr wiederholt werden soll.

Gibt zurück

Alle Codeausschnitte auflisten

Listet alle aktuellen Codeausschnitte in Ihrem Konto auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Gibt zurück

Gegenstände
SnippetList

Alle Dashboards auflisten

Listet alle aktuellen Dashboards in Ihrem Konto auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Gibt zurück

Gegenstände
DashboardsList

Alle privaten Speicherorte auflisten

Listet alle privaten Speicherorte in Ihrem Konto auf.

Gibt zurück

Alle Prüfgruppen auflisten

Listet alle aktuellen Check-Gruppen in Ihrem Konto auf. Die Check-Eigenschaft ist ein Array von Check UUIDs für die praktische Referenzierung. Sie ist schreibgeschützt und kann nicht zum Hinzufügen von Prüfungen zu einer Gruppe verwendet werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Gibt zurück

Gegenstände
CheckGroupList

Alle Prüfungen auflisten

Listet alle aktuellen Prüfungen in Ihrem Konto auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

API-Überprüfungs-URL-Filter
apiCheckUrlFilterPattern string

Filtert die Ergebnisse nach einer Zeichenfolge, die in der URL einer API-Überprüfung enthalten ist, z. B. eine Domäne wie www.myapp.com. Gibt nur API-Prüfungen zurück.

Gibt zurück

Gegenstände
CheckList

Alle Umgebungsvariablen auflisten

Listet alle aktuellen Umgebungsvariablen in Ihrem Konto auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Gibt zurück

Alle Warnungskanäle auflisten

Listet alle konfigurierten Warnungskanäle und ihre abonnierten Prüfungen auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Gibt zurück

Gegenstände
AlertChannelList

Alle Wartungsfenster auflisten

Listet alle Wartungsfenster in Ihrem Konto auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Gibt zurück

Die Wartungsfensterliste.

Gegenstände
MaintenanceWindowList

Alle Überprüfungsstatus auflisten

Zeigt die aktuellen Statusinformationen für alle Prüfungen in Ihrem Konto an. Die Statusdatensätze für die Überprüfung werden kontinuierlich aktualisiert, wenn neue Prüfergebnisse eingecheckt werden.

Gibt zurück

Gegenstände
CheckStatusList

Auflisten aller Benachrichtigungen für Ihr Konto

Listet alle Benachrichtigungen für Ihr Konto auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Von
from date

Wählen Sie Dokumente aus diesem UNIX-Zeitstempel (>= Datum) aus. Der Standardwert ist jetzt - 6 Stunden.

Bis
to date

Wählen Sie Warnungen bis zu diesem UNIX-Zeitstempel (< Datum) aus. Der Standardwert ist 6 Stunden nach ablaufen.

Gibt zurück

Gegenstände
CheckAlertList

Auflisten von Warnungen für eine bestimmte Überprüfung

Listet alle Warnungen für eine bestimmte Überprüfung auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Von
from date

Wählen Sie Dokumente aus diesem UNIX-Zeitstempel (>= Datum) aus. Der Standardwert ist jetzt - 6 Stunden.

Bis
to date

Wählen Sie Warnungen bis zu diesem UNIX-Zeitstempel (< Datum) aus. Der Standardwert ist 6 Stunden nach ablaufen.

Gibt zurück

Gegenstände
CheckAlertList

Ein Dashboard erstellen

Erstellt ein neues Dashboard. Gibt einen Wert vom Typ 409 zurück, wenn versucht wird, ein Dashboard mit einer benutzerdefinierten URL oder benutzerdefinierten Domäne zu erstellen, die bereits verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzerdefinierte URL
customUrl string

Ein Unterdomänenname unter checklyhq.com. Muss für alle Benutzer eindeutig sein.

Benutzerdefinierte Domäne
customDomain string

Eine benutzerdefinierte Benutzerdomäne, z. B. status.example.com. Informationen zum Aktualisieren Ihrer DNS- und SSL-Verwendung finden Sie in den Dokumenten.

Logo
logo string

Eine URL, die auf eine Bilddatei zeigt.

Favicon
favicon string

Eine URL, die auf eine Bilddatei zeigt, die als Dashboard-Favicon verwendet wird.

Link
link string

Ein URL-Link zum Umleiten, wenn auf das Dashboardlogo geklickt wird.

Header
header string

Ein Textabschnitt, der oben im Dashboard angezeigt wird.

Description
description string

Ein Textabschnitt, der unterhalb der Kopfzeile oder des Titels Ihres Dashboards angezeigt wird.

Breite
width string

Bestimmt, ob der Vollbildmodus oder der Fokus in der Mitte verwendet werden soll.

Aktualisierungsrate
refreshRate number

Wie oft das Dashboard in Sekunden aktualisiert werden soll.

Paginieren
paginate boolean

Bestimmt, dass die Paginierung aktiviert oder deaktiviert ist.

Paginierungsrate
paginationRate number

Wie oft die Paginierung in Sekunden ausgelöst wird.

Prüfungen pro Seite
checksPerPage number

Anzahl der pro Seite angezeigten Prüfungen.

Verwenden und Operator
useTagsAndOperator boolean

Gründe für die Verwendung des AND-Operators für die Nachschlagevorgang von Tags.

Tags ausblenden
hideTags boolean

Blenden Sie die Tags im Dashboard ein oder aus.

Dashboard-Tagliste
tags array of string

Eine Liste mit einem oder mehreren Tags, die filtern, die auf dem Dashboard angezeigt werden sollen.

Gibt zurück

Body
Dashboard

Entfernen eines privaten Speicherorts

Entfernt dauerhaft einen privaten Speicherort.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Entfernen eines vorhandenen API-Schlüssels für einen privaten Speicherort

Entfernt dauerhaft einen API-Schlüssel von einem privaten Speicherort.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Schlüssel-ID
keyId True string

Der Schlüsselbezeichner.

Erstellen des Check-Triggers

Erstellt den Check-Trigger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Gibt zurück

Erstellen des Prüfgruppentriggers

Erstellt den Häkchengruppentrigger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
groupId True integer

Der Gruppenbezeichner.

Gibt zurück

Erstellen einer API-Prüfung

Erstellt eine neue API-Prüfung. Gibt einen 402 Wert zurück, wenn Sie den Grenzwert Ihres Plans überschreiten. Bei Verwendung der globalAlertSettingalertSettingnull

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name True string

Der Name der Prüfung.

Aktiviert
activated True boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

method
method True string
URL
url True string

Die URL-Adresse.

Umleitungen folgen
followRedirects boolean

Gibt an, ob Umleitungen folgen.

SSL überspringen
skipSSL boolean

Gibt an, ob SSL übersprungen werden soll.

Body
body string

Der Körper.

bodyType
bodyType string
Key
key True string

Der Schlüssel.

Wert
value True string

Der Wert.

Gesperrt
locked boolean

Gibt an, ob gesperrt.

Quelle
source string

Die Quelle.

Eigentum
property string

Die Eigenschaft.

Vergleich
comparison string

Der Vergleich.

Ziel
target string

Das Ziel.

Nutzername
username True string

Der Benutzername.

Kennwort
password True string

Das Kennwort.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung verwendet werden soll.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung verwendet werden soll.

Frequenzversatz
frequencyOffset integer

Wird für das Festlegen von Sekunden für Die Überprüfungsfrequenzen unter 1 Minuten und die Verteilung von Prüfungen über einen Zeitraum für Frequenzen über 1 Minute verwendet. Dies funktioniert wie folgt: Prüfungen mit einer Häufigkeit von 0 können eine Häufigkeit von 10, 20 oder 30 aufweisen, was bedeutet, dass sie alle 10, 20 oder 30 Sekunden ausgeführt werden. Prüfungen mit einer Häufigkeit niedriger als und gleich 60 können einen FrequencyOffset zwischen 1 und einem maximalen Wert basierend auf der Formel Math.floor(Häufigkeit * 10) aufweisen, d. h. für eine Prüfung, die alle 5 Minuten ausgeführt wird, beträgt die maximale HäufigkeitOffset 50. Überprüfungen mit einer Häufigkeit, die höher als 60 ist, können eine häufigkeitoffset zwischen 1 und einem höchstwert basierend auf der Formel Math.ceil(frequency / 60) aufweisen, d. h. für eine Überprüfung, die alle 720 Minuten ausgeführt wird, ist das max. frequencyOffset 12.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase ausgeführt werden soll.

Herabgestufte Reaktionszeit
degradedResponseTime number

Die Reaktionszeit in Millisekunden, bei der eine Überprüfung als herabgestuft betrachtet werden sollte.

Maximale Reaktionszeit
maxResponseTime number

Die Antwortzeit in Millisekunden, bei der eine Überprüfung als fehlschlägt.

Private Speicherorte
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Gibt zurück

Body
CheckAPI

Erstellen einer Browserüberprüfung

Erstellt eine neue Browserüberprüfung. Gibt einen 402 Wert zurück, wenn Sie den Grenzwert Ihres Plans überschreiten. Bei Verwendung der globalAlertSettingalertSettingnull

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name True string

Der Name der Prüfung.

Aktiviert
activated True boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Key
key True string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Skript
script True string

Ein gültiger Teil Node.js Javascript-Code, der eine Browserinteraktion mit den Puppeteer- oder Playwright-Frameworks beschreibt.

Private Speicherorte
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Gibt zurück

Erstellen einer Prüfgruppe

Erstellt eine neue Prüfgruppe. Sie können der Gruppe Überprüfungen hinzufügen, indem Sie die groupId-Eigenschaft einzelner Prüfungen festlegen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name True string

Der Name der Prüfgruppe.

Aktiviert
activated boolean

Bestimmt, ob die Prüfungen in der Gruppe ausgeführt werden oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn ein Einchecken dieser Gruppe fehlschlägt und/oder wiederhergestellt wird.

Gruppentagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Überprüfen der Gruppenspeicherortliste
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem die Prüfungen ausgeführt werden sollen.

Konkurrenz
concurrency number

Bestimmt, wie viele Prüfungen gleichzeitig aufgerufen werden, wenn eine Prüfgruppe von CI/CD oder über die API ausgelöst wird.

URL
url string

Die Basis-URL für diese Gruppe, auf die Sie in allen Gruppenüberprüfungen mit der Variablen {{GROUP_BASE_URL}} verweisen können.

Key
key True string

Der Schlüssel.

Wert
value True string

Der Wert.

Gesperrt
locked boolean

Gibt an, ob gesperrt.

Quelle
source string

Die Quelle.

Eigentum
property string

Die Eigenschaft.

Vergleich
comparison string

Der Vergleich.

Ziel
target string

Das Ziel.

Nutzername
username True string

Der Benutzername.

Kennwort
password True string

Das Kennwort.

Überprüfen der Standardeinstellungen für die Browsererstellung für Gruppen
browserCheckDefaults object

Die Standardeinstellungen für die Überprüfungsgruppe zum Erstellen von Browserüberprüfungen.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen von Überprüfungen in dieser Gruppe verwendet werden.

Key
key True string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Prüfgruppe definierte Warnungseinstellung.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung in dieser Gruppe verwendet werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung in dieser Gruppe verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase einer API-Überprüfung in dieser Gruppe ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase einer API-Überprüfung in dieser Gruppe ausgeführt werden soll.

Private Speicherorte überprüfen
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Prüfungen ausgeführt werden sollen.

Gibt zurück

Body
CheckGroup

Erstellen einer Umgebungsvariable

Erstellt eine neue Umgebungsvariable.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Key
key True string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Gibt zurück

Erstellen eines Codeausschnitts

Erstellt einen neuen Codeausschnitt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Name
name True string

Der Codeausschnittname.

Skript
script True string

Ihr Node.js Code, der mit dem API-Prüflebenszyklus interagiert, oder fungiert als Teil für Browserüberprüfungen.

Gibt zurück

Body
Snippet

Erstellen eines Häkchens [VERALTET]

[VERALTET] Dieser Endpunkt wird am Montag, dem 4. Juli 2022, entfernt. Verwenden Sie stattdessen POST /checks/api oder POST /checks/browser. Erstellt eine neue API- oder Browserüberprüfung. Gibt einen 402 Wert zurück, wenn Sie den Grenzwert Ihres Plans überschreiten. Bei Verwendung der globalAlertSettingsalertSettingsnull

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benachrichtigungen automatisch zuweisen
autoAssignAlerts boolean

Bestimmt, ob eine neue Prüfung automatisch als Abonnent zu allen vorhandenen Warnungskanälen hinzugefügt wird, wenn sie erstellt wird.

Name
name True string

Der Name der Prüfung.

Aktiviert
activated True boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations array of string

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags array of string

Tags zum Organisieren und Filtern von Prüfungen.

Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

Warnungskanal-ID
alertChannelId True number

Der Warnungskanalbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Überprüfen des Typs
checkType True string

Der Typ der Prüfung.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Frequenzversatz
frequencyOffset integer

Wird für das Festlegen von Sekunden für Überprüfungsfrequenzen unter 1 Minuten (nur für API-Prüfungen) und die Verteilung von Prüfungen über einen Zeitraum für Frequenzen über 1 Minute verwendet. Dies funktioniert wie folgt: Prüfungen mit einer Häufigkeit von 0 können eine Häufigkeit von 10, 20 oder 30 aufweisen, was bedeutet, dass sie alle 10, 20 oder 30 Sekunden ausgeführt werden. Prüfungen mit einer Häufigkeit niedriger als und gleich 60 können einen FrequencyOffset zwischen 1 und einem maximalen Wert basierend auf der Formel Math.floor(Häufigkeit * 10) aufweisen, d. h. für eine Prüfung, die alle 5 Minuten ausgeführt wird, beträgt die maximale HäufigkeitOffset 50. Überprüfungen mit einer Häufigkeit, die höher als 60 ist, können eine häufigkeitoffset zwischen 1 und einem höchstwert basierend auf der Formel Math.ceil(frequency / 60) aufweisen, d. h. für eine Überprüfung, die alle 720 Minuten ausgeführt wird, ist das max. frequencyOffset 12.

Anforderung überprüfen
request object

Die Check-Anforderung.

Skript
script True string

Das Skript.

Key
key True string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value True string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung verwendet werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase ausgeführt werden soll.

Herabgestufte Reaktionszeit
degradedResponseTime number

Die Reaktionszeit in Millisekunden, bei der eine Überprüfung als herabgestuft betrachtet werden sollte.

Maximale Reaktionszeit
maxResponseTime number

Die Antwortzeit in Millisekunden, bei der eine Überprüfung als fehlschlägt.

Private Speicherorte
privateLocations array of string

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Gibt zurück

Body
Check

Erstellen eines privaten Speicherorts

Erstellt einen neuen privaten Speicherort.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Name
name True string

Der Name, der dem privaten Speicherort zugewiesen ist.

Slug Name
slugName True string

Gültiger Schrägstrichname.

Ikone
icon string

Das Symbol.

Gibt zurück

Erstellen eines Warnungskanals

Erstellt einen neuen Warnungskanal.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id number

Der Bezeichner.

Id überprüfen
checkId guid

Der Prüfbezeichner.

Gruppen-ID
groupId number

Der Gruppenbezeichner.

Aktiviert
activated True boolean

Gibt an, ob aktiviert.

Typ
type True string

Der Typ.

Konfigurationskonfiguration für Den Warnungskanal erstellen
config True object

Die Konfiguration des Warnungskanals wird erstellt.

Wiederherstellung senden
sendRecovery boolean

Gibt an, ob die Wiederherstellung gesendet wird.

Sendefehler
sendFailure boolean

Gibt an, ob sendefehler.

Herabgestuft senden
sendDegraded boolean

Gibt an, ob das Senden herabgestuft wurde.

SSL-Ablauf
sslExpiry boolean

Bestimmt, ob eine Warnung für ablaufende SSL-Zertifikate gesendet werden soll.

SSL-Ablaufschwellenwert
sslExpiryThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Gibt zurück

Erstellen eines Wartungsfensters

Erstellt ein neues Wartungsfenster.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Name
name True string

Der Name des Wartungsfensters.

Wartungsfenster-Tagliste
tags array of string

Die Namen des Wartungsfensters für Prüfungen und Gruppen sollten angewendet werden.

Beginnt bei
startsAt True date

Das Startdatum des Wartungsfensters.

Endet am
endsAt True date

Das Enddatum des Wartungsfensters.

Wiederholungsintervall
repeatInterval number

Das Wiederholungsintervall des Wartungsfensters vom ersten Vorkommen.

Wiederholungseinheit
repeatUnit True string

Die Wiederholungsstrategie für das Wartungsfenster.

Wiederholte Enden bei
repeatEndsAt date

Das Enddatum, an dem das Wartungsfenster nicht mehr wiederholt werden soll.

Gibt zurück

Generieren eines neuen API-Schlüssels für einen privaten Speicherort

Erstellt einen API-Schlüssel am privaten Speicherort.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Gibt zurück

Generiert einen anpassbaren Bericht für alle Browserüberprüfungsmetriken.

Generiert einen Bericht mit aggregierten oder nicht aggregierten Statistiken für eine bestimmte Browserüberprüfung über ein bestimmtes Zeitfenster.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Von
from date

Benutzerdefinierte Startzeit des Berichtsfensters im Unix-Zeitstempelformat. Durch Festlegen eines benutzerdefinierten Zeitstempels wird die Verwendung von voreingestelltenWindow außer Kraft gesetzt.

Bis
to date

Benutzerdefinierte Endzeit des Berichtsfensters im Unix-Zeitstempelformat. Wenn Sie einen benutzerdefinierten Zeitstempel festlegen, wird die Verwendung von voreingestelltenWindow außer Kraft gesetzt.

Voreingestelltes Fenster
presetWindow string

Voreingestellte Berichtsfenster werden zum schnellen Generieren von Berichten in häufig verwendeten Fenstern verwendet. Kann mithilfe eines benutzerdefinierten zu und vom Zeitstempel überschrieben werden.

Aggregationsintervall
aggregationInterval number

Das Zeitintervall, das für das Aggregieren von Metriken in Minuten verwendet werden soll. Beispielsweise beträgt fünf Minuten 300, 24 Stunden beträgt 1440.

Gruppieren nach
groupBy string

Bestimmt, wie die Datenreihen gruppiert werden.

Nach Status filtern
filterByStatus array

Verwenden Sie den Status, um nach fehlerhaften oder erfolgreichen Überprüfungsergebnisdaten zu filtern.

Metriken
metrics array

Metrikoptionen für Browserüberprüfungen.

Gibt zurück

Die Attribute.

Attribute
object

Generiert einen Bericht mit aggregierter Statistik für Überprüfungen und Überprüfungsgruppen.

Generiert einen Bericht mit aggregierter Statistik für alle Prüfungen oder einen gefilterten Satz von Prüfungen über ein bestimmtes Zeitfenster.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Von
from date

Benutzerdefinierte Startzeit des Berichtsfensters im Unix-Zeitstempelformat. Durch Festlegen eines benutzerdefinierten Zeitstempels wird die Verwendung von voreingestelltenWindow außer Kraft gesetzt.

Bis
to date

Benutzerdefinierte Endzeit des Berichtsfensters im Unix-Zeitstempelformat. Wenn Sie einen benutzerdefinierten Zeitstempel festlegen, wird die Verwendung von voreingestelltenWindow außer Kraft gesetzt.

Voreingestelltes Fenster
presetWindow string

Voreingestellte Berichtsfenster werden zum schnellen Generieren von Berichten in häufig verwendeten Fenstern verwendet. Kann mithilfe eines benutzerdefinierten zu und vom Zeitstempel überschrieben werden.

Nach Tags filtern
filterByTags array

Verwenden Sie Tags, um die Überprüfungen zu filtern, die in Ihrem Bericht angezeigt werden sollen.

Deaktiviert
deactivated boolean

Filtert Überprüfungen nach aktivierten Status.

Gibt zurück

Gegenstände
ReportingList

Gruppenstatussignal abrufen

Abrufen des Gruppenstatussignals.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
groupId True integer

Der Gruppenbezeichner.

Stil
style string

Die Formatvorlage.

Design
theme string

Das Design.

Antwortzeit
responseTime boolean

Die Antwortzeit.

Gibt zurück

response
string

Listet alle Prüfergebnisse auf

Listet die vollständigen, unformatierten Überprüfungsergebnisse für eine bestimmte Überprüfung auf. Wir behalten rohe Ergebnisse für 30 Tage bei. Nach 30 Tagen werden sie gelöscht. Wir behalten jedoch die Rollupergebnisse für eine unbestimmte Zeit bei. Sie können filtern, indem Sie den Typ und den Ergebnistyp überprüfen, um die Liste einzugrenzen. Verwenden Sie die to Parameter und from die Parameter, um einen Datumsbereich (UNIX-Zeitstempel in Sekunden) anzugeben. Je nach Überprüfungstyp sind einige Felder möglicherweise NULL. Dieser Endpunkt gibt Daten innerhalb eines Zeitraums von sechs Stunden zurück. Wenn von und zu Params festgelegt werden, müssen sie höchstens sechs Stunden auseinander liegen. Wenn keine festgelegt ist, betrachten wir den Param jetzt und von Param bis zu sechs Stunden früher. Wenn nur der Param festgelegt ist, werden wir von sechs Stunden früher festgelegt. Im Gegenteil, wenn nur der von Param festgelegt ist, werden wir den Param für sechs Stunden später betrachten. Die Rate-Limitierung wird auf diesen Endpunkt angewendet, Sie können höchstens 5 Anforderungen / 10 Sekunden senden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Limit
limit integer

Beschränken Sie die Anzahl der Ergebnisse.

Number
page number

Die Seitenzahl.

Von
from date

Wählen Sie Dokumente aus diesem UNIX-Zeitstempel (>= Datum) aus. Der Standardwert ist jetzt - 6 Stunden.

Bis
to date

Wählen Sie Warnungen bis zu diesem UNIX-Zeitstempel (< Datum) aus. Der Standardwert ist 6 Stunden nach ablaufen.

Standort
location string

Bereitstellen eines Rechenzentrumsstandorts, z. B. eu-west-1 zum Filtern nach Standort

Überprüfen des Typs
checkType string

Der Typ der Prüfung.

Hat Fehler
hasFailures boolean

Das Überprüfungsergebnis weist mindestens einen Fehler auf.

Gibt zurück

Gegenstände
CheckResultList

Listet alle unterstützten Laufzeiten auf.

Listet alle unterstützten Laufzeiten und die enthaltenen NPM-Pakete für Browserüberprüfungen und Setup- und Teardownskripts für API-Prüfungen auf.

Gibt zurück

Gegenstände
RuntimeList

Listet alle unterstützten Speicherorte auf

Listet alle unterstützten Speicherorte auf.

Gibt zurück

Gegenstände
LocationList

Löschen des Check-Triggers

Löscht den Check-Trigger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id überprüfen
checkId True string

Der Prüfbezeichner.

Löschen des Häkchengruppentriggers

Löscht den Auslöser der Prüfgruppen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
groupId True integer

Der Gruppenbezeichner.

Löschen einer Prüfgruppe

Entfernt eine Prüfgruppe dauerhaft. Sie können eine Prüfgruppe nicht löschen, wenn sie weiterhin Prüfungen enthält.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Löschen einer Prüfung

Entfernt eine API oder einen Browser sowie alle zugehörigen Status- und Ergebnisdaten dauerhaft.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Löschen einer Umgebungsvariable

Entfernt dauerhaft eine Umgebungsvariable. Verwendet das Schlüsselfeld als Bezeichner für das Löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Key
key True string

Der Schlüssel.

Löschen eines Codeausschnitts

Entfernt einen Codeausschnitt dauerhaft.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Löschen eines Dashboards

Entfernt dauerhaft ein Dashboard.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
dashboardId True string

Der Dashboardbezeichner.

Löschen eines Warnungskanals

Entfernt dauerhaft einen Warnungskanal.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Löschen eines Wartungsfensters

Entfernt dauerhaft ein Wartungsfenster.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True integer

Der Bezeichner.

Zeigt Details für eine bestimmte Laufzeit an.

Zeigt die Details aller enthaltenen NPM-Pakete und deren Version für eine bestimmte Laufzeit an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID
id True string

Der Bezeichner.

Gibt zurück

Body
Runtime

Definitionen

AlertChannelConfig

Die Konfiguration des Warnungskanals.

Name Pfad Typ Beschreibung
Warnungskanalkonfiguration
object

Die Konfiguration des Warnungskanals.

AlertChanelSubscription

Name Pfad Typ Beschreibung
ID
id number

Der Bezeichner.

Id überprüfen
checkId guid

Der Prüfbezeichner.

Gruppen-ID
groupId number

Der Gruppenbezeichner.

Aktiviert
activated boolean

Gibt an, ob aktiviert.

AlertChanelSubscriptionList

Alle Prüfungen haben diesen Kanal abonniert.

Name Pfad Typ Beschreibung
Gegenstände
AlertChanelSubscription

AlertChannel

Name Pfad Typ Beschreibung
ID
id number

Der Bezeichner.

Typ
type string

Der Typ des Benachrichtigungskanals, d. h. E-Mail oder SLACK.

Warnungskanalkonfiguration
config AlertChannelConfig

Die Konfiguration des Warnungskanals.

Warnungskanalabonnementliste
subscriptions AlertChanelSubscriptionList

Alle Prüfungen haben diesen Kanal abonniert.

Wiederherstellung senden
sendRecovery boolean

Gibt an, ob die Wiederherstellung gesendet wird.

Sendefehler
sendFailure boolean

Gibt an, ob sendefehler.

Herabgestuft senden
sendDegraded boolean

Gibt an, ob das Senden herabgestuft wurde.

SSL-Ablauf
sslExpiry boolean

Bestimmt, ob eine Warnung für ablaufende SSL-Zertifikate gesendet werden soll.

SSL-Ablaufschwellenwert
sslExpiryThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

Erstellt unter
created_at date-time

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

AlertChannelList

Name Pfad Typ Beschreibung
Gegenstände
AlertChannel

CheckAlert

Name Pfad Typ Beschreibung
ID
id string

Der eindeutige Bezeichner dieser Warnung.

Name
name string

Der Name der Prüfung.

Id überprüfen
checkId string

Der Bezeichner der Überprüfung dieser Warnung gehört.

Warnungstyp
alertType string

Der Typ der Warnung.

Überprüfen des Typs
checkType string

Der Typ der Prüfung.

Ausführungsort
runLocation string

Von welchem Rechenzentrumsort diese Überprüfungsbenachrichtigung ausgelöst wurde.

Antwortzeit
responseTime number

Beschreibt die Zeit, die zum Ausführen relevanter Teile dieser Überprüfung benötigt wurde. Jedes Setupzeitgebersystem, das zum Starten der Ausführung dieser Überprüfung im Checkly-Back-End benötigt wird, ist nicht Teil davon.

Fehler
error string

Alle spezifischen Fehlermeldungen, die Teil der Fehlerüberprüfung waren, die die Warnung auslösen.

Statuscode
statusCode string

Der Statuscode der Antwort. Gilt nur für API-Prüfungen.

Erstellt unter
created_at date

Das Datum und die Uhrzeit, zu dem diese Überprüfungsbenachrichtigung erstellt wurde.

Begonnen am
startedAt date

Das Datum und die Uhrzeit, zu dem diese Überprüfungsbenachrichtigung gestartet wurde.

CheckAlertList

Name Pfad Typ Beschreibung
Gegenstände
CheckAlert

CheckGroupTagList

Tags zum Organisieren und Filtern von Prüfungen.

Name Pfad Typ Beschreibung
Gegenstände
string

CheckGroupLocationList

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem die Prüfungen ausgeführt werden sollen.

Name Pfad Typ Beschreibung
Gegenstände
string

KeyValue

Name Pfad Typ Beschreibung
Key
key string

Der Schlüssel.

Wert
value string

Der Wert.

Gesperrt
locked boolean

Gibt an, ob gesperrt.

HeaderList

Name Pfad Typ Beschreibung
Gegenstände
KeyValue

QueryParameterList

Name Pfad Typ Beschreibung
Gegenstände
KeyValue

Behauptung

Name Pfad Typ Beschreibung
Quelle
source string

Die Quelle.

Eigentum
property string

Die Eigenschaft.

Vergleich
comparison string

Der Vergleich.

Ziel
target string

Das Ziel.

AssertionList

Überprüfen Sie die Hauptdokumentation zu Assertionen für bestimmte Werte wie reguläre Ausdrücke und JSON-Pfaddeskriptoren, die Sie im Eigenschaftenfeld verwenden können.

Name Pfad Typ Beschreibung
Gegenstände
Assertion

BasicAuth

Name Pfad Typ Beschreibung
Nutzername
username string

Der Benutzername.

Kennwort
password string

Das Kennwort.

CheckGroupAPICheckDefaults

Name Pfad Typ Beschreibung
URL
url string

Die Basis-URL für diese Gruppe, auf die Sie in allen Gruppenüberprüfungen mit der Variablen {{GROUP_BASE_URL}} verweisen können.

headers
headers HeaderList
queryParameters (englisch)
queryParameters QueryParameterList
Assertionsliste
assertions AssertionList

Überprüfen Sie die Hauptdokumentation zu Assertionen für bestimmte Werte wie reguläre Ausdrücke und JSON-Pfaddeskriptoren, die Sie im Eigenschaftenfeld verwenden können.

basicAuth
basicAuth BasicAuth

CheckGroupBrowserCheckDefaults

Die Standardeinstellungen für die Überprüfung des Gruppenbrowsers.

Name Pfad Typ Beschreibung
Überprüfen der Standardeinstellungen für den Gruppenbrowser
object

Die Standardeinstellungen für die Überprüfung des Gruppenbrowsers.

EnvironmentVariable

Name Pfad Typ Beschreibung
Key
key string

Der Schlüssel der Umgebungsvariable (dieser Wert kann nicht geändert werden).

Wert
value string

Der Wert der Umgebungsvariable.

Gesperrt
locked boolean

Wird nur in der Benutzeroberfläche verwendet, um den Wert wie ein Kennwort auszublenden.

EnvironmentVariableList

Name Pfad Typ Beschreibung
Gegenstände
EnvironmentVariable

AlertSettingsRunBasedEscalation

Name Pfad Typ Beschreibung
Fehler beim Ausführen des Schwellenwerts
failedRunThreshold number

Nachdem die Anzahl der fehlgeschlagenen aufeinanderfolgenden Überprüfungen ausgeführt wurde, sollte eine Benachrichtigung gesendet werden.

AlertSettingsTimeBasedEscalation

Name Pfad Typ Beschreibung
Schwellenwert für minutenausfallende Minuten
minutesFailingThreshold number

Nach wie vielen Minuten nach dem Start einer Prüfung sollte eine Warnung gesendet werden.

AlertSettingsReminders

Name Pfad Typ Beschreibung
Betrag
amount number

Anzahl der Erinnerungen, die nach der anfänglichen Benachrichtigung gesendet werden sollen.

Intervall
interval number

In welchem Intervall die Erinnerungen gesendet werden sollen.

AlertSettingsSSLCertificates

[VERALTET] sslCertificates ist veraltet und wird nicht mehr verwendet. Ignorieren Sie es bitte, wird in einer zukünftigen Version entfernt.

Name Pfad Typ Beschreibung
Enabled
enabled boolean

Bestimmt, ob Warnungsbenachrichtigungen für ablaufende SSL-Zertifikate gesendet werden sollen.

Warnungsschwellenwert
alertThreshold integer

Zu welchem Zeitpunkt, um mit dem Warnen von SSL-Zertifikaten zu beginnen.

CheckGroupAlertSettings

Warnungseinstellungen.

Name Pfad Typ Beschreibung
Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
Erinnerungen
reminders AlertSettingsReminders
SSL-Zertifikate für Warnungseinstellungen
sslCertificates AlertSettingsSSLCertificates

[VERALTET] sslCertificates ist veraltet und wird nicht mehr verwendet. Ignorieren Sie es bitte, wird in einer zukünftigen Version entfernt.

Model1

Benachrichtigungskanalabonnement.

Name Pfad Typ Beschreibung
Warnungskanal-ID
alertChannelId number

Der Warnungskanalbezeichner.

Aktiviert
activated boolean

Gibt an, ob aktiviert.

AlertChannelSubscriptionCreateList

Liste der Warnungskanalabonnements.

Name Pfad Typ Beschreibung
Benachrichtigungskanalabonnement
Model1

Benachrichtigungskanalabonnement.

privateLocations

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Name Pfad Typ Beschreibung
Gegenstände
string

CheckGroup

Name Pfad Typ Beschreibung
ID
id number

Der Bezeichner.

Name
name string

Der Name der Prüfgruppe.

Aktiviert
activated boolean

Bestimmt, ob die Prüfungen in der Gruppe ausgeführt werden oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn ein Einchecken dieser Gruppe fehlschlägt und/oder wiederhergestellt wird.

Gruppentagliste überprüfen
tags CheckGroupTagList

Tags zum Organisieren und Filtern von Prüfungen.

Überprüfen der Gruppenspeicherortliste
locations CheckGroupLocationList

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem die Prüfungen ausgeführt werden sollen.

Konkurrenz
concurrency number

Bestimmt, wie viele Prüfungen gleichzeitig aufgerufen werden, wenn eine Prüfgruppe von CI/CD oder über die API ausgelöst wird.

apiCheckDefaults
apiCheckDefaults CheckGroupAPICheckDefaults
Überprüfen der Standardeinstellungen für den Gruppenbrowser
browserCheckDefaults CheckGroupBrowserCheckDefaults

Die Standardeinstellungen für die Überprüfung des Gruppenbrowsers.

environmentVariables
environmentVariables EnvironmentVariableList
Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Prüfgruppe definierte Warnungseinstellung.

Überprüfen von Gruppenbenachrichtigungseinstellungen
alertSettings CheckGroupAlertSettings

Warnungseinstellungen.

Liste zum Erstellen von Benachrichtigungskanalabonnements
alertChannelSubscriptions AlertChannelSubscriptionCreateList

Liste der Warnungskanalabonnements.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung in dieser Gruppe verwendet werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung in dieser Gruppe verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase einer API-Überprüfung in dieser Gruppe ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase einer API-Überprüfung in dieser Gruppe ausgeführt werden soll.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen von Überprüfungen in dieser Gruppe verwendet werden.

Private Speicherorte
privateLocations privateLocations

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

CheckGroupList

Name Pfad Typ Beschreibung
Gegenstände
CheckGroup

CheckLocationList

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Name Pfad Typ Beschreibung
Gegenstände
string

CheckTagList

Tags zum Organisieren und Filtern von Prüfungen.

Name Pfad Typ Beschreibung
Gegenstände
string

CheckAlertSettings

Warnungseinstellungen.

Name Pfad Typ Beschreibung
Eskalationstyp
escalationType string

Bestimmt, welche Art von Eskalation verwendet werden soll.

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
Erinnerungen
reminders AlertSettingsReminders
SSL-Zertifikate für Warnungseinstellungen
sslCertificates AlertSettingsSSLCertificates

[VERALTET] sslCertificates ist veraltet und wird nicht mehr verwendet. Ignorieren Sie es bitte, wird in einer zukünftigen Version entfernt.

CheckAlertChannelSubscription

Name Pfad Typ Beschreibung
Warnungskanal-ID
alertChannelId number

Der Warnungskanalbezeichner.

Aktiviert
activated boolean

Gibt an, ob aktiviert.

CheckAlertChannelSubscriptionList

Name Pfad Typ Beschreibung
Gegenstände
CheckAlertChannelSubscription

CheckRequest

Die Check-Anforderung.

Name Pfad Typ Beschreibung
Anforderung überprüfen
object

Die Check-Anforderung.

CheckEnvironmentVariableList

Schlüssel-Wert-Paare zum Festlegen von Umgebungsvariablen während der Überprüfungsausführung. Diese sind nur für Browserüberprüfungen relevant. Verwenden Sie nach Möglichkeit globale Umgebungsvariablen.

Name Pfad Typ Beschreibung
Gegenstände
EnvironmentVariable

CheckAlertEmail

Name Pfad Typ Beschreibung
Adresse
address string

Die Adresse.

CheckAlertEmailList

Name Pfad Typ Beschreibung
Gegenstände
CheckAlertEmail

Model4

Name Pfad Typ Beschreibung
Gegenstände
KeyValue

Model5

Name Pfad Typ Beschreibung
Gegenstände
KeyValue

CheckAlertWebhook

Name Pfad Typ Beschreibung
Name
name string

Der Name.

URL
url string

Die URL-Adresse.

Methode
method string

Die Methode.

headers
headers Model4
queryParameters (englisch)
queryParameters Model5

CheckAlertWebhookList

Name Pfad Typ Beschreibung
Gegenstände
CheckAlertWebhook

CheckAlertSlack

Name Pfad Typ Beschreibung
URL
url string

Die URL-Adresse.

CheckAlertSlackList

Name Pfad Typ Beschreibung
Gegenstände
CheckAlertSlack

CheckAlertSMS

Name Pfad Typ Beschreibung
Number
number string

Die Zahl.

Name
name string

Der Name.

CheckAlertSMSList

Name Pfad Typ Beschreibung
Gegenstände
CheckAlertSMS

CheckAlertChannels

Name Pfad Typ Beschreibung
E-Mail
email CheckAlertEmailList
Webhook
webhook CheckAlertWebhookList
schlaff
slack CheckAlertSlackList
SMS
sms CheckAlertSMSList

CheckGroupCheck

Name Pfad Typ Beschreibung
ID
id string

Der Bezeichner.

Name
name string

Der Name der Prüfung.

Aktiviert
activated boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations CheckLocationList

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags CheckTagList

Tags zum Organisieren und Filtern von Prüfungen.

Benachrichtigungseinstellungen überprüfen
alertSettings CheckAlertSettings

Warnungseinstellungen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
Überprüfen des Typs
checkType string

Der Typ der Prüfung.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Frequenzversatz
frequencyOffset integer

Der Frequenzversatz.

Anforderung überprüfen
request CheckRequest

Die Check-Anforderung.

Skript
script string

Das Skript.

Umgebungsvariablenliste überprüfen
environmentVariables CheckEnvironmentVariableList

Schlüssel-Wert-Paare zum Festlegen von Umgebungsvariablen während der Überprüfungsausführung. Diese sind nur für Browserüberprüfungen relevant. Verwenden Sie nach Möglichkeit globale Umgebungsvariablen.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung verwendet werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase ausgeführt werden soll.

Herabgestufte Reaktionszeit
degradedResponseTime number

Die Reaktionszeit in Millisekunden, bei der eine Überprüfung als herabgestuft betrachtet werden sollte.

Maximale Reaktionszeit
maxResponseTime number

Die Antwortzeit in Millisekunden, bei der eine Überprüfung als fehlschlägt.

alertChannels
alertChannels CheckAlertChannels
Private Speicherorte
privateLocations privateLocations

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

Modell8

Name Pfad Typ Beschreibung
Gegenstände
CheckGroupCheck

Behauptungen

Liste der API-Überprüfungs assertionen.

Name Pfad Typ Beschreibung
Gegenstände
string

headers

Die Kopfzeilen.

Name Pfad Typ Beschreibung
Headers
object

Die Kopfzeilen.

Parameter

Die Parameter.

Name Pfad Typ Beschreibung
Params
object

Die Parameter.

request

Die Anforderung für die API.

Name Pfad Typ Beschreibung
method
method string
URL
url string
Daten
data string
Headers
headers headers

Die Kopfzeilen.

Params
params params

Die Parameter.

Zeiteinteilungen

Die Anzeigedauern.

Name Pfad Typ Beschreibung
Zeiteinteilungen
object

Die Anzeigedauern.

timingPhases

Die Anzeigedauerphasen.

Name Pfad Typ Beschreibung
Anzeigedauerphasen
object

Die Anzeigedauerphasen.

response

Die API-Antwort.

Name Pfad Typ Beschreibung
Der Status
status number

Der Status.

Statustext
statusText string

Der Statustext.

Body
body string

Der Körper.

Headers
headers headers

Die Kopfzeilen.

Zeiteinteilungen
timings timings

Die Anzeigedauern.

Anzeigedauerphasen
timingPhases timingPhases

Die Anzeigedauerphasen.

jobLog

Das Auftragsprotokoll.

Name Pfad Typ Beschreibung
Auftragsprotokoll
object

Das Auftragsprotokoll.

jobAssets

Ressourcen, die aus der Überprüfungsausführung generiert wurden.

Name Pfad Typ Beschreibung
Gegenstände
string

CheckResultAPI

Die Antwortdaten für eine API-Überprüfung.

Name Pfad Typ Beschreibung
Assertions
assertions assertions

Liste der API-Überprüfungs assertionen.

Anfrage
request request

Die Anforderung für die API.

Antwort
response response

Die API-Antwort.

Anforderungsfehler
requestError string

Beschreibt, ob bei der Anforderung ein Fehler aufgetreten ist.

Auftragsprotokoll
jobLog jobLog

Das Auftragsprotokoll.

Auftragsressourcen
jobAssets jobAssets

Ressourcen, die aus der Überprüfungsausführung generiert wurden.

Irrtümer

Liste der Fehler bei der Ausführung der Überprüfung.

Name Pfad Typ Beschreibung
Gegenstände
string

Modell9

Überprüfen Sie die Ausführungsprotokollergebnisse.

Name Pfad Typ Beschreibung
Gegenstände
string

traceSummary

Die Ablaufverfolgungszusammenfassung.

Name Pfad Typ Beschreibung
Ablaufverfolgungszusammenfassung
object

Die Ablaufverfolgungszusammenfassung.

pages

Liste der seiten, die für die Überprüfungsausführung verwendet werden.

Name Pfad Typ Beschreibung
Gegenstände
string

CheckResultBrowser

Die Antwortdaten für eine Browserüberprüfung.

Name Pfad Typ Beschreibung
Typ
type string

Der Typ des Frameworks, das die Überprüfung verwendet.

Errors
errors errors

Liste der Fehler bei der Ausführung der Überprüfung.

Endzeit
endTime number

Endzeit der Überprüfungsausführung.

Startzeit
startTime number

Startzeit der Überprüfungsausführung.

Laufzeitversion
runtimeVersion string

Aktive Laufzeitversion.

Überprüfen des Ausführungsprotokolls
jobLog Model9

Überprüfen Sie die Ausführungsprotokollergebnisse.

Auftragsressourcen
jobAssets jobAssets

Ressourcen, die aus der Überprüfungsausführung generiert wurden.

Ablaufverfolgungszusammenfassung
traceSummary traceSummary

Die Ablaufverfolgungszusammenfassung.

Seiten
pages pages

Liste der seiten, die für die Überprüfungsausführung verwendet werden.

CheckResult

Name Pfad Typ Beschreibung
ID
id string

Der eindeutige Bezeichner dieses Ergebnisses.

Name
name string

Der Name der Prüfung.

Id überprüfen
checkId string

Der Bezeichner der Prüfung.

Hat Fehler
hasFailures boolean

Beschreibt, ob während dieser Überprüfung ein Fehler aufgetreten ist. Dies sollte Ihr Hauptaugenmerk auf die Bewertung des API- oder Browserüberprüfungsverhaltens sein. Assertionen, die fehlschlagen, Timeouts oder fehlerhafte Skripts auflösen, werden in diesem Wert auf "true" aufgelöst.

Hat Fehler
hasErrors boolean

Beschreibt, ob im Back-End von Checkly ein interner Fehler aufgetreten ist. Dies sollte in fast allen Fällen falsch sein.

Wird herabgestuft
isDegraded boolean

Eine Überprüfung wird herabgestuft, wenn sie über dem herabgestuften Feld "DegradedResponseTime" auf der Prüfung liegt. Gilt nur für API-Prüfungen.

Über max. Reaktionszeit
overMaxResponseTime boolean

Wird auf "true" festgelegt, wenn die Antwortzeit den Grenzwert überschreitet, der vom Feld "maxResponseTime" für die Überprüfung festgelegt wurde. Gilt nur für API-Prüfungen.

Ausführungsort
runLocation string

Von welchem Rechenzentrumsstandort dieses Überprüfungsergebnis stammt.

Begonnen am
startedAt date-time

Der Startzeitpunkt.

Beendet am
stoppedAt date-time

Der Vorgang wird zur Zeit angehalten.

Erstellt unter
created_at date-time

Beim Erstellen bei.

Antwortzeit
responseTime number

Beschreibt die Zeit, die zum Ausführen relevanter Teile dieser Überprüfung benötigt wurde. Jedes Setupzeitgebersystem, das zum Starten der Ausführung dieser Überprüfung im Checkly-Back-End benötigt wird, ist nicht Teil davon.

Ergebnis-API überprüfen
apiCheckResult CheckResultAPI

Die Antwortdaten für eine API-Überprüfung.

Browserüberprüfungsergebnis
browserCheckResult CheckResultBrowser

Die Antwortdaten für eine Browserüberprüfung.

Ausführen-ID überprüfen
checkRunId number

Der Bezeichner der spezifischen Überprüfung, die dieses Überprüfungsergebnis erstellt hat.

Versucht
attempts number

Wie oft diese Prüfung wiederholt wurde. Dies ist größer als 0, wenn die Doppelüberprüfung aktiviert ist.

CheckResultList

Name Pfad Typ Beschreibung
Gegenstände
CheckResult

CheckStatus

Name Pfad Typ Beschreibung
Name
name string

Der Name der Prüfung.

Id überprüfen
checkId string

Der Bezeichner der Überprüfung dieses Status gehört.

Hat Fehler
hasFailures boolean

Beschreibt, ob diese Überprüfung zurzeit fehlschlägt. Wenn eine der Assertionen für eine API-Überprüfung fehlschlägt, ist dieser Wert wahr. Wenn eine Browserüberprüfung aus irgendeinem Grund fehlschlägt, ist dies richtig.

Hat Fehler
hasErrors boolean

Beschreibt, ob aufgrund eines Fehlers außerhalb des normalen Vorgangs diese Überprüfung fehlschlägt. Dies sollte extrem selten sein und nur dann, wenn im Checkly-Back-End ein Fehler auftritt.

Wird herabgestuft
isDegraded boolean

Eine Überprüfung wird herabgestuft, wenn sie über dem herabgestuften Feld "DegradedResponseTime" auf der Prüfung liegt. Gilt nur für API-Prüfungen.

Längste Ausführung
longestRun number

Die längste aufgezeichnete Antwortzeit für diese Überprüfung.

Kürzester Lauf
shortestRun number

Die kürzeste aufgezeichnete Reaktionszeit für diese Überprüfung.

Speicherort der letzten Ausführung
lastRunLocation string

An welchem Speicherort diese Überprüfung zuletzt ausgeführt wurde.

Id der letzten Überprüfung der Ausführung
lastCheckRunId string

Der eindeutige inkrementierende Bezeichner für jede Überprüfungsausführung.

VERBLEIBENDE SSL-Tage
sslDaysRemaining number

Wie viele Tage verbleiben, bis das aktuelle SSL-Zertifikat abläuft.

Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

CheckStatusList

Name Pfad Typ Beschreibung
Gegenstände
CheckStatus

Prüfen

Name Pfad Typ Beschreibung
ID
id string

Der Bezeichner.

Name
name string

Der Name der Prüfung.

Aktiviert
activated boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations CheckLocationList

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags CheckTagList

Tags zum Organisieren und Filtern von Prüfungen.

Benachrichtigungseinstellungen überprüfen
alertSettings CheckAlertSettings

Warnungseinstellungen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
Überprüfen des Typs
checkType string

Der Typ der Prüfung.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Frequenzversatz
frequencyOffset integer

Der Frequenzversatz.

Anforderung überprüfen
request CheckRequest

Die Check-Anforderung.

Skript
script string

Das Skript.

Umgebungsvariablenliste überprüfen
environmentVariables CheckEnvironmentVariableList

Schlüssel-Wert-Paare zum Festlegen von Umgebungsvariablen während der Überprüfungsausführung. Diese sind nur für Browserüberprüfungen relevant. Verwenden Sie nach Möglichkeit globale Umgebungsvariablen.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung verwendet werden soll.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase ausgeführt werden soll.

Herabgestufte Reaktionszeit
degradedResponseTime number

Die Reaktionszeit in Millisekunden, bei der eine Überprüfung als herabgestuft betrachtet werden sollte.

Maximale Reaktionszeit
maxResponseTime number

Die Antwortzeit in Millisekunden, bei der eine Überprüfung als fehlschlägt.

alertChannels
alertChannels CheckAlertChannels
Private Speicherorte
privateLocations privateLocations

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

CheckList

Name Pfad Typ Beschreibung
Gegenstände
Check

Model14

Name Pfad Typ Beschreibung
Gegenstände
KeyValue

Modell 15

Name Pfad Typ Beschreibung
Gegenstände
KeyValue

Modell16

Bestimmt die Anforderung, dass die Überprüfung ausgeführt wird.

Name Pfad Typ Beschreibung
method
method string
URL
url string

Die URL-Adresse.

Follow Redirects
followRedirects boolean

Gibt an, ob Umleitungen befolgt werden sollen.

SSL überspringen
skipSSL boolean

Gibt an, ob SSL übersprungen werden soll.

Body
body string

Der Körper.

Körpertyp
bodyType string

Der Textkörpertyp.

headers
headers Model14
queryParameters (englisch)
queryParameters Model15
Assertionsliste
assertions AssertionList

Überprüfen Sie die Hauptdokumentation zu Assertionen für bestimmte Werte wie reguläre Ausdrücke und JSON-Pfaddeskriptoren, die Sie im Eigenschaftenfeld verwenden können.

basicAuth
basicAuth BasicAuth

CheckAPI

Name Pfad Typ Beschreibung
ID
id string

Der Bezeichner.

Name
name string

Der Name der Prüfung.

Aktiviert
activated boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations CheckLocationList

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags CheckTagList

Tags zum Organisieren und Filtern von Prüfungen.

Benachrichtigungseinstellungen überprüfen
alertSettings CheckAlertSettings

Warnungseinstellungen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
Anforderung überprüfen
request Model16

Bestimmt die Anforderung, dass die Überprüfung ausgeführt wird.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Frequenzversatz
frequencyOffset integer

Wird für das Festlegen von Sekunden für Überprüfungsfrequenzen unter 1 Minuten (nur für API-Prüfungen) und die Verteilung von Prüfungen über einen Zeitraum für Frequenzen über 1 Minute verwendet. Dies funktioniert wie folgt: Prüfungen mit einer Häufigkeit von 0 können eine Häufigkeit von 10, 20 oder 30 aufweisen, was bedeutet, dass sie alle 10, 20 oder 30 Sekunden ausgeführt werden. Prüfungen mit einer Häufigkeit niedriger als und gleich 60 können einen FrequencyOffset zwischen 1 und einem maximalen Wert basierend auf der Formel Math.floor(Häufigkeit * 10) aufweisen, d. h. für eine Prüfung, die alle 5 Minuten ausgeführt wird, beträgt die maximale HäufigkeitOffset 50. Überprüfungen mit einer Häufigkeit, die höher als 60 ist, können eine häufigkeitoffset zwischen 1 und einem höchstwert basierend auf der Formel Math.ceil(frequency / 60) aufweisen, d. h. für eine Überprüfung, die alle 720 Minuten ausgeführt wird, ist das max. frequencyOffset 12.

Codeausschnitt-ID abreißen
tearDownSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Abrissphase einer API-Überprüfung verwendet werden soll.

Setup-Codeausschnitt-ID
setupSnippetId number

Ein Bezeichnerverweis auf einen Codeausschnitt, der in der Setupphase einer API-Überprüfung verwendet werden soll.

Lokales Setupskript
localSetupScript string

Ein gültiger Node.js Code, der in der Setupphase ausgeführt werden soll.

Lokales Skript zum Abreißen
localTearDownScript string

Ein gültiger Node.js Code, der in der Abreißphase ausgeführt werden soll.

Herabgestufte Reaktionszeit
degradedResponseTime number

Die Reaktionszeit in Millisekunden, bei der eine Überprüfung als herabgestuft betrachtet werden sollte.

Maximale Reaktionszeit
maxResponseTime number

Die Antwortzeit in Millisekunden, bei der eine Überprüfung als fehlschlägt.

Private Speicherorte
privateLocations privateLocations

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

Überprüfen des Typs
checkType string

Der Überprüfungstyp.

alertChannels
alertChannels CheckAlertChannels
Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

CheckBrowser

Name Pfad Typ Beschreibung
ID
id string

Der Bezeichner.

Name
name string

Der Name der Prüfung.

Aktiviert
activated boolean

Bestimmt, ob die Überprüfung ausgeführt wird oder nicht.

Gedämpft
muted boolean

Bestimmt, ob Benachrichtigungen gesendet werden, wenn eine Überprüfung fehlschlägt und/oder wiederhergestellt wird.

Double Check
doubleCheck boolean

Wenn Sie diesen Wert auf "true" festlegen, wird ein Wiederholungsversuch ausgelöst, wenn eine Prüfung aus dem fehlerhaften Bereich und einem anderen, zufällig ausgewählten Bereich fehlschlägt, bevor die Prüfung als fehlgeschlagen markiert wird.

Sollte fehlschlagen
shouldFail boolean

Ermöglicht das Umkehren des Verhaltens, wenn eine Prüfung als fehlschlägt. Ermöglicht das Überprüfen des Fehlerstatus wie 404.

Speicherortliste überprüfen
locations CheckLocationList

Ein Array von mindestens einem Rechenzentrumsspeicherort, an dem diese Überprüfung ausgeführt werden soll.

Tagliste überprüfen
tags CheckTagList

Tags zum Organisieren und Filtern von Prüfungen.

Benachrichtigungseinstellungen überprüfen
alertSettings CheckAlertSettings

Warnungseinstellungen.

Globale Warnungseinstellungen verwenden
useGlobalAlertSettings boolean

Bei "true" wird die Warnungseinstellung auf Kontoebene verwendet, nicht die für diese Überprüfung definierte Warnungseinstellung.

Gruppen-ID
groupId number

Der Bezeichner der Prüfgruppe, zu der diese Überprüfung gehört.

Gruppenreihenfolge
groupOrder number

Die Position dieser Überprüfung in einer Prüfgruppe. Es bestimmt, in welcher Reihenfolge Überprüfungen ausgeführt werden, wenn eine Gruppe von der API oder von CI/CD ausgelöst wird.

Laufzeit-ID
runtimeId string

Die Laufzeitversion, d. h. feste Gruppe von Laufzeitabhängigkeiten, die zum Ausführen dieser Überprüfung verwendet werden.

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
Überprüfen des Typs
checkType string

Der Überprüfungstyp.

Frequenz
frequency integer

Wie oft die Überprüfung in Minuten ausgeführt werden soll.

Skript
script string

Ein gültiger Teil Node.js Javascript-Code, der eine Browserinteraktion mit den Puppeteer- oder Playwright-Frameworks beschreibt.

Private Speicherorte
privateLocations privateLocations

Ein Array von mindestens einem privaten Speicherort, an dem die Überprüfung ausgeführt werden soll.

alertChannels
alertChannels CheckAlertChannels
Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

DashboardTagList

Eine Liste mit einem oder mehreren Tags, die filtern, die auf dem Dashboard angezeigt werden sollen.

Name Pfad Typ Beschreibung
Gegenstände
string

Dashboard

Name Pfad Typ Beschreibung
Benutzerdefinierte Domäne
customDomain string

Eine benutzerdefinierte Benutzerdomäne, z. B. status.example.com. Informationen zum Aktualisieren Ihrer DNS- und SSL-Verwendung finden Sie in den Dokumenten.

Benutzerdefinierte URL
customUrl string

Ein Unterdomänenname unter checklyhq.com. Muss für alle Benutzer eindeutig sein.

Logo
logo string

Eine URL, die auf eine Bilddatei zeigt.

Favicon
favicon string

Eine URL, die auf eine Bilddatei zeigt, die als Dashboard-Favicon verwendet wird.

Link
link string

Ein URL-Link zum Umleiten, wenn auf das Dashboardlogo geklickt wird.

Header
header string

Ein Textabschnitt, der oben im Dashboard angezeigt wird.

Description
description string

Ein Textabschnitt, der unterhalb der Kopfzeile oder des Titels Ihres Dashboards angezeigt wird.

Breite
width string

Bestimmt, ob der Vollbildmodus oder der Fokus in der Mitte verwendet werden soll.

Aktualisierungsrate
refreshRate number

Wie oft das Dashboard in Sekunden aktualisiert werden soll.

Paginieren
paginate boolean

Bestimmt, dass die Paginierung aktiviert oder deaktiviert ist.

Paginierungsrate
paginationRate number

Wie oft die Paginierung in Sekunden ausgelöst wird.

Prüfungen pro Seite
checksPerPage number

Anzahl der pro Seite angezeigten Prüfungen.

Verwenden und Operator
useTagsAndOperator boolean

Gründe für die Verwendung des AND-Operators für die Nachschlagevorgang von Tags.

Tags ausblenden
hideTags boolean

Blenden Sie die Tags im Dashboard ein oder aus.

Dashboard-Tagliste
tags DashboardTagList

Eine Liste mit einem oder mehreren Tags, die filtern, die auf dem Dashboard angezeigt werden sollen.

Dashboard-ID
dashboardId string

Der Dashboardbezeichner.

DashboardsList

Name Pfad Typ Beschreibung
Gegenstände
Dashboard

Standort

Name Pfad Typ Beschreibung
Region
region string

Der eindeutige Bezeichner dieses Speicherorts.

Name
name string

Anzeigename dieses Speicherorts.

LocationList

Name Pfad Typ Beschreibung
Gegenstände
Location

MaintenanceWindowTagList

Die Namen des Wartungsfensters für Prüfungen und Gruppen sollten angewendet werden.

Name Pfad Typ Beschreibung
Gegenstände
string

Wartungsfenster

Name Pfad Typ Beschreibung
ID
id number

Der Bezeichner des Wartungsfensters.

Name
name string

Der Name des Wartungsfensters.

Wartungsfenster-Tagliste
tags MaintenanceWindowTagList

Die Namen des Wartungsfensters für Prüfungen und Gruppen sollten angewendet werden.

Beginnt bei
startsAt date

Das Startdatum des Wartungsfensters.

Endet am
endsAt date

Das Enddatum des Wartungsfensters.

Wiederholungsintervall
repeatInterval number

Das Wiederholungsintervall des Wartungsfensters vom ersten Vorkommen.

Wiederholungseinheit
repeatUnit string

Die Wiederholungsstrategie für das Wartungsfenster.

Wiederholte Enden bei
repeatEndsAt date

Das Enddatum, an dem das Wartungsfenster nicht mehr wiederholt werden soll.

Erstellt unter
created_at date

Das Erstellungsdatum des Wartungsfensters.

Aktualisiert unter
updated_at date

Das letzte Datum, an dem das Wartungsfenster aktualisiert wurde.

MaintenanceWindowList

Die Wartungsfensterliste.

Name Pfad Typ Beschreibung
Gegenstände
MaintenanceWindow

CheckAssignment

Name Pfad Typ Beschreibung
ID
id guid

Der Bezeichner.

Id überprüfen
checkId guid

Der Bezeichner der Prüfung.

ID des privaten Standorts
privateLocationId guid

Der Bezeichner des zugewiesenen privaten Speicherorts.

checkAssignments

Die Überprüfung dieses privaten Speicherorts wurde zugewiesen.

Name Pfad Typ Beschreibung
Gegenstände
CheckAssignment

GroupAssignment

Name Pfad Typ Beschreibung
ID
id guid

Der Bezeichner.

Gruppen-ID
groupId number

Der Bezeichner der Gruppe.

ID des privaten Standorts
privateLocationId guid

Der Bezeichner des zugewiesenen privaten Speicherorts.

groupAssignments

Die Gruppe, der dieser private Speicherort zugewiesen wurde.

Name Pfad Typ Beschreibung
Gegenstände
GroupAssignment

privateLocationKeys

Name Pfad Typ Beschreibung
ID
id guid

Der Bezeichner.

Unformatierter Schlüssel
rawKey string

Der unformatierte Schlüssel.

Maskierte Taste
maskedKey string

Der maskierte Schlüsselwert.

Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date

Wenn aktualisiert unter.

keys

Name Pfad Typ Beschreibung
Gegenstände
privateLocationKeys

privatelocationschema

Name Pfad Typ Beschreibung
ID
id guid

Der Bezeichner.

Name
name string

Der Name, der dem privaten Speicherort zugewiesen ist.

Slug Name
slugName string

Gültiger Schrägstrichname.

Ikone
icon string

Das Symbol für den privaten Speicherort.

Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date

Wenn aktualisiert unter.

Aufgaben überprüfen
checkAssignments checkAssignments

Die Überprüfung dieses privaten Speicherorts wurde zugewiesen.

Gruppenzuweisungen
groupAssignments groupAssignments

Die Gruppe, der dieser private Speicherort zugewiesen wurde.

keys
keys keys
Zuletzt gesehen
lastSeen date

Das datum der letzten Veröffentlichung.

Agentanzahl
agentCount number

Die Agentanzahl.

privateLocationsListSchema

Name Pfad Typ Beschreibung
Gegenstände
privatelocationschema

commonPrivateLocationSchemaResponse

Name Pfad Typ Beschreibung
ID
id guid

Der Bezeichner.

Name
name string

Der Name, der dem privaten Speicherort zugewiesen ist.

Slug Name
slugName string

Gültiger Schrägstrichname.

Ikone
icon string

Das Symbol für den privaten Speicherort.

Erstellt unter
created_at date

Beim Erstellen bei.

Aktualisiert unter
updated_at date

Wenn aktualisiert unter.

Aufgaben überprüfen
checkAssignments checkAssignments

Die Überprüfung dieses privaten Speicherorts wurde zugewiesen.

Gruppenzuweisungen
groupAssignments groupAssignments

Die Gruppe, der dieser private Speicherort zugewiesen wurde.

keys
keys keys

Zeitstempel

Name Pfad Typ Beschreibung
Zeitstempel
date-time

Der Zeitstempel.

queueSize

Die Warteschlangengröße.

Name Pfad Typ Beschreibung
Gegenstände
number

oldestScheduledCheckRun

Name Pfad Typ Beschreibung
Gegenstände
number

privateLocationsMetricsHistoryResponseSchema

Name Pfad Typ Beschreibung
Zeitstempel
timestamps timestamps
Warteschlangengröße
queueSize queueSize

Die Warteschlangengröße.

oldestScheduledCheckRun
oldestScheduledCheckRun oldestScheduledCheckRun

ReportingTagList

Häkchen.

Name Pfad Typ Beschreibung
Gegenstände
string

ReportingAggregate

Name Pfad Typ Beschreibung
Erfolgsquote
successRatio number

Erfolgsverhältnis der Überprüfung über den ausgewählten Datumsbereich. Der Prozentsatz ist in dezimaler Form.

Average
avg number

Durchschnittliche Reaktionszeit der Überprüfung über den ausgewählten Datumsbereich in Millisekunden.

P95
p95 number

P95-Antwortzeit der Überprüfung über den ausgewählten Datumsbereich in Millisekunden.

P99
p99 number

P99-Antwortzeit der Überprüfung über den ausgewählten Datumsbereich in Millisekunden.

Berichterstattung

Name Pfad Typ Beschreibung
Name
name string

Überprüfen Sie den Namen.

Id überprüfen
checkId string

Überprüfen Sie die ID.

Überprüfen des Typs
checkType string

Überprüfen Sie den Typ.

Deaktiviert
deactivated boolean

Aktiviert.

Berichtstagliste
tags ReportingTagList

Häkchen.

aggregate
aggregate ReportingAggregate

ReportingList

Name Pfad Typ Beschreibung
Gegenstände
Reporting

Laufzeit

Name Pfad Typ Beschreibung
Name
name string

Der eindeutige Name dieser Laufzeit.

Phase
stage string

Aktuelle Lebensdauerphase einer Laufzeit.

Laufzeitende der Lebensdauer
runtimeEndOfLife string

Datum, an dem eine Laufzeit von unserer Plattform entfernt wird.

Standard
default boolean

Gibt an, ob dies die aktuelle Standardlaufzeit ist, die von Checkly bereitgestellt wird.

Description
description string

Eine kurze, lesbare Beschreibung der Hauptupdates in dieser Laufzeit.

String
dependencies.string string

Die Zeichenfolge.

RuntimeList

Name Pfad Typ Beschreibung
Gegenstände
Runtime

Schnipsel

Name Pfad Typ Beschreibung
ID
id number

Der Bezeichner.

Name
name string

Der Codeausschnittname.

Skript
script string

Ihr Node.js Code, der mit dem API-Prüflebenszyklus interagiert, oder fungiert als Teil für Browserüberprüfungen.

Erstellt unter
created_at date-time

Beim Erstellen bei.

Aktualisiert unter
updated_at date-time

Wenn aktualisiert unter.

SnippetList

Name Pfad Typ Beschreibung
Gegenstände
Snippet

CheckGroupTrigger

Name Pfad Typ Beschreibung
ID
id number

Der Bezeichner.

Token
token string

Das Token.

Erstellt unter
created_at date

Beim Erstellen bei.

Aufgerufen bei
called_at date

Wird aufgerufen bei.

Aktualisiert unter
updated_at date

Wenn aktualisiert unter.

Gruppen-ID
groupId number

Der Gruppenbezeichner.

CheckTrigger

Name Pfad Typ Beschreibung
ID
id number

Der Bezeichner.

Token
token string

Das Token.

Erstellt unter
created_at date

Beim Erstellen bei.

Aufgerufen bei
called_at date

Wird aufgerufen bei.

Aktualisiert unter
updated_at date

Wenn aktualisiert unter.

Id überprüfen
checkId string

Der Prüfbezeichner.

Objekt

Dies ist der Typ 'object'.

Schnur

Dies ist der grundlegende Datentyp "string".