Checkly (nezávislý vydavatel) (Preview)

Podívejte se, jestli je monitorovací platforma pro moderní zásobník: programovatelná, flexibilní a milovaná JavaScript. Monitorujte a ověřte klíčové transakce lokality. Automaticky shromážděte trasování chyb, snímky obrazovky a metriky výkonu při každé kontrole, kterou spustíte.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadata konektoru
Vydavatel	Troy Taylor
Internetová stránka	https://www.checklyhq.com/
Zásady ochrany osobních údajů	https://www.checklyhq.com/privacy
Kategorie	IT provoz

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
ID účtu	securestring	ID účtu pro toto rozhraní API.	Pravdivé
Klíč rozhraní API (ve formátu Bearer apiKey)	securestring	Klíč rozhraní API (ve formátu Bearer apiKey) pro toto rozhraní API	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace fragmentu kódu	Aktualizuje fragment kódu.
Aktualizace kanálu upozornění	Aktualizujte kanál upozornění.
Aktualizace kontrolní skupiny	Aktualizuje kontrolní skupinu.
Aktualizace kontroly [ZASTARALÉ]	[ZASTARALÉ] Tento koncový bod bude odebrán 4. července 2022. Místo toho použijte PUT /checks/api/{id} nebo PUT /checks/browser/{id}. Aktualizuje nové rozhraní API nebo kontrolu prohlížeče.
Aktualizace kontroly prohlížeče	Aktualizuje kontrolu prohlížeče.
Aktualizace kontroly rozhraní API	Aktualizuje kontrolu rozhraní API.
Aktualizace odběrů kanálu upozornění	Aktualizujte odběry kanálu upozornění. Tato možnost slouží k přidání kontroly do kanálu upozornění, aby se pro tuto kontrolu odesílala upozornění na selhání a obnovení. Poznámka: Při předávání objektu předplatného můžete zadat pouze checkId nebo groupId, nikoli obojí.
Aktualizace privátního umístění	Aktualizuje privátní umístění.
Aktualizace proměnné prostředí	Aktualizuje proměnnou prostředí. Použije pole klíče jako identifikátor pro aktualizaci. Aktualizuje pouze hodnotu a uzamčenou vlastnost.
Aktualizace časového období údržby	Aktualizuje časové období údržby.
Aktualizace řídicího panelu	Aktualizuje řídicí panel. Vrátí chybu 409 při pokusu o vytvoření řídicího panelu s vlastní adresou URL nebo vlastní doménou, která už byla přijata.
Načtení fragmentu kódu	Zobrazí podrobnosti o konkrétním fragmentu kódu.
Načtení jedné vrácení se změnami v konkrétní skupině s použitým nastavením skupiny	Umožňuje zobrazit podrobnosti o jedné skupině vrácení se změnami s použitým nastavením skupiny.
Načtení kanálu upozornění	Umožňuje zobrazit podrobnosti o konkrétním kanálu upozornění.
Načtení kontrolní skupiny	Umožňuje zobrazit podrobnosti o konkrétní skupině kontroly.
Načtení kontroly	Zobrazení podrobností o konkrétním rozhraní API nebo kontrole prohlížeče
Načtení podrobností o stavu kontroly	Umožňuje zobrazit aktuální informace o stavu pro konkrétní kontrolu.
Načtení privátního umístění	Umožňuje zobrazit podrobnosti o konkrétním privátním umístění.
Načtení proměnné prostředí	Umožňuje zobrazit podrobnosti o konkrétní proměnné prostředí. Použije pole klíče pro výběr.
Načtení výsledku kontroly	Umožňuje zobrazit podrobnosti o konkrétním výsledku kontroly.
Načtení časového období údržby	Umožňuje zobrazit podrobnosti o konkrétním časovém období údržby.
Načtenívšechch	Zobrazí seznam všech kontrol v konkrétní skupině kontroly s použitým nastavením skupiny.
Odebrání existujícího klíče rozhraní API pro privátní umístění	Trvale odebere klíč rozhraní API z privátního umístění.
Odebrání privátního umístění	Trvale odebere soukromé umístění.
Odstranění fragmentu kódu	Trvale odebere fragment kódu.
Odstranění kanálu upozornění	Trvale odebere kanál upozornění.
Odstranění kontroly	Trvale odebere kontrolu rozhraní API nebo prohlížeče a všechna související data o stavu a výsledcích.
Odstranění proměnné prostředí	Trvale odebere proměnnou prostředí. Použije pole klíče jako identifikátor pro odstranění.
Odstranění skupiny zaškrtnutí	Trvale odebere skupinu kontroly. Skupinu kontroly nelze odstranit, pokud stále obsahuje kontroly.
Odstranění triggeru kontrolní skupiny	Odstraní trigger kontrolních skupin.
Odstranění triggeru kontroly	Odstraní trigger kontroly.
Odstranění časového období údržby	Trvale odebere časové období údržby.
Odstraňte řídicí panel	Trvale odebere řídicí panel.
Odznak Získání stavu skupiny	Získejte odznak stavu skupiny.
Odznáček Získat stav kontroly	Získejte odznáček stavu kontroly.
Vygenerování nového klíče rozhraní API pro privátní umístění	Vytvoří klíč rozhraní API v privátním umístění.
Vygeneruje přizpůsobitelnou sestavu pro všechny metriky kontroly prohlížeče.	Vygeneruje sestavu s agregovanými nebo neagregovanými statistikami pro konkrétní kontrolu prohlížeče v zadaném časovém intervalu.
Vygeneruje sestavu s agregovanými statistikami pro kontroly a skupiny kontrol.	Generuje sestavu s agregovanými statistikami pro všechny kontroly nebo filtrovanou sadu kontrol v zadaném časovém intervalu.
Vytvoření fragmentu kódu	Vytvoří nový fragment kódu.
Vytvoření kanálu upozornění	Vytvoří nový kanál upozornění.
Vytvoření kontrolní skupiny	Vytvoří novou skupinu kontroly. Do skupiny můžete přidat kontroly nastavením vlastnosti groupId jednotlivých kontrol.
Vytvoření kontroly [ZASTARALÉ]	[ZASTARALÉ] Tento koncový bod bude odebrán 4. července 2022. Místo toho použijte POST /checks/api nebo POST /checks/browser. Vytvoří nové rozhraní API nebo kontrolu prohlížeče. Vrátí, 402 když jste nad limitem plánu. Při použití globalAlertSettings, alertSettings může být null
Vytvoření kontroly prohlížeče	Vytvoří novou kontrolu prohlížeče. Vrátí, 402 když jste nad limitem plánu. Při použití globalAlertSetting, alertSetting může být null
Vytvoření kontroly rozhraní API	Vytvoří novou kontrolu rozhraní API. Vrátí, 402 když jste nad limitem plánu. Při použití globalAlertSetting, alertSetting může být null
Vytvoření privátního umístění	Vytvoří nové privátní umístění.
Vytvoření proměnné prostředí	Vytvoří novou proměnnou prostředí.
Vytvoření triggeru kontrolní skupiny	Vytvoří trigger skupiny kontroly.
Vytvoření triggeru kontroly	Vytvoří trigger kontroly.
Vytvoření časového období údržby	Vytvoří nové časové období údržby.
Vytvoření řídicího panelu	Vytvoří nový řídicí panel. Vrátí chybu 409 při pokusu o vytvoření řídicího panelu s vlastní adresou URL nebo vlastní doménou, která už byla přijata.
Výpis všech fragmentů kódu	Zobrazí seznam všech aktuálních fragmentů kódu ve vašem účtu.
Výpis všech kanálů upozornění	Zobrazí seznam všech nakonfigurovaných kanálů upozornění a jejich odebíraných kontrol.
Výpis všech kontrolních skupin	Zobrazí seznam všech aktuálních kontrolních skupin ve vašem účtu. Vlastnost checks je pole identifikátoru UUID kontroly pro pohodlné odkazování. Je jen pro čtení a nemůžete ji použít k přidání kontrol do skupiny.
Výpis všech privátních umístění	Zobrazí seznam všech privátních umístění ve vašem účtu.
Výpis všech proměnných prostředí	Zobrazí seznam všech aktuálních proměnných prostředí ve vašem účtu.
Výpis všech upozornění pro váš účet	Zobrazí seznam všech upozornění pro váš účet.
Výpis všech řídicích panelů	Zobrazí seznam všech aktuálních řídicích panelů ve vašem účtu.
Zobrazení seznamu výstrah pro konkrétní kontrolu	Zobrazí seznam všech výstrah pro konkrétní kontrolu.
Zobrazit seznam všech kontrol	Zobrazí seznam všech aktuálních kontrol ve vašem účtu.
Zobrazit seznam všech stavů kontroly	Zobrazuje aktuální informace o stavu všech kontrol ve vašem účtu. Záznamy o stavu kontroly se průběžně aktualizují, jakmile se objeví nové výsledky kontroly.
Zobrazit seznam všech časových období údržby	Zobrazí seznam všech časových období údržby ve vašem účtu.
Zobrazuje podrobnosti pro jeden konkrétní modul runtime.	Zobrazuje podrobnosti o všech zahrnutých balíčcích NPM a jejich verzi pro jeden konkrétní modul runtime.
Zobrazí seznam všech podporovaných modulů runtime.	Zobrazí seznam všech podporovaných modulů runtime a zahrnutých balíčků NPM pro kontroly prohlížeče a nastavení a skripty pro kontroly rozhraní API.
Zobrazí seznam všech podporovaných umístění.	Zobrazí seznam všech podporovaných umístění.
Zobrazí seznam všech výsledků kontroly.	Zobrazí seznam úplných nezpracovaných výsledků kontroly konkrétní kontroly. Nezpracované výsledky uchováváme po dobu 30 dnů. Po 30 dnech se vymažou. Souhrnné výsledky ale udržujeme po neomezenou dobu. Pokud chcete seznam zúžit, můžete filtrovat podle typu zaškrtnutí a typu výsledku. to Pomocí parametrů zadejte from rozsah dat (časové razítko systému UNIX v sekundách). V závislosti na typu kontroly můžou být některá pole null. Tento koncový bod vrátí data do šestihodinového časového rámce. Pokud jsou nastaveny parametry od a do parametrů, musí být maximálně šest hodin od sebe. Pokud nejsou nastaveny žádné, budeme uvažovat o parametru, který má být nyní a z parametru bude šest hodin dříve. Pokud je nastavena pouze hodnota parametru, nastavíme hodnotu od šesti hodin dříve. Naopak, pokud je nastavena pouze z paramu, budeme uvažovat o param, aby byl šest hodin později. U tohoto koncového bodu se uplatňuje omezování rychlosti, maximálně můžete odesílat 5 požadavků / 10 sekund.
Získání metrik stavu privátního umístění z časového intervalu	Získání metrik stavu privátního umístění z časového intervalu
Získání triggeru kontrolní skupiny	Vyhledá trigger skupiny kontroly.
Získání triggeru kontroly	Vyhledá aktivační událost kontroly.

Aktualizace fragmentu kódu

ID operace:

PutV1SnippetsId

Aktualizuje fragment kódu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.
Název	name	True	string	Název fragmentu kódu
Script	script	True	string	Váš Node.js kód, který komunikuje s životním cyklem kontroly rozhraní API, nebo funguje jako částečná kontrola prohlížeče.

Návraty

Body

Snippet

Aktualizace kanálu upozornění

ID operace:

PutV1AlertchannelsId

Aktualizujte kanál upozornění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.
ID	id		number	Identifikátor.
Kontrola ID	checkId		guid	Identifikátor kontroly.
ID skupiny	groupId		number	Identifikátor skupiny.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
Typ	type	True	string	Typ.
Konfigurace vytvoření kanálu upozornění	config	True	object	Konfigurace vytvoření kanálu upozornění.
Odeslat obnovení	sendRecovery		boolean	Určuje, jestli se má odeslat obnovení.
Selhání odeslání	sendFailure		boolean	Určuje, jestli došlo k chybě odeslání.
Snížení výkonu při odesílání	sendDegraded		boolean	Určuje, jestli je odesílání degradované.
Vypršení platnosti PROTOKOLU SSL	sslExpiry		boolean	Určuje, jestli má být odeslána výstraha pro vypršení platnosti certifikátů SSL.
Prahová hodnota vypršení platnosti protokolu SSL	sslExpiryThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.

Návraty

Body

AlertChannel

Aktualizace kontrolní skupiny

ID operace:

PutV1CheckgroupsId

Aktualizuje kontrolní skupinu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name		string	Název skupiny kontroly.
Aktivovaný	activated		boolean	Určuje, jestli jsou kontroly ve skupině spuštěné nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se některá oznámení odesílají, když selže vrácení se změnami v této skupině nebo se obnoví.
Kontrola seznamu značek skupiny	tags		array of string	Značky pro uspořádání a filtrování kontrol
Kontrola seznamu umístění skupiny	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se mají kontroly spouštět.
Souběžnost	concurrency		number	Určuje, kolik kontrol se vyvolá souběžně při aktivaci skupiny kontroly z CI/CD nebo prostřednictvím rozhraní API.
URL	url		string	Základní adresa URL pro tuto skupinu, na kterou můžete odkazovat s proměnnou {{GROUP_BASE_URL}} ve všech kontrolách skupin.
Key	key	True	string	Klíč.
Hodnota	value	True	string	Hodnota.
Uzamčeno	locked		boolean	Zda je uzamčeno.
Zdroj	source		string	Zdroj.
Vlastnictví	property		string	Vlastnost.
Comparison	comparison		string	Porovnání.
Target	target		string	Cíl.
Uživatelské jméno	username	True	string	Uživatelské jméno.
Heslo	password	True	string	Heslo.
Kontrola výchozích hodnot pro vytváření skupin v prohlížeči	browserCheckDefaults		object	Ve skupině kontroly se vytvoří výchozí nastavení prohlížeče.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provádění kontrol v této skupině.
Key	key	True	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované pro tuto skupinu kontroly.
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
ID fragmentu kódu instalace	setupSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API v této skupině.
Id fragmentu kódu pro roztrhání	tearDownSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odtrhání kontroly rozhraní API v této skupině.
Místní instalační skript	localSetupScript		string	Platný kód Node.js, který se má spustit ve fázi instalace kontroly rozhraní API v této skupině.
Místní roztrhání skriptu	localTearDownScript		string	Platný kód Node.js, který se má spustit ve fázi odstranění kontroly rozhraní API v této skupině.
Kontrola privátních umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se mají kontroly spouštět.

Návraty

Body

CheckGroup

Aktualizace kontroly [ZASTARALÉ]

ID operace:

PutV1ChecksId

[ZASTARALÉ] Tento koncový bod bude odebrán 4. července 2022. Místo toho použijte PUT /checks/api/{id} nebo PUT /checks/browser/{id}. Aktualizuje nové rozhraní API nebo kontrolu prohlížeče.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name		string	Název kontroly.
Aktivovaný	activated		boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail		boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags		array of string	Značky pro uspořádání a filtrování kontrol
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId		number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder		number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
Kontrola typu	checkType		string	Typ kontroly.
Četnost	frequency		integer	Jak často se má kontrola spouštět v minutách.
Posun frekvence	frequencyOffset		integer	Používá se pro nastavení sekund pro četnost kontroly pod 1 minutami (pouze pro kontroly rozhraní API) a šíření kontrol v časovém rozsahu četností přes 1 minutu. Funguje takto: Kontroly s frekvencí 0 mohou mít frekvenciOffset 10, 20 nebo 30, což znamená, že se spustí každých 10, 20 nebo 30 sekund. Kontroly s frekvencí nižší než a rovnou 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.floor(frekvence * 10), tj. kontrola spuštění každých 5 minut, maximální frekvenceOffset je 50. Kontroly s frekvencí vyšší než 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.ceil(frequency / 60), tj. při kontrole, která se spouští každých 720 minut, maximální frekvenceOffset je 12.
Kontrola žádosti	request	True	object	Žádost o kontrolu.
Script	script	True	string	Skript.
Key	key	True	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.
ID fragmentu kódu instalace	setupSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API.
Id fragmentu kódu pro roztrhání	tearDownSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odstranění kontroly rozhraní API.
Místní instalační skript	localSetupScript		string	Platný kód Node.js ke spuštění ve fázi instalace.
Místní roztrhání skriptu	localTearDownScript		string	Platný kód Node.js, který se má spustit ve fázi odstranění.
Degradovaná doba odezvy	degradedResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za degradovanou.
Maximální doba odezvy	maxResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za selhání.
Privátní umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.

Návraty

Body

Check

Aktualizace kontroly prohlížeče

ID operace:

PutV1ChecksBrowserId

Aktualizuje kontrolu prohlížeče.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name		string	Název kontroly.
Aktivovaný	activated		boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail		boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags		array of string	Značky pro uspořádání a filtrování kontrol
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId		number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder		number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
Key	key	True	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.
Četnost	frequency		integer	Jak často se má kontrola spouštět v minutách.
Script	script		string	Platný kód Node.js javascriptu popisující interakci prohlížeče s architekturou Puppeteer nebo Playwright.
Privátní umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.

Návraty

Body

CheckBrowser

Aktualizace kontroly rozhraní API

ID operace:

PutV1ChecksApiId

Aktualizuje kontrolu rozhraní API.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name		string	Název kontroly.
Aktivovaný	activated		boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail		boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags		array of string	Značky pro uspořádání a filtrování kontrol
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId		number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder		number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
metoda	method	True	string
URL	url	True	string	Adresa URL.
Sledování přesměrování	followRedirects		boolean	Zda se mají sledovat přesměrování.
Přeskočit SSL	skipSSL		boolean	Jestli se má protokol SSL přeskočit.
Body	body		string	Tělo.
Typ karoserie	bodyType		string	Typ těla.
Key	key	True	string	Klíč.
Hodnota	value	True	string	Hodnota.
Uzamčeno	locked		boolean	Zda je uzamčeno.
Zdroj	source		string	Zdroj.
Vlastnictví	property		string	Vlastnost.
Comparison	comparison		string	Porovnání.
Target	target		string	Cíl.
Uživatelské jméno	username	True	string	Uživatelské jméno.
Heslo	password	True	string	Heslo.
Četnost	frequency		integer	Jak často se má kontrola spouštět v minutách.
Id fragmentu kódu pro roztrhání	tearDownSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odstranění kontroly rozhraní API.
ID fragmentu kódu instalace	setupSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API.
Posun frekvence	frequencyOffset		integer	Používá se pro nastavení sekund pro kontroly četností pod 1 minutami a šíření kontrol v časovém rozsahu četností přes 1 minutu. Funguje takto: Kontroly s frekvencí 0 mohou mít frekvenciOffset 10, 20 nebo 30, což znamená, že se spustí každých 10, 20 nebo 30 sekund. Kontroly s frekvencí nižší než a rovnou 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.floor(frekvence * 10), tj. kontrola spuštění každých 5 minut, maximální frekvenceOffset je 50. Kontroly s frekvencí vyšší než 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.ceil(frequency / 60), tj. při kontrole, která se spouští každých 720 minut, maximální frekvenceOffset je 12.
Místní instalační skript	localSetupScript		string	Platný kód Node.js ke spuštění ve fázi instalace.
Místní roztrhání skriptu	localTearDownScript		string	Platný kód Node.js, který se má spustit ve fázi odstranění.
Degradovaná doba odezvy	degradedResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za degradovanou.
Maximální doba odezvy	maxResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za selhání.
Privátní umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.

Návraty

Body

CheckAPI

Aktualizace odběrů kanálu upozornění

ID operace:

PutV1AlertchannelsIdSubscriptions

Aktualizujte odběry kanálu upozornění. Tato možnost slouží k přidání kontroly do kanálu upozornění, aby se pro tuto kontrolu odesílala upozornění na selhání a obnovení. Poznámka: Při předávání objektu předplatného můžete zadat pouze checkId nebo groupId, nikoli obojí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.
Kontrola ID	checkId		guid	Můžete buď předat checkId, nebo id skupiny, ale ne obojí.
ID skupiny	groupId		number	Můžete buď předat checkId, nebo id skupiny, ale ne obojí.
Aktivovaný	activated	True	boolean	Zda je aktivováno.

Návraty

Body

AlertChanelSubscription

Aktualizace privátního umístění

ID operace:

PutV1PrivatelocationsId

Aktualizuje privátní umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.
Název	name	True	string	Název přiřazený k privátnímu umístění.
Ikona	icon		string	Ikona.

Návraty

Body

commonPrivateLocationSchemaResponse

Aktualizace proměnné prostředí

ID operace:

PutV1VariablesKey

Aktualizuje proměnnou prostředí. Použije pole klíče jako identifikátor pro aktualizaci. Aktualizuje pouze hodnotu a uzamčenou vlastnost.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Key	key	True	string	Klíč.
Key	key		string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.

Návraty

Body

EnvironmentVariable

Aktualizace časového období údržby

ID operace:

PutV1MaintenancewindowsId

Aktualizuje časové období údržby.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.
Název	name	True	string	Název časového období údržby.
Seznam značek časového období údržby	tags		array of string	Názvy kontrol a skupinových časových období údržby by se měly vztahovat na.
Začíná na	startsAt	True	date	Počáteční datum časového období údržby.
Končí na	endsAt	True	date	Koncové datum časového období údržby.
Interval opakování	repeatInterval		number	Interval opakování časového období údržby od prvního výskytu.
Opakovat jednotku	repeatUnit	True	string	Strategie opakování pro časové období údržby.
Opakování končí na	repeatEndsAt		date	Koncové datum, kdy by se mělo časové období údržby přestat opakovat.

Návraty

Body

MaintenanceWindow

Aktualizace řídicího panelu

ID operace:

PutV1DashboardsDashboardid

Aktualizuje řídicí panel. Vrátí chybu 409 při pokusu o vytvoření řídicího panelu s vlastní adresou URL nebo vlastní doménou, která už byla přijata.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	dashboardId	True	string	Identifikátor řídicího panelu.
Vlastní adresa URL	customUrl		string	Název subdomény pod checklyhq.com. Musí být jedinečný pro všechny uživatele.
Custom Domain	customDomain		string	Vlastní doména uživatele, například status.example.com. Podívejte se na dokumentaci k aktualizaci využití DNS a SSL.
Logo	logo		string	Adresa URL odkazující na soubor obrázku
Favicon	favicon		string	Adresa URL odkazující na soubor obrázku použitý jako favicon řídicího panelu
Link	link		string	Odkaz na adresu URL pro přesměrování při kliknutí na logo řídicího panelu.
Header	header		string	Část textu zobrazená v horní části řídicího panelu
Description	description		string	Část textu zobrazená pod záhlavím nebo názvem řídicího panelu
Šířka	width		string	Určuje, zda se má použít celá obrazovka nebo fokus uprostřed.
Obnovovací frekvence	refreshRate		number	Jak často se má řídicí panel aktualizovat během několika sekund.
Stránkovat	paginate		boolean	Určuje, jestli je stránkování zapnuté nebo vypnuté.
Frekvence stránkování	paginationRate		number	Jak často se stránkování spouští v sekundách.
Kontroly na stránku	checksPerPage		number	Počet kontrol zobrazených na stránce
Použití a operátor	useTagsAndOperator		boolean	Kdy použít operátor AND pro vyhledávání značek.
Skrýt značky	hideTags		boolean	Umožňuje zobrazit nebo skrýt značky na řídicím panelu.
Seznam značek řídicího panelu	tags		array of string	Seznam jedné nebo více značek, které filtruje, které se mají zobrazit na řídicím panelu.

Návraty

Body

Dashboard

Načtení fragmentu kódu

ID operace:

GetV1SnippetsId

Zobrazí podrobnosti o konkrétním fragmentu kódu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Návraty

Body

Snippet

Načtení jedné vrácení se změnami v konkrétní skupině s použitým nastavením skupiny

ID operace:

GetV1CheckgroupsGroupidChecksCheckid

Umožňuje zobrazit podrobnosti o jedné skupině vrácení se změnami s použitým nastavením skupiny.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupId	True	integer	Identifikátor skupiny.
Kontrola ID	checkId	True	string	Identifikátor kontroly.

Návraty

Body

CheckGroupCheck

Načtení kanálu upozornění

ID operace:

GetV1AlertchannelsId

Umožňuje zobrazit podrobnosti o konkrétním kanálu upozornění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Návraty

Body

AlertChannel

Načtení kontrolní skupiny

ID operace:

GetV1CheckgroupsId

Umožňuje zobrazit podrobnosti o konkrétní skupině kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Návraty

Body

CheckGroup

Načtení kontroly

ID operace:

GetV1ChecksId

Zobrazení podrobností o konkrétním rozhraní API nebo kontrole prohlížeče

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.

Návraty

Body

Check

Načtení podrobností o stavu kontroly

ID operace:

GetV1CheckstatusesCheckid

Umožňuje zobrazit aktuální informace o stavu pro konkrétní kontrolu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.

Návraty

Body

CheckStatus

Načtení privátního umístění

ID operace:

GetV1PrivatelocationsId

Umožňuje zobrazit podrobnosti o konkrétním privátním umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.

Návraty

Body

privatelocationschema

Načtení proměnné prostředí

ID operace:

GetV1VariablesKey

Umožňuje zobrazit podrobnosti o konkrétní proměnné prostředí. Použije pole klíče pro výběr.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Key	key	True	string	Klíč.

Návraty

Body

EnvironmentVariable

Načtení výsledku kontroly

ID operace:

GetV1CheckresultsCheckidCheckresultid

Umožňuje zobrazit podrobnosti o konkrétním výsledku kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.
Kontrola ID výsledku	checkResultId	True	string	Identifikátor výsledku kontroly.

Návraty

Body

CheckResult

Načtení časového období údržby

ID operace:

GetV1MaintenancewindowsId

Umožňuje zobrazit podrobnosti o konkrétním časovém období údržby.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Návraty

Body

MaintenanceWindow

Načtenívšechch

ID operace:

GetV1CheckgroupsIdChecks

Zobrazí seznam všech kontrol v konkrétní skupině kontroly s použitým nastavením skupiny.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.

Návraty

Položky

Model8

Odebrání existujícího klíče rozhraní API pro privátní umístění

ID operace:

DeleteV1PrivatelocationsIdKeysKeyid

Trvale odebere klíč rozhraní API z privátního umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.
ID klíče	keyId	True	string	Identifikátor klíče.

Odebrání privátního umístění

ID operace:

DeleteV1PrivatelocationsId

Trvale odebere soukromé umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.

Odstranění fragmentu kódu

ID operace:

DeleteV1SnippetsId

Trvale odebere fragment kódu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Odstranění kanálu upozornění

ID operace:

DeleteV1AlertchannelsId

Trvale odebere kanál upozornění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Odstranění kontroly

ID operace:

DeleteV1ChecksId

Trvale odebere kontrolu rozhraní API nebo prohlížeče a všechna související data o stavu a výsledcích.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.

Odstranění proměnné prostředí

ID operace:

DeleteV1VariablesKey

Trvale odebere proměnnou prostředí. Použije pole klíče jako identifikátor pro odstranění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Key	key	True	string	Klíč.

Odstranění skupiny zaškrtnutí

ID operace:

DeleteV1CheckgroupsId

Trvale odebere skupinu kontroly. Skupinu kontroly nelze odstranit, pokud stále obsahuje kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Odstranění triggeru kontrolní skupiny

ID operace:

DeleteV1TriggersCheckgroupsGroupid

Odstraní trigger kontrolních skupin.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupId	True	integer	Identifikátor skupiny.

Odstranění triggeru kontroly

ID operace:

DeleteV1TriggersChecksCheckid

Odstraní trigger kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.

Odstranění časového období údržby

ID operace:

DeleteV1MaintenancewindowsId

Trvale odebere časové období údržby.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	integer	Identifikátor.

Odstraňte řídicí panel

ID operace:

DeleteV1DashboardsDashboardid

Trvale odebere řídicí panel.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	dashboardId	True	string	Identifikátor řídicího panelu.

Odznak Získání stavu skupiny

ID operace:

GetV1BadgesGroupsGroupid

Získejte odznak stavu skupiny.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupId	True	integer	Identifikátor skupiny.
Styl	style		string	Styl.
Theme	theme		string	Motiv.
Doba odezvy	responseTime		boolean	Doba odezvy.

Návraty

response

string

Odznáček Získat stav kontroly

ID operace:

GetV1BadgesChecksCheckid

Získejte odznáček stavu kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.
Styl	style		string	Styl.
Theme	theme		string	Motiv.
Doba odezvy	responseTime		boolean	Doba odezvy.

Návraty

response

string

Vygenerování nového klíče rozhraní API pro privátní umístění

ID operace:

PostV1PrivatelocationsIdKeys

Vytvoří klíč rozhraní API v privátním umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.

Návraty

Body

privateLocationKeys

Vygeneruje přizpůsobitelnou sestavu pro všechny metriky kontroly prohlížeče.

ID operace:

GetV2ReportingBrowserchecksId

Vygeneruje sestavu s agregovanými nebo neagregovanými statistikami pro konkrétní kontrolu prohlížeče v zadaném časovém intervalu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.
Od	from		date	Vlastní počáteční čas okna generování sestav ve formátu časového razítka unixu Nastavení vlastního časového razítka přepíše použití libovolné přednastavenéwindow.
To	to		date	Vlastní koncový čas okna generování sestav ve formátu časového razítka unixu Nastavení vlastního časového razítka přepíše použití libovolné přednastavenéwindow.
Přednastavené okno	presetWindow		string	Přednastavená okna generování sestav se používají k rychlému generování sestav v běžně používaných oknech. Lze přepsat pomocí vlastního razítka a z časového razítka.
Interval agregace	aggregationInterval		number	Časový interval, který se má použít pro agregaci metrik v minutách. Například pět minut je 300, 24 hodin je 1440.
Seskupit podle	groupBy		string	Určuje, jak se data řad seskupují.
Filtrovat podle stavu	filterByStatus		array	Pomocí stavu můžete filtrovat data neúspěšných nebo úspěšných výsledků kontroly.
Metrics	metrics		array	možnosti metrik pro kontroly prohlížeče

Návraty

Atributy.

Attributes

object

Vygeneruje sestavu s agregovanými statistikami pro kontroly a skupiny kontrol.

ID operace:

GetV1Reporting

Generuje sestavu s agregovanými statistikami pro všechny kontroly nebo filtrovanou sadu kontrol v zadaném časovém intervalu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Od	from		date	Vlastní počáteční čas okna generování sestav ve formátu časového razítka unixu Nastavení vlastního časového razítka přepíše použití libovolné přednastavenéwindow.
To	to		date	Vlastní koncový čas okna generování sestav ve formátu časového razítka unixu Nastavení vlastního časového razítka přepíše použití libovolné přednastavenéwindow.
Přednastavené okno	presetWindow		string	Přednastavená okna generování sestav se používají k rychlému generování sestav v běžně používaných oknech. Lze přepsat pomocí vlastního razítka a z časového razítka.
Filtrovat podle značek	filterByTags		array	Pomocí značek můžete filtrovat kontroly, které chcete zobrazit v sestavě.
Deaktivováno	deactivated		boolean	Filtruje kontroly podle aktivovaného stavu.

Návraty

Položky

ReportingList

Vytvoření fragmentu kódu

ID operace:

PostV1Snippets

Vytvoří nový fragment kódu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název	name	True	string	Název fragmentu kódu
Script	script	True	string	Váš Node.js kód, který komunikuje s životním cyklem kontroly rozhraní API, nebo funguje jako částečná kontrola prohlížeče.

Návraty

Body

Snippet

Vytvoření kanálu upozornění

ID operace:

PostV1Alertchannels

Vytvoří nový kanál upozornění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id		number	Identifikátor.
Kontrola ID	checkId		guid	Identifikátor kontroly.
ID skupiny	groupId		number	Identifikátor skupiny.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
Typ	type	True	string	Typ.
Konfigurace vytvoření kanálu upozornění	config	True	object	Konfigurace vytvoření kanálu upozornění.
Odeslat obnovení	sendRecovery		boolean	Určuje, jestli se má odeslat obnovení.
Selhání odeslání	sendFailure		boolean	Určuje, jestli došlo k chybě odeslání.
Snížení výkonu při odesílání	sendDegraded		boolean	Určuje, jestli je odesílání degradované.
Vypršení platnosti PROTOKOLU SSL	sslExpiry		boolean	Určuje, jestli má být odeslána výstraha pro vypršení platnosti certifikátů SSL.
Prahová hodnota vypršení platnosti protokolu SSL	sslExpiryThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.

Návraty

Body

AlertChannel

Vytvoření kontrolní skupiny

ID operace:

PostV1Checkgroups

Vytvoří novou skupinu kontroly. Do skupiny můžete přidat kontroly nastavením vlastnosti groupId jednotlivých kontrol.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name	True	string	Název skupiny kontroly.
Aktivovaný	activated		boolean	Určuje, jestli jsou kontroly ve skupině spuštěné nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se některá oznámení odesílají, když selže vrácení se změnami v této skupině nebo se obnoví.
Kontrola seznamu značek skupiny	tags		array of string	Značky pro uspořádání a filtrování kontrol
Kontrola seznamu umístění skupiny	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se mají kontroly spouštět.
Souběžnost	concurrency		number	Určuje, kolik kontrol se vyvolá souběžně při aktivaci skupiny kontroly z CI/CD nebo prostřednictvím rozhraní API.
URL	url		string	Základní adresa URL pro tuto skupinu, na kterou můžete odkazovat s proměnnou {{GROUP_BASE_URL}} ve všech kontrolách skupin.
Key	key	True	string	Klíč.
Hodnota	value	True	string	Hodnota.
Uzamčeno	locked		boolean	Zda je uzamčeno.
Zdroj	source		string	Zdroj.
Vlastnictví	property		string	Vlastnost.
Comparison	comparison		string	Porovnání.
Target	target		string	Cíl.
Uživatelské jméno	username	True	string	Uživatelské jméno.
Heslo	password	True	string	Heslo.
Kontrola výchozích hodnot pro vytváření skupin v prohlížeči	browserCheckDefaults		object	Ve skupině kontroly se vytvoří výchozí nastavení prohlížeče.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provádění kontrol v této skupině.
Key	key	True	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované pro tuto skupinu kontroly.
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
ID fragmentu kódu instalace	setupSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API v této skupině.
Id fragmentu kódu pro roztrhání	tearDownSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odtrhání kontroly rozhraní API v této skupině.
Místní instalační skript	localSetupScript		string	Platný kód Node.js, který se má spustit ve fázi instalace kontroly rozhraní API v této skupině.
Místní roztrhání skriptu	localTearDownScript		string	Platný kód Node.js, který se má spustit ve fázi odstranění kontroly rozhraní API v této skupině.
Kontrola privátních umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se mají kontroly spouštět.

Návraty

Body

CheckGroup

Vytvoření kontroly [ZASTARALÉ]

ID operace:

PostV1Checks

[ZASTARALÉ] Tento koncový bod bude odebrán 4. července 2022. Místo toho použijte POST /checks/api nebo POST /checks/browser. Vytvoří nové rozhraní API nebo kontrolu prohlížeče. Vrátí, 402 když jste nad limitem plánu. Při použití globalAlertSettings, alertSettings může být null

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name	True	string	Název kontroly.
Aktivovaný	activated	True	boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail		boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags		array of string	Značky pro uspořádání a filtrování kontrol
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId		number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder		number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
Kontrola typu	checkType	True	string	Typ kontroly.
Četnost	frequency		integer	Jak často se má kontrola spouštět v minutách.
Posun frekvence	frequencyOffset		integer	Používá se pro nastavení sekund pro četnost kontroly pod 1 minutami (pouze pro kontroly rozhraní API) a šíření kontrol v časovém rozsahu četností přes 1 minutu. Funguje takto: Kontroly s frekvencí 0 mohou mít frekvenciOffset 10, 20 nebo 30, což znamená, že se spustí každých 10, 20 nebo 30 sekund. Kontroly s frekvencí nižší než a rovnou 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.floor(frekvence * 10), tj. kontrola spuštění každých 5 minut, maximální frekvenceOffset je 50. Kontroly s frekvencí vyšší než 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.ceil(frequency / 60), tj. při kontrole, která se spouští každých 720 minut, maximální frekvenceOffset je 12.
Kontrola žádosti	request		object	Žádost o kontrolu.
Script	script	True	string	Skript.
Key	key	True	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.
ID fragmentu kódu instalace	setupSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API.
Id fragmentu kódu pro roztrhání	tearDownSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odstranění kontroly rozhraní API.
Místní instalační skript	localSetupScript		string	Platný kód Node.js ke spuštění ve fázi instalace.
Místní roztrhání skriptu	localTearDownScript		string	Platný kód Node.js, který se má spustit ve fázi odstranění.
Degradovaná doba odezvy	degradedResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za degradovanou.
Maximální doba odezvy	maxResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za selhání.
Privátní umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.

Návraty

Body

Check

Vytvoření kontroly prohlížeče

ID operace:

PostV1ChecksBrowser

Vytvoří novou kontrolu prohlížeče. Vrátí, 402 když jste nad limitem plánu. Při použití globalAlertSetting, alertSetting může být null

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name	True	string	Název kontroly.
Aktivovaný	activated	True	boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail		boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags		array of string	Značky pro uspořádání a filtrování kontrol
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId		number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder		number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
Key	key	True	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.
Četnost	frequency		integer	Jak často se má kontrola spouštět v minutách.
Script	script	True	string	Platný kód Node.js javascriptu popisující interakci prohlížeče s architekturou Puppeteer nebo Playwright.
Privátní umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.

Návraty

Body

CheckBrowser

Vytvoření kontroly rozhraní API

ID operace:

PostV1ChecksApi

Vytvoří novou kontrolu rozhraní API. Vrátí, 402 když jste nad limitem plánu. Při použití globalAlertSetting, alertSetting může být null

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Automatické přiřazování výstrah	autoAssignAlerts		boolean	Určuje, jestli se nová kontrola při vytváření automaticky přidá jako odběratel do všech existujících kanálů upozornění.
Název	name	True	string	Název kontroly.
Aktivovaný	activated	True	boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted		boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck		boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail		boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations		array of string	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags		array of string	Značky pro uspořádání a filtrování kontrol
Typ eskalace	escalationType		string	Určuje, jaký typ eskalace se má použít.
Prahová hodnota neúspěšného spuštění	failedRunThreshold		number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.
Minuta selhává prahová hodnota	minutesFailingThreshold		number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.
Množství	amount		number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval		number	V jakém intervalu mají být připomenutí odeslána.
Enabled	enabled		boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold		integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
Použití globálního nastavení upozornění	useGlobalAlertSettings		boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId		number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder		number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId		string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
ID kanálu upozornění	alertChannelId	True	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	True	boolean	Zda je aktivováno.
metoda	method	True	string
URL	url	True	string	Adresa URL.
Sledování přesměrování	followRedirects		boolean	Zda následuje přesměrování.
Přeskočit SSL	skipSSL		boolean	Jestli se má protokol SSL přeskočit.
Body	body		string	Tělo.
bodyType	bodyType		string
Key	key	True	string	Klíč.
Hodnota	value	True	string	Hodnota.
Uzamčeno	locked		boolean	Zda je uzamčeno.
Zdroj	source		string	Zdroj.
Vlastnictví	property		string	Vlastnost.
Comparison	comparison		string	Porovnání.
Target	target		string	Cíl.
Uživatelské jméno	username	True	string	Uživatelské jméno.
Heslo	password	True	string	Heslo.
Četnost	frequency		integer	Jak často se má kontrola spouštět v minutách.
Id fragmentu kódu pro roztrhání	tearDownSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odstranění kontroly rozhraní API.
ID fragmentu kódu instalace	setupSnippetId		number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API.
Posun frekvence	frequencyOffset		integer	Používá se pro nastavení sekund pro kontroly četností pod 1 minutami a šíření kontrol v časovém rozsahu četností přes 1 minutu. Funguje takto: Kontroly s frekvencí 0 mohou mít frekvenciOffset 10, 20 nebo 30, což znamená, že se spustí každých 10, 20 nebo 30 sekund. Kontroly s frekvencí nižší než a rovnou 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.floor(frekvence * 10), tj. kontrola spuštění každých 5 minut, maximální frekvenceOffset je 50. Kontroly s frekvencí vyšší než 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.ceil(frequency / 60), tj. při kontrole, která se spouští každých 720 minut, maximální frekvenceOffset je 12.
Místní instalační skript	localSetupScript		string	Platný kód Node.js ke spuštění ve fázi instalace.
Místní roztrhání skriptu	localTearDownScript		string	Platný kód Node.js, který se má spustit ve fázi odstranění.
Degradovaná doba odezvy	degradedResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za degradovanou.
Maximální doba odezvy	maxResponseTime		number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za selhání.
Privátní umístění	privateLocations		array of string	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.

Návraty

Body

CheckAPI

Vytvoření privátního umístění

ID operace:

PostV1Privatelocations

Vytvoří nové privátní umístění.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název	name	True	string	Název přiřazený k privátnímu umístění.
Název slug	slugName	True	string	Platný název slug.
Ikona	icon		string	Ikona.

Návraty

Body

commonPrivateLocationSchemaResponse

Vytvoření proměnné prostředí

ID operace:

PostV1Variables

Vytvoří novou proměnnou prostředí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Key	key	True	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	True	string	Hodnota proměnné prostředí.
Uzamčeno	locked		boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.

Návraty

Body

EnvironmentVariable

Vytvoření triggeru kontrolní skupiny

ID operace:

PostV1TriggersCheckgroupsGroupid

Vytvoří trigger skupiny kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupId	True	integer	Identifikátor skupiny.

Návraty

Body

CheckGroupTrigger

Vytvoření triggeru kontroly

ID operace:

PostV1TriggersChecksCheckid

Vytvoří trigger kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.

Návraty

Body

CheckTrigger

Vytvoření časového období údržby

ID operace:

PostV1Maintenancewindows

Vytvoří nové časové období údržby.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název	name	True	string	Název časového období údržby.
Seznam značek časového období údržby	tags		array of string	Názvy kontrol a skupinových časových období údržby by se měly vztahovat na.
Začíná na	startsAt	True	date	Počáteční datum časového období údržby.
Končí na	endsAt	True	date	Koncové datum časového období údržby.
Interval opakování	repeatInterval		number	Interval opakování časového období údržby od prvního výskytu.
Opakovat jednotku	repeatUnit	True	string	Strategie opakování pro časové období údržby.
Opakování končí na	repeatEndsAt		date	Koncové datum, kdy by se mělo časové období údržby přestat opakovat.

Návraty

Body

MaintenanceWindow

Vytvoření řídicího panelu

ID operace:

PostV1Dashboards

Vytvoří nový řídicí panel. Vrátí chybu 409 při pokusu o vytvoření řídicího panelu s vlastní adresou URL nebo vlastní doménou, která už byla přijata.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Vlastní adresa URL	customUrl		string	Název subdomény pod checklyhq.com. Musí být jedinečný pro všechny uživatele.
Custom Domain	customDomain		string	Vlastní doména uživatele, například status.example.com. Podívejte se na dokumentaci k aktualizaci využití DNS a SSL.
Logo	logo		string	Adresa URL odkazující na soubor obrázku
Favicon	favicon		string	Adresa URL odkazující na soubor obrázku použitý jako favicon řídicího panelu
Link	link		string	Odkaz na adresu URL pro přesměrování při kliknutí na logo řídicího panelu.
Header	header		string	Část textu zobrazená v horní části řídicího panelu
Description	description		string	Část textu zobrazená pod záhlavím nebo názvem řídicího panelu
Šířka	width		string	Určuje, zda se má použít celá obrazovka nebo fokus uprostřed.
Obnovovací frekvence	refreshRate		number	Jak často se má řídicí panel aktualizovat během několika sekund.
Stránkovat	paginate		boolean	Určuje, jestli je stránkování zapnuté nebo vypnuté.
Frekvence stránkování	paginationRate		number	Jak často se stránkování spouští v sekundách.
Kontroly na stránku	checksPerPage		number	Počet kontrol zobrazených na stránce
Použití a operátor	useTagsAndOperator		boolean	Kdy použít operátor AND pro vyhledávání značek.
Skrýt značky	hideTags		boolean	Umožňuje zobrazit nebo skrýt značky na řídicím panelu.
Seznam značek řídicího panelu	tags		array of string	Seznam jedné nebo více značek, které filtruje, které se mají zobrazit na řídicím panelu.

Návraty

Body

Dashboard

Výpis všech fragmentů kódu

ID operace:

GetV1Snippets

Zobrazí seznam všech aktuálních fragmentů kódu ve vašem účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.

Návraty

Položky

SnippetList

Výpis všech kanálů upozornění

ID operace:

GetV1Alertchannels

Zobrazí seznam všech nakonfigurovaných kanálů upozornění a jejich odebíraných kontrol.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.

Návraty

Položky

AlertChannelList

Výpis všech kontrolních skupin

ID operace:

GetV1Checkgroups

Zobrazí seznam všech aktuálních kontrolních skupin ve vašem účtu. Vlastnost checks je pole identifikátoru UUID kontroly pro pohodlné odkazování. Je jen pro čtení a nemůžete ji použít k přidání kontrol do skupiny.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.

Návraty

Položky

CheckGroupList

Výpis všech privátních umístění

ID operace:

GetV1Privatelocations

Zobrazí seznam všech privátních umístění ve vašem účtu.

Návraty

Položky

privateLocationsListSchema

Výpis všech proměnných prostředí

ID operace:

GetV1Variables

Zobrazí seznam všech aktuálních proměnných prostředí ve vašem účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.

Návraty

Položky

EnvironmentVariableList

Výpis všech upozornění pro váš účet

ID operace:

GetV1Checkalerts

Zobrazí seznam všech upozornění pro váš účet.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.
Od	from		date	Vyberte dokumenty z tohoto časového razítka systému UNIX (>= datum). Výchozí hodnota je teď – 6 hodin.
To	to		date	Vyberte výstrahy až do tohoto časového razítka systému UNIX (< datum). Výchozí hodnota je 6 hodin od.

Návraty

Položky

CheckAlertList

Výpis všech řídicích panelů

ID operace:

GetV1Dashboards

Zobrazí seznam všech aktuálních řídicích panelů ve vašem účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.

Návraty

Položky

DashboardsList

Zobrazení seznamu výstrah pro konkrétní kontrolu

ID operace:

GetV1CheckalertsCheckid

Zobrazí seznam všech výstrah pro konkrétní kontrolu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.
Od	from		date	Vyberte dokumenty z tohoto časového razítka systému UNIX (>= datum). Výchozí hodnota je teď – 6 hodin.
To	to		date	Vyberte výstrahy až do tohoto časového razítka systému UNIX (< datum). Výchozí hodnota je 6 hodin od.

Návraty

Položky

CheckAlertList

Zobrazit seznam všech kontrol

ID operace:

GetV1Checks

Zobrazí seznam všech aktuálních kontrol ve vašem účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.
Filtr adresy URL pro kontrolu rozhraní API	apiCheckUrlFilterPattern		string	Filtruje výsledky podle řetězce obsaženého v adrese URL kontroly rozhraní API, například domény, jako je www.myapp.com. Vrátí pouze kontroly rozhraní API.

Návraty

Položky

CheckList

Zobrazit seznam všech stavů kontroly

ID operace:

GetV1Checkstatuses

Zobrazuje aktuální informace o stavu všech kontrol ve vašem účtu. Záznamy o stavu kontroly se průběžně aktualizují, jakmile se objeví nové výsledky kontroly.

Návraty

Položky

CheckStatusList

Zobrazit seznam všech časových období údržby

ID operace:

GetV1Maintenancewindows

Zobrazí seznam všech časových období údržby ve vašem účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.

Návraty

Seznam časových období údržby.

Položky

MaintenanceWindowList

Zobrazuje podrobnosti pro jeden konkrétní modul runtime.

ID operace:

GetV1RuntimesId

Zobrazuje podrobnosti o všech zahrnutých balíčcích NPM a jejich verzi pro jeden konkrétní modul runtime.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.

Návraty

Body

Runtime

Zobrazí seznam všech podporovaných modulů runtime.

ID operace:

GetV1Runtimes

Zobrazí seznam všech podporovaných modulů runtime a zahrnutých balíčků NPM pro kontroly prohlížeče a nastavení a skripty pro kontroly rozhraní API.

Návraty

Položky

RuntimeList

Zobrazí seznam všech podporovaných umístění.

ID operace:

GetV1Locations

Zobrazí seznam všech podporovaných umístění.

Návraty

Položky

LocationList

Zobrazí seznam všech výsledků kontroly.

ID operace:

GetV1CheckresultsCheckid

Zobrazí seznam úplných nezpracovaných výsledků kontroly konkrétní kontroly. Nezpracované výsledky uchováváme po dobu 30 dnů. Po 30 dnech se vymažou. Souhrnné výsledky ale udržujeme po neomezenou dobu. Pokud chcete seznam zúžit, můžete filtrovat podle typu zaškrtnutí a typu výsledku. to Pomocí parametrů zadejte from rozsah dat (časové razítko systému UNIX v sekundách). V závislosti na typu kontroly můžou být některá pole null. Tento koncový bod vrátí data do šestihodinového časového rámce. Pokud jsou nastaveny parametry od a do parametrů, musí být maximálně šest hodin od sebe. Pokud nejsou nastaveny žádné, budeme uvažovat o parametru, který má být nyní a z parametru bude šest hodin dříve. Pokud je nastavena pouze hodnota parametru, nastavíme hodnotu od šesti hodin dříve. Naopak, pokud je nastavena pouze z paramu, budeme uvažovat o param, aby byl šest hodin později. U tohoto koncového bodu se uplatňuje omezování rychlosti, maximálně můžete odesílat 5 požadavků / 10 sekund.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.
Omezení	limit		integer	Omezte počet výsledků.
Number	page		number	Číslo stránky.
Od	from		date	Vyberte dokumenty z tohoto časového razítka systému UNIX (>= datum). Výchozí hodnota je teď – 6 hodin.
To	to		date	Vyberte výstrahy až do tohoto časového razítka systému UNIX (< datum). Výchozí hodnota je 6 hodin od.
Umístění	location		string	Zadejte umístění datového centra, například eu-west-1, abyste mohli filtrovat podle umístění.
Kontrola typu	checkType		string	Typ kontroly.
Došlo k chybám	hasFailures		boolean	Výsledek kontroly má jednu nebo více selhání.

Návraty

Položky

CheckResultList

Získání metrik stavu privátního umístění z časového intervalu

ID operace:

GetV1PrivatelocationsIdMetrics

Získání metrik stavu privátního umístění z časového intervalu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID	id	True	string	Identifikátor.
Od	from	True	date	Vyberte metriky začínající tímto časovým razítkem systému UNIX. Musí to být před 15 dny.
To	to	True	date	Vyberte metriky až do tohoto časového razítka systému UNIX.

Návraty

Body

privateLocationsMetricsHistoryResponseSchema

Získání triggeru kontrolní skupiny

ID operace:

GetV1TriggersCheckgroupsGroupid

Vyhledá trigger skupiny kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID skupiny	groupId	True	integer	Identifikátor skupiny.

Návraty

Body

CheckGroupTrigger

Získání triggeru kontroly

ID operace:

GetV1TriggersChecksCheckid

Vyhledá aktivační událost kontroly.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Kontrola ID	checkId	True	string	Identifikátor kontroly.

Návraty

Body

CheckTrigger

Definice

AlertChannelConfig

Konfigurace kanálu upozornění.

Name	Cesta	Typ	Description
Konfigurace kanálu upozornění		object	Konfigurace kanálu upozornění.

AlertChanelSubscription

Name	Cesta	Typ	Description
ID	id	number	Identifikátor.
Kontrola ID	checkId	guid	Identifikátor kontroly.
ID skupiny	groupId	number	Identifikátor skupiny.
Aktivovaný	activated	boolean	Zda je aktivováno.

AlertChanelSubscriptionList

Všechny kontroly se přihlásí k odběru tohoto kanálu.

Name	Cesta	Typ	Description
Položky		AlertChanelSubscription

AlertChannel

Name	Cesta	Typ	Description
ID	id	number	Identifikátor.
Typ	type	string	Typ kanálu upozornění, tj. E-MAIL nebo SLACK.
Konfigurace kanálu upozornění	config	AlertChannelConfig	Konfigurace kanálu upozornění.
Seznam odběrů kanálu upozornění	subscriptions	AlertChanelSubscriptionList	Všechny kontroly se přihlásí k odběru tohoto kanálu.
Odeslat obnovení	sendRecovery	boolean	Určuje, jestli se má odeslat obnovení.
Selhání odeslání	sendFailure	boolean	Určuje, jestli došlo k chybě odeslání.
Snížení výkonu při odesílání	sendDegraded	boolean	Určuje, jestli je odesílání degradované.
Vypršení platnosti PROTOKOLU SSL	sslExpiry	boolean	Určuje, jestli má být odeslána výstraha pro vypršení platnosti certifikátů SSL.
Prahová hodnota vypršení platnosti protokolu SSL	sslExpiryThreshold	integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.
Vytvořeno na adrese	created_at	date-time	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

AlertChannelList

Name	Cesta	Typ	Description
Položky		AlertChannel

CheckAlert

Name	Cesta	Typ	Description
ID	id	string	Jedinečný identifikátor této výstrahy.
Název	name	string	Název kontroly.
Kontrola ID	checkId	string	Identifikátor kontroly, do které tato výstraha patří.
Typ upozornění	alertType	string	Typ výstrahy.
Kontrola typu	checkType	string	Typ kontroly.
Umístění spuštění	runLocation	string	Z jakého umístění datového centra se toto upozornění kontroly aktivovalo.
Doba odezvy	responseTime	number	Popisuje dobu, kterou trvalo provedení relevantních částí této kontroly. Systémový čas časovače instalace potřebný ke spuštění této kontroly v back-endu Checkly není součástí tohoto příkazu.
Error	error	string	Všechny konkrétní chybové zprávy, které byly součástí neúspěšné kontroly, které aktivovaly výstrahu.
Kód stavu	statusCode	string	Stavový kód odpovědi. Platí jenom pro kontroly rozhraní API.
Vytvořeno na adrese	created_at	date	Datum a čas vytvoření tohoto upozornění kontroly
Spuštěno na adrese	startedAt	date	Datum a čas, kdy byla tato výstraha kontroly zahájena.

Kontrolní seznam

Name	Cesta	Typ	Description
Položky		CheckAlert

CheckGroupTagList

Značky pro uspořádání a filtrování kontrol

Name	Cesta	Typ	Description
Položky		string

CheckGroupLocationList

Pole jednoho nebo více umístění datacentra, kde se mají kontroly spouštět.

Name	Cesta	Typ	Description
Položky		string

KeyValue

Name	Cesta	Typ	Description
Key	key	string	Klíč.
Hodnota	value	string	Hodnota.
Uzamčeno	locked	boolean	Zda je uzamčeno.

HeaderList

Name	Cesta	Typ	Description
Položky		KeyValue

QueryParameterList

Name	Cesta	Typ	Description
Položky		KeyValue

Tvrzení

Name	Cesta	Typ	Description
Zdroj	source	string	Zdroj.
Vlastnictví	property	string	Vlastnost.
Comparison	comparison	string	Porovnání.
Target	target	string	Cíl.

AssertionList

Projděte si hlavní dokumentaci k kontrolním výrazům pro konkrétní hodnoty, jako jsou regulární výrazy a popisovače cest JSON, které můžete použít v poli vlastnosti.

Name	Cesta	Typ	Description
Položky		Assertion

BasicAuth

Name	Cesta	Typ	Description
Uživatelské jméno	username	string	Uživatelské jméno.
Heslo	password	string	Heslo.

CheckGroupAPICheckDefaults

Name	Cesta	Typ	Description
URL	url	string	Základní adresa URL pro tuto skupinu, na kterou můžete odkazovat s proměnnou {{GROUP_BASE_URL}} ve všech kontrolách skupin.
headers	headers	HeaderList
parametry dotazu	queryParameters	QueryParameterList
Seznam kontrolních výrazů	assertions	AssertionList	Projděte si hlavní dokumentaci k kontrolním výrazům pro konkrétní hodnoty, jako jsou regulární výrazy a popisovače cest JSON, které můžete použít v poli vlastnosti.
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

Ve výchozím nastavení zkontrolujte, jestli prohlížeč skupiny kontroluje výchozí hodnoty.

Name	Cesta	Typ	Description
Kontrola výchozích hodnot prohlížeče skupin		object	Ve výchozím nastavení zkontrolujte, jestli prohlížeč skupiny kontroluje výchozí hodnoty.

EnvironmentVariable

Name	Cesta	Typ	Description
Key	key	string	Klíč proměnné prostředí (tuto hodnotu nelze změnit).
Hodnota	value	string	Hodnota proměnné prostředí.
Uzamčeno	locked	boolean	Používá se pouze v uživatelském rozhraní ke skrytí hodnoty jako heslo.

EnvironmentVariableList

Name	Cesta	Typ	Description
Položky		EnvironmentVariable

AlertSettingsRunBasedEscalation

Name	Cesta	Typ	Description
Prahová hodnota neúspěšného spuštění	failedRunThreshold	number	Po tom, kolik neúspěšných po sobě jdoucích kontrol spustí oznámení výstrahy, by se mělo odeslat.

AlertSettingsTimeBasedEscalation

Name	Cesta	Typ	Description
Minuta selhává prahová hodnota	minutesFailingThreshold	number	Po tom, kolik minut po spuštění kontroly selhává, se má odeslat upozornění.

AlertSettingsReminders

Name	Cesta	Typ	Description
Množství	amount	number	Kolik připomenutí se má odeslat po počátečním oznámení upozornění.
Rozmezí	interval	number	V jakém intervalu mají být připomenutí odeslána.

AlertSettingsSSLCertificates

[ZASTARALÉ] sslCertificates je zastaralý a už se nepoužívá. Ignorujte ho, odebere se v budoucí verzi.

Name	Cesta	Typ	Description
Enabled	enabled	boolean	Určuje, jestli se mají odesílat oznámení o upozorněních na vypršení platnosti certifikátů SSL.
Prahová hodnota upozornění	alertThreshold	integer	V jakém okamžiku začnete upozorňovat na certifikáty SSL.

CheckGroupAlertSettings

Nastavení upozornění.

Name	Cesta	Typ	Description
Typ eskalace	escalationType	string	Určuje, jaký typ eskalace se má použít.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
upomínky	reminders	AlertSettingsReminders
Nastavení upozornění – Certifikáty SSL	sslCertificates	AlertSettingsSSLCertificates	[ZASTARALÉ] sslCertificates je zastaralý a už se nepoužívá. Ignorujte ho, odebere se v budoucí verzi.

Model1

Odběr kanálu upozornění.

Name	Cesta	Typ	Description
ID kanálu upozornění	alertChannelId	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	boolean	Zda je aktivováno.

AlertChannelSubscriptionCreateList

Seznam odběrů kanálu upozornění

Name	Cesta	Typ	Description
Odběr kanálu upozornění		Model1	Odběr kanálu upozornění.

privateLocations

Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.

Name	Cesta	Typ	Description
Položky		string

CheckGroup

Name	Cesta	Typ	Description
ID	id	number	Identifikátor.
Název	name	string	Název skupiny kontroly.
Aktivovaný	activated	boolean	Určuje, jestli jsou kontroly ve skupině spuštěné nebo ne.
Ztlumený	muted	boolean	Určuje, jestli se některá oznámení odesílají, když selže vrácení se změnami v této skupině nebo se obnoví.
Kontrola seznamu značek skupiny	tags	CheckGroupTagList	Značky pro uspořádání a filtrování kontrol
Kontrola seznamu umístění skupiny	locations	CheckGroupLocationList	Pole jednoho nebo více umístění datacentra, kde se mají kontroly spouštět.
Souběžnost	concurrency	number	Určuje, kolik kontrol se vyvolá souběžně při aktivaci skupiny kontroly z CI/CD nebo prostřednictvím rozhraní API.
ApiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Kontrola výchozích hodnot prohlížeče skupin	browserCheckDefaults	CheckGroupBrowserCheckDefaults	Ve výchozím nastavení zkontrolujte, jestli prohlížeč skupiny kontroluje výchozí hodnoty.
environmentVariables	environmentVariables	EnvironmentVariableList
Překontrolovat	doubleCheck	boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Použití globálního nastavení upozornění	useGlobalAlertSettings	boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované pro tuto skupinu kontroly.
Kontrola nastavení upozornění skupiny	alertSettings	CheckGroupAlertSettings	Nastavení upozornění.
Seznam vytvoření odběru kanálu upozornění	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Seznam odběrů kanálu upozornění
ID fragmentu kódu instalace	setupSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API v této skupině.
Id fragmentu kódu pro roztrhání	tearDownSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odtrhání kontroly rozhraní API v této skupině.
Místní instalační skript	localSetupScript	string	Platný kód Node.js, který se má spustit ve fázi instalace kontroly rozhraní API v této skupině.
Místní roztrhání skriptu	localTearDownScript	string	Platný kód Node.js, který se má spustit ve fázi odstranění kontroly rozhraní API v této skupině.
Runtime ID	runtimeId	string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provádění kontrol v této skupině.
Privátní umístění	privateLocations	privateLocations	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

CheckGroupList

Name	Cesta	Typ	Description
Položky		CheckGroup

Kontrolní seznam pro polohu

Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.

Name	Cesta	Typ	Description
Položky		string

Kontrolní seznam

Značky pro uspořádání a filtrování kontrol

Name	Cesta	Typ	Description
Položky		string

CheckAlertSettings

Nastavení upozornění.

Name	Cesta	Typ	Description
Typ eskalace	escalationType	string	Určuje, jaký typ eskalace se má použít.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
upomínky	reminders	AlertSettingsReminders
Nastavení upozornění – Certifikáty SSL	sslCertificates	AlertSettingsSSLCertificates	[ZASTARALÉ] sslCertificates je zastaralý a už se nepoužívá. Ignorujte ho, odebere se v budoucí verzi.

CheckAlertChannelSubscription

Name	Cesta	Typ	Description
ID kanálu upozornění	alertChannelId	number	Identifikátor kanálu upozornění.
Aktivovaný	activated	boolean	Zda je aktivováno.

CheckAlertChannelSubscriptionList

Name	Cesta	Typ	Description
Položky		CheckAlertChannelSubscription

CheckRequest

Žádost o kontrolu.

Name	Cesta	Typ	Description
Kontrola žádosti		object	Žádost o kontrolu.

CheckEnvironmentVariableList

Páry klíč/hodnota pro nastavení proměnných prostředí během provádění kontroly. Ty jsou relevantní jenom pro kontroly prohlížeče. Kdykoli je to možné, používejte globální proměnné prostředí.

Name	Cesta	Typ	Description
Položky		EnvironmentVariable

CheckAlertEmail

Name	Cesta	Typ	Description
Address	address	string	Adresa.

CheckAlertEmailList

Name	Cesta	Typ	Description
Položky		CheckAlertEmail

Model4

Name	Cesta	Typ	Description
Položky		KeyValue

Model5

Name	Cesta	Typ	Description
Položky		KeyValue

CheckAlertWebhook

Name	Cesta	Typ	Description
Název	name	string	Název.
URL	url	string	Adresa URL.
Metoda	method	string	Metoda.
headers	headers	Model4
parametry dotazu	queryParameters	Model5

CheckAlertWebhookList

Name	Cesta	Typ	Description
Položky		CheckAlertWebhook

CheckAlertSlack

Name	Cesta	Typ	Description
URL	url	string	Adresa URL.

CheckAlertSlackList

Name	Cesta	Typ	Description
Položky		CheckAlertSlack

CheckAlertSMS

Name	Cesta	Typ	Description
Number	number	string	Číslo.
Název	name	string	Název.

CheckAlertSMSList

Name	Cesta	Typ	Description
Položky		CheckAlertSMS

CheckAlertChannels

Name	Cesta	Typ	Description
e-mail	email	CheckAlertEmailList
webhook	webhook	CheckAlertWebhookList
malátný	slack	CheckAlertSlackList
textová zpráva (sms)	sms	CheckAlertSMSList

CheckGroupCheck

Name	Cesta	Typ	Description
ID	id	string	Identifikátor.
Název	name	string	Název kontroly.
Aktivovaný	activated	boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted	boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck	boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail	boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations	CheckLocationList	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags	CheckTagList	Značky pro uspořádání a filtrování kontrol
Kontrola nastavení upozornění	alertSettings	CheckAlertSettings	Nastavení upozornění.
Použití globálního nastavení upozornění	useGlobalAlertSettings	boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId	number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder	number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId	string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrola typu	checkType	string	Typ kontroly.
Četnost	frequency	integer	Jak často se má kontrola spouštět v minutách.
Posun frekvence	frequencyOffset	integer	Posun frekvence.
Kontrola žádosti	request	CheckRequest	Žádost o kontrolu.
Script	script	string	Skript.
Kontrola seznamu proměnných prostředí	environmentVariables	CheckEnvironmentVariableList	Páry klíč/hodnota pro nastavení proměnných prostředí během provádění kontroly. Ty jsou relevantní jenom pro kontroly prohlížeče. Kdykoli je to možné, používejte globální proměnné prostředí.
ID fragmentu kódu instalace	setupSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API.
Id fragmentu kódu pro roztrhání	tearDownSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odstranění kontroly rozhraní API.
Místní instalační skript	localSetupScript	string	Platný kód Node.js ke spuštění ve fázi instalace.
Místní roztrhání skriptu	localTearDownScript	string	Platný kód Node.js, který se má spustit ve fázi odstranění.
Degradovaná doba odezvy	degradedResponseTime	number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za degradovanou.
Maximální doba odezvy	maxResponseTime	number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za selhání.
alertChannels	alertChannels	CheckAlertChannels
Privátní umístění	privateLocations	privateLocations	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

Model8

Name	Cesta	Typ	Description
Položky		CheckGroupCheck

prohlašování

Seznam kontrolních kontrolních výrazů rozhraní API

Name	Cesta	Typ	Description
Položky		string

headers

Záhlaví.

Name	Cesta	Typ	Description
Headers		object	Záhlaví.

parametry

Parametry.

Name	Cesta	Typ	Description
Parametry		object	Parametry.

žádost

Požadavek na rozhraní API.

Name	Cesta	Typ	Description
metoda	method	string
adresa URL	url	string
data	data	string
Headers	headers	headers	Záhlaví.
Parametry	params	params	Parametry.

načasování

Časování.

Name	Cesta	Typ	Description
Načasování		object	Časování.

časováníPhases

Fáze časování.

Name	Cesta	Typ	Description
Fáze časování		object	Fáze časování.

response

Odpověď rozhraní API.

Name	Cesta	Typ	Description
Stav	status	number	Stav.
Text stavu	statusText	string	Text stavu.
Body	body	string	Tělo.
Headers	headers	headers	Záhlaví.
Načasování	timings	timings	Časování.
Fáze časování	timingPhases	timingPhases	Fáze časování.

jobLog

Protokol úloh.

Name	Cesta	Typ	Description
Protokol úloh		object	Protokol úloh.

jobAssets

Prostředky vygenerované z šeku.

Name	Cesta	Typ	Description
Položky		string

CheckResultAPI

Data odpovědí pro kontrolu rozhraní API.

Name	Cesta	Typ	Description
Assertions	assertions	assertions	Seznam kontrolních kontrolních výrazů rozhraní API
Žádost	request	request	Požadavek na rozhraní API.
Odezva	response	response	Odpověď rozhraní API.
Chyba požadavku	requestError	string	Popisuje, jestli v požadavku došlo k chybě.
Protokol úloh	jobLog	jobLog	Protokol úloh.
Prostředky úloh	jobAssets	jobAssets	Prostředky vygenerované z šeku.

chyby

Seznam chyb při spuštění kontroly

Name	Cesta	Typ	Description
Položky		string

Model9

Zkontrolujte výsledky protokolu spuštění.

Name	Cesta	Typ	Description
Položky		string

traceSummary

Souhrn trasování.

Name	Cesta	Typ	Description
Souhrn trasování		object	Souhrn trasování.

stránky

Seznam stránek použitých při spuštění kontroly

Name	Cesta	Typ	Description
Položky		string

CheckResultBrowser

Data odpovědí pro kontrolu prohlížeče.

Name	Cesta	Typ	Description
Typ	type	string	Typ architektury, který kontrola používá.
Errors	errors	errors	Seznam chyb při spuštění kontroly
Koncový čas	endTime	number	Koncový čas spuštění kontroly.
Čas zahájení	startTime	number	Čas spuštění kontroly
Verze modulu runtime	runtimeVersion	string	Aktivní verze modulu runtime
Kontrola protokolu spuštění	jobLog	Model9	Zkontrolujte výsledky protokolu spuštění.
Prostředky úloh	jobAssets	jobAssets	Prostředky vygenerované z šeku.
Souhrn trasování	traceSummary	traceSummary	Souhrn trasování.
Stránky	pages	pages	Seznam stránek použitých při spuštění kontroly

CheckResult

Name	Cesta	Typ	Description
ID	id	string	Jedinečný identifikátor tohoto výsledku.
Název	name	string	Název kontroly.
Kontrola ID	checkId	string	Identifikátor kontroly.
Došlo k chybám	hasFailures	boolean	Popisuje, jestli během této kontroly došlo k nějaké chybě. Toto je hlavní zaměření na posouzení chování rozhraní API nebo kontroly prohlížeče. Kontrolní výrazy, které selžou, vypršení časového limitu nebo neúspěšné skripty, se přeloží na hodnotu true.
Obsahuje chyby	hasErrors	boolean	Popisuje, jestli v back-endu Checkly došlo k vnitřní chybě. To by mělo být ve většině případů nepravdivé.
Je snížený výkon	isDegraded	boolean	Kontrola je degradovaná, pokud je nad limitem snížení výkonu nastaveným polem degradedResponseTime na kontrole. Platí jenom pro kontroly rozhraní API.
Maximální doba odezvy	overMaxResponseTime	boolean	Pokud doba odezvy překročila limit nastavený polem maxResponseTime při kontrole, nastavte na hodnotu true. Platí jenom pro kontroly rozhraní API.
Umístění spuštění	runLocation	string	Z jakého umístění datového centra pochází tento výsledek kontroly.
Spuštěno na adrese	startedAt	date-time	Začátek v čase.
Zastaveno na	stoppedAt	date-time	Zastaveno v čase.
Vytvořeno na adrese	created_at	date-time	Při vytváření na adrese.
Doba odezvy	responseTime	number	Popisuje dobu, kterou trvalo provedení relevantních částí této kontroly. Systémový čas časovače instalace potřebný ke spuštění této kontroly v back-endu Checkly není součástí tohoto příkazu.
Kontrola rozhraní API výsledků	apiCheckResult	CheckResultAPI	Data odpovědí pro kontrolu rozhraní API.
Výsledek kontroly prohlížeče	browserCheckResult	CheckResultBrowser	Data odpovědí pro kontrolu prohlížeče.
Kontrola ID spuštění	checkRunId	number	Identifikátor konkrétního spuštění kontroly, který vytvořil tento výsledek kontroly.
Pokusy	attempts	number	Jak často se tato kontrola opakuje. Pokud je povolená dvojitá kontrola, bude tato hodnota větší než 0.

Kontrolní seznam

Name	Cesta	Typ	Description
Položky		CheckResult

CheckStatus

Name	Cesta	Typ	Description
Název	name	string	Název kontroly.
Kontrola ID	checkId	string	Identifikátor kontroly tohoto stavu patří.
Došlo k chybám	hasFailures	boolean	Popisuje, jestli tato kontrola aktuálně selhává. Pokud některá z kontrolních výrazů pro kontrolu rozhraní API selže, je tato hodnota pravdivá. Pokud kontrola prohlížeče z jakéhokoli důvodu selže, je to pravda.
Obsahuje chyby	hasErrors	boolean	Popisuje, jestli kvůli nějaké chybě mimo normální provoz tato kontrola selhává. To by mělo být extrémně vzácné a pouze v případě, že v back-endu Checkly dojde k chybě.
Je snížený výkon	isDegraded	boolean	Kontrola je degradovaná, pokud je nad limitem snížení výkonu nastaveným polem degradedResponseTime na kontrole. Platí jenom pro kontroly rozhraní API.
Nejdelší běh	longestRun	number	Nejdelší doba odezvy pro tuto kontrolu.
Nejkratší spuštění	shortestRun	number	Nejkratší doba odezvy pro tuto kontrolu.
Umístění posledního spuštění	lastRunLocation	string	Na jakém místě byla tato kontrola naposledy spuštěna.
ID poslední kontroly spuštění	lastCheckRunId	string	Jedinečný identifikátor přírůstku pro každé spuštění kontroly.
Zbývající dny PROTOKOLU SSL	sslDaysRemaining	number	Kolik dní zbývá do vypršení platnosti aktuálního certifikátu SSL.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

Kontrolní seznam

Name	Cesta	Typ	Description
Položky		CheckStatus

Zkontrolujte

Name	Cesta	Typ	Description
ID	id	string	Identifikátor.
Název	name	string	Název kontroly.
Aktivovaný	activated	boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted	boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck	boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail	boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations	CheckLocationList	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags	CheckTagList	Značky pro uspořádání a filtrování kontrol
Kontrola nastavení upozornění	alertSettings	CheckAlertSettings	Nastavení upozornění.
Použití globálního nastavení upozornění	useGlobalAlertSettings	boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId	number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder	number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId	string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrola typu	checkType	string	Typ kontroly.
Četnost	frequency	integer	Jak často se má kontrola spouštět v minutách.
Posun frekvence	frequencyOffset	integer	Posun frekvence.
Kontrola žádosti	request	CheckRequest	Žádost o kontrolu.
Script	script	string	Skript.
Kontrola seznamu proměnných prostředí	environmentVariables	CheckEnvironmentVariableList	Páry klíč/hodnota pro nastavení proměnných prostředí během provádění kontroly. Ty jsou relevantní jenom pro kontroly prohlížeče. Kdykoli je to možné, používejte globální proměnné prostředí.
ID fragmentu kódu instalace	setupSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API.
Id fragmentu kódu pro roztrhání	tearDownSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odstranění kontroly rozhraní API.
Místní instalační skript	localSetupScript	string	Platný kód Node.js ke spuštění ve fázi instalace.
Místní roztrhání skriptu	localTearDownScript	string	Platný kód Node.js, který se má spustit ve fázi odstranění.
Degradovaná doba odezvy	degradedResponseTime	number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za degradovanou.
Maximální doba odezvy	maxResponseTime	number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za selhání.
alertChannels	alertChannels	CheckAlertChannels
Privátní umístění	privateLocations	privateLocations	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

Kontrolní seznam

Name	Cesta	Typ	Description
Položky		Check

Model14

Name	Cesta	Typ	Description
Položky		KeyValue

Model15

Name	Cesta	Typ	Description
Položky		KeyValue

Model16

Určuje požadavek, že se kontrola spustí.

Name	Cesta	Typ	Description
metoda	method	string
URL	url	string	Adresa URL.
Sledování přesměrování	followRedirects	boolean	Zda se mají sledovat přesměrování.
Přeskočit SSL	skipSSL	boolean	Jestli se má protokol SSL přeskočit.
Body	body	string	Tělo.
Typ karoserie	bodyType	string	Typ těla.
headers	headers	Model14
parametry dotazu	queryParameters	Model15
Seznam kontrolních výrazů	assertions	AssertionList	Projděte si hlavní dokumentaci k kontrolním výrazům pro konkrétní hodnoty, jako jsou regulární výrazy a popisovače cest JSON, které můžete použít v poli vlastnosti.
basicAuth	basicAuth	BasicAuth

CheckAPI

Name	Cesta	Typ	Description
ID	id	string	Identifikátor.
Název	name	string	Název kontroly.
Aktivovaný	activated	boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted	boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck	boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail	boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations	CheckLocationList	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags	CheckTagList	Značky pro uspořádání a filtrování kontrol
Kontrola nastavení upozornění	alertSettings	CheckAlertSettings	Nastavení upozornění.
Použití globálního nastavení upozornění	useGlobalAlertSettings	boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId	number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder	number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId	string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrola žádosti	request	Model16	Určuje požadavek, že se kontrola spustí.
Četnost	frequency	integer	Jak často se má kontrola spouštět v minutách.
Posun frekvence	frequencyOffset	integer	Používá se pro nastavení sekund pro četnost kontroly pod 1 minutami (pouze pro kontroly rozhraní API) a šíření kontrol v časovém rozsahu četností přes 1 minutu. Funguje takto: Kontroly s frekvencí 0 mohou mít frekvenciOffset 10, 20 nebo 30, což znamená, že se spustí každých 10, 20 nebo 30 sekund. Kontroly s frekvencí nižší než a rovnou 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.floor(frekvence * 10), tj. kontrola spuštění každých 5 minut, maximální frekvenceOffset je 50. Kontroly s frekvencí vyšší než 60 můžou mít frekvenciOffset mezi 1 a maximální hodnotou na základě vzorce Math.ceil(frequency / 60), tj. při kontrole, která se spouští každých 720 minut, maximální frekvenceOffset je 12.
Id fragmentu kódu pro roztrhání	tearDownSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi odstranění kontroly rozhraní API.
ID fragmentu kódu instalace	setupSnippetId	number	Odkaz na identifikátor fragmentu, který se má použít ve fázi nastavení kontroly rozhraní API.
Místní instalační skript	localSetupScript	string	Platný kód Node.js ke spuštění ve fázi instalace.
Místní roztrhání skriptu	localTearDownScript	string	Platný kód Node.js, který se má spustit ve fázi odstranění.
Degradovaná doba odezvy	degradedResponseTime	number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za degradovanou.
Maximální doba odezvy	maxResponseTime	number	Doba odezvy v milisekundách, kde by se měla kontrola považovat za selhání.
Privátní umístění	privateLocations	privateLocations	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.
Kontrola typu	checkType	string	Typ kontroly.
alertChannels	alertChannels	CheckAlertChannels
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

CheckBrowser

Name	Cesta	Typ	Description
ID	id	string	Identifikátor.
Název	name	string	Název kontroly.
Aktivovaný	activated	boolean	Určuje, jestli je kontrola spuštěná nebo ne.
Ztlumený	muted	boolean	Určuje, jestli se nějaká oznámení odesílají, když se kontrola nezdaří nebo se obnoví.
Překontrolovat	doubleCheck	boolean	Nastavení na hodnotu true aktivuje opakování, když se kontrola nezdaří z oblasti selhání a jiné, náhodně vybrané oblasti před označením kontroly jako neúspěšné.
Mělo by selhat	shouldFail	boolean	Umožňuje invertovat chování, kdy je kontrola považována za neúspěšnou. Umožňuje ověření stavu chyby, jako je 404.
Kontrola seznamu umístění	locations	CheckLocationList	Pole jednoho nebo více umístění datacentra, kde se má tato kontrola spustit.
Kontrola seznamu značek	tags	CheckTagList	Značky pro uspořádání a filtrování kontrol
Kontrola nastavení upozornění	alertSettings	CheckAlertSettings	Nastavení upozornění.
Použití globálního nastavení upozornění	useGlobalAlertSettings	boolean	Pokud je hodnota true, použije se nastavení upozornění na úrovni účtu, nikoli nastavení výstrahy definované při této kontrole.
ID skupiny	groupId	number	Identifikátor kontrolní skupiny je tato kontrola součástí.
Pořadí skupin	groupOrder	number	Pozice této kontroly ve skupině zaškrtnutí. Určuje, v jakém pořadí se kontroly spustí, když se skupina aktivuje z rozhraní API nebo z CI/CD.
Runtime ID	runtimeId	string	Verze modulu runtime, tj. pevná sada závislostí modulu runtime, která se používá k provedení této kontroly.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrola typu	checkType	string	Typ kontroly.
Četnost	frequency	integer	Jak často se má kontrola spouštět v minutách.
Script	script	string	Platný kód Node.js javascriptu popisující interakci prohlížeče s architekturou Puppeteer nebo Playwright.
Privátní umístění	privateLocations	privateLocations	Pole jednoho nebo více privátních umístění, kde se má kontrola spustit.
alertChannels	alertChannels	CheckAlertChannels
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

DashboardTagList

Seznam jedné nebo více značek, které filtruje, které se mají zobrazit na řídicím panelu.

Name	Cesta	Typ	Description
Položky		string

Dashboard

Name	Cesta	Typ	Description
Custom Domain	customDomain	string	Vlastní doména uživatele, například status.example.com. Podívejte se na dokumentaci k aktualizaci využití DNS a SSL.
Vlastní adresa URL	customUrl	string	Název subdomény pod checklyhq.com. Musí být jedinečný pro všechny uživatele.
Logo	logo	string	Adresa URL odkazující na soubor obrázku
Favicon	favicon	string	Adresa URL odkazující na soubor obrázku použitý jako favicon řídicího panelu
Link	link	string	Odkaz na adresu URL pro přesměrování při kliknutí na logo řídicího panelu.
Header	header	string	Část textu zobrazená v horní části řídicího panelu
Description	description	string	Část textu zobrazená pod záhlavím nebo názvem řídicího panelu
Šířka	width	string	Určuje, zda se má použít celá obrazovka nebo fokus uprostřed.
Obnovovací frekvence	refreshRate	number	Jak často se má řídicí panel aktualizovat během několika sekund.
Stránkovat	paginate	boolean	Určuje, jestli je stránkování zapnuté nebo vypnuté.
Frekvence stránkování	paginationRate	number	Jak často se stránkování spouští v sekundách.
Kontroly na stránku	checksPerPage	number	Počet kontrol zobrazených na stránce
Použití a operátor	useTagsAndOperator	boolean	Kdy použít operátor AND pro vyhledávání značek.
Skrýt značky	hideTags	boolean	Umožňuje zobrazit nebo skrýt značky na řídicím panelu.
Seznam značek řídicího panelu	tags	DashboardTagList	Seznam jedné nebo více značek, které filtruje, které se mají zobrazit na řídicím panelu.
ID řídicího panelu	dashboardId	string	Identifikátor řídicího panelu.

DashboardsList

Name	Cesta	Typ	Description
Položky		Dashboard

Umístění

Name	Cesta	Typ	Description
Región	region	string	Jedinečný identifikátor tohoto umístění.
Název	name	string	Popisný název tohoto umístění

LocationList

Name	Cesta	Typ	Description
Položky		Location

MaintenanceWindowTagList

Názvy kontrol a skupinových časových období údržby by se měly vztahovat na.

Name	Cesta	Typ	Description
Položky		string

Okno údržby

Name	Cesta	Typ	Description
ID	id	number	Identifikátor časového období údržby.
Název	name	string	Název časového období údržby.
Seznam značek časového období údržby	tags	MaintenanceWindowTagList	Názvy kontrol a skupinových časových období údržby by se měly vztahovat na.
Začíná na	startsAt	date	Počáteční datum časového období údržby.
Končí na	endsAt	date	Koncové datum časového období údržby.
Interval opakování	repeatInterval	number	Interval opakování časového období údržby od prvního výskytu.
Opakovat jednotku	repeatUnit	string	Strategie opakování pro časové období údržby.
Opakování končí na	repeatEndsAt	date	Koncové datum, kdy by se mělo časové období údržby přestat opakovat.
Vytvořeno na adrese	created_at	date	Datum vytvoření časového období údržby.
Aktualizováno na adrese	updated_at	date	Datum poslední aktualizace časového období údržby.

MaintenanceWindowList

Seznam časových období údržby.

Name	Cesta	Typ	Description
Položky		MaintenanceWindow

CheckAssignment

Name	Cesta	Typ	Description
ID	id	guid	Identifikátor.
Kontrola ID	checkId	guid	Identifikátor kontroly.
ID privátního umístění	privateLocationId	guid	Identifikátor přiřazeného privátního umístění.

checkAssignments

Zaškrtnutá tato soukromá poloha byla přiřazena.

Name	Cesta	Typ	Description
Položky		CheckAssignment

Přiřazení skupin

Name	Cesta	Typ	Description
ID	id	guid	Identifikátor.
ID skupiny	groupId	number	Identifikátor skupiny.
ID privátního umístění	privateLocationId	guid	Identifikátor přiřazeného privátního umístění.

groupAssignments

Skupina, která má toto soukromé umístění přiřazené.

Name	Cesta	Typ	Description
Položky		GroupAssignment

privateLocationKeys

Name	Cesta	Typ	Description
ID	id	guid	Identifikátor.
Nezpracovaný klíč	rawKey	string	Nezpracovaný klíč.
Maskovaný klíč	maskedKey	string	Maskovaná hodnota klíče.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date	Při aktualizaci na adrese

keys

Name	Cesta	Typ	Description
Položky		privateLocationKeys

privatelocationschema

Name	Cesta	Typ	Description
ID	id	guid	Identifikátor.
Název	name	string	Název přiřazený k privátnímu umístění.
Název slug	slugName	string	Platný název slug.
Ikona	icon	string	Ikona soukromého umístění.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date	Při aktualizaci na adrese
Kontrola přiřazení	checkAssignments	checkAssignments	Zaškrtnutá tato soukromá poloha byla přiřazena.
Přiřazení skupin	groupAssignments	groupAssignments	Skupina, která má toto soukromé umístění přiřazené.
keys	keys	keys
Naposledy vidět	lastSeen	date	Datum posledního výskytu.
Počet agentů	agentCount	number	Počet agentů.

privateLocationsListSchema

Name	Cesta	Typ	Description
Položky		privatelocationschema

commonPrivateLocationSchemaResponse

Name	Cesta	Typ	Description
ID	id	guid	Identifikátor.
Název	name	string	Název přiřazený k privátnímu umístění.
Název slug	slugName	string	Platný název slug.
Ikona	icon	string	Ikona soukromého umístění.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date	Při aktualizaci na adrese
Kontrola přiřazení	checkAssignments	checkAssignments	Zaškrtnutá tato soukromá poloha byla přiřazena.
Přiřazení skupin	groupAssignments	groupAssignments	Skupina, která má toto soukromé umístění přiřazené.
keys	keys	keys

Časová razítka

Name	Cesta	Typ	Description
Časová značka		date-time	Časové razítko.

queueSize

Velikost fronty.

Name	Cesta	Typ	Description
Položky		number

nejstaršíScheduledCheckRun

Name	Cesta	Typ	Description
Položky		number

privateLocationsMetricsHistoryResponseSchema

Name	Cesta	Typ	Description
Časová razítka	timestamps	timestamps
Velikost fronty	queueSize	queueSize	Velikost fronty.
nejstaršíScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Zkontrolujte značky.

Name	Cesta	Typ	Description
Položky		string

ReportingAggregate

Name	Cesta	Typ	Description
Poměr úspěšnosti	successRatio	number	Poměr úspěšnosti kontroly u vybraného rozsahu kalendářních dat Procento je v desítkové podobě.
Průměr	avg	number	Průměrná doba odezvy kontroly u vybraného rozsahu dat v milisekundách
P95	p95	number	Doba odezvy P95 kontroly nad vybraným rozsahem kalendářních dat v milisekundách
P99	p99	number	Doba odezvy P99 kontroly nad vybraným rozsahem kalendářních dat v milisekundách

Reportování

Name	Cesta	Typ	Description
Název	name	string	Zkontrolujte název.
Kontrola ID	checkId	string	Zkontrolujte ID.
Kontrola typu	checkType	string	Zkontrolujte typ.
Deaktivováno	deactivated	boolean	Zkontrolujte deaktivaci.
Seznam značek pro vytváření sestav	tags	ReportingTagList	Zkontrolujte značky.
agregace	aggregate	ReportingAggregate

Seznam sestav

Name	Cesta	Typ	Description
Položky		Reporting

Runtime

Name	Cesta	Typ	Description
Název	name	string	Jedinečný název tohoto modulu runtime.
Etapa	stage	string	Aktuální fáze životnosti modulu runtime
Konec životnosti modulu runtime	runtimeEndOfLife	string	Datum, kdy se modul runtime odebere z naší platformy.
Výchozí	default	boolean	Označuje, jestli se jedná o aktuální výchozí modul runtime poskytovaný nástrojem Checkly.
Description	description	string	Krátký popis hlavních aktualizací v tomto modulu runtime, který je čitelný pro člověka.
String	dependencies.string	string	Řetězec.

RuntimeList

Name	Cesta	Typ	Description
Položky		Runtime

Úryvek

Name	Cesta	Typ	Description
ID	id	number	Identifikátor.
Název	name	string	Název fragmentu kódu
Script	script	string	Váš Node.js kód, který komunikuje s životním cyklem kontroly rozhraní API, nebo funguje jako částečná kontrola prohlížeče.
Vytvořeno na adrese	created_at	date-time	Při vytváření na adrese.
Aktualizováno na adrese	updated_at	date-time	Při aktualizaci na adrese

SnippetList

Name	Cesta	Typ	Description
Položky		Snippet

CheckGroupTrigger

Name	Cesta	Typ	Description
ID	id	number	Identifikátor.
Žeton	token	string	Token.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Volal na	called_at	date	Při zavolání.
Aktualizováno na adrese	updated_at	date	Při aktualizaci na adrese
ID skupiny	groupId	number	Identifikátor skupiny.

CheckTrigger

Name	Cesta	Typ	Description
ID	id	number	Identifikátor.
Žeton	token	string	Token.
Vytvořeno na adrese	created_at	date	Při vytváření na adrese.
Volal na	called_at	date	Při zavolání.
Aktualizováno na adrese	updated_at	date	Při aktualizaci na adrese
Kontrola ID	checkId	string	Identifikátor kontroly.

objekt

Toto je typ "object".

řetězec

Toto je základní datový typ String.