Checkly (niezależny wydawca) (wersja zapoznawcza)

Sprawdź, czy platforma monitorowania nowoczesnego stosu: programowalne, elastyczne i kochające język JavaScript. Monitoruj i zweryfikuj kluczowe transakcje lokacji. Automatycznie zbieraj ślady błędów, zrzuty ekranu i metryki wydajności przy każdym uruchomieniu sprawdzania.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt
Name	Troy Taylor
adres URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadane łącznika
Publisher	Troy Taylor
Witryna internetowa	https://www.checklyhq.com/
Zasady ochrony prywatności	https://www.checklyhq.com/privacy
Kategorie	Operacje IT

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:


Wartość domyślna	Parametry tworzenia połączenia.	Wszystkie regiony	Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name	Typ	Description	Wymagane
Identyfikator konta	securestring	Identyfikator konta dla tego interfejsu API.	Prawda
Klucz interfejsu API (w postaci "Bearer apiKey")	securestring	Klucz interfejsu API (w postaci "Bearer apiKey") dla tego interfejsu API	Prawda

Limity ograniczania

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Aktualizowanie fragmentu kodu	Aktualizuje fragment kodu.
Aktualizowanie grupy kontrolnej	Aktualizuje grupę kontrolną.
Aktualizowanie kanału alertów	Aktualizowanie kanału alertów.
Aktualizowanie lokalizacji prywatnej	Aktualizuje lokalizację prywatną.
Aktualizowanie okna obsługi	Aktualizuje okno obsługi.
Aktualizowanie pulpitu nawigacyjnego	Aktualizuje pulpit nawigacyjny. Zwróci błąd 409 podczas próby utworzenia pulpitu nawigacyjnego z niestandardowym adresem URL lub domeną niestandardową, która jest już zajęta.
Aktualizowanie sprawdzania [PRZESTARZAŁE]	[PRZESTARZAŁE] Ten punkt końcowy zostanie usunięty w poniedziałek 4 lipca 2022 r. Zamiast tego użyj polecenia `PUT /checks/api/{id}` lub `PUT /checks/browser/{id}`. Aktualizuje nowy interfejs API lub sprawdzanie przeglądarki.
Aktualizowanie sprawdzania interfejsu API	Aktualizuje sprawdzanie interfejsu API.
Aktualizowanie sprawdzania przeglądarki	Aktualizuje sprawdzanie przeglądarki.
Aktualizowanie subskrypcji kanału alertów	Zaktualizuj subskrypcje kanału alertów. Służy do dodawania sprawdzania do kanału alertów, dzięki czemu alerty dotyczące niepowodzeń i odzyskiwania są wysyłane do tego sprawdzenia. Uwaga: podczas przekazywania obiektu subskrypcji można określić tylko identyfikator checkId lub groupId, a nie oba.
Aktualizowanie zmiennej środowiskowej	Aktualizuje zmienną środowiskową. Używa pola klucza jako identyfikatora do aktualizowania. Aktualizuje tylko wartość i zablokowaną właściwość.
Generowanie nowego klucza interfejsu API dla lokalizacji prywatnej	Tworzy klucz interfejsu API w lokalizacji prywatnej.
Generuje dostosowywalny raport dla wszystkich metryk sprawdzania przeglądarki	Generuje raport z zagregowanymi lub niegregowanymi statystykami dla określonej kontroli przeglądarki w określonym przedziale czasu.
Generuje raport z zagregowanymi statystykami dla kontroli i sprawdzania grup	Generuje raport ze zagregowanymi statystykami dla wszystkich kontroli lub filtrowanego zestawu kontroli w określonym przedziale czasu.
Pobieranie fragmentu kodu	Pokaż szczegóły określonego fragmentu kodu.
Pobieranie grupy kontrolnej	Pokaż szczegóły określonej grupy kontrolnej.
Pobieranie jednego zaewidencjonowania w określonej grupie z zastosowanymi ustawieniami grupy	Pokaż szczegóły jednego zaewidencjonowania w określonej grupie kontrolnej z zastosowanymi ustawieniami grupy.
Pobieranie kanału alertów	Pokaż szczegóły określonego kanału alertu.
Pobieranie lokalizacji prywatnej	Pokaż szczegóły określonej lokalizacji prywatnej.
Pobieranie metryk kondycji lokalizacji prywatnej z przedziału czasu	Pobieranie metryk kondycji lokalizacji prywatnej z przedziału czasu.
Pobieranie okna obsługi	Pokaż szczegóły określonego okna obsługi.
Pobieranie sprawdzania	Pokaż szczegóły określonego interfejsu API lub sprawdzania przeglądarki.
Pobieranie szczegółów stanu sprawdzania	Pokaż bieżące informacje o stanie dla określonego sprawdzenia.
Pobieranie wszystkich kontroli w określonej grupie z zastosowanymi ustawieniami grupy	Wyświetla listę wszystkich kontroli w określonej grupie kontrolnej z zastosowanymi ustawieniami grupy.
Pobieranie wyniku sprawdzania	Pokaż szczegóły określonego wyniku sprawdzania.
Pobieranie wyzwalacza sprawdzania	Znajduje wyzwalacz sprawdzania.
Pobieranie zmiennej środowiskowej	Pokaż szczegóły określonej zmiennej środowiskowej. Używa pola klucza do wyboru.
Pokazuje szczegóły dla jednego określonego środowiska uruchomieniowego	Przedstawia szczegóły wszystkich dołączonych pakietów NPM i ich wersji dla jednego określonego środowiska uruchomieniowego.
Tworzenie fragmentu kodu	Tworzy nowy fragment kodu.
Tworzenie grupy kontrolnej	Tworzy nową grupę kontrolną. Możesz dodać kontrole do grupy, ustawiając właściwość groupId poszczególnych testów.
Tworzenie kanału alertów	Tworzy nowy kanał alertów.
Tworzenie lokalizacji prywatnej	Tworzy nową lokalizację prywatną.
Tworzenie okna obsługi	Tworzy nowe okno obsługi.
Tworzenie pulpitu nawigacyjnego	Tworzy nowy pulpit nawigacyjny. Zwróci błąd 409 podczas próby utworzenia pulpitu nawigacyjnego z niestandardowym adresem URL lub domeną niestandardową, która jest już zajęta.
Tworzenie sprawdzania [PRZESTARZAŁE]	[PRZESTARZAŁE] Ten punkt końcowy zostanie usunięty w poniedziałek 4 lipca 2022 r. Zamiast tego użyj polecenia `POST /checks/api` lub `POST /checks/browser`. Tworzy nowy interfejs API lub sprawdzanie przeglądarki. Zwróci wartość `402` , gdy przekraczasz limit planu. W przypadku korzystania z elementu `globalAlertSettingsalertSettings` element może mieć wartość`null`
Tworzenie sprawdzania interfejsu API	Tworzy nowe sprawdzanie interfejsu API. Zwróci wartość `402` , gdy przekraczasz limit planu. W przypadku korzystania z elementu `globalAlertSettingalertSetting` element może mieć wartość`null`
Tworzenie sprawdzania przeglądarki	Tworzy nowe sprawdzanie przeglądarki. Zwróci wartość `402` , gdy przekraczasz limit planu. W przypadku korzystania z elementu `globalAlertSettingalertSetting` element może mieć wartość`null`
Tworzenie wyzwalacza grupy sprawdzania	Tworzy wyzwalacz grupy sprawdzania.
Tworzenie wyzwalacza sprawdzania	Tworzy wyzwalacz sprawdzania.
Tworzenie zmiennej środowiskowej	Tworzy nową zmienną środowiskową.
Usuwanie fragmentu kodu	Trwale usuwa fragment kodu.
Usuwanie grupy kontrolnej	Trwale usuwa grupę kontrolną. Nie można usunąć grupy sprawdzania, jeśli nadal zawiera testy.
Usuwanie istniejącego klucza interfejsu API dla lokalizacji prywatnej	Trwale usuwa klucz interfejsu API z lokalizacji prywatnej.
Usuwanie kanału alertów	Trwale usuwa kanał alertów.
Usuwanie lokalizacji prywatnej	Trwale usuwa lokalizację prywatną.
Usuwanie okna obsługi	Trwale usuwa okno obsługi.
Usuwanie sprawdzania	Trwale usuwa interfejs API lub sprawdzanie przeglądarki oraz wszystkie powiązane z nią dane o stanie i wynikach.
Usuwanie wyzwalacza grupy sprawdzania	Usuwa wyzwalacz grup sprawdzania.
Usuwanie wyzwalacza sprawdzania	Usuwa wyzwalacz sprawdzania.
Usuwanie zmiennej środowiskowej	Trwale usuwa zmienną środowiskową. Używa pola klucza jako identyfikatora do usunięcia.
Usuń pulpit nawigacyjny	Trwale usuwa pulpit nawigacyjny.
Uzyskiwanie wyzwalacza grupy kontrolnej	Znajduje wyzwalacz grupy sprawdzania.
Wyświetl listę wszystkich testów	Wyświetla listę wszystkich bieżących kontroli na koncie.
Wyświetl wszystkie fragmenty kodu	Wyświetla listę wszystkich bieżących fragmentów kodu na twoim koncie.
Wyświetla listę wszystkich obsługiwanych lokalizacji	Wyświetla listę wszystkich obsługiwanych lokalizacji.
Wyświetla listę wszystkich obsługiwanych środowisk uruchomieniowych	Wyświetla listę wszystkich obsługiwanych środowisk uruchomieniowych i dołączonych pakietów NPM do sprawdzania i konfigurowania i usuwania skryptów na potrzeby sprawdzania interfejsu API.
Wyświetla wszystkie wyniki sprawdzania	Wyświetla listę pełnych, nieprzetworzonych wyników sprawdzania dla określonego sprawdzenia. Utrzymujemy nieprzetworzone wyniki przez 30 dni. Po 30 dniach zostaną one wymazane. Jednak utrzymujemy zwijane wyniki przez nieokreślony okres. Możesz filtrować według typu sprawdzania i typu wyników, aby zawęzić listę. Użyj parametrów `to` i `from` , aby określić zakres dat (sygnatura czasowa systemu UNIX w sekundach). W zależności od typu sprawdzania niektóre pola mogą mieć wartość null. Ten punkt końcowy zwróci dane w ciągu sześciu godzin. Jeśli parametry z i do parametrów są ustawione, muszą być co najwyżej sześć godzin od siebie. Jeśli żadna z nich nie zostanie ustawiona, rozważymy parametr do teraz i z parametru do sześciu godzin wcześniej. Jeśli parametr to jest ustawiony, ustawimy wartość z na sześć godzin wcześniej. Wręcz przeciwnie, jeśli tylko parametr z parametru zostanie ustawiony, rozważymy parametr do sześciu godzin później. Ograniczenie szybkości jest stosowane do tego punktu końcowego. Można wysłać co najwyżej 5 żądań na 10 sekund.
Wyświetlanie listy alertów dotyczących określonego sprawdzenia	Wyświetla listę wszystkich alertów dla określonego sprawdzenia.
Wyświetlanie listy wszystkich alertów dla konta	Wyświetla listę wszystkich alertów dla twojego konta.
Wyświetlanie listy wszystkich grup sprawdzania	Wyświetla listę wszystkich bieżących grup kontrolnych na koncie. Właściwość checks to tablica identyfikatorów UUID sprawdzania w celu wygodnego odwoływania się. Jest on tylko do odczytu i nie można go używać do dodawania kontroli do grupy.
Wyświetlanie listy wszystkich kanałów alertów	Wyświetla listę wszystkich skonfigurowanych kanałów alertów i ich subskrybowanych testów.
Wyświetlanie listy wszystkich lokalizacji prywatnych	Wyświetla listę wszystkich lokalizacji prywatnych na koncie.
Wyświetlanie listy wszystkich okien obsługi	Wyświetla listę wszystkich okien obsługi na koncie.
Wyświetlanie listy wszystkich pulpitów nawigacyjnych	Wyświetla listę wszystkich bieżących pulpitów nawigacyjnych na koncie.
Wyświetlanie listy wszystkich stanów sprawdzania	Przedstawia bieżące informacje o stanie dla wszystkich kontroli na twoim koncie. Rekordy stanu sprawdzania są stale aktualizowane, gdy pojawiają się nowe wyniki sprawdzania.
Wyświetlanie listy wszystkich zmiennych środowiskowych	Wyświetla listę wszystkich bieżących zmiennych środowiskowych na koncie.
Znaczek Uzyskiwanie stanu grupy	Uzyskaj wskaźnik stanu grupy.
Znaczek Uzyskiwanie stanu sprawdzania	Uzyskaj wskaźnik stanu sprawdzania.

Aktualizowanie fragmentu kodu

Identyfikator operacji:: PutV1SnippetsId

Aktualizuje fragment kodu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.
Name	name	True	string	Nazwa fragmentu kodu.
Skrypt	script	True	string	Kod Node.js, który wchodzi w interakcję z cyklem życia sprawdzania interfejsu API, lub działa jako częściowy kod do sprawdzania przeglądarki.

Zwraca

Body: Snippet

Aktualizowanie grupy kontrolnej

Identyfikator operacji:: PutV1CheckgroupsId

Aktualizuje grupę kontrolną.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name		string	Nazwa grupy kontrolnej.
Aktywowany	activated		boolean	Określa, czy kontrole w grupie są uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane, gdy zaewidencjonowanie tej grupy nie powiedzie się i/lub odzyska.
Sprawdzanie listy tagów grupy	tags		array of string	Tagi do organizowania i filtrowania testów.
Sprawdzanie listy lokalizacji grupy	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której należy uruchomić kontrole.
Concurrency	concurrency		number	Określa, ile testów jest wywoływanych współbieżnie podczas wyzwalania grupy kontrolnej z ciągłej integracji/ciągłego wdrażania lub za pośrednictwem interfejsu API.
adres URL	url		string	Podstawowy adres URL dla tej grupy, do której można odwoływać się za pomocą zmiennej {{GROUP_BASE_URL}} we wszystkich sprawdzaniach grup.
Key	key	True	string	Klucz.
Wartość	value	True	string	Wartość.
Zablokowane	locked		boolean	Czy zablokowane.
Źródło	source		string	Źródło.
Majątek	property		string	Właściwość .
Comparison	comparison		string	Porównanie.
Target	target		string	Cel.
Nazwa użytkownika	username	True	string	Nazwa użytkownika.
Hasło	password	True	string	Hasło.
Sprawdzanie domyślnych ustawień domyślnych tworzenia przeglądarki w grupie	browserCheckDefaults		object	Ustawienie domyślne tworzenia przeglądarki jest sprawdzane przez grupę kontrolną.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonywania kontroli w tej grupie.
Key	key	True	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane w tej grupie kontrolnej.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
Identyfikator fragmentu kodu instalatora	setupSnippetId		number	Odwołanie identyfikatora do fragmentu kodu do użycia w fazie instalacji ewidencjonowania interfejsu API w tej grupie.
Identyfikator fragmentu kodu w dół	tearDownSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API w tej grupie.
Skrypt instalacji lokalnej	localSetupScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji sprawdzania interfejsu API w tej grupie.
Lokalny skrypt zrywania	localTearDownScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania interfejsu API w tej grupie.
Sprawdzanie lokalizacji prywatnych	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić kontrole.

Zwraca

Body: CheckGroup

Aktualizowanie kanału alertów

Identyfikator operacji:: PutV1AlertchannelsId

Aktualizowanie kanału alertów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.
identyfikator	id		number	Identyfikator.
Sprawdź identyfikator	checkId		guid	Identyfikator sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy.
Aktywowany	activated	True	boolean	Czy aktywowano.
Typ	type	True	string	Typ.
Konfiguracja tworzenia kanału alertów	config	True	object	Kanał alertu tworzy konfigurację.
Wysyłanie odzyskiwania	sendRecovery		boolean	Czy wysyłać odzyskiwanie.
Niepowodzenie wysyłania	sendFailure		boolean	Czy niepowodzenie wysyłania.
Obniżona wydajność wysyłania	sendDegraded		boolean	Czy wysyłanie jest obniżone.
Wygaśnięcie protokołu SSL	sslExpiry		boolean	Określa, czy alert powinien być wysyłany do wygasających certyfikatów SSL.
Próg wygaśnięcia protokołu SSL	sslExpiryThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.

Zwraca

Body: AlertChannel

Aktualizowanie lokalizacji prywatnej

Identyfikator operacji:: PutV1PrivatelocationsId

Aktualizuje lokalizację prywatną.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.
Name	name	True	string	Nazwa przypisana do lokalizacji prywatnej.
Icon	icon		string	Ikona.

Zwraca

Body: commonPrivateLocationSchemaResponse

Aktualizowanie okna obsługi

Identyfikator operacji:: PutV1MaintenancewindowsId

Aktualizuje okno obsługi.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.
Name	name	True	string	Nazwa okna obsługi.
Lista tagów okna obsługi	tags		array of string	Nazwy okien obsługi sprawdzania i grup powinny mieć zastosowanie.
Rozpoczyna się od	startsAt	True	date	Data rozpoczęcia okna obsługi.
Kończy się na	endsAt	True	date	Data zakończenia okna obsługi.
Powtarzanie interwału	repeatInterval		number	Interwał powtarzania okna obsługi od pierwszego wystąpienia.
Powtórz jednostkę	repeatUnit	True	string	Strategia powtarzania okna obsługi.
Powtarzanie kończy się na	repeatEndsAt		date	Data zakończenia, w której okno obsługi powinno przestać się powtarzać.

Zwraca

Body: MaintenanceWindow

Aktualizowanie pulpitu nawigacyjnego

Identyfikator operacji:: PutV1DashboardsDashboardid

Aktualizuje pulpit nawigacyjny. Zwróci błąd 409 podczas próby utworzenia pulpitu nawigacyjnego z niestandardowym adresem URL lub domeną niestandardową, która jest już zajęta.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	dashboardId	True	string	Identyfikator pulpitu nawigacyjnego.
Niestandardowy adres URL	customUrl		string	Nazwa poddomeny w obszarze checklyhq.com. Musi być unikatowa dla wszystkich użytkowników.
Custom Domain	customDomain		string	Niestandardowa domena użytkownika, np. status.example.com. Zapoznaj się z dokumentacją dotyczącą aktualizowania użycia usługi DNS i protokołu SSL.
Logo	logo		string	Adres URL wskazujący plik obrazu.
Favicon (ikona ulubionych)	favicon		string	Adres URL wskazujący plik obrazu używany jako favicon pulpitu nawigacyjnego.
Link	link		string	Link adresu URL do przekierowania po kliknięciu logo pulpitu nawigacyjnego.
Header	header		string	Fragment tekstu wyświetlany w górnej części pulpitu nawigacyjnego.
Description	description		string	Fragment tekstu wyświetlany poniżej nagłówka lub tytułu pulpitu nawigacyjnego.
Szerokość	width		string	Określa, czy używać pełnego ekranu, czy fokusu w środku.
Częstotliwość odświeżania	refreshRate		number	Jak często odświeżać pulpit nawigacyjny w sekundach.
Podzielony	paginate		boolean	Określa stronicowanie jest włączone lub wyłączone.
Szybkość stronicowania	paginationRate		number	Jak często wyzwalać stronicowanie w sekundach.
Sprawdzanie na stronę	checksPerPage		number	Liczba wyświetlanych testów na stronę.
Używanie operatora i	useTagsAndOperator		boolean	Kiedy używać operatora AND dla wyszukiwania tagów.
Ukryj tagi	hideTags		boolean	Pokaż lub ukryj tagi na pulpicie nawigacyjnym.
Lista tagów pulpitu nawigacyjnego	tags		array of string	Lista co najmniej jednego tagu, który filtruje sprawdzanie, które ma być wyświetlane na pulpicie nawigacyjnym.

Zwraca

Body: Dashboard

Aktualizowanie sprawdzania [PRZESTARZAŁE]

Identyfikator operacji:: PutV1ChecksId

[PRZESTARZAŁE] Ten punkt końcowy zostanie usunięty w poniedziałek 4 lipca 2022 r. Zamiast tego użyj polecenia PUT /checks/api/{id} lub PUT /checks/browser/{id}. Aktualizuje nowy interfejs API lub sprawdzanie przeglądarki.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name		string	Nazwa sprawdzania.
Aktywowany	activated		boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail		boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags		array of string	Tagi do organizowania i filtrowania testów.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder		number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
Sprawdzanie typu	checkType		string	Typ sprawdzania.
Częstotliwość	frequency		integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Przesunięcie częstotliwości	frequencyOffset		integer	Służy do ustawiania sekund dla częstotliwości sprawdzania poniżej 1 minut (tylko w przypadku sprawdzania interfejsu API) i rozłożenia kontroli w zakresie czasu częstotliwości w ciągu 1 minuty. Działa to w następujący sposób: Kontrole z częstotliwością 0 mogą mieć wartość frequencyOffset 10, 20 lub 30, co oznacza, że będą uruchamiane co 10, 20 lub 30 sekund. Sprawdzanie z częstotliwością niższą niż i równą 60 może mieć właściwość frequencyOffset z zakresu od 1 do maksymalnej wartości na podstawie formuły Math.floor(frequency * 10), tj. dla sprawdzenia, które jest uruchamiane co 5 minut, maksymalna częstotliwośćOffset wynosi 50. Sprawdzanie z częstotliwością wyższą niż 60 może mieć wartość frequencyOffset z zakresu od 1 do wartości maksymalnej na podstawie formuły Math.ceil(frequency / 60), tj. w przypadku sprawdzenia, które jest uruchamiane co 720 minut, maksymalna częstotliwośćOffset wynosi 12.
Sprawdzanie żądania	request	True	object	Żądanie sprawdzania.
Skrypt	script	True	string	Skrypt.
Key	key	True	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.
Identyfikator fragmentu kodu instalatora	setupSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie konfiguracji sprawdzania interfejsu API.
Identyfikator fragmentu kodu w dół	tearDownSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API.
Skrypt instalacji lokalnej	localSetupScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji.
Lokalny skrypt zrywania	localTearDownScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania.
Czas odpowiedzi obniżonej wydajności	degradedResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć obniżenie wydajności sprawdzania.
Maksymalny czas odpowiedzi	maxResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć niepowodzenie sprawdzania.
Lokalizacje prywatne	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.

Zwraca

Body: Check

Aktualizowanie sprawdzania interfejsu API

Identyfikator operacji:: PutV1ChecksApiId

Aktualizuje sprawdzanie interfejsu API.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name		string	Nazwa sprawdzania.
Aktywowany	activated		boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail		boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags		array of string	Tagi do organizowania i filtrowania testów.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder		number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
metoda	method	True	string
adres URL	url	True	string	Adres URL.
Obserwowanie przekierowań	followRedirects		boolean	Czy postępować zgodnie z przekierowaniami.
Pomiń protokół SSL	skipSSL		boolean	Czy pominąć protokół SSL.
Body	body		string	Ciało.
Typ nadwozia	bodyType		string	Typ treści.
Key	key	True	string	Klucz.
Wartość	value	True	string	Wartość.
Zablokowane	locked		boolean	Czy zablokowane.
Źródło	source		string	Źródło.
Majątek	property		string	Właściwość .
Comparison	comparison		string	Porównanie.
Target	target		string	Cel.
Nazwa użytkownika	username	True	string	Nazwa użytkownika.
Hasło	password	True	string	Hasło.
Częstotliwość	frequency		integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Identyfikator fragmentu kodu w dół	tearDownSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API.
Identyfikator fragmentu kodu instalatora	setupSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie konfiguracji sprawdzania interfejsu API.
Przesunięcie częstotliwości	frequencyOffset		integer	Służy do ustawiania sekund dla częstotliwości sprawdzania poniżej 1 minut i rozkładania kontroli w zakresie czasu częstotliwości w ciągu 1 minuty. Działa to w następujący sposób: Kontrole z częstotliwością 0 mogą mieć wartość frequencyOffset 10, 20 lub 30, co oznacza, że będą uruchamiane co 10, 20 lub 30 sekund. Sprawdzanie z częstotliwością niższą niż i równą 60 może mieć właściwość frequencyOffset z zakresu od 1 do maksymalnej wartości na podstawie formuły Math.floor(frequency * 10), tj. dla sprawdzenia, które jest uruchamiane co 5 minut, maksymalna częstotliwośćOffset wynosi 50. Sprawdzanie z częstotliwością wyższą niż 60 może mieć wartość frequencyOffset z zakresu od 1 do wartości maksymalnej na podstawie formuły Math.ceil(frequency / 60), tj. w przypadku sprawdzenia, które jest uruchamiane co 720 minut, maksymalna częstotliwośćOffset wynosi 12.
Skrypt instalacji lokalnej	localSetupScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji.
Lokalny skrypt zrywania	localTearDownScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania.
Czas odpowiedzi obniżonej wydajności	degradedResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć obniżenie wydajności sprawdzania.
Maksymalny czas odpowiedzi	maxResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć niepowodzenie sprawdzania.
Lokalizacje prywatne	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.

Zwraca

Body: CheckAPI

Aktualizowanie sprawdzania przeglądarki

Identyfikator operacji:: PutV1ChecksBrowserId

Aktualizuje sprawdzanie przeglądarki.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name		string	Nazwa sprawdzania.
Aktywowany	activated		boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail		boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags		array of string	Tagi do organizowania i filtrowania testów.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder		number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
Key	key	True	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.
Częstotliwość	frequency		integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Skrypt	script		string	Prawidłowy fragment kodu javascript Node.js opisujący interakcję przeglądarki z platformami Puppeteer lub Playwright.
Lokalizacje prywatne	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.

Zwraca

Body: CheckBrowser

Aktualizowanie subskrypcji kanału alertów

Identyfikator operacji:: PutV1AlertchannelsIdSubscriptions

Zaktualizuj subskrypcje kanału alertów. Służy do dodawania sprawdzania do kanału alertów, dzięki czemu alerty dotyczące niepowodzeń i odzyskiwania są wysyłane do tego sprawdzenia. Uwaga: podczas przekazywania obiektu subskrypcji można określić tylko identyfikator checkId lub groupId, a nie oba.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.
Sprawdź identyfikator	checkId		guid	Można przekazać identyfikator checkId lub groupId, ale nie oba.
Identyfikator grupy	groupId		number	Można przekazać identyfikator checkId lub groupId, ale nie oba.
Aktywowany	activated	True	boolean	Czy aktywowano.

Zwraca

Body: AlertChanelSubscription

Aktualizowanie zmiennej środowiskowej

Identyfikator operacji:: PutV1VariablesKey

Aktualizuje zmienną środowiskową. Używa pola klucza jako identyfikatora do aktualizowania. Aktualizuje tylko wartość i zablokowaną właściwość.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Key	key	True	string	Klucz.
Key	key		string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.

Zwraca

Body: EnvironmentVariable

Generowanie nowego klucza interfejsu API dla lokalizacji prywatnej

Identyfikator operacji:: PostV1PrivatelocationsIdKeys

Tworzy klucz interfejsu API w lokalizacji prywatnej.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.

Zwraca

Body: privateLocationKeys

Generuje dostosowywalny raport dla wszystkich metryk sprawdzania przeglądarki

Identyfikator operacji:: GetV2ReportingBrowserchecksId

Generuje raport z zagregowanymi lub niegregowanymi statystykami dla określonej kontroli przeglądarki w określonym przedziale czasu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.
Źródło	from		date	Niestandardowy czas rozpoczęcia okna raportowania w formacie znacznika czasu systemu unix. Ustawienie niestandardowego znacznika czasu zastępuje użycie dowolnego ustawienia wstępnegoWindow.
Do	to		date	Niestandardowy czas zakończenia okna raportowania w formacie znacznika czasu systemu UNIX. Ustawienie niestandardowego znacznika czasu zastępuje użycie dowolnego ustawienia wstępnegoWindow.
Okno ustawienia wstępne	presetWindow		string	Wstępnie ustawione okna raportowania służą do szybkiego generowania raportu w często używanych oknach. Można przesłonić za pomocą niestandardowego znacznika czasu i .
Interwał agregacji	aggregationInterval		number	Interwał czasu używany do agregowania metryk w minutach. Na przykład pięć minut to 300, 24 godziny to 1440.
Grupuj według	groupBy		string	Określa sposób grupowania danych serii.
Filtruj według stanu	filterByStatus		array	Użyj stanu, aby filtrować pod kątem sprawdzania, czy nie powiodło się, czy dane wyników sprawdzania zakończyły się powodzeniem.
Metrics	metrics		array	opcje metryk dla kontroli przeglądarki.

Zwraca

Atrybuty.

Attributes: object

Generuje raport z zagregowanymi statystykami dla kontroli i sprawdzania grup

Identyfikator operacji:: GetV1Reporting

Generuje raport ze zagregowanymi statystykami dla wszystkich kontroli lub filtrowanego zestawu kontroli w określonym przedziale czasu.

Parametry

Nazwa	Klucz	Typ	Opis
Źródło	from	date	Niestandardowy czas rozpoczęcia okna raportowania w formacie znacznika czasu systemu unix. Ustawienie niestandardowego znacznika czasu zastępuje użycie dowolnego ustawienia wstępnegoWindow.
Do	to	date	Niestandardowy czas zakończenia okna raportowania w formacie znacznika czasu systemu UNIX. Ustawienie niestandardowego znacznika czasu zastępuje użycie dowolnego ustawienia wstępnegoWindow.
Okno ustawienia wstępne	presetWindow	string	Wstępnie ustawione okna raportowania służą do szybkiego generowania raportu w często używanych oknach. Można przesłonić za pomocą niestandardowego znacznika czasu i .
Filtruj według tagów	filterByTags	array	Użyj tagów, aby filtrować kontrole, które chcesz zobaczyć w raporcie.
Dezaktywowany	deactivated	boolean	Filtruj testy według stanu aktywowanego.

Zwraca

Przedmioty: ReportingList

Pobieranie fragmentu kodu

Identyfikator operacji:: GetV1SnippetsId

Pokaż szczegóły określonego fragmentu kodu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Zwraca

Body: Snippet

Pobieranie grupy kontrolnej

Identyfikator operacji:: GetV1CheckgroupsId

Pokaż szczegóły określonej grupy kontrolnej.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Zwraca

Body: CheckGroup

Pobieranie jednego zaewidencjonowania w określonej grupie z zastosowanymi ustawieniami grupy

Identyfikator operacji:: GetV1CheckgroupsGroupidChecksCheckid

Pokaż szczegóły jednego zaewidencjonowania w określonej grupie kontrolnej z zastosowanymi ustawieniami grupy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	groupId	True	integer	Identyfikator grupy.
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.

Zwraca

Body: CheckGroupCheck

Pobieranie kanału alertów

Identyfikator operacji:: GetV1AlertchannelsId

Pokaż szczegóły określonego kanału alertu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Zwraca

Body: AlertChannel

Pobieranie lokalizacji prywatnej

Identyfikator operacji:: GetV1PrivatelocationsId

Pokaż szczegóły określonej lokalizacji prywatnej.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.

Zwraca

Body: privatelocationschema

Pobieranie metryk kondycji lokalizacji prywatnej z przedziału czasu

Identyfikator operacji:: GetV1PrivatelocationsIdMetrics

Pobieranie metryk kondycji lokalizacji prywatnej z przedziału czasu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.
Źródło	from	True	date	Wybierz metryki rozpoczynające się od tego znacznika czasu systemu UNIX. Musi być mniej niż 15 dni temu.
Do	to	True	date	Wybierz metryki do tego znacznika czasu systemu UNIX.

Zwraca

Body: privateLocationsMetricsHistoryResponseSchema

Pobieranie okna obsługi

Identyfikator operacji:: GetV1MaintenancewindowsId

Pokaż szczegóły określonego okna obsługi.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Zwraca

Body: MaintenanceWindow

Pobieranie sprawdzania

Identyfikator operacji:: GetV1ChecksId

Pokaż szczegóły określonego interfejsu API lub sprawdzania przeglądarki.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.

Zwraca

Body: Check

Pobieranie szczegółów stanu sprawdzania

Identyfikator operacji:: GetV1CheckstatusesCheckid

Pokaż bieżące informacje o stanie dla określonego sprawdzenia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.

Zwraca

Body: CheckStatus

Pobieranie wszystkich kontroli w określonej grupie z zastosowanymi ustawieniami grupy

Identyfikator operacji:: GetV1CheckgroupsIdChecks

Wyświetla listę wszystkich kontroli w określonej grupie kontrolnej z zastosowanymi ustawieniami grupy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.

Zwraca

Przedmioty: Model8

Pobieranie wyniku sprawdzania

Identyfikator operacji:: GetV1CheckresultsCheckidCheckresultid

Pokaż szczegóły określonego wyniku sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.
Sprawdzanie identyfikatora wyniku	checkResultId	True	string	Identyfikator wyniku sprawdzania.

Zwraca

Body: CheckResult

Pobieranie wyzwalacza sprawdzania

Identyfikator operacji:: GetV1TriggersChecksCheckid

Znajduje wyzwalacz sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.

Zwraca

Body: CheckTrigger

Pobieranie zmiennej środowiskowej

Identyfikator operacji:: GetV1VariablesKey

Pokaż szczegóły określonej zmiennej środowiskowej. Używa pola klucza do wyboru.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Key	key	True	string	Klucz.

Zwraca

Body: EnvironmentVariable

Pokazuje szczegóły dla jednego określonego środowiska uruchomieniowego

Identyfikator operacji:: GetV1RuntimesId

Przedstawia szczegóły wszystkich dołączonych pakietów NPM i ich wersji dla jednego określonego środowiska uruchomieniowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.

Zwraca

Body: Runtime

Tworzenie fragmentu kodu

Identyfikator operacji:: PostV1Snippets

Tworzy nowy fragment kodu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa fragmentu kodu.
Skrypt	script	True	string	Kod Node.js, który wchodzi w interakcję z cyklem życia sprawdzania interfejsu API, lub działa jako częściowy kod do sprawdzania przeglądarki.

Zwraca

Body: Snippet

Tworzenie grupy kontrolnej

Identyfikator operacji:: PostV1Checkgroups

Tworzy nową grupę kontrolną. Możesz dodać kontrole do grupy, ustawiając właściwość groupId poszczególnych testów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name	True	string	Nazwa grupy kontrolnej.
Aktywowany	activated		boolean	Określa, czy kontrole w grupie są uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane, gdy zaewidencjonowanie tej grupy nie powiedzie się i/lub odzyska.
Sprawdzanie listy tagów grupy	tags		array of string	Tagi do organizowania i filtrowania testów.
Sprawdzanie listy lokalizacji grupy	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której należy uruchomić kontrole.
Concurrency	concurrency		number	Określa, ile testów jest wywoływanych współbieżnie podczas wyzwalania grupy kontrolnej z ciągłej integracji/ciągłego wdrażania lub za pośrednictwem interfejsu API.
adres URL	url		string	Podstawowy adres URL dla tej grupy, do której można odwoływać się za pomocą zmiennej {{GROUP_BASE_URL}} we wszystkich sprawdzaniach grup.
Key	key	True	string	Klucz.
Wartość	value	True	string	Wartość.
Zablokowane	locked		boolean	Czy zablokowane.
Źródło	source		string	Źródło.
Majątek	property		string	Właściwość .
Comparison	comparison		string	Porównanie.
Target	target		string	Cel.
Nazwa użytkownika	username	True	string	Nazwa użytkownika.
Hasło	password	True	string	Hasło.
Sprawdzanie domyślnych ustawień domyślnych tworzenia przeglądarki w grupie	browserCheckDefaults		object	Ustawienie domyślne tworzenia przeglądarki jest sprawdzane przez grupę kontrolną.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonywania kontroli w tej grupie.
Key	key	True	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane w tej grupie kontrolnej.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
Identyfikator fragmentu kodu instalatora	setupSnippetId		number	Odwołanie identyfikatora do fragmentu kodu do użycia w fazie instalacji ewidencjonowania interfejsu API w tej grupie.
Identyfikator fragmentu kodu w dół	tearDownSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API w tej grupie.
Skrypt instalacji lokalnej	localSetupScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji sprawdzania interfejsu API w tej grupie.
Lokalny skrypt zrywania	localTearDownScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania interfejsu API w tej grupie.
Sprawdzanie lokalizacji prywatnych	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić kontrole.

Zwraca

Body: CheckGroup

Tworzenie kanału alertów

Identyfikator operacji:: PostV1Alertchannels

Tworzy nowy kanał alertów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id		number	Identyfikator.
Sprawdź identyfikator	checkId		guid	Identyfikator sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy.
Aktywowany	activated	True	boolean	Czy aktywowano.
Typ	type	True	string	Typ.
Konfiguracja tworzenia kanału alertów	config	True	object	Kanał alertu tworzy konfigurację.
Wysyłanie odzyskiwania	sendRecovery		boolean	Czy wysyłać odzyskiwanie.
Niepowodzenie wysyłania	sendFailure		boolean	Czy niepowodzenie wysyłania.
Obniżona wydajność wysyłania	sendDegraded		boolean	Czy wysyłanie jest obniżone.
Wygaśnięcie protokołu SSL	sslExpiry		boolean	Określa, czy alert powinien być wysyłany do wygasających certyfikatów SSL.
Próg wygaśnięcia protokołu SSL	sslExpiryThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.

Zwraca

Body: AlertChannel

Tworzenie lokalizacji prywatnej

Identyfikator operacji:: PostV1Privatelocations

Tworzy nową lokalizację prywatną.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa przypisana do lokalizacji prywatnej.
Nazwa ślimaka	slugName	True	string	Prawidłowa nazwa ślimaka.
Icon	icon		string	Ikona.

Zwraca

Body: commonPrivateLocationSchemaResponse

Tworzenie okna obsługi

Identyfikator operacji:: PostV1Maintenancewindows

Tworzy nowe okno obsługi.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa okna obsługi.
Lista tagów okna obsługi	tags		array of string	Nazwy okien obsługi sprawdzania i grup powinny mieć zastosowanie.
Rozpoczyna się od	startsAt	True	date	Data rozpoczęcia okna obsługi.
Kończy się na	endsAt	True	date	Data zakończenia okna obsługi.
Powtarzanie interwału	repeatInterval		number	Interwał powtarzania okna obsługi od pierwszego wystąpienia.
Powtórz jednostkę	repeatUnit	True	string	Strategia powtarzania okna obsługi.
Powtarzanie kończy się na	repeatEndsAt		date	Data zakończenia, w której okno obsługi powinno przestać się powtarzać.

Zwraca

Body: MaintenanceWindow

Tworzenie pulpitu nawigacyjnego

Identyfikator operacji:: PostV1Dashboards

Tworzy nowy pulpit nawigacyjny. Zwróci błąd 409 podczas próby utworzenia pulpitu nawigacyjnego z niestandardowym adresem URL lub domeną niestandardową, która jest już zajęta.

Parametry

Nazwa	Klucz	Typ	Opis
Niestandardowy adres URL	customUrl	string	Nazwa poddomeny w obszarze checklyhq.com. Musi być unikatowa dla wszystkich użytkowników.
Custom Domain	customDomain	string	Niestandardowa domena użytkownika, np. status.example.com. Zapoznaj się z dokumentacją dotyczącą aktualizowania użycia usługi DNS i protokołu SSL.
Logo	logo	string	Adres URL wskazujący plik obrazu.
Favicon (ikona ulubionych)	favicon	string	Adres URL wskazujący plik obrazu używany jako favicon pulpitu nawigacyjnego.
Link	link	string	Link adresu URL do przekierowania po kliknięciu logo pulpitu nawigacyjnego.
Header	header	string	Fragment tekstu wyświetlany w górnej części pulpitu nawigacyjnego.
Description	description	string	Fragment tekstu wyświetlany poniżej nagłówka lub tytułu pulpitu nawigacyjnego.
Szerokość	width	string	Określa, czy używać pełnego ekranu, czy fokusu w środku.
Częstotliwość odświeżania	refreshRate	number	Jak często odświeżać pulpit nawigacyjny w sekundach.
Podzielony	paginate	boolean	Określa stronicowanie jest włączone lub wyłączone.
Szybkość stronicowania	paginationRate	number	Jak często wyzwalać stronicowanie w sekundach.
Sprawdzanie na stronę	checksPerPage	number	Liczba wyświetlanych testów na stronę.
Używanie operatora i	useTagsAndOperator	boolean	Kiedy używać operatora AND dla wyszukiwania tagów.
Ukryj tagi	hideTags	boolean	Pokaż lub ukryj tagi na pulpicie nawigacyjnym.
Lista tagów pulpitu nawigacyjnego	tags	array of string	Lista co najmniej jednego tagu, który filtruje sprawdzanie, które ma być wyświetlane na pulpicie nawigacyjnym.

Zwraca

Body: Dashboard

Tworzenie sprawdzania [PRZESTARZAŁE]

Identyfikator operacji:: PostV1Checks

[PRZESTARZAŁE] Ten punkt końcowy zostanie usunięty w poniedziałek 4 lipca 2022 r. Zamiast tego użyj polecenia POST /checks/api lub POST /checks/browser. Tworzy nowy interfejs API lub sprawdzanie przeglądarki. Zwróci wartość 402 , gdy przekraczasz limit planu. W przypadku korzystania z elementu globalAlertSettingsalertSettings element może mieć wartośćnull

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name	True	string	Nazwa sprawdzania.
Aktywowany	activated	True	boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail		boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags		array of string	Tagi do organizowania i filtrowania testów.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder		number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
Sprawdzanie typu	checkType	True	string	Typ sprawdzania.
Częstotliwość	frequency		integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Przesunięcie częstotliwości	frequencyOffset		integer	Służy do ustawiania sekund dla częstotliwości sprawdzania poniżej 1 minut (tylko w przypadku sprawdzania interfejsu API) i rozłożenia kontroli w zakresie czasu częstotliwości w ciągu 1 minuty. Działa to w następujący sposób: Kontrole z częstotliwością 0 mogą mieć wartość frequencyOffset 10, 20 lub 30, co oznacza, że będą uruchamiane co 10, 20 lub 30 sekund. Sprawdzanie z częstotliwością niższą niż i równą 60 może mieć właściwość frequencyOffset z zakresu od 1 do maksymalnej wartości na podstawie formuły Math.floor(frequency * 10), tj. dla sprawdzenia, które jest uruchamiane co 5 minut, maksymalna częstotliwośćOffset wynosi 50. Sprawdzanie z częstotliwością wyższą niż 60 może mieć wartość frequencyOffset z zakresu od 1 do wartości maksymalnej na podstawie formuły Math.ceil(frequency / 60), tj. w przypadku sprawdzenia, które jest uruchamiane co 720 minut, maksymalna częstotliwośćOffset wynosi 12.
Sprawdzanie żądania	request		object	Żądanie sprawdzania.
Skrypt	script	True	string	Skrypt.
Key	key	True	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.
Identyfikator fragmentu kodu instalatora	setupSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie konfiguracji sprawdzania interfejsu API.
Identyfikator fragmentu kodu w dół	tearDownSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API.
Skrypt instalacji lokalnej	localSetupScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji.
Lokalny skrypt zrywania	localTearDownScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania.
Czas odpowiedzi obniżonej wydajności	degradedResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć obniżenie wydajności sprawdzania.
Maksymalny czas odpowiedzi	maxResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć niepowodzenie sprawdzania.
Lokalizacje prywatne	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.

Zwraca

Body: Check

Tworzenie sprawdzania interfejsu API

Identyfikator operacji:: PostV1ChecksApi

Tworzy nowe sprawdzanie interfejsu API. Zwróci wartość 402 , gdy przekraczasz limit planu. W przypadku korzystania z elementu globalAlertSettingalertSetting element może mieć wartośćnull

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name	True	string	Nazwa sprawdzania.
Aktywowany	activated	True	boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail		boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags		array of string	Tagi do organizowania i filtrowania testów.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder		number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
metoda	method	True	string
adres URL	url	True	string	Adres URL.
Obserwowanie przekierowań	followRedirects		boolean	Czy następuje przekierowania.
Pomiń protokół SSL	skipSSL		boolean	Czy pominąć protokół SSL.
Body	body		string	Ciało.
bodyType	bodyType		string
Key	key	True	string	Klucz.
Wartość	value	True	string	Wartość.
Zablokowane	locked		boolean	Czy zablokowane.
Źródło	source		string	Źródło.
Majątek	property		string	Właściwość .
Comparison	comparison		string	Porównanie.
Target	target		string	Cel.
Nazwa użytkownika	username	True	string	Nazwa użytkownika.
Hasło	password	True	string	Hasło.
Częstotliwość	frequency		integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Identyfikator fragmentu kodu w dół	tearDownSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API.
Identyfikator fragmentu kodu instalatora	setupSnippetId		number	Odwołanie do fragmentu kodu do użycia w fazie konfiguracji sprawdzania interfejsu API.
Przesunięcie częstotliwości	frequencyOffset		integer	Służy do ustawiania sekund dla częstotliwości sprawdzania poniżej 1 minut i rozkładania kontroli w zakresie czasu częstotliwości w ciągu 1 minuty. Działa to w następujący sposób: Kontrole z częstotliwością 0 mogą mieć wartość frequencyOffset 10, 20 lub 30, co oznacza, że będą uruchamiane co 10, 20 lub 30 sekund. Sprawdzanie z częstotliwością niższą niż i równą 60 może mieć właściwość frequencyOffset z zakresu od 1 do maksymalnej wartości na podstawie formuły Math.floor(frequency * 10), tj. dla sprawdzenia, które jest uruchamiane co 5 minut, maksymalna częstotliwośćOffset wynosi 50. Sprawdzanie z częstotliwością wyższą niż 60 może mieć wartość frequencyOffset z zakresu od 1 do wartości maksymalnej na podstawie formuły Math.ceil(frequency / 60), tj. w przypadku sprawdzenia, które jest uruchamiane co 720 minut, maksymalna częstotliwośćOffset wynosi 12.
Skrypt instalacji lokalnej	localSetupScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji.
Lokalny skrypt zrywania	localTearDownScript		string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania.
Czas odpowiedzi obniżonej wydajności	degradedResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć obniżenie wydajności sprawdzania.
Maksymalny czas odpowiedzi	maxResponseTime		number	Czas odpowiedzi w milisekundach, w których należy rozważyć niepowodzenie sprawdzania.
Lokalizacje prywatne	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.

Zwraca

Body: CheckAPI

Tworzenie sprawdzania przeglądarki

Identyfikator operacji:: PostV1ChecksBrowser

Tworzy nowe sprawdzanie przeglądarki. Zwróci wartość 402 , gdy przekraczasz limit planu. W przypadku korzystania z elementu globalAlertSettingalertSetting element może mieć wartośćnull

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Automatyczne przypisywanie alertów	autoAssignAlerts		boolean	Określa, czy nowe sprawdzanie zostanie automatycznie dodane jako subskrybent do wszystkich istniejących kanałów alertów po jego utworzeniu.
Name	name	True	string	Nazwa sprawdzania.
Aktywowany	activated	True	boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted		boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck		boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail		boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations		array of string	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags		array of string	Tagi do organizowania i filtrowania testów.
Typ eskalacji	escalationType		string	Określa typ eskalacji do użycia.
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold		number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.
Próg niepowodzenia minut	minutesFailingThreshold		number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.
Kwota	amount		number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval		number	W jakim odstępie czasu powinny być wysyłane przypomnienia.
Włączona	enabled		boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold		integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Używanie globalnych ustawień alertów	useGlobalAlertSettings		boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId		number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder		number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId		string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
Identyfikator kanału alertu	alertChannelId	True	number	Identyfikator kanału alertu.
Aktywowany	activated	True	boolean	Czy aktywowano.
Key	key	True	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.
Częstotliwość	frequency		integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Skrypt	script	True	string	Prawidłowy fragment kodu javascript Node.js opisujący interakcję przeglądarki z platformami Puppeteer lub Playwright.
Lokalizacje prywatne	privateLocations		array of string	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.

Zwraca

Body: CheckBrowser

Tworzenie wyzwalacza grupy sprawdzania

Identyfikator operacji:: PostV1TriggersCheckgroupsGroupid

Tworzy wyzwalacz grupy sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	groupId	True	integer	Identyfikator grupy.

Zwraca

Body: CheckGroupTrigger

Tworzenie wyzwalacza sprawdzania

Identyfikator operacji:: PostV1TriggersChecksCheckid

Tworzy wyzwalacz sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.

Zwraca

Body: CheckTrigger

Tworzenie zmiennej środowiskowej

Identyfikator operacji:: PostV1Variables

Tworzy nową zmienną środowiskową.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Key	key	True	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	True	string	Wartość zmiennej środowiskowej.
Zablokowane	locked		boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.

Zwraca

Body: EnvironmentVariable

Usuwanie fragmentu kodu

Identyfikator operacji:: DeleteV1SnippetsId

Trwale usuwa fragment kodu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Usuwanie grupy kontrolnej

Identyfikator operacji:: DeleteV1CheckgroupsId

Trwale usuwa grupę kontrolną. Nie można usunąć grupy sprawdzania, jeśli nadal zawiera testy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Usuwanie istniejącego klucza interfejsu API dla lokalizacji prywatnej

Identyfikator operacji:: DeleteV1PrivatelocationsIdKeysKeyid

Trwale usuwa klucz interfejsu API z lokalizacji prywatnej.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.
Identyfikator klucza	keyId	True	string	Identyfikator klucza.

Usuwanie kanału alertów

Identyfikator operacji:: DeleteV1AlertchannelsId

Trwale usuwa kanał alertów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Usuwanie lokalizacji prywatnej

Identyfikator operacji:: DeleteV1PrivatelocationsId

Trwale usuwa lokalizację prywatną.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.

Usuwanie okna obsługi

Identyfikator operacji:: DeleteV1MaintenancewindowsId

Trwale usuwa okno obsługi.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	integer	Identyfikator.

Usuwanie sprawdzania

Identyfikator operacji:: DeleteV1ChecksId

Trwale usuwa interfejs API lub sprawdzanie przeglądarki oraz wszystkie powiązane z nią dane o stanie i wynikach.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	id	True	string	Identyfikator.

Usuwanie wyzwalacza grupy sprawdzania

Identyfikator operacji:: DeleteV1TriggersCheckgroupsGroupid

Usuwa wyzwalacz grup sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	groupId	True	integer	Identyfikator grupy.

Usuwanie wyzwalacza sprawdzania

Identyfikator operacji:: DeleteV1TriggersChecksCheckid

Usuwa wyzwalacz sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.

Usuwanie zmiennej środowiskowej

Identyfikator operacji:: DeleteV1VariablesKey

Trwale usuwa zmienną środowiskową. Używa pola klucza jako identyfikatora do usunięcia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Key	key	True	string	Klucz.

Usuń pulpit nawigacyjny

Identyfikator operacji:: DeleteV1DashboardsDashboardid

Trwale usuwa pulpit nawigacyjny.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
identyfikator	dashboardId	True	string	Identyfikator pulpitu nawigacyjnego.

Uzyskiwanie wyzwalacza grupy kontrolnej

Identyfikator operacji:: GetV1TriggersCheckgroupsGroupid

Znajduje wyzwalacz grupy sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	groupId	True	integer	Identyfikator grupy.

Zwraca

Body: CheckGroupTrigger

Wyświetl listę wszystkich testów

Identyfikator operacji:: GetV1Checks

Wyświetla listę wszystkich bieżących kontroli na koncie.

Parametry

Nazwa	Klucz	Typ	Opis
Ograniczenie	limit	integer	Ogranicz liczbę wyników.
Number	page	number	Numer strony.
Filtr adresu URL sprawdzania interfejsu API	apiCheckUrlFilterPattern	string	Filtruje wyniki według ciągu zawartego w adresie URL sprawdzania interfejsu API, na przykład domeny, takiej jak www.myapp.com. Zwraca tylko kontrole interfejsu API.

Zwraca

Przedmioty: CheckList

Wyświetl wszystkie fragmenty kodu

Identyfikator operacji:: GetV1Snippets

Wyświetla listę wszystkich bieżących fragmentów kodu na twoim koncie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.

Zwraca

Przedmioty: SnippetList

Wyświetla listę wszystkich obsługiwanych lokalizacji

Identyfikator operacji:: GetV1Locations

Wyświetla listę wszystkich obsługiwanych lokalizacji.

Zwraca

Przedmioty: LocationList

Wyświetla listę wszystkich obsługiwanych środowisk uruchomieniowych

Identyfikator operacji:: GetV1Runtimes

Wyświetla listę wszystkich obsługiwanych środowisk uruchomieniowych i dołączonych pakietów NPM do sprawdzania i konfigurowania i usuwania skryptów na potrzeby sprawdzania interfejsu API.

Zwraca

Przedmioty: RuntimeList

Wyświetla wszystkie wyniki sprawdzania

Identyfikator operacji:: GetV1CheckresultsCheckid

Wyświetla listę pełnych, nieprzetworzonych wyników sprawdzania dla określonego sprawdzenia. Utrzymujemy nieprzetworzone wyniki przez 30 dni. Po 30 dniach zostaną one wymazane. Jednak utrzymujemy zwijane wyniki przez nieokreślony okres. Możesz filtrować według typu sprawdzania i typu wyników, aby zawęzić listę. Użyj parametrów to i from , aby określić zakres dat (sygnatura czasowa systemu UNIX w sekundach). W zależności od typu sprawdzania niektóre pola mogą mieć wartość null. Ten punkt końcowy zwróci dane w ciągu sześciu godzin. Jeśli parametry z i do parametrów są ustawione, muszą być co najwyżej sześć godzin od siebie. Jeśli żadna z nich nie zostanie ustawiona, rozważymy parametr do teraz i z parametru do sześciu godzin wcześniej. Jeśli parametr to jest ustawiony, ustawimy wartość z na sześć godzin wcześniej. Wręcz przeciwnie, jeśli tylko parametr z parametru zostanie ustawiony, rozważymy parametr do sześciu godzin później. Ograniczenie szybkości jest stosowane do tego punktu końcowego. Można wysłać co najwyżej 5 żądań na 10 sekund.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.
Źródło	from		date	Wybierz dokumenty w górę z tego znacznika czasu systemu UNIX (>= data). Wartość domyślna to teraz — 6 godzin.
Do	to		date	Wybierz alerty do tej sygnatury czasowej systemu UNIX (< data). Wartość domyślna to 6 godzin po.
Lokalizacja	location		string	Podaj lokalizację centrum danych, np. eu-west-1, aby filtrować według lokalizacji
Sprawdzanie typu	checkType		string	Typ sprawdzania.
Ma błędy	hasFailures		boolean	Wynik sprawdzania zawiera co najmniej jeden błąd.

Zwraca

Przedmioty: CheckResultList

Wyświetlanie listy alertów dotyczących określonego sprawdzenia

Identyfikator operacji:: GetV1CheckalertsCheckid

Wyświetla listę wszystkich alertów dla określonego sprawdzenia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.
Źródło	from		date	Wybierz dokumenty w górę z tego znacznika czasu systemu UNIX (>= data). Wartość domyślna to teraz — 6 godzin.
Do	to		date	Wybierz alerty do tej sygnatury czasowej systemu UNIX (< data). Wartość domyślna to 6 godzin po.

Zwraca

Przedmioty: CheckAlertList

Wyświetlanie listy wszystkich alertów dla konta

Identyfikator operacji:: GetV1Checkalerts

Wyświetla listę wszystkich alertów dla twojego konta.

Parametry

Nazwa	Klucz	Typ	Opis
Ograniczenie	limit	integer	Ogranicz liczbę wyników.
Number	page	number	Numer strony.
Źródło	from	date	Wybierz dokumenty w górę z tego znacznika czasu systemu UNIX (>= data). Wartość domyślna to teraz — 6 godzin.
Do	to	date	Wybierz alerty do tej sygnatury czasowej systemu UNIX (< data). Wartość domyślna to 6 godzin po.

Zwraca

Przedmioty: CheckAlertList

Wyświetlanie listy wszystkich grup sprawdzania

Identyfikator operacji:: GetV1Checkgroups

Wyświetla listę wszystkich bieżących grup kontrolnych na koncie. Właściwość checks to tablica identyfikatorów UUID sprawdzania w celu wygodnego odwoływania się. Jest on tylko do odczytu i nie można go używać do dodawania kontroli do grupy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.

Zwraca

Przedmioty: CheckGroupList

Wyświetlanie listy wszystkich kanałów alertów

Identyfikator operacji:: GetV1Alertchannels

Wyświetla listę wszystkich skonfigurowanych kanałów alertów i ich subskrybowanych testów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.

Zwraca

Przedmioty: AlertChannelList

Wyświetlanie listy wszystkich lokalizacji prywatnych

Identyfikator operacji:: GetV1Privatelocations

Wyświetla listę wszystkich lokalizacji prywatnych na koncie.

Zwraca

Przedmioty: privateLocationsListSchema

Wyświetlanie listy wszystkich okien obsługi

Identyfikator operacji:: GetV1Maintenancewindows

Wyświetla listę wszystkich okien obsługi na koncie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.

Zwraca

Lista okien obsługi.

Przedmioty: MaintenanceWindowList

Wyświetlanie listy wszystkich pulpitów nawigacyjnych

Identyfikator operacji:: GetV1Dashboards

Wyświetla listę wszystkich bieżących pulpitów nawigacyjnych na koncie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.

Zwraca

Przedmioty: DashboardsList

Wyświetlanie listy wszystkich stanów sprawdzania

Identyfikator operacji:: GetV1Checkstatuses

Przedstawia bieżące informacje o stanie dla wszystkich kontroli na twoim koncie. Rekordy stanu sprawdzania są stale aktualizowane, gdy pojawiają się nowe wyniki sprawdzania.

Zwraca

Przedmioty: CheckStatusList

Wyświetlanie listy wszystkich zmiennych środowiskowych

Identyfikator operacji:: GetV1Variables

Wyświetla listę wszystkich bieżących zmiennych środowiskowych na koncie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Ogranicz liczbę wyników.
Number	page		number	Numer strony.

Zwraca

Przedmioty: EnvironmentVariableList

Znaczek Uzyskiwanie stanu grupy

Identyfikator operacji:: GetV1BadgesGroupsGroupid

Uzyskaj wskaźnik stanu grupy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	groupId	True	integer	Identyfikator grupy.
Styl	style		string	Styl.
Theme	theme		string	Motyw.
Czas odpowiedzi	responseTime		boolean	Czas odpowiedzi.

Zwraca

response: string

Znaczek Uzyskiwanie stanu sprawdzania

Identyfikator operacji:: GetV1BadgesChecksCheckid

Uzyskaj wskaźnik stanu sprawdzania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Sprawdź identyfikator	checkId	True	string	Identyfikator sprawdzania.
Styl	style		string	Styl.
Theme	theme		string	Motyw.
Czas odpowiedzi	responseTime		boolean	Czas odpowiedzi.

Zwraca

response: string

Definicje

AlertChannelConfig

Konfiguracja kanału alertów.

Nazwa	Ścieżka	Typ	Opis
Konfiguracja kanału alertów		object	Konfiguracja kanału alertów.

AlertChanelSubscription

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	number	Identyfikator.
Sprawdź identyfikator	checkId	guid	Identyfikator sprawdzania.
Identyfikator grupy	groupId	number	Identyfikator grupy.
Aktywowany	activated	boolean	Czy aktywowano.

AlertChanelSubscriptionList

Wszystkie testy zasubskrybowane do tego kanału.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		AlertChanelSubscription

AlertChannel

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	number	Identyfikator.
Typ	type	string	Typ kanału alertu, tj. ADRES E-MAIL lub SLACK.
Konfiguracja kanału alertów	config	AlertChannelConfig	Konfiguracja kanału alertów.
Lista subskrypcji kanału alertów	subscriptions	AlertChanelSubscriptionList	Wszystkie testy zasubskrybowane do tego kanału.
Wysyłanie odzyskiwania	sendRecovery	boolean	Czy wysyłać odzyskiwanie.
Niepowodzenie wysyłania	sendFailure	boolean	Czy niepowodzenie wysyłania.
Obniżona wydajność wysyłania	sendDegraded	boolean	Czy wysyłanie jest obniżone.
Wygaśnięcie protokołu SSL	sslExpiry	boolean	Określa, czy alert powinien być wysyłany do wygasających certyfikatów SSL.
Próg wygaśnięcia protokołu SSL	sslExpiryThreshold	integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.
Utworzono pod adresem	created_at	date-time	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

AlertChannelList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		AlertChannel

CheckAlert

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator tego alertu.
Name	name	string	Nazwa sprawdzania.
Sprawdź identyfikator	checkId	string	Identyfikator sprawdzania, czy ten alert należy do.
Typ alertu	alertType	string	Typ alertu.
Sprawdzanie typu	checkType	string	Typ sprawdzania.
Lokalizacja uruchamiania	runLocation	string	Z której lokalizacji centrum danych został wyzwolony ten alert sprawdzania.
Czas odpowiedzi	responseTime	number	Opisuje czas wykonywania odpowiednich części tego sprawdzania. Każdy czas system czasomierza konfiguracji potrzebny do rozpoczęcia wykonywania tego zaewidencjonowania w zapleczu Checkly nie jest częścią tego.
Error	error	string	Wszelkie określone komunikaty o błędach, które były częścią sprawdzania niepowodzenia wyzwalającego alert.
Kod stanu	statusCode	string	Kod stanu odpowiedzi. Dotyczy tylko kontroli interfejsu API.
Utworzono pod adresem	created_at	date	Data i godzina utworzenia tego alertu sprawdzania.
Rozpoczęto o	startedAt	date	Data i godzina rozpoczęcia tego alertu sprawdzania.

CheckAlertList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckAlert

CheckGroupTagList

Tagi do organizowania i filtrowania testów.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

CheckGroupLocationList

Tablica z co najmniej jedną lokalizacją centrum danych, w której należy uruchomić kontrole.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

KeyValue

Nazwa	Ścieżka	Typ	Opis
Key	key	string	Klucz.
Wartość	value	string	Wartość.
Zablokowane	locked	boolean	Czy zablokowane.

Lista nagłówków

Nazwa	Ścieżka	Typ	Opis
Przedmioty		KeyValue

QueryParameterList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		KeyValue

Twierdzenie

Nazwa	Ścieżka	Typ	Opis
Źródło	source	string	Źródło.
Majątek	property	string	Właściwość .
Comparison	comparison	string	Porównanie.
Target	target	string	Cel.

AssertionList

Zapoznaj się z główną dokumentacją checkly dotyczącą asercji pod kątem określonych wartości, takich jak wyrażenia regularne i deskryptory ścieżki JSON, których można użyć w polu właściwości.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		Assertion

BasicAuth

Nazwa	Ścieżka	Typ	Opis
Nazwa użytkownika	username	string	Nazwa użytkownika.
Hasło	password	string	Hasło.

CheckGroupAPICheckDefaults

Nazwa	Ścieżka	Typ	Opis
adres URL	url	string	Podstawowy adres URL dla tej grupy, do której można odwoływać się za pomocą zmiennej {{GROUP_BASE_URL}} we wszystkich sprawdzaniach grup.
headers	headers	HeaderList
Parametry zapytania	queryParameters	QueryParameterList
Lista asercji	assertions	AssertionList	Zapoznaj się z główną dokumentacją checkly dotyczącą asercji pod kątem określonych wartości, takich jak wyrażenia regularne i deskryptory ścieżki JSON, których można użyć w polu właściwości.
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

Przeglądarka grupy sprawdzania sprawdza wartości domyślne.

Nazwa	Ścieżka	Typ	Opis
Sprawdzanie wartości domyślnych przeglądarki grupy		object	Przeglądarka grupy sprawdzania sprawdza wartości domyślne.

EnvironmentVariable

Nazwa	Ścieżka	Typ	Opis
Key	key	string	Klucz zmiennej środowiskowej (nie można zmienić tej wartości).
Wartość	value	string	Wartość zmiennej środowiskowej.
Zablokowane	locked	boolean	Używany tylko w interfejsie użytkownika do ukrywania wartości takiej jak hasło.

EnvironmentVariableList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		EnvironmentVariable

AlertSettingsRunBasedEscalation

Nazwa	Ścieżka	Typ	Opis
Próg uruchomienia, który zakończył się niepowodzeniem	failedRunThreshold	number	Po tym, ile kolejnych operacji sprawdzania nie powiodło się, powinno zostać wysłane powiadomienie o alercie.

AlertSettingsTimeBasedEscalation

Nazwa	Ścieżka	Typ	Opis
Próg niepowodzenia minut	minutesFailingThreshold	number	Po liczbie minut po rozpoczęciu sprawdzania powinien zostać wysłany alert.

AlertSettingsReminders

Nazwa	Ścieżka	Typ	Opis
Kwota	amount	number	Ile przypomnień ma być wysyłanych po początkowym powiadomieniu o alercie.
Odstęp	interval	number	W jakim odstępie czasu powinny być wysyłane przypomnienia.

AlertSettingsSSLCertificates

[PRZESTARZAŁE] sslCertificates jest przestarzały i nie jest już używany. Zignoruj go, zostanie usunięty w przyszłej wersji.

Nazwa	Ścieżka	Typ	Opis
Włączona	enabled	boolean	Określa, czy powiadomienia o alertach powinny być wysyłane dla wygasających certyfikatów SSL.
Próg alertu	alertThreshold	integer	W tym momencie, aby rozpocząć alerty dotyczące certyfikatów SSL.

CheckGroupAlertSettings

Ustawienia alertu.

Nazwa	Ścieżka	Typ	Opis
Typ eskalacji	escalationType	string	Określa typ eskalacji do użycia.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Przypomnienia	reminders	AlertSettingsReminders
Ustawienia alertów Certyfikaty SSL	sslCertificates	AlertSettingsSSLCertificates	[PRZESTARZAŁE] `sslCertificates` jest przestarzały i nie jest już używany. Zignoruj go, zostanie usunięty w przyszłej wersji.

Model1

Subskrypcja kanału alertów.

Nazwa	Ścieżka	Typ	Opis
Identyfikator kanału alertu	alertChannelId	number	Identyfikator kanału alertu.
Aktywowany	activated	boolean	Czy aktywowano.

AlertChannelSubscriptionCreateList

Lista subskrypcji kanału alertów.

Nazwa	Ścieżka	Typ	Opis
Subskrypcja kanału alertów		Model1	Subskrypcja kanału alertów.

privateLocations

Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

CheckGroup

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	number	Identyfikator.
Name	name	string	Nazwa grupy kontrolnej.
Aktywowany	activated	boolean	Określa, czy kontrole w grupie są uruchomione, czy nie.
Wyciszony	muted	boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane, gdy zaewidencjonowanie tej grupy nie powiedzie się i/lub odzyska.
Sprawdzanie listy tagów grupy	tags	CheckGroupTagList	Tagi do organizowania i filtrowania testów.
Sprawdzanie listy lokalizacji grupy	locations	CheckGroupLocationList	Tablica z co najmniej jedną lokalizacją centrum danych, w której należy uruchomić kontrole.
Concurrency	concurrency	number	Określa, ile testów jest wywoływanych współbieżnie podczas wyzwalania grupy kontrolnej z ciągłej integracji/ciągłego wdrażania lub za pośrednictwem interfejsu API.
apiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Sprawdzanie wartości domyślnych przeglądarki grupy	browserCheckDefaults	CheckGroupBrowserCheckDefaults	Przeglądarka grupy sprawdzania sprawdza wartości domyślne.
environmentVariables	environmentVariables	EnvironmentVariableList
Sprawdzanie podwójne	doubleCheck	boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Używanie globalnych ustawień alertów	useGlobalAlertSettings	boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane w tej grupie kontrolnej.
Sprawdzanie ustawień alertu grupy	alertSettings	CheckGroupAlertSettings	Ustawienia alertu.
Lista tworzenia subskrypcji kanału alertów	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Lista subskrypcji kanału alertów.
Identyfikator fragmentu kodu instalatora	setupSnippetId	number	Odwołanie identyfikatora do fragmentu kodu do użycia w fazie instalacji ewidencjonowania interfejsu API w tej grupie.
Identyfikator fragmentu kodu w dół	tearDownSnippetId	number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API w tej grupie.
Skrypt instalacji lokalnej	localSetupScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji sprawdzania interfejsu API w tej grupie.
Lokalny skrypt zrywania	localTearDownScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania interfejsu API w tej grupie.
Identyfikator środowiska uruchomieniowego	runtimeId	string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonywania kontroli w tej grupie.
Lokalizacje prywatne	privateLocations	privateLocations	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

CheckGroupList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckGroup

CheckLocationList

Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

CheckTagList

Tagi do organizowania i filtrowania testów.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

CheckAlertSettings

Ustawienia alertu.

Nazwa	Ścieżka	Typ	Opis
Typ eskalacji	escalationType	string	Określa typ eskalacji do użycia.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Przypomnienia	reminders	AlertSettingsReminders
Ustawienia alertów Certyfikaty SSL	sslCertificates	AlertSettingsSSLCertificates	[PRZESTARZAŁE] `sslCertificates` jest przestarzały i nie jest już używany. Zignoruj go, zostanie usunięty w przyszłej wersji.

CheckAlertChannelSubscription

Nazwa	Ścieżka	Typ	Opis
Identyfikator kanału alertu	alertChannelId	number	Identyfikator kanału alertu.
Aktywowany	activated	boolean	Czy aktywowano.

CheckAlertChannelSubscriptionList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckAlertChannelSubscription

CheckRequest

Żądanie sprawdzania.

Nazwa	Ścieżka	Typ	Opis
Sprawdzanie żądania		object	Żądanie sprawdzania.

CheckEnvironmentVariableList

Pary klucz/wartość do ustawiania zmiennych środowiskowych podczas wykonywania sprawdzania. Są one istotne tylko w przypadku sprawdzania przeglądarki. Zawsze, gdy jest to możliwe, użyj globalnych zmiennych środowiskowych.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		EnvironmentVariable

CheckAlertEmail

Nazwa	Ścieżka	Typ	Opis
Address	address	string	Adres.

CheckAlertEmailList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckAlertEmail

Model4

Nazwa	Ścieżka	Typ	Opis
Przedmioty		KeyValue

Model5

Nazwa	Ścieżka	Typ	Opis
Przedmioty		KeyValue

CheckAlertWebhook

Nazwa	Ścieżka	Typ	Opis
Name	name	string	Nazwa.
adres URL	url	string	Adres URL.
Metoda	method	string	Metoda.
headers	headers	Model4
Parametry zapytania	queryParameters	Model5

CheckAlertWebhookList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckAlertWebhook

CheckAlertSlack

Nazwa	Ścieżka	Typ	Opis
adres URL	url	string	Adres URL.

CheckAlertSlackList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckAlertSlack

CheckAlertSMS

Nazwa	Ścieżka	Typ	Opis
Number	number	string	Liczba.
Name	name	string	Nazwa.

CheckAlertSMSList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckAlertSMS

CheckAlertChannels

Nazwa	Ścieżka	Typ
e-mail	email	CheckAlertEmailList
element webhook	webhook	CheckAlertWebhookList
Luzu	slack	CheckAlertSlackList
wiadomość SMS	sms	CheckAlertSMSList

CheckGroupCheck

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Identyfikator.
Name	name	string	Nazwa sprawdzania.
Aktywowany	activated	boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted	boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck	boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail	boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations	CheckLocationList	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags	CheckTagList	Tagi do organizowania i filtrowania testów.
Sprawdzanie ustawień alertu	alertSettings	CheckAlertSettings	Ustawienia alertu.
Używanie globalnych ustawień alertów	useGlobalAlertSettings	boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId	number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder	number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId	string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Sprawdzanie typu	checkType	string	Typ sprawdzania.
Częstotliwość	frequency	integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Przesunięcie częstotliwości	frequencyOffset	integer	Przesunięcie częstotliwości.
Sprawdzanie żądania	request	CheckRequest	Żądanie sprawdzania.
Skrypt	script	string	Skrypt.
Sprawdzanie listy zmiennych środowiskowych	environmentVariables	CheckEnvironmentVariableList	Pary klucz/wartość do ustawiania zmiennych środowiskowych podczas wykonywania sprawdzania. Są one istotne tylko w przypadku sprawdzania przeglądarki. Zawsze, gdy jest to możliwe, użyj globalnych zmiennych środowiskowych.
Identyfikator fragmentu kodu instalatora	setupSnippetId	number	Odwołanie do fragmentu kodu do użycia w fazie konfiguracji sprawdzania interfejsu API.
Identyfikator fragmentu kodu w dół	tearDownSnippetId	number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API.
Skrypt instalacji lokalnej	localSetupScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji.
Lokalny skrypt zrywania	localTearDownScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania.
Czas odpowiedzi obniżonej wydajności	degradedResponseTime	number	Czas odpowiedzi w milisekundach, w których należy rozważyć obniżenie wydajności sprawdzania.
Maksymalny czas odpowiedzi	maxResponseTime	number	Czas odpowiedzi w milisekundach, w których należy rozważyć niepowodzenie sprawdzania.
alertChannels	alertChannels	CheckAlertChannels
Lokalizacje prywatne	privateLocations	privateLocations	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

Model8

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckGroupCheck

Potwierdzeń

Lista asercji sprawdzania interfejsu API.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

headers

Nagłówki.

Nazwa	Ścieżka	Typ	Opis
Nagłówki		object	Nagłówki.

parametry

Parametry.

Nazwa	Ścieżka	Typ	Opis
Parametry		object	Parametry.

żądanie

Żądanie interfejsu API.

Nazwa	Ścieżka	Typ	Opis
metoda	method	string
URL	url	string
dane	data	string
Nagłówki	headers	headers	Nagłówki.
Parametry	params	params	Parametry.

Chronometraż

Czasy.

Nazwa	Ścieżka	Typ	Opis
Chronometraż		object	Czasy.

chronometraż

Fazy chronometrażu.

Nazwa	Ścieżka	Typ	Opis
Fazy chronometrażu		object	Fazy chronometrażu.

response

Odpowiedź interfejsu API.

Nazwa	Ścieżka	Typ	Opis
Status	status	number	Stan.
Tekst stanu	statusText	string	Tekst stanu.
Body	body	string	Ciało.
Nagłówki	headers	headers	Nagłówki.
Chronometraż	timings	timings	Czasy.
Fazy chronometrażu	timingPhases	timingPhases	Fazy chronometrażu.

jobLog

Dziennik zadań.

Nazwa	Ścieżka	Typ	Opis
Dziennik zadań		object	Dziennik zadań.

jobAssets (zasoby zadania)

Zasoby wygenerowane na podstawie przebiegu sprawdzania.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

CheckResultAPI

Dane odpowiedzi dotyczące sprawdzania interfejsu API.

Nazwa	Ścieżka	Typ	Opis
Assertions	assertions	assertions	Lista asercji sprawdzania interfejsu API.
Żądanie	request	request	Żądanie interfejsu API.
Odpowiedź	response	response	Odpowiedź interfejsu API.
Błąd żądania	requestError	string	Opisuje, czy wystąpił błąd w żądaniu.
Dziennik zadań	jobLog	jobLog	Dziennik zadań.
Zasoby zadań	jobAssets	jobAssets	Zasoby wygenerowane na podstawie przebiegu sprawdzania.

Błędy

Lista błędów w przebiegu sprawdzania.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

Model9

Sprawdź wyniki dziennika uruchamiania.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

traceSummary

Podsumowanie śledzenia.

Nazwa	Ścieżka	Typ	Opis
Podsumowanie śledzenia		object	Podsumowanie śledzenia.

Stron

Lista stron używanych w przebiegu sprawdzania.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

CheckResultBrowser

Dane odpowiedzi dotyczące sprawdzania przeglądarki.

Nazwa	Ścieżka	Typ	Opis
Typ	type	string	Typ struktury używanej przez sprawdzanie.
Errors	errors	errors	Lista błędów w przebiegu sprawdzania.
Godzina zakończenia	endTime	number	Godzina zakończenia przebiegu sprawdzania.
Godzina rozpoczęcia	startTime	number	Godzina rozpoczęcia przebiegu sprawdzania.
Wersja środowiska uruchomieniowego	runtimeVersion	string	Aktywna wersja środowiska uruchomieniowego.
Sprawdzanie dziennika uruchamiania	jobLog	Model9	Sprawdź wyniki dziennika uruchamiania.
Zasoby zadań	jobAssets	jobAssets	Zasoby wygenerowane na podstawie przebiegu sprawdzania.
Podsumowanie śledzenia	traceSummary	traceSummary	Podsumowanie śledzenia.
Strony	pages	pages	Lista stron używanych w przebiegu sprawdzania.

CheckResult

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator tego wyniku.
Name	name	string	Nazwa sprawdzania.
Sprawdź identyfikator	checkId	string	Identyfikator sprawdzania.
Ma błędy	hasFailures	boolean	Opisuje, czy wystąpił błąd podczas tego przebiegu sprawdzania. Powinno to być głównym celem oceny zachowania interfejsu API lub sprawdzania przeglądarki. Potwierdzenia, które kończą się niepowodzeniem, przekroczeniem limitu czasu lub niepowodzeniem skryptów, wszystkie rozpoznają tę wartość jako true.
Zawiera błędy	hasErrors	boolean	Opisuje, czy w zapleczu Checkly wystąpił błąd wewnętrzny. Powinno to być fałszywe we wszystkich przypadkach.
Obniżona wydajność	isDegraded	boolean	Sprawdzanie jest obniżone, jeśli przekracza limit degradacji ustawiony przez pole degradedResponseTime w czeku. Dotyczy tylko kontroli interfejsu API.
Ponad maksymalny czas odpowiedzi	overMaxResponseTime	boolean	Ustaw wartość true, jeśli czas odpowiedzi przekracza limit ustawiony przez pole maxResponseTime w czeku. Dotyczy tylko kontroli interfejsu API.
Lokalizacja uruchamiania	runLocation	string	Z której lokalizacji centrum danych pochodzi ten wynik sprawdzania.
Rozpoczęto o	startedAt	date-time	Rozpoczęte w czasie.
Zatrzymano o	stoppedAt	date-time	Zatrzymany w czasie.
Utworzono pod adresem	created_at	date-time	Po utworzeniu na.
Czas odpowiedzi	responseTime	number	Opisuje czas wykonywania odpowiednich części tego sprawdzania. Każdy czas system czasomierza konfiguracji potrzebny do rozpoczęcia wykonywania tego zaewidencjonowania w zapleczu Checkly nie jest częścią tego.
Interfejs API wyników sprawdzania	apiCheckResult	CheckResultAPI	Dane odpowiedzi dotyczące sprawdzania interfejsu API.
Wynik sprawdzania przeglądarki	browserCheckResult	CheckResultBrowser	Dane odpowiedzi dotyczące sprawdzania przeglądarki.
Sprawdzanie identyfikatora przebiegu	checkRunId	number	Identyfikator określonego przebiegu sprawdzania, który utworzył ten wynik sprawdzania.
Prób	attempts	number	Jak często ta kontrola została ponowiona. Będzie to większe niż 0 po włączeniu podwójnego sprawdzania.

CheckResultList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckResult

CheckStatus

Nazwa	Ścieżka	Typ	Opis
Name	name	string	Nazwa sprawdzania.
Sprawdź identyfikator	checkId	string	Identyfikator sprawdzania, czy ten stan należy do.
Ma błędy	hasFailures	boolean	Opisuje, czy ta kontrola obecnie kończy się niepowodzeniem. Jeśli którakolwiek z asercji dla sprawdzania interfejsu API nie powiedzie się, ta wartość jest prawdziwa. Jeśli sprawdzanie przeglądarki zakończy się niepowodzeniem z jakiegokolwiek powodu, to prawda.
Zawiera błędy	hasErrors	boolean	Opisuje, czy z powodu błędu poza normalną operacją sprawdzanie kończy się niepowodzeniem. Powinno to być niezwykle rzadkie i tylko wtedy, gdy w zapleczu Checkly występuje błąd.
Obniżona wydajność	isDegraded	boolean	Sprawdzanie jest obniżone, jeśli przekracza limit degradacji ustawiony przez pole degradedResponseTime w czeku. Dotyczy tylko kontroli interfejsu API.
Najdłuższy przebieg	longestRun	number	Najdłużej kiedykolwiek zarejestrowano czas odpowiedzi dla tej kontroli.
Najkrótszy przebieg	shortestRun	number	Najkrótszy kiedykolwiek zarejestrowany czas odpowiedzi dla tego sprawdzenia.
Ostatnia lokalizacja uruchomienia	lastRunLocation	string	W jakiej lokalizacji ta kontrola została ostatnio uruchomiona.
Ostatni identyfikator uruchomienia sprawdzania	lastCheckRunId	string	Unikatowy identyfikator przyrostowy dla każdego przebiegu sprawdzania.
Pozostałe dni ssl	sslDaysRemaining	number	Ile dni pozostanie do wygaśnięcia bieżącego certyfikatu SSL.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

CheckStatusList

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckStatus

Sprawdź

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Identyfikator.
Name	name	string	Nazwa sprawdzania.
Aktywowany	activated	boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted	boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck	boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail	boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations	CheckLocationList	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags	CheckTagList	Tagi do organizowania i filtrowania testów.
Sprawdzanie ustawień alertu	alertSettings	CheckAlertSettings	Ustawienia alertu.
Używanie globalnych ustawień alertów	useGlobalAlertSettings	boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId	number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder	number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId	string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Sprawdzanie typu	checkType	string	Typ sprawdzania.
Częstotliwość	frequency	integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Przesunięcie częstotliwości	frequencyOffset	integer	Przesunięcie częstotliwości.
Sprawdzanie żądania	request	CheckRequest	Żądanie sprawdzania.
Skrypt	script	string	Skrypt.
Sprawdzanie listy zmiennych środowiskowych	environmentVariables	CheckEnvironmentVariableList	Pary klucz/wartość do ustawiania zmiennych środowiskowych podczas wykonywania sprawdzania. Są one istotne tylko w przypadku sprawdzania przeglądarki. Zawsze, gdy jest to możliwe, użyj globalnych zmiennych środowiskowych.
Identyfikator fragmentu kodu instalatora	setupSnippetId	number	Odwołanie do fragmentu kodu do użycia w fazie konfiguracji sprawdzania interfejsu API.
Identyfikator fragmentu kodu w dół	tearDownSnippetId	number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API.
Skrypt instalacji lokalnej	localSetupScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji.
Lokalny skrypt zrywania	localTearDownScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania.
Czas odpowiedzi obniżonej wydajności	degradedResponseTime	number	Czas odpowiedzi w milisekundach, w których należy rozważyć obniżenie wydajności sprawdzania.
Maksymalny czas odpowiedzi	maxResponseTime	number	Czas odpowiedzi w milisekundach, w których należy rozważyć niepowodzenie sprawdzania.
alertChannels	alertChannels	CheckAlertChannels
Lokalizacje prywatne	privateLocations	privateLocations	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

Lista kontrolna

Nazwa	Ścieżka	Typ	Opis
Przedmioty		Check

Model14

Nazwa	Ścieżka	Typ	Opis
Przedmioty		KeyValue

Model15

Nazwa	Ścieżka	Typ	Opis
Przedmioty		KeyValue

Model16

Określa żądanie uruchomienia sprawdzania.

Nazwa	Ścieżka	Typ	Opis
metoda	method	string
adres URL	url	string	Adres URL.
Obserwowanie przekierowań	followRedirects	boolean	Czy postępować zgodnie z przekierowaniami.
Pomiń protokół SSL	skipSSL	boolean	Czy pominąć protokół SSL.
Body	body	string	Ciało.
Typ nadwozia	bodyType	string	Typ treści.
headers	headers	Model14
Parametry zapytania	queryParameters	Model15
Lista asercji	assertions	AssertionList	Zapoznaj się z główną dokumentacją checkly dotyczącą asercji pod kątem określonych wartości, takich jak wyrażenia regularne i deskryptory ścieżki JSON, których można użyć w polu właściwości.
basicAuth	basicAuth	BasicAuth

CheckAPI

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Identyfikator.
Name	name	string	Nazwa sprawdzania.
Aktywowany	activated	boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted	boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck	boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail	boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations	CheckLocationList	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags	CheckTagList	Tagi do organizowania i filtrowania testów.
Sprawdzanie ustawień alertu	alertSettings	CheckAlertSettings	Ustawienia alertu.
Używanie globalnych ustawień alertów	useGlobalAlertSettings	boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId	number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder	number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId	string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Sprawdzanie żądania	request	Model16	Określa żądanie uruchomienia sprawdzania.
Częstotliwość	frequency	integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Przesunięcie częstotliwości	frequencyOffset	integer	Służy do ustawiania sekund dla częstotliwości sprawdzania poniżej 1 minut (tylko w przypadku sprawdzania interfejsu API) i rozłożenia kontroli w zakresie czasu częstotliwości w ciągu 1 minuty. Działa to w następujący sposób: Kontrole z częstotliwością 0 mogą mieć wartość frequencyOffset 10, 20 lub 30, co oznacza, że będą uruchamiane co 10, 20 lub 30 sekund. Sprawdzanie z częstotliwością niższą niż i równą 60 może mieć właściwość frequencyOffset z zakresu od 1 do maksymalnej wartości na podstawie formuły Math.floor(frequency * 10), tj. dla sprawdzenia, które jest uruchamiane co 5 minut, maksymalna częstotliwośćOffset wynosi 50. Sprawdzanie z częstotliwością wyższą niż 60 może mieć wartość frequencyOffset z zakresu od 1 do wartości maksymalnej na podstawie formuły Math.ceil(frequency / 60), tj. w przypadku sprawdzenia, które jest uruchamiane co 720 minut, maksymalna częstotliwośćOffset wynosi 12.
Identyfikator fragmentu kodu w dół	tearDownSnippetId	number	Odwołanie do fragmentu kodu do użycia w fazie usuwania interfejsu API.
Identyfikator fragmentu kodu instalatora	setupSnippetId	number	Odwołanie do fragmentu kodu do użycia w fazie konfiguracji sprawdzania interfejsu API.
Skrypt instalacji lokalnej	localSetupScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie instalacji.
Lokalny skrypt zrywania	localTearDownScript	string	Prawidłowy fragment kodu Node.js do uruchomienia w fazie usuwania.
Czas odpowiedzi obniżonej wydajności	degradedResponseTime	number	Czas odpowiedzi w milisekundach, w których należy rozważyć obniżenie wydajności sprawdzania.
Maksymalny czas odpowiedzi	maxResponseTime	number	Czas odpowiedzi w milisekundach, w których należy rozważyć niepowodzenie sprawdzania.
Lokalizacje prywatne	privateLocations	privateLocations	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.
Sprawdzanie typu	checkType	string	Typ sprawdzania.
alertChannels	alertChannels	CheckAlertChannels
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

CheckBrowser

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Identyfikator.
Name	name	string	Nazwa sprawdzania.
Aktywowany	activated	boolean	Określa, czy sprawdzanie jest uruchomione, czy nie.
Wyciszony	muted	boolean	Określa, czy jakiekolwiek powiadomienia będą wysyłane w przypadku niepowodzenia sprawdzania i/lub odzyskiwania.
Sprawdzanie podwójne	doubleCheck	boolean	Ustawienie wartości true spowoduje wyzwolenie ponawiania próby w przypadku niepowodzenia sprawdzania z regionu niepowodzenia i innego losowo wybranego regionu przed oznaczeniem sprawdzania jako zakończonego niepowodzeniem.
Powinna zakończyć się niepowodzeniem	shouldFail	boolean	Umożliwia odwrócenie zachowania, gdy sprawdzanie jest uznawane za niepowodzenie. Umożliwia weryfikowanie stanu błędu, takiego jak 404.
Sprawdź listę lokalizacji	locations	CheckLocationList	Tablica z co najmniej jedną lokalizacją centrum danych, w której ma zostać uruchomiona ta kontrola.
Sprawdzanie listy tagów	tags	CheckTagList	Tagi do organizowania i filtrowania testów.
Sprawdzanie ustawień alertu	alertSettings	CheckAlertSettings	Ustawienia alertu.
Używanie globalnych ustawień alertów	useGlobalAlertSettings	boolean	Jeśli ma wartość true, zostanie użyte ustawienie alertu na poziomie konta, a nie ustawienie alertu zdefiniowane podczas tego sprawdzania.
Identyfikator grupy	groupId	number	Identyfikator grupy kontrolnej, do których należy ta kontrola.
Kolejność grup	groupOrder	number	Pozycja tego zaewidencjonowania w grupie kontrolnej. Określa, w jakiej kolejności są uruchamiane kontrole po wyzwoleniu grupy z interfejsu API lub ciągłej integracji/ciągłego wdrażania.
Identyfikator środowiska uruchomieniowego	runtimeId	string	Wersja środowiska uruchomieniowego, tj. stały zestaw zależności środowiska uruchomieniowego, używany do wykonania tej kontroli.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Sprawdzanie typu	checkType	string	Typ sprawdzania.
Częstotliwość	frequency	integer	Jak często sprawdzanie powinno być uruchamiane w ciągu kilku minut.
Skrypt	script	string	Prawidłowy fragment kodu javascript Node.js opisujący interakcję przeglądarki z platformami Puppeteer lub Playwright.
Lokalizacje prywatne	privateLocations	privateLocations	Tablica z co najmniej jedną prywatną lokalizacją, w której należy uruchomić sprawdzanie.
alertChannels	alertChannels	CheckAlertChannels
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

DashboardTagList

Lista co najmniej jednego tagu, który filtruje sprawdzanie, które ma być wyświetlane na pulpicie nawigacyjnym.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

Dashboard

Nazwa	Ścieżka	Typ	Opis
Custom Domain	customDomain	string	Niestandardowa domena użytkownika, np. status.example.com. Zapoznaj się z dokumentacją dotyczącą aktualizowania użycia usługi DNS i protokołu SSL.
Niestandardowy adres URL	customUrl	string	Nazwa poddomeny w obszarze checklyhq.com. Musi być unikatowa dla wszystkich użytkowników.
Logo	logo	string	Adres URL wskazujący plik obrazu.
Favicon (ikona ulubionych)	favicon	string	Adres URL wskazujący plik obrazu używany jako favicon pulpitu nawigacyjnego.
Link	link	string	Link adresu URL do przekierowania po kliknięciu logo pulpitu nawigacyjnego.
Header	header	string	Fragment tekstu wyświetlany w górnej części pulpitu nawigacyjnego.
Description	description	string	Fragment tekstu wyświetlany poniżej nagłówka lub tytułu pulpitu nawigacyjnego.
Szerokość	width	string	Określa, czy używać pełnego ekranu, czy fokusu w środku.
Częstotliwość odświeżania	refreshRate	number	Jak często odświeżać pulpit nawigacyjny w sekundach.
Podzielony	paginate	boolean	Określa stronicowanie jest włączone lub wyłączone.
Szybkość stronicowania	paginationRate	number	Jak często wyzwalać stronicowanie w sekundach.
Sprawdzanie na stronę	checksPerPage	number	Liczba wyświetlanych testów na stronę.
Używanie operatora i	useTagsAndOperator	boolean	Kiedy używać operatora AND dla wyszukiwania tagów.
Ukryj tagi	hideTags	boolean	Pokaż lub ukryj tagi na pulpicie nawigacyjnym.
Lista tagów pulpitu nawigacyjnego	tags	DashboardTagList	Lista co najmniej jednego tagu, który filtruje sprawdzanie, które ma być wyświetlane na pulpicie nawigacyjnym.
Identyfikator pulpitu nawigacyjnego	dashboardId	string	Identyfikator pulpitu nawigacyjnego.

Pulpity nawigacyjneLista

Nazwa	Ścieżka	Typ	Opis
Przedmioty		Dashboard

Lokalizacja

Nazwa	Ścieżka	Typ	Opis
Region	region	string	Unikatowy identyfikator tej lokalizacji.
Name	name	string	Przyjazna nazwa tej lokalizacji.

Lista lokalizacji

Nazwa	Ścieżka	Typ	Opis
Przedmioty		Location

KonserwacjaWindowTagList

Nazwy okien obsługi sprawdzania i grup powinny mieć zastosowanie.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

KonserwacjaWindow

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	number	Identyfikator okna obsługi.
Name	name	string	Nazwa okna obsługi.
Lista tagów okna obsługi	tags	MaintenanceWindowTagList	Nazwy okien obsługi sprawdzania i grup powinny mieć zastosowanie.
Rozpoczyna się od	startsAt	date	Data rozpoczęcia okna obsługi.
Kończy się na	endsAt	date	Data zakończenia okna obsługi.
Powtarzanie interwału	repeatInterval	number	Interwał powtarzania okna obsługi od pierwszego wystąpienia.
Powtórz jednostkę	repeatUnit	string	Strategia powtarzania okna obsługi.
Powtarzanie kończy się na	repeatEndsAt	date	Data zakończenia, w której okno obsługi powinno przestać się powtarzać.
Utworzono pod adresem	created_at	date	Data utworzenia okna obsługi.
Zaktualizowano o	updated_at	date	Data ostatniej aktualizacji okna obsługi.

KonserwacjaWindowList

Lista okien obsługi.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		MaintenanceWindow

CheckAssignment

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	guid	Identyfikator.
Sprawdź identyfikator	checkId	guid	Identyfikator sprawdzania.
Identyfikator lokalizacji prywatnej	privateLocationId	guid	Identyfikator przypisanej lokalizacji prywatnej.

checkAssignments

Sprawdź, czy przypisano tę lokalizację prywatną.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		CheckAssignment

GroupAssignment

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	guid	Identyfikator.
Identyfikator grupy	groupId	number	Identyfikator grupy.
Identyfikator lokalizacji prywatnej	privateLocationId	guid	Identyfikator przypisanej lokalizacji prywatnej.

groupAssignments

Grupa, do której przypisano tę prywatną lokalizację.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		GroupAssignment

privateLocationKeys

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	guid	Identyfikator.
Klucz pierwotny	rawKey	string	Klucz pierwotny.
Klucz maskowany	maskedKey	string	Wartość zamaskowanego klucza.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date	Po zaktualizowaniu o.

keys

Nazwa	Ścieżka	Typ	Opis
Przedmioty		privateLocationKeys

privatelocationschema

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	guid	Identyfikator.
Name	name	string	Nazwa przypisana do lokalizacji prywatnej.
Nazwa ślimaka	slugName	string	Prawidłowa nazwa ślimaka.
Icon	icon	string	Ikona lokalizacji prywatnej.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date	Po zaktualizowaniu o.
Sprawdzanie przypisań	checkAssignments	checkAssignments	Sprawdź, czy przypisano tę lokalizację prywatną.
Przypisania grup	groupAssignments	groupAssignments	Grupa, do której przypisano tę prywatną lokalizację.
keys	keys	keys
Ostatnio widziany	lastSeen	date	Ostatnia widziana data.
Liczba agentów	agentCount	number	Liczba agentów.

privateLocationsListSchema

Nazwa	Ścieżka	Typ	Opis
Przedmioty		privatelocationschema

commonPrivateLocationSchemaResponse

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	guid	Identyfikator.
Name	name	string	Nazwa przypisana do lokalizacji prywatnej.
Nazwa ślimaka	slugName	string	Prawidłowa nazwa ślimaka.
Icon	icon	string	Ikona lokalizacji prywatnej.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Zaktualizowano o	updated_at	date	Po zaktualizowaniu o.
Sprawdzanie przypisań	checkAssignments	checkAssignments	Sprawdź, czy przypisano tę lokalizację prywatną.
Przypisania grup	groupAssignments	groupAssignments	Grupa, do której przypisano tę prywatną lokalizację.
keys	keys	keys

Sygnatury czasowe

Nazwa	Ścieżka	Typ	Opis
Sygnatura czasowa		date-time	Sygnatura czasowa.

queueSize

Rozmiar kolejki.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		number

najstarszyScheduledCheckRun

Nazwa	Ścieżka	Typ	Opis
Przedmioty		number

privateLocationsMetricsHistoryResponseSchema

Nazwa	Ścieżka	Typ	Opis
Sygnatury czasowe	timestamps	timestamps
Rozmiar kolejki	queueSize	queueSize	Rozmiar kolejki.
najstarszyScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Sprawdź tagi.

Nazwa	Ścieżka	Typ	Opis
Przedmioty		string

RaportowanieAggregate

Nazwa	Ścieżka	Typ	Opis
Współczynnik powodzenia	successRatio	number	Współczynnik powodzenia sprawdzania dla wybranego zakresu dat. Wartość procentowa jest wyrażona w postaci dziesiętnej.
Average	avg	number	Średni czas odpowiedzi dla wybranego zakresu dat w milisekundach.
P95	p95	number	Czas odpowiedzi P95 dla wybranego zakresu dat w milisekundach.
P99	p99	number	Czas odpowiedzi P99 dla wybranego zakresu dat w milisekundach.

Raportowanie

Nazwa	Ścieżka	Typ	Opis
Name	name	string	Sprawdź nazwę.
Sprawdź identyfikator	checkId	string	Sprawdź identyfikator.
Sprawdzanie typu	checkType	string	Sprawdź typ.
Dezaktywowany	deactivated	boolean	Sprawdź dezaktywację.
Lista tagów raportowania	tags	ReportingTagList	Sprawdź tagi.
agregacja	aggregate	ReportingAggregate

Lista raportowania

Nazwa	Ścieżka	Typ	Opis
Przedmioty		Reporting

Runtime

Nazwa	Ścieżka	Typ	Opis
Name	name	string	Unikatowa nazwa tego środowiska uruchomieniowego.
Etap	stage	string	Bieżący etap życia środowiska uruchomieniowego.
Koniec życia środowiska uruchomieniowego	runtimeEndOfLife	string	Data usunięcia środowiska uruchomieniowego z naszej platformy.
Default	default	boolean	Wskazuje, czy jest to bieżące domyślne środowisko uruchomieniowe udostępniane przez checkly.
Description	description	string	Krótki czytelny opis głównych aktualizacji w tym środowisku uruchomieniowym.
Sznurek	dependencies.string	string	Ciąg.

Lista środowiska uruchomieniowego

Nazwa	Ścieżka	Typ	Opis
Przedmioty		Runtime

Fragment

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	number	Identyfikator.
Name	name	string	Nazwa fragmentu kodu.
Skrypt	script	string	Kod Node.js, który wchodzi w interakcję z cyklem życia sprawdzania interfejsu API, lub działa jako częściowy kod do sprawdzania przeglądarki.
Utworzono pod adresem	created_at	date-time	Po utworzeniu na.
Zaktualizowano o	updated_at	date-time	Po zaktualizowaniu o.

Lista fragmentów kodu

Nazwa	Ścieżka	Typ	Opis
Przedmioty		Snippet

CheckGroupTrigger

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	number	Identyfikator.
Żeton	token	string	Znacznik.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Wywoływane pod adresem	called_at	date	Po wywołaniu.
Zaktualizowano o	updated_at	date	Po zaktualizowaniu o.
Identyfikator grupy	groupId	number	Identyfikator grupy.

CheckTrigger

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	number	Identyfikator.
Żeton	token	string	Znacznik.
Utworzono pod adresem	created_at	date	Po utworzeniu na.
Wywoływane pod adresem	called_at	date	Po wywołaniu.
Zaktualizowano o	updated_at	date	Po zaktualizowaniu o.
Sprawdź identyfikator	checkId	string	Identyfikator sprawdzania.

obiekt

Jest to typ 'obiekt'.

ciąg

Jest to podstawowy typ danych "string".

Udostępnij przez

Checkly (niezależny wydawca) (wersja zapoznawcza)

Tworzenie połączenia

Domyślny

Limity ograniczania

Akcje

Aktualizowanie fragmentu kodu

Parametry

Zwraca

Aktualizowanie grupy kontrolnej

Parametry

Zwraca

Aktualizowanie kanału alertów

Parametry

Zwraca

Aktualizowanie lokalizacji prywatnej

Parametry

Zwraca

Aktualizowanie okna obsługi

Parametry

Zwraca

Aktualizowanie pulpitu nawigacyjnego

Parametry

Zwraca

Aktualizowanie sprawdzania [PRZESTARZAŁE]

Parametry

Zwraca

Aktualizowanie sprawdzania interfejsu API

Parametry

Zwraca

Aktualizowanie sprawdzania przeglądarki

Parametry

Zwraca

Aktualizowanie subskrypcji kanału alertów

Parametry

Zwraca

Aktualizowanie zmiennej środowiskowej

Parametry

Zwraca

Generowanie nowego klucza interfejsu API dla lokalizacji prywatnej

Parametry

Zwraca

Generuje dostosowywalny raport dla wszystkich metryk sprawdzania przeglądarki

Parametry

Zwraca

Generuje raport z zagregowanymi statystykami dla kontroli i sprawdzania grup

Parametry

Zwraca

Pobieranie fragmentu kodu

Parametry

Zwraca

Pobieranie grupy kontrolnej

Parametry

Zwraca

Pobieranie jednego zaewidencjonowania w określonej grupie z zastosowanymi ustawieniami grupy

Parametry

Zwraca

Pobieranie kanału alertów

Parametry

Zwraca

Pobieranie lokalizacji prywatnej

Parametry

Zwraca

Pobieranie metryk kondycji lokalizacji prywatnej z przedziału czasu

Parametry

Zwraca

Pobieranie okna obsługi

Parametry

Zwraca

Pobieranie sprawdzania

Parametry

Zwraca

Pobieranie szczegółów stanu sprawdzania

Parametry

Zwraca

Pobieranie wszystkich kontroli w określonej grupie z zastosowanymi ustawieniami grupy

Parametry

Zwraca

Pobieranie wyniku sprawdzania

Parametry