Aracılığıyla paylaş


Checkly (Bağımsız Yayımcı) (Önizleme)

Checkly, modern yığının izleme platformudur: programlanabilir, esnek ve sevgi dolu JavaScript. Kritik site işlemlerinizi izleyin ve doğrulayın. Çalıştırdığınız her denetimde hata izlemelerini, ekran görüntülerini ve performans ölçümlerini otomatik olarak toplayın.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet Class Bölgeler
Copilot Studio Premium Aşağıdakiler dışında tüm Power Automate bölgeleri :
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Logic Apps Standart Aşağıdakiler dışında tüm Logic Apps bölgeleri :
     - Azure Kamu bölgeleri
     - Azure Çin bölgeleri
     - ABD Savunma Bakanlığı (DoD)
Power Apps Premium Aşağıdakiler dışında tüm Power Apps bölgeleri :
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Power Automate Premium Aşağıdakiler dışında tüm Power Automate bölgeleri :
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
İletişim
İsim Troy Taylor
URL https://www.hitachisolutions.com
E-posta ttaylor@hitachisolutions.com
Bağlayıcı Meta Verileri
Publisher Troy Taylor
Web sitesi https://www.checklyhq.com/
Gizlilik ilkesi https://www.checklyhq.com/privacy
Kategoriler BT İşlemleri

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:

Varsayılan Bağlantı oluşturmak için parametreler. Tüm bölgeler Paylaşılamaz

Temerrüt

Geçerli: Tüm bölgeler

Bağlantı oluşturmak için parametreler.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim Türü Description Gerekli
Hesap Kimliği securestring Bu API'nin Hesap Kimliği. Doğru
API Anahtarı ('Taşıyıcı apiKey' biçiminde) securestring Bu API için API Anahtarı ('Taşıyıcı apiKey' biçiminde) Doğru

Azaltma Sınırları

Name Çağrılar Yenileme Dönemi
Bağlantı başına API çağrıları 100 60 saniye

Eylemler

API denetimi oluşturma

Yeni bir API denetimi oluşturur. Planınızın sınırını aştığınızda bir 402 döndürür. kullanılırkenglobalAlertSetting,alertSettingnull

API denetimini güncelleştirme

API denetimini güncelleştirir.

Bakım penceresi alma

Belirli bir bakım penceresinin ayrıntılarını gösterir.

Bakım penceresi oluşturma

Yeni bir bakım penceresi oluşturur.

Bakım penceresini güncelleştirme

Bakım penceresini güncelleştirir.

Bakım penceresini silme

Bakım penceresini kalıcı olarak kaldırır.

Belirli bir denetim için uyarıları listeleme

Belirli bir denetim için tüm uyarıları listeler.

Belirli bir zaman penceresinden özel konum durumu ölçümlerini alma

Belirli bir zaman penceresinden özel konum durumu ölçümlerini alın.

Belirli bir çalışma zamanının ayrıntılarını gösterir

Belirli bir çalışma zamanı için dahil edilen tüm NPM paketlerinin ve bunların sürümlerinin ayrıntılarını gösterir.

Denetim durumu ayrıntılarını alma

Belirli bir denetim için geçerli durum bilgilerini gösterin.

Denetim grubu alma

Belirli bir denetim grubunun ayrıntılarını gösterir.

Denetim grubu oluşturma

Yeni bir denetim grubu oluşturur. Tek tek denetimlerin groupId özelliğini ayarlayarak gruba denetimler ekleyebilirsiniz.

Denetim grubu tetikleyicisini alma

Denetim grubu tetikleyicisini bulur.

Denetim grubu tetikleyicisini oluşturma

Denetim grubu tetikleyicisini oluşturur.

Denetim grubu tetikleyicisini silme

Denetim grupları tetikleyicisini siler.

Denetim grubunu güncelleştirme

Bir denetim grubunu güncelleştirir.

Denetim grubunu silme

Denetim grubunu kalıcı olarak kaldırır. Denetim içeren bir denetim grubunu silemezsiniz.

Denetim oluşturma [KULLANIM DIŞI]

[KULLANIM DIŞI] Bu uç nokta 4 Temmuz 2022 Pazartesi günü kaldırılacaktır. Bunun yerine POST /checks/api veya POST /checks/browser kullanın. Yeni bir API veya tarayıcı denetimi oluşturur. Planınızın sınırını aştığınızda bir 402 döndürür. kullanılırkenglobalAlertSettings,alertSettingsnull

Denetim sonucu alma

Belirli bir denetim sonucunun ayrıntılarını gösterir.

Denetim tetikleyicisini alma

Denetim tetikleyicisini bulur.

Denetim tetikleyicisini oluşturma

Denetim tetikleyicisini oluşturur.

Denetim tetikleyicisini silme

Denetim tetikleyicisini siler.

Denetimi güncelleştirme [KULLANIM DIŞI]

[KULLANIM DIŞI] Bu uç nokta 4 Temmuz 2022 Pazartesi günü kaldırılacaktır. Bunun yerine PUT /checks/api/{id} veya PUT /checks/browser/{id} kullanın. Yeni bir API veya tarayıcı denetimini güncelleştirir.

Denetimi silme

Api veya tarayıcı denetimini ve ilgili tüm durum ve sonuç verilerini kalıcı olarak kaldırır.

Denetimler ve denetim grupları için toplam istatistikler içeren bir rapor oluşturur

Tüm denetimler için toplu istatistikler içeren bir rapor veya belirli bir zaman penceresi üzerinde filtrelenmiş bir denetim kümesi oluşturur.

Desteklenen tüm konumları listeler

Desteklenen tüm konumları listeler.

Desteklenen tüm çalışma zamanlarını listeler

Tüm desteklenen çalışma zamanlarını ve Tarayıcı denetimleri için dahil edilen NPM paketlerini listeler ve API denetimleri için betikleri ayarlar ve yok eder.

Durum denetimi al rozeti

Durum denetimi rozetini alın.

Grup ayarlarının uygulandığı belirli bir grupta bir denetim alma

Grup ayarlarının uygulandığı belirli bir onay grubundaki bir denetimin ayrıntılarını gösterin.

Grup ayarlarının uygulandığı belirli bir gruptaki tüm denetimleri alma

Belirli bir denetim grubundaki tüm denetimleri grup ayarlarının uygulandığı şekilde listeler.

Grup durumunu alma rozeti

Grup durumu rozetini alın.

Hesabınız için tüm uyarıları listeleme

Hesabınız için tüm uyarıları listeler.

Kod parçacığı alma

Belirli bir kod parçacığının ayrıntılarını gösterir.

Kod parçacığı oluşturma

Yeni bir kod parçacığı oluşturur.

Kod parçacığını güncelleştirme

Kod parçacığını güncelleştirir.

Kod parçacığını silme

Bir kod parçacığını kalıcı olarak kaldırır.

Ortam değişkeni oluşturma

Yeni bir ortam değişkeni oluşturur.

Ortam değişkenlerini alma

Belirli bir ortam değişkeninin ayrıntılarını gösterir. Seçim için anahtar alanını kullanır.

Ortam değişkenlerini güncelleştirme

Ortam değişkenlerini güncelleştirir. Güncelleştirme tanımlayıcısı olarak anahtar alanını kullanır. Yalnızca değeri ve kilitli özelliği güncelleştirir.

Ortam değişkenlerini silme

Ortam değişkenlerini kalıcı olarak kaldırır. Anahtar alanını silme tanımlayıcısı olarak kullanır.

Pano oluşturma

Yeni bir pano oluşturur. Önceden alınmış bir özel URL'ye veya özel etki alanına sahip bir pano oluşturmaya çalışırken 409 döndürür.

Pano sil

Panoyu kalıcı olarak kaldırır.

Panoyu güncelleştirme

Panoyu güncelleştirir. Önceden alınmış bir özel URL'ye veya özel etki alanına sahip bir pano oluşturmaya çalışırken 409 döndürür.

Tarayıcı denetimi oluşturma

Yeni bir tarayıcı denetimi oluşturur. Planınızın sınırını aştığınızda bir 402 döndürür. kullanılırkenglobalAlertSetting,alertSettingnull

Tarayıcı denetimini güncelleştirme

Tarayıcı denetimini güncelleştirir.

Tüm bakım pencerelerini listeleme

Hesabınızdaki tüm bakım pencerelerini listeler.

Tüm denetim durumlarını listeleme

Hesabınızdaki tüm denetimler için geçerli durum bilgilerini gösterir. Yeni denetim sonuçları geldikçe denetim durumu kayıtları sürekli olarak güncelleştirilir.

Tüm denetim gruplarını listeleme

Hesabınızdaki tüm geçerli denetim gruplarını listeler. checks özelliği, kullanışlı başvuru için check UUID'lerinin bir dizisidir. Salt okunurdur ve bir gruba denetim eklemek için kullanamazsınız.

Tüm denetim sonuçlarını listeler

Belirli bir denetimin tam ham denetim sonuçlarını listeler. Ham sonuçları 30 gün boyunca saklarız. 30 gün sonra silinirler. Ancak toplanmış sonuçları belirsiz bir süre boyunca saklarız. Listeyi daraltmak için denetim türüne ve sonuç türüne göre filtreleyebilirsiniz. to Bir tarih aralığı belirtmek için ve from parametrelerini kullanın (saniye olarak UNIX zaman damgası). Denetim türüne bağlı olarak, bazı alanlar null olabilir. Bu uç nokta altı saatlik bir zaman çerçevesi içinde veri döndürür. Başlangıç ve son parametreleri ayarlanırsa, en fazla altı saat ayrı olmalıdır. Hiçbiri ayarlı değilse, param değerinin şimdi ve parametreden değerinin altı saat önce olacağını düşüneceğiz. Yalnızca to parametresi ayarlanırsa, değerini altı saat önceye ayarlayacağız. Tam tersine, yalnızca kaynak parametre ayarlanırsa, parametresini altı saat sonra olarak değerlendiririz. Hız sınırlaması bu uç noktaya uygulanır, en fazla 5 istek / 10 saniye gönderebilirsiniz.

Tüm denetimleri listeleme

Hesabınızdaki tüm geçerli denetimleri listeler.

Tüm kod parçacıklarını listeleme

Hesabınızdaki tüm geçerli kod parçacıklarını listeler.

Tüm ortam değişkenlerini listeleme

Hesabınızdaki tüm geçerli ortam değişkenlerini listeler.

Tüm panoları listeleme

Hesabınızdaki tüm geçerli panoları listeler.

Tüm Tarayıcı Denetimi ölçümleri için özelleştirilebilir bir rapor oluşturur

Belirli bir zaman penceresinde belirli bir Tarayıcı Denetimi için toplanmış veya toplanmamış istatistiklere sahip bir rapor oluşturur.

Tüm uyarı kanallarını listeleme

Yapılandırılmış tüm uyarı kanallarını ve bunların abone olunan denetimlerini listeler.

Tüm özel konumları listeleme

Hesabınızdaki tüm özel konumları listeler.

Uyarı kanalı alma

Belirli bir uyarı kanalının ayrıntılarını gösterin.

Uyarı kanalı oluşturma

Yeni bir uyarı kanalı oluşturur.

Uyarı kanalını güncelleştirme

Uyarı kanalını güncelleştirme.

Uyarı kanalını silme

Uyarı kanalını kalıcı olarak kaldırır.

Uyarı kanalının aboneliklerini güncelleştirme

Bir uyarı kanalının aboneliklerini güncelleştirme. Hata ve kurtarma uyarılarının bu denetim için gönderilmesi için uyarı kanalına denetim eklemek için bunu kullanın. Not: Abonelik nesnesini geçirirken, her ikisini birden değil yalnızca checkId veya groupId belirtebilirsiniz.

Çek alma

Belirli bir API veya tarayıcı denetiminin ayrıntılarını gösterin.

Özel bir konum için mevcut API anahtarını kaldırma

Api anahtarını özel bir konumdan kalıcı olarak kaldırır.

Özel konum alma

Belirli bir özel konumun ayrıntılarını gösterir.

Özel konum için yeni bir API Anahtarı oluşturma

Özel konumda bir api anahtarı oluşturur.

Özel konum oluşturma

Yeni bir özel konum oluşturur.

Özel konumu güncelleştirme

Özel konumu güncelleştirir.

Özel konumu kaldırma

Özel konumu kalıcı olarak kaldırır.

API denetimi oluşturma

Yeni bir API denetimi oluşturur. Planınızın sınırını aştığınızda bir 402 döndürür. kullanılırkenglobalAlertSetting,alertSettingnull

Parametreler

Name Anahtar Gerekli Tür Description
Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name True string

Çekin adı.

Aktif
activated True boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations array of string

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

method
method True string
URL
url True string

URL adresi.

Yeniden Yönlendirmeleri Takip Et
followRedirects boolean

Yönlendirmeleri takip edip etmediği.

SSL'i atla
skipSSL boolean

SSL'nin atlanıp atlanmayacağı.

Body
body string

Ceset.

bodyType
bodyType string
Key
key True string

Anahtar.

Değer
value True string

Değer.

Kilitli
locked boolean

Kilitli olup olmadığı.

Kaynak
source string

Kaynak.

Mülkiyet
property string

özelliği.

Karşılaştırma
comparison string

Karşılaştırma.

Target
target string

Hedef.

Kullanıcı adı
username True string

Kullanıcı adı.

Şifre
password True string

Parola.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

API denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

API denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Sıklık Uzaklığı
frequencyOffset integer

1 dakikanın altındaki kontrol frekansları için saniyeler ayarlamak ve 1 dakikadan daha sıklıklar için bir zaman aralığına kontrol yaymak için kullanılır. Bu, şu şekilde çalışır: 0 sıklığına sahip denetimler frequencyOffset 10, 20 veya 30 olabilir; bu da her 10, 20 veya 30 saniyede bir çalıştırılacağı anlamına gelir. 60'tan küçük ve 60'a eşit bir frekansa sahip denetimler, Math.floor(frequency * 10) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin, 5 dakikada bir çalışan bir denetim için maksimum frequencyOffset 50'dir. Sıklık değeri 60'tan yüksek olan denetimler, Math.ceil(frequency / 60) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin 720 dakikada bir çalışan bir denetim için maksimum frequencyOffset 12'dir.

Yerel Kurulum Betiği
localSetupScript string

Kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Düşürülmüş Yanıt Süresi
degradedResponseTime number

Bir denetimin düşürülmüş olarak kabul edilmesi gereken milisaniye cinsinden yanıt süresi.

Maksimum Yanıt Süresi
maxResponseTime number

Bir denetimin başarısız olduğu düşünülmesi gereken milisaniye cinsinden yanıt süresi.

Özel Konumlar
privateLocations array of string

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Body
CheckAPI

API denetimini güncelleştirme

API denetimini güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name string

Çekin adı.

Aktif
activated boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations array of string

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

method
method True string
URL
url True string

URL adresi.

Yeniden yönlendirmeleri takip et
followRedirects boolean

Yeniden yönlendirmelerin izlenip izlenmeyeceği.

SSL'i atla
skipSSL boolean

SSL'nin atlanıp atlanmayacağı.

Body
body string

Ceset.

Vücut Tipi
bodyType string

Gövde türü.

Key
key True string

Anahtar.

Değer
value True string

Değer.

Kilitli
locked boolean

Kilitli olup olmadığı.

Kaynak
source string

Kaynak.

Mülkiyet
property string

özelliği.

Karşılaştırma
comparison string

Karşılaştırma.

Target
target string

Hedef.

Kullanıcı adı
username True string

Kullanıcı adı.

Şifre
password True string

Parola.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

API denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

API denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Sıklık Uzaklığı
frequencyOffset integer

1 dakikanın altındaki kontrol frekansları için saniyeler ayarlamak ve 1 dakikadan daha sıklıklar için bir zaman aralığına kontrol yaymak için kullanılır. Bu, şu şekilde çalışır: 0 sıklığına sahip denetimler frequencyOffset 10, 20 veya 30 olabilir; bu da her 10, 20 veya 30 saniyede bir çalıştırılacağı anlamına gelir. 60'tan küçük ve 60'a eşit bir frekansa sahip denetimler, Math.floor(frequency * 10) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin, 5 dakikada bir çalışan bir denetim için maksimum frequencyOffset 50'dir. Sıklık değeri 60'tan yüksek olan denetimler, Math.ceil(frequency / 60) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin 720 dakikada bir çalışan bir denetim için maksimum frequencyOffset 12'dir.

Yerel Kurulum Betiği
localSetupScript string

Kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Düşürülmüş Yanıt Süresi
degradedResponseTime number

Bir denetimin düşürülmüş olarak kabul edilmesi gereken milisaniye cinsinden yanıt süresi.

Maksimum Yanıt Süresi
maxResponseTime number

Bir denetimin başarısız olduğu düşünülmesi gereken milisaniye cinsinden yanıt süresi.

Özel Konumlar
privateLocations array of string

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Body
CheckAPI

Bakım penceresi alma

Belirli bir bakım penceresinin ayrıntılarını gösterir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Döndürülenler

Bakım penceresi oluşturma

Yeni bir bakım penceresi oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
name True string

Bakım penceresi adı.

Bakım Penceresi Etiket Listesi
tags array of string

Denetimler ve gruplar bakım penceresinin adları için geçerli olmalıdır.

Başlangıç:
startsAt True date

Bakım penceresinin başlangıç tarihi.

Bitiş Tarihi:
endsAt True date

Bakım penceresinin bitiş tarihi.

Yineleme Aralığı
repeatInterval number

İlk oluşumdan itibaren bakım penceresinin yineleme aralığı.

Birimi Yinele
repeatUnit True string

Bakım penceresi için yineleme stratejisi.

Yinele Bitiş Tarihi
repeatEndsAt date

Bakım penceresinin yinelenmeyi durdurması gereken bitiş tarihi.

Döndürülenler

Bakım penceresini güncelleştirme

Bakım penceresini güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

İsim
name True string

Bakım penceresi adı.

Bakım Penceresi Etiket Listesi
tags array of string

Denetimler ve gruplar bakım penceresinin adları için geçerli olmalıdır.

Başlangıç:
startsAt True date

Bakım penceresinin başlangıç tarihi.

Bitiş Tarihi:
endsAt True date

Bakım penceresinin bitiş tarihi.

Yineleme Aralığı
repeatInterval number

İlk oluşumdan itibaren bakım penceresinin yineleme aralığı.

Birimi Yinele
repeatUnit True string

Bakım penceresi için yineleme stratejisi.

Yinele Bitiş Tarihi
repeatEndsAt date

Bakım penceresinin yinelenmeyi durdurması gereken bitiş tarihi.

Döndürülenler

Bakım penceresini silme

Bakım penceresini kalıcı olarak kaldırır.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Belirli bir denetim için uyarıları listeleme

Belirli bir denetim için tüm uyarıları listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Kaynak
from date

Bu UNIX zaman damgasından (>= tarih) belgeleri seçin. Varsayılan değer: şimdi - 6 saat.

İçin
to date

Bu UNIX zaman damgasına (< tarih) kadar olan uyarıları seçin. Varsayılan olarak 6 saat sonrasına ayarlanır.

Döndürülenler

Belirli bir zaman penceresinden özel konum durumu ölçümlerini alma

Belirli bir zaman penceresinden özel konum durumu ölçümlerini alın.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Kaynak
from True date

Bu UNIX zaman damgasıyla başlayan ölçümleri seçin. 15 günden az önce olmalı.

İçin
to True date

Bu UNIX zaman damgasına kadar olan ölçümleri seçin.

Döndürülenler

Belirli bir çalışma zamanının ayrıntılarını gösterir

Belirli bir çalışma zamanı için dahil edilen tüm NPM paketlerinin ve bunların sürümlerinin ayrıntılarını gösterir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Döndürülenler

Body
Runtime

Denetim durumu ayrıntılarını alma

Belirli bir denetim için geçerli durum bilgilerini gösterin.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Döndürülenler

Denetim grubu alma

Belirli bir denetim grubunun ayrıntılarını gösterir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Döndürülenler

Body
CheckGroup

Denetim grubu oluşturma

Yeni bir denetim grubu oluşturur. Tek tek denetimlerin groupId özelliğini ayarlayarak gruba denetimler ekleyebilirsiniz.

Parametreler

Name Anahtar Gerekli Tür Description
Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name True string

Denetim grubunun adı.

Aktif
activated boolean

Gruptaki denetimlerin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bu gruptaki bir iade başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Grup Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

Grup Konumu Listesini Denetle
locations array of string

Denetimlerin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Concurrency
concurrency number

CI/CD'den veya API aracılığıyla bir denetim grubu tetiklenirken eşzamanlı olarak kaç denetimin çağrıldığını belirler.

URL
url string

Tüm grup denetimlerinde {{GROUP_BASE_URL}} değişkeniyle başvurabileceğiniz bu grubun temel URL'si.

Key
key True string

Anahtar.

Değer
value True string

Değer.

Kilitli
locked boolean

Kilitli olup olmadığı.

Kaynak
source string

Kaynak.

Mülkiyet
property string

özelliği.

Karşılaştırma
comparison string

Karşılaştırma.

Target
target string

Hedef.

Kullanıcı adı
username True string

Kullanıcı adı.

Şifre
password True string

Parola.

Grup Oluştur TarayıcıYı Denetle Varsayılanları Denetle
browserCheckDefaults object

Tarayıcı oluşturma denetim grubu varsayılanları denetler.

Çalışma Zamanı Kimliği
runtimeId string

Bu grupta denetimleri yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Key
key True string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

Doğru olduğunda, bu denetim grubunda tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

Bu grupta api denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

Bu grupta api denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Bu grupta api denetiminin kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Bu grupta api denetiminin yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Özel Konumları Denetle
privateLocations array of string

Denetimlerin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Body
CheckGroup

Denetim grubu tetikleyicisini alma

Denetim grubu tetikleyicisini bulur.

Parametreler

Name Anahtar Gerekli Tür Description
Grup Kimliği
groupId True integer

Grup tanımlayıcısı.

Döndürülenler

Denetim grubu tetikleyicisini oluşturma

Denetim grubu tetikleyicisini oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Grup Kimliği
groupId True integer

Grup tanımlayıcısı.

Döndürülenler

Denetim grubu tetikleyicisini silme

Denetim grupları tetikleyicisini siler.

Parametreler

Name Anahtar Gerekli Tür Description
Grup Kimliği
groupId True integer

Grup tanımlayıcısı.

Denetim grubunu güncelleştirme

Bir denetim grubunu güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name string

Denetim grubunun adı.

Aktif
activated boolean

Gruptaki denetimlerin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bu gruptaki bir iade başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Grup Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

Grup Konumu Listesini Denetle
locations array of string

Denetimlerin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Concurrency
concurrency number

CI/CD'den veya API aracılığıyla bir denetim grubu tetiklenirken eşzamanlı olarak kaç denetimin çağrıldığını belirler.

URL
url string

Tüm grup denetimlerinde {{GROUP_BASE_URL}} değişkeniyle başvurabileceğiniz bu grubun temel URL'si.

Key
key True string

Anahtar.

Değer
value True string

Değer.

Kilitli
locked boolean

Kilitli olup olmadığı.

Kaynak
source string

Kaynak.

Mülkiyet
property string

özelliği.

Karşılaştırma
comparison string

Karşılaştırma.

Target
target string

Hedef.

Kullanıcı adı
username True string

Kullanıcı adı.

Şifre
password True string

Parola.

Grup Oluştur TarayıcıYı Denetle Varsayılanları Denetle
browserCheckDefaults object

Tarayıcı oluşturma denetim grubu varsayılanları denetler.

Çalışma Zamanı Kimliği
runtimeId string

Bu grupta denetimleri yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Key
key True string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

Doğru olduğunda, bu denetim grubunda tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

Bu grupta api denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

Bu grupta api denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Bu grupta api denetiminin kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Bu grupta api denetiminin yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Özel Konumları Denetle
privateLocations array of string

Denetimlerin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Body
CheckGroup

Denetim grubunu silme

Denetim grubunu kalıcı olarak kaldırır. Denetim içeren bir denetim grubunu silemezsiniz.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Denetim oluşturma [KULLANIM DIŞI]

[KULLANIM DIŞI] Bu uç nokta 4 Temmuz 2022 Pazartesi günü kaldırılacaktır. Bunun yerine POST /checks/api veya POST /checks/browser kullanın. Yeni bir API veya tarayıcı denetimi oluşturur. Planınızın sınırını aştığınızda bir 402 döndürür. kullanılırkenglobalAlertSettings,alertSettingsnull

Parametreler

Name Anahtar Gerekli Tür Description
Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name True string

Çekin adı.

Aktif
activated True boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations array of string

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Denetim Türü
checkType True string

Denetimin türü.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Sıklık Uzaklığı
frequencyOffset integer

1 dakikanın altındaki denetim sıklıkları için saniyeler ayarlamak (yalnızca API denetimleri için) ve denetimleri 1 dakikadan fazla sıklık için bir zaman aralığına yaymak için kullanılır. Bu, şu şekilde çalışır: 0 sıklığına sahip denetimler frequencyOffset 10, 20 veya 30 olabilir; bu da her 10, 20 veya 30 saniyede bir çalıştırılacağı anlamına gelir. 60'tan küçük ve 60'a eşit bir frekansa sahip denetimler, Math.floor(frequency * 10) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin, 5 dakikada bir çalışan bir denetim için maksimum frequencyOffset 50'dir. Sıklık değeri 60'tan yüksek olan denetimler, Math.ceil(frequency / 60) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin 720 dakikada bir çalışan bir denetim için maksimum frequencyOffset 12'dir.

İsteği Denetle
request object

Denetim isteği.

Senaryo
script True string

Betik.

Key
key True string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

API denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

API denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Düşürülmüş Yanıt Süresi
degradedResponseTime number

Bir denetimin düşürülmüş olarak kabul edilmesi gereken milisaniye cinsinden yanıt süresi.

Maksimum Yanıt Süresi
maxResponseTime number

Bir denetimin başarısız olduğu düşünülmesi gereken milisaniye cinsinden yanıt süresi.

Özel Konumlar
privateLocations array of string

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Body
Check

Denetim sonucu alma

Belirli bir denetim sonucunun ayrıntılarını gösterir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Sonuç Kimliğini Denetle
checkResultId True string

Denetim sonucu tanımlayıcısı.

Döndürülenler

Denetim tetikleyicisini alma

Denetim tetikleyicisini bulur.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Döndürülenler

Denetim tetikleyicisini oluşturma

Denetim tetikleyicisini oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Döndürülenler

Denetim tetikleyicisini silme

Denetim tetikleyicisini siler.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Denetimi güncelleştirme [KULLANIM DIŞI]

[KULLANIM DIŞI] Bu uç nokta 4 Temmuz 2022 Pazartesi günü kaldırılacaktır. Bunun yerine PUT /checks/api/{id} veya PUT /checks/browser/{id} kullanın. Yeni bir API veya tarayıcı denetimini güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name string

Çekin adı.

Aktif
activated boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations array of string

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Denetim Türü
checkType string

Denetimin türü.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Sıklık Uzaklığı
frequencyOffset integer

1 dakikanın altındaki denetim sıklıkları için saniyeler ayarlamak (yalnızca API denetimleri için) ve denetimleri 1 dakikadan fazla sıklık için bir zaman aralığına yaymak için kullanılır. Bu, şu şekilde çalışır: 0 sıklığına sahip denetimler frequencyOffset 10, 20 veya 30 olabilir; bu da her 10, 20 veya 30 saniyede bir çalıştırılacağı anlamına gelir. 60'tan küçük ve 60'a eşit bir frekansa sahip denetimler, Math.floor(frequency * 10) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin, 5 dakikada bir çalışan bir denetim için maksimum frequencyOffset 50'dir. Sıklık değeri 60'tan yüksek olan denetimler, Math.ceil(frequency / 60) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin 720 dakikada bir çalışan bir denetim için maksimum frequencyOffset 12'dir.

İsteği Denetle
request True object

Denetim isteği.

Senaryo
script True string

Betik.

Key
key True string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

API denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

API denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Düşürülmüş Yanıt Süresi
degradedResponseTime number

Bir denetimin düşürülmüş olarak kabul edilmesi gereken milisaniye cinsinden yanıt süresi.

Maksimum Yanıt Süresi
maxResponseTime number

Bir denetimin başarısız olduğu düşünülmesi gereken milisaniye cinsinden yanıt süresi.

Özel Konumlar
privateLocations array of string

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Body
Check

Denetimi silme

Api veya tarayıcı denetimini ve ilgili tüm durum ve sonuç verilerini kalıcı olarak kaldırır.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Denetimler ve denetim grupları için toplam istatistikler içeren bir rapor oluşturur

Tüm denetimler için toplu istatistikler içeren bir rapor veya belirli bir zaman penceresi üzerinde filtrelenmiş bir denetim kümesi oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Kaynak
from date

Unix zaman damgası biçiminde raporlama penceresinin özel başlangıç zamanı. Zaman damgasından özel ayar, önceden ayarlanmışWindow kullanımını geçersiz kılar.

İçin
to date

Unix zaman damgası biçiminde raporlama penceresinin özel bitiş zamanı. Zaman damgasına özel ayarı, önceden ayarlanmışWindow kullanımını geçersiz kılar.

Önceden Ayarlanmış Pencere
presetWindow string

Önceden ayarlanmış raporlama pencereleri, yaygın olarak kullanılan pencerelerde hızlı bir şekilde rapor oluşturmak için kullanılır. Özel ve zaman damgası kullanılarak geçersiz kılınabilir.

Etiketlere Göre Filtrele
filterByTags array

Raporunuzda görmek istediğiniz denetimleri filtrelemek için etiketleri kullanın.

Devre dışı
deactivated boolean

Etkinleştirilmiş duruma göre filtre denetimleri.

Döndürülenler

Desteklenen tüm konumları listeler

Desteklenen tüm konumları listeler.

Döndürülenler

Eşya
LocationList

Desteklenen tüm çalışma zamanlarını listeler

Tüm desteklenen çalışma zamanlarını ve Tarayıcı denetimleri için dahil edilen NPM paketlerini listeler ve API denetimleri için betikleri ayarlar ve yok eder.

Döndürülenler

Eşya
RuntimeList

Durum denetimi al rozeti

Durum denetimi rozetini alın.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Style
style string

Stil.

Theme
theme string

Tema.

Yanıt Süresi
responseTime boolean

Yanıt süresi.

Döndürülenler

response
string

Grup ayarlarının uygulandığı belirli bir grupta bir denetim alma

Grup ayarlarının uygulandığı belirli bir onay grubundaki bir denetimin ayrıntılarını gösterin.

Parametreler

Name Anahtar Gerekli Tür Description
Grup Kimliği
groupId True integer

Grup tanımlayıcısı.

Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Döndürülenler

Grup ayarlarının uygulandığı belirli bir gruptaki tüm denetimleri alma

Belirli bir denetim grubundaki tüm denetimleri grup ayarlarının uygulandığı şekilde listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Döndürülenler

Eşya
Model8

Grup durumunu alma rozeti

Grup durumu rozetini alın.

Parametreler

Name Anahtar Gerekli Tür Description
Grup Kimliği
groupId True integer

Grup tanımlayıcısı.

Style
style string

Stil.

Theme
theme string

Tema.

Yanıt Süresi
responseTime boolean

Yanıt süresi.

Döndürülenler

response
string

Hesabınız için tüm uyarıları listeleme

Hesabınız için tüm uyarıları listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Kaynak
from date

Bu UNIX zaman damgasından (>= tarih) belgeleri seçin. Varsayılan değer: şimdi - 6 saat.

İçin
to date

Bu UNIX zaman damgasına (< tarih) kadar olan uyarıları seçin. Varsayılan olarak 6 saat sonrasına ayarlanır.

Döndürülenler

Kod parçacığı alma

Belirli bir kod parçacığının ayrıntılarını gösterir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Döndürülenler

Body
Snippet

Kod parçacığı oluşturma

Yeni bir kod parçacığı oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
name True string

Kod parçacığı adı.

Senaryo
script True string

API denetimi yaşam döngüsüyle etkileşim kuran veya tarayıcı denetimleri için kısmi olarak işlev gösteren Node.js kodunuz.

Döndürülenler

Body
Snippet

Kod parçacığını güncelleştirme

Kod parçacığını güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

İsim
name True string

Kod parçacığı adı.

Senaryo
script True string

API denetimi yaşam döngüsüyle etkileşim kuran veya tarayıcı denetimleri için kısmi olarak işlev gösteren Node.js kodunuz.

Döndürülenler

Body
Snippet

Kod parçacığını silme

Bir kod parçacığını kalıcı olarak kaldırır.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Ortam değişkeni oluşturma

Yeni bir ortam değişkeni oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Key
key True string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Döndürülenler

Ortam değişkenlerini alma

Belirli bir ortam değişkeninin ayrıntılarını gösterir. Seçim için anahtar alanını kullanır.

Parametreler

Name Anahtar Gerekli Tür Description
Key
key True string

Anahtar.

Döndürülenler

Ortam değişkenlerini güncelleştirme

Ortam değişkenlerini güncelleştirir. Güncelleştirme tanımlayıcısı olarak anahtar alanını kullanır. Yalnızca değeri ve kilitli özelliği güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Key
key True string

Anahtar.

Key
key string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Döndürülenler

Ortam değişkenlerini silme

Ortam değişkenlerini kalıcı olarak kaldırır. Anahtar alanını silme tanımlayıcısı olarak kullanır.

Parametreler

Name Anahtar Gerekli Tür Description
Key
key True string

Anahtar.

Pano oluşturma

Yeni bir pano oluşturur. Önceden alınmış bir özel URL'ye veya özel etki alanına sahip bir pano oluşturmaya çalışırken 409 döndürür.

Parametreler

Name Anahtar Gerekli Tür Description
Özel URL
customUrl string

checklyhq.com altında bir alt etki alanı adı. Tüm kullanıcılar arasında benzersiz olması gerekir.

Özel Etki Alanı
customDomain string

Özel bir kullanıcı etki alanı, örneğin status.example.com. DNS ve SSL kullanımınızı güncelleştirme belgelerine bakın.

Logo
logo string

Görüntü dosyasını gösteren bir URL.

Favori simgesi (Favicon)
favicon string

Pano favicon olarak kullanılan bir görüntü dosyasına işaret eden URL.

Link
link string

Pano logosuna tıklandığında yeniden yönlendirmeye yönelik bir URL bağlantısı.

Header
header string

Panonuzun üst kısmında görüntülenen bir metin parçası.

Description
description string

Panonuzun üst bilgisinin veya başlığının altında görüntülenen metin parçası.

Genişlik
width string

Tam ekranın mı yoksa ortada odağın mı kullanılacağını belirler.

Yenileme Hızı
refreshRate number

Panoyu saniyeler içinde yenileme sıklığı.

Ilerlemek
paginate boolean

Sayfalandırmanın açık veya kapalı olduğunu belirler.

Sayfalama Oranı
paginationRate number

Saniyeler içinde sayfalandırmanın tetiklenme sıklığı.

Sayfa Başına Denetim sayısı
checksPerPage number

Sayfa başına görüntülenen denetim sayısı.

Ve işlecini kullanma
useTagsAndOperator boolean

Etiket arama için AND işleci ne zaman kullanılır?

Etiketleri Gizle
hideTags boolean

Panodaki etiketleri gösterin veya gizleyin.

Pano Etiket Listesi
tags array of string

Panoda görüntülenmek üzere denetleyen bir veya daha fazla etiketin listesi.

Döndürülenler

Body
Dashboard

Pano sil

Panoyu kalıcı olarak kaldırır.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
dashboardId True string

Pano tanımlayıcısı.

Panoyu güncelleştirme

Panoyu güncelleştirir. Önceden alınmış bir özel URL'ye veya özel etki alanına sahip bir pano oluşturmaya çalışırken 409 döndürür.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
dashboardId True string

Pano tanımlayıcısı.

Özel URL
customUrl string

checklyhq.com altında bir alt etki alanı adı. Tüm kullanıcılar arasında benzersiz olması gerekir.

Özel Etki Alanı
customDomain string

Özel bir kullanıcı etki alanı, örneğin status.example.com. DNS ve SSL kullanımınızı güncelleştirme belgelerine bakın.

Logo
logo string

Görüntü dosyasını gösteren bir URL.

Favori simgesi (Favicon)
favicon string

Pano favicon olarak kullanılan bir görüntü dosyasına işaret eden URL.

Link
link string

Pano logosuna tıklandığında yeniden yönlendirmeye yönelik bir URL bağlantısı.

Header
header string

Panonuzun üst kısmında görüntülenen bir metin parçası.

Description
description string

Panonuzun üst bilgisinin veya başlığının altında görüntülenen metin parçası.

Genişlik
width string

Tam ekranın mı yoksa ortada odağın mı kullanılacağını belirler.

Yenileme Hızı
refreshRate number

Panoyu saniyeler içinde yenileme sıklığı.

Ilerlemek
paginate boolean

Sayfalandırmanın açık veya kapalı olduğunu belirler.

Sayfalama Oranı
paginationRate number

Saniyeler içinde sayfalandırmanın tetiklenme sıklığı.

Sayfa Başına Denetim sayısı
checksPerPage number

Sayfa başına görüntülenen denetim sayısı.

Ve işlecini kullanma
useTagsAndOperator boolean

Etiket arama için AND işleci ne zaman kullanılır?

Etiketleri Gizle
hideTags boolean

Panodaki etiketleri gösterin veya gizleyin.

Pano Etiket Listesi
tags array of string

Panoda görüntülenmek üzere denetleyen bir veya daha fazla etiketin listesi.

Döndürülenler

Body
Dashboard

Tarayıcı denetimi oluşturma

Yeni bir tarayıcı denetimi oluşturur. Planınızın sınırını aştığınızda bir 402 döndürür. kullanılırkenglobalAlertSetting,alertSettingnull

Parametreler

Name Anahtar Gerekli Tür Description
Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name True string

Çekin adı.

Aktif
activated True boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations array of string

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Key
key True string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Senaryo
script True string

Puppeteer veya Playwright çerçeveleriyle tarayıcı etkileşimini açıklayan geçerli bir Node.js javascript kodu.

Özel Konumlar
privateLocations array of string

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Tarayıcı denetimini güncelleştirme

Tarayıcı denetimini güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Uyarıları otomatik olarak atama
autoAssignAlerts boolean

Yeni bir denetimin, oluşturulduktan sonra tüm mevcut uyarı kanallarına otomatik olarak abone olarak eklenip eklenmeyeceğini belirler.

İsim
name string

Çekin adı.

Aktif
activated boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations array of string

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags array of string

Denetimleri düzenlemek ve filtrelemek için etiketler.

İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Uyarı Kanalı Kimliği
alertChannelId True number

Uyarı kanalı tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Key
key True string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value True string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Senaryo
script string

Puppeteer veya Playwright çerçeveleriyle tarayıcı etkileşimini açıklayan geçerli bir Node.js javascript kodu.

Özel Konumlar
privateLocations array of string

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Döndürülenler

Tüm bakım pencerelerini listeleme

Hesabınızdaki tüm bakım pencerelerini listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Döndürülenler

Bakım penceresi listesi.

Tüm denetim durumlarını listeleme

Hesabınızdaki tüm denetimler için geçerli durum bilgilerini gösterir. Yeni denetim sonuçları geldikçe denetim durumu kayıtları sürekli olarak güncelleştirilir.

Döndürülenler

Tüm denetim gruplarını listeleme

Hesabınızdaki tüm geçerli denetim gruplarını listeler. checks özelliği, kullanışlı başvuru için check UUID'lerinin bir dizisidir. Salt okunurdur ve bir gruba denetim eklemek için kullanamazsınız.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Döndürülenler

Tüm denetim sonuçlarını listeler

Belirli bir denetimin tam ham denetim sonuçlarını listeler. Ham sonuçları 30 gün boyunca saklarız. 30 gün sonra silinirler. Ancak toplanmış sonuçları belirsiz bir süre boyunca saklarız. Listeyi daraltmak için denetim türüne ve sonuç türüne göre filtreleyebilirsiniz. to Bir tarih aralığı belirtmek için ve from parametrelerini kullanın (saniye olarak UNIX zaman damgası). Denetim türüne bağlı olarak, bazı alanlar null olabilir. Bu uç nokta altı saatlik bir zaman çerçevesi içinde veri döndürür. Başlangıç ve son parametreleri ayarlanırsa, en fazla altı saat ayrı olmalıdır. Hiçbiri ayarlı değilse, param değerinin şimdi ve parametreden değerinin altı saat önce olacağını düşüneceğiz. Yalnızca to parametresi ayarlanırsa, değerini altı saat önceye ayarlayacağız. Tam tersine, yalnızca kaynak parametre ayarlanırsa, parametresini altı saat sonra olarak değerlendiririz. Hız sınırlaması bu uç noktaya uygulanır, en fazla 5 istek / 10 saniye gönderebilirsiniz.

Parametreler

Name Anahtar Gerekli Tür Description
Kimliği Denetle
checkId True string

Denetim tanımlayıcısı.

Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Kaynak
from date

Bu UNIX zaman damgasından (>= tarih) belgeleri seçin. Varsayılan değer: şimdi - 6 saat.

İçin
to date

Bu UNIX zaman damgasına (< tarih) kadar olan uyarıları seçin. Varsayılan olarak 6 saat sonrasına ayarlanır.

Yer
location string

Konuma göre filtrelemek için bir veri merkezi konumu (ör. eu-west-1) sağlayın

Denetim Türü
checkType string

Denetimin türü.

Hatalar Var
hasFailures boolean

Denetim sonucunda bir veya daha fazla hata var.

Döndürülenler

Tüm denetimleri listeleme

Hesabınızdaki tüm geçerli denetimleri listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

API URL Filtresini Denetleme
apiCheckUrlFilterPattern string

Sonuçları API denetiminin URL'sinde bulunan bir dizeye göre filtreler; örneğin www.myapp.comgibi bir etki alanı. Yalnızca API denetimlerini döndürür.

Döndürülenler

Eşya
CheckList

Tüm kod parçacıklarını listeleme

Hesabınızdaki tüm geçerli kod parçacıklarını listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Döndürülenler

Eşya
SnippetList

Tüm ortam değişkenlerini listeleme

Hesabınızdaki tüm geçerli ortam değişkenlerini listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Döndürülenler

Tüm panoları listeleme

Hesabınızdaki tüm geçerli panoları listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Döndürülenler

Tüm Tarayıcı Denetimi ölçümleri için özelleştirilebilir bir rapor oluşturur

Belirli bir zaman penceresinde belirli bir Tarayıcı Denetimi için toplanmış veya toplanmamış istatistiklere sahip bir rapor oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Kaynak
from date

Unix zaman damgası biçiminde raporlama penceresinin özel başlangıç zamanı. Zaman damgasından özel ayar, önceden ayarlanmışWindow kullanımını geçersiz kılar.

İçin
to date

Unix zaman damgası biçiminde raporlama penceresinin özel bitiş zamanı. Zaman damgasına özel ayarı, önceden ayarlanmışWindow kullanımını geçersiz kılar.

Önceden Ayarlanmış Pencere
presetWindow string

Önceden ayarlanmış raporlama pencereleri, yaygın olarak kullanılan pencerelerde hızlı bir şekilde rapor oluşturmak için kullanılır. Özel ve zaman damgası kullanılarak geçersiz kılınabilir.

Toplama Aralığı
aggregationInterval number

Ölçümleri dakika cinsinden toplama için kullanılacak zaman aralığı. Örneğin, beş dakika 300, 24 saat 1440'tır.

Grupla göre
groupBy string

Seri verilerinin nasıl gruplandırileceğini belirler.

Duruma Göre Filtrele
filterByStatus array

Başarısız veya başarılı denetim sonucu verilerini denetlemek için filtrelemek için durumu kullanın.

Metrics
metrics array

tarayıcı denetimleri için ölçüm seçenekleri.

Döndürülenler

Öznitelikler.

Attributes
object

Tüm uyarı kanallarını listeleme

Yapılandırılmış tüm uyarı kanallarını ve bunların abone olunan denetimlerini listeler.

Parametreler

Name Anahtar Gerekli Tür Description
Sınır
limit integer

Sonuç sayısını sınırlayın.

Sayı
page number

Sayfa numarası.

Döndürülenler

Tüm özel konumları listeleme

Hesabınızdaki tüm özel konumları listeler.

Döndürülenler

Uyarı kanalı alma

Belirli bir uyarı kanalının ayrıntılarını gösterin.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Döndürülenler

Uyarı kanalı oluşturma

Yeni bir uyarı kanalı oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id number

Tanımlayıcı.

Kimliği Denetle
checkId guid

Denetim tanımlayıcısı.

Grup Kimliği
groupId number

Grup tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Türü
type True string

Türü.

Uyarı Kanalı Yapılandırma Oluştur
config True object

Uyarı kanalı yapılandırma oluşturur.

Kurtarma Gönder
sendRecovery boolean

Kurtarma gönderip göndermediği.

Gönderme Hatası
sendFailure boolean

Gönderme hatası olup olmadığı.

Düzeyi Düşürülmüş Gönderme
sendDegraded boolean

Göndermenin düzeyi düşürülmüş olup olmadığı.

SSL Süre Sonu
sslExpiry boolean

Süresi dolan SSL sertifikaları için bir uyarı gönderilip gönderilmeyeceğini belirler.

SSL Süre Sonu Eşiği
sslExpiryThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Döndürülenler

Uyarı kanalını güncelleştirme

Uyarı kanalını güncelleştirme.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Kimlik
id number

Tanımlayıcı.

Kimliği Denetle
checkId guid

Denetim tanımlayıcısı.

Grup Kimliği
groupId number

Grup tanımlayıcısı.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Türü
type True string

Türü.

Uyarı Kanalı Yapılandırma Oluştur
config True object

Uyarı kanalı yapılandırma oluşturur.

Kurtarma Gönder
sendRecovery boolean

Kurtarma gönderip göndermediği.

Gönderme Hatası
sendFailure boolean

Gönderme hatası olup olmadığı.

Düzeyi Düşürülmüş Gönderme
sendDegraded boolean

Göndermenin düzeyi düşürülmüş olup olmadığı.

SSL Süre Sonu
sslExpiry boolean

Süresi dolan SSL sertifikaları için bir uyarı gönderilip gönderilmeyeceğini belirler.

SSL Süre Sonu Eşiği
sslExpiryThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Döndürülenler

Uyarı kanalını silme

Uyarı kanalını kalıcı olarak kaldırır.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Uyarı kanalının aboneliklerini güncelleştirme

Bir uyarı kanalının aboneliklerini güncelleştirme. Hata ve kurtarma uyarılarının bu denetim için gönderilmesi için uyarı kanalına denetim eklemek için bunu kullanın. Not: Abonelik nesnesini geçirirken, her ikisini birden değil yalnızca checkId veya groupId belirtebilirsiniz.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True integer

Tanımlayıcı.

Kimliği Denetle
checkId guid

CheckId veya groupId geçirebilirsiniz, ancak ikisini birden geçiremezsiniz.

Grup Kimliği
groupId number

CheckId veya groupId geçirebilirsiniz, ancak ikisini birden geçiremezsiniz.

Aktif
activated True boolean

Etkinleştirilip etkinleştirilmediği.

Döndürülenler

Çek alma

Belirli bir API veya tarayıcı denetiminin ayrıntılarını gösterin.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Döndürülenler

Body
Check

Özel bir konum için mevcut API anahtarını kaldırma

Api anahtarını özel bir konumdan kalıcı olarak kaldırır.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Anahtar Kimliği
keyId True string

Anahtar tanımlayıcısı.

Özel konum alma

Belirli bir özel konumun ayrıntılarını gösterir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Döndürülenler

Özel konum için yeni bir API Anahtarı oluşturma

Özel konumda bir api anahtarı oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Döndürülenler

Özel konum oluşturma

Yeni bir özel konum oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
name True string

Özel konuma atanan ad.

Bilgi Bilgi Grubu Adı
slugName True string

Geçerli bilgi bilgi grubu adı.

İkon
icon string

Simge.

Döndürülenler

Özel konumu güncelleştirme

Özel konumu güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

İsim
name True string

Özel konuma atanan ad.

İkon
icon string

Simge.

Döndürülenler

Özel konumu kaldırma

Özel konumu kalıcı olarak kaldırır.

Parametreler

Name Anahtar Gerekli Tür Description
Kimlik
id True string

Tanımlayıcı.

Tanımlar

AlertChannelConfig

Uyarı kanalının yapılandırması.

Name Yol Tür Description
Uyarı Kanalı Yapılandırması
object

Uyarı kanalının yapılandırması.

AlertChanelSubscription

Name Yol Tür Description
Kimlik
id number

Tanımlayıcı.

Kimliği Denetle
checkId guid

Denetim tanımlayıcısı.

Grup Kimliği
groupId number

Grup tanımlayıcısı.

Aktif
activated boolean

Etkinleştirilip etkinleştirilmediği.

AlertChanelSubscriptionList

Bu kanala abone olan tüm denetimler.

Name Yol Tür Description
Eşya
AlertChanelSubscription

AlertChannel

Name Yol Tür Description
Kimlik
id number

Tanımlayıcı.

Türü
type string

E-posta veya SLACK gibi bir uyarı kanalının türü.

Uyarı Kanalı Yapılandırması
config AlertChannelConfig

Uyarı kanalının yapılandırması.

Uyarı Kanalı Abonelik Listesi
subscriptions AlertChanelSubscriptionList

Bu kanala abone olan tüm denetimler.

Kurtarma Gönder
sendRecovery boolean

Kurtarma gönderip göndermediği.

Gönderme Hatası
sendFailure boolean

Gönderme hatası olup olmadığı.

Düzeyi Düşürülmüş Gönderme
sendDegraded boolean

Göndermenin düzeyi düşürülmüş olup olmadığı.

SSL Süre Sonu
sslExpiry boolean

Süresi dolan SSL sertifikaları için bir uyarı gönderilip gönderilmeyeceğini belirler.

SSL Süre Sonu Eşiği
sslExpiryThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

Oluşturma Tarihi
created_at date-time

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

AlertChannelList

Name Yol Tür Description
Eşya
AlertChannel

CheckAlert

Name Yol Tür Description
Kimlik
id string

Bu uyarının benzersiz tanımlayıcısı.

İsim
name string

Çekin adı.

Kimliği Denetle
checkId string

Bu uyarının ait olduğu denetimin tanımlayıcısı.

Uyarı Türü
alertType string

Uyarı türü.

Denetim Türü
checkType string

Denetimin türü.

Çalıştırma Konumu
runLocation string

Bu denetim uyarısının tetiklendiği veri merkezi konumu.

Yanıt Süresi
responseTime number

Bu denetimin ilgili bölümlerini yürütmek için geçen süreyi açıklar. Checkly arka ucundaki bu denetimi yürütmeye başlamak için gereken kurulum zamanlayıcı sistemi süresi bunun bir parçası değildir.

Hata
error string

Uyarıyı tetikleyen başarısız denetimin parçası olan belirli hata iletileri.

Durum Kodu
statusCode string

Yanıtın durum kodu. Yalnızca API denetimleri için geçerlidir.

Oluşturma Tarihi
created_at date

Bu denetim uyarısının oluşturulduğu tarih ve saat.

Başlangıç:
startedAt date

Bu denetim uyarısının başlatıldığı tarih ve saat.

CheckAlertList

Name Yol Tür Description
Eşya
CheckAlert

CheckGroupTagList

Denetimleri düzenlemek ve filtrelemek için etiketler.

Name Yol Tür Description
Eşya
string

CheckGroupLocationList

Denetimlerin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Name Yol Tür Description
Eşya
string

KeyValue

Name Yol Tür Description
Key
key string

Anahtar.

Değer
value string

Değer.

Kilitli
locked boolean

Kilitli olup olmadığı.

HeaderList

Name Yol Tür Description
Eşya
KeyValue

QueryParameterList

Name Yol Tür Description
Eşya
KeyValue

Iddia

Name Yol Tür Description
Kaynak
source string

Kaynak.

Mülkiyet
property string

özelliği.

Karşılaştırma
comparison string

Karşılaştırma.

Target
target string

Hedef.

AssertionList

Özellik alanında kullanabileceğiniz normal ifadeler ve JSON yol tanımlayıcıları gibi belirli değerler için onaylarla ilgili ana Onay belgelerine bakın.

Name Yol Tür Description
Eşya
Assertion

BasicAuth

Name Yol Tür Description
Kullanıcı adı
username string

Kullanıcı adı.

Şifre
password string

Parola.

CheckGroupAPICheckDefaults

Name Yol Tür Description
URL
url string

Tüm grup denetimlerinde {{GROUP_BASE_URL}} değişkeniyle başvurabileceğiniz bu grubun temel URL'si.

headers
headers HeaderList
queryParameters
queryParameters QueryParameterList
Onay Listesi
assertions AssertionList

Özellik alanında kullanabileceğiniz normal ifadeler ve JSON yol tanımlayıcıları gibi belirli değerler için onaylarla ilgili ana Onay belgelerine bakın.

basicAuth
basicAuth BasicAuth

CheckGroupBrowserCheckDefaults

Denetim grubu tarayıcısı varsayılanları denetler.

Name Yol Tür Description
Grup Tarayıcısı Denetle Varsayılanları Denetle
object

Denetim grubu tarayıcısı varsayılanları denetler.

EnvironmentVariable

Name Yol Tür Description
Key
key string

Ortam değişkeninin anahtarı (bu değer değiştirilemez).

Değer
value string

Ortam değişkeninin değeri.

Kilitli
locked boolean

Değeri parola gibi gizlemek için yalnızca kullanıcı arabiriminde kullanılır.

EnvironmentVariableList

Name Yol Tür Description
Eşya
EnvironmentVariable

AlertSettingsRunBasedEscalation

Name Yol Tür Description
Başarısız Çalıştırma Eşiği
failedRunThreshold number

Kaç başarısız ardışık denetim çalıştırıldıktan sonra bir uyarı bildirimi gönderilmelidir.

AlertSettingsTimeBasedEscalation

Name Yol Tür Description
Dakika Başarısız Eşiği
minutesFailingThreshold number

Bir denetim başarısız olmaya başladıktan kaç dakika sonra bir uyarı gönderilmelidir.

AlertSettingsReminders

Name Yol Tür Description
Miktar
amount number

İlk uyarı bildiriminden sonra kaç anımsatıcı gönderebilirsiniz?

Zaman Aralığı
interval number

Anımsatıcıların hangi aralıkta gönderileceği.

AlertSettingsSSLCertificates

[KULLANIM DIŞI] sslCertificates kullanım dışıdır ve artık kullanılmaz. Lütfen yoksayın, gelecekteki bir sürümde kaldırılacaktır.

Name Yol Tür Description
Etkinleştirildi
enabled boolean

Süresi dolan SSL sertifikaları için uyarı bildirimlerinin gönderilip gönderilmeyeceğini belirler.

Uyarı Eşiği
alertThreshold integer

SSL sertifikalarında uyarı vermeye başlamak için gereken zamanda.

CheckGroupAlertSettings

Uyarı ayarları.

Name Yol Tür Description
İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
Hatırlatmalar
reminders AlertSettingsReminders
Uyarı Ayarları SSL Sertifikaları
sslCertificates AlertSettingsSSLCertificates

[KULLANIM DIŞI] sslCertificates kullanım dışıdır ve artık kullanılmaz. Lütfen yoksayın, gelecekteki bir sürümde kaldırılacaktır.

Model1

Uyarı kanalı aboneliği.

Name Yol Tür Description
Uyarı Kanalı Kimliği
alertChannelId number

Uyarı kanalı tanımlayıcısı.

Aktif
activated boolean

Etkinleştirilip etkinleştirilmediği.

AlertChannelSubscriptionCreateList

Uyarı kanalı aboneliklerinin listesi.

Name Yol Tür Description
Uyarı Kanalı Aboneliği
Model1

Uyarı kanalı aboneliği.

privateLocations

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Name Yol Tür Description
Eşya
string

CheckGroup

Name Yol Tür Description
Kimlik
id number

Tanımlayıcı.

İsim
name string

Denetim grubunun adı.

Aktif
activated boolean

Gruptaki denetimlerin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bu gruptaki bir iade başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Grup Etiket Listesini Denetle
tags CheckGroupTagList

Denetimleri düzenlemek ve filtrelemek için etiketler.

Grup Konumu Listesini Denetle
locations CheckGroupLocationList

Denetimlerin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Concurrency
concurrency number

CI/CD'den veya API aracılığıyla bir denetim grubu tetiklenirken eşzamanlı olarak kaç denetimin çağrıldığını belirler.

apiCheckDefaults
apiCheckDefaults CheckGroupAPICheckDefaults
Grup Tarayıcısı Denetle Varsayılanları Denetle
browserCheckDefaults CheckGroupBrowserCheckDefaults

Denetim grubu tarayıcısı varsayılanları denetler.

environmentVariables
environmentVariables EnvironmentVariableList
Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

Doğru olduğunda, bu denetim grubunda tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Uyarısı Ayarlarını Denetle
alertSettings CheckGroupAlertSettings

Uyarı ayarları.

Uyarı Kanalı Aboneliği Oluşturma Listesi
alertChannelSubscriptions AlertChannelSubscriptionCreateList

Uyarı kanalı aboneliklerinin listesi.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

Bu grupta api denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

Bu grupta api denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Bu grupta api denetiminin kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Bu grupta api denetiminin yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Çalışma Zamanı Kimliği
runtimeId string

Bu grupta denetimleri yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

Özel Konumlar
privateLocations privateLocations

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

CheckGroupList

Name Yol Tür Description
Eşya
CheckGroup

CheckLocationList

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Name Yol Tür Description
Eşya
string

CheckTagList

Denetimleri düzenlemek ve filtrelemek için etiketler.

Name Yol Tür Description
Eşya
string

CheckAlertSettings

Uyarı ayarları.

Name Yol Tür Description
İlerletme Türü
escalationType string

Kullanılacak yükseltme türünü belirler.

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
Hatırlatmalar
reminders AlertSettingsReminders
Uyarı Ayarları SSL Sertifikaları
sslCertificates AlertSettingsSSLCertificates

[KULLANIM DIŞI] sslCertificates kullanım dışıdır ve artık kullanılmaz. Lütfen yoksayın, gelecekteki bir sürümde kaldırılacaktır.

CheckAlertChannelSubscription

Name Yol Tür Description
Uyarı Kanalı Kimliği
alertChannelId number

Uyarı kanalı tanımlayıcısı.

Aktif
activated boolean

Etkinleştirilip etkinleştirilmediği.

CheckAlertChannelSubscriptionList

Name Yol Tür Description
Eşya
CheckAlertChannelSubscription

CheckRequest

Denetim isteği.

Name Yol Tür Description
İsteği Denetle
object

Denetim isteği.

CheckEnvironmentVariableList

Denetim yürütmesi sırasında ortam değişkenlerini ayarlamak için anahtar/değer çiftleri. Bunlar yalnızca Tarayıcı denetimleri için geçerlidir. Mümkün olduğunda genel ortam değişkenlerini kullanın.

Name Yol Tür Description
Eşya
EnvironmentVariable

CheckAlertEmail

Name Yol Tür Description
Adres
address string

Adres.

CheckAlertEmailList

Name Yol Tür Description
Eşya
CheckAlertEmail

Model4

Name Yol Tür Description
Eşya
KeyValue

Model5

Name Yol Tür Description
Eşya
KeyValue

CheckAlertWebhook

Name Yol Tür Description
İsim
name string

Adı.

URL
url string

URL adresi.

Yöntem
method string

yöntemi.

headers
headers Model4
queryParameters
queryParameters Model5

CheckAlertWebhookList

Name Yol Tür Description
Eşya
CheckAlertWebhook

CheckAlertSlack

Name Yol Tür Description
URL
url string

URL adresi.

CheckAlertSlackList

Name Yol Tür Description
Eşya
CheckAlertSlack

CheckAlertSMS

Name Yol Tür Description
Sayı
number string

Sayı.

İsim
name string

Adı.

CheckAlertSMSList

Name Yol Tür Description
Eşya
CheckAlertSMS

CheckAlertChannels

Name Yol Tür Description
e-posta
email CheckAlertEmailList
web kancası
webhook CheckAlertWebhookList
gevşek
slack CheckAlertSlackList
kısa mesaj
sms CheckAlertSMSList

CheckGroupCheck

Name Yol Tür Description
Kimlik
id string

Tanımlayıcı.

İsim
name string

Çekin adı.

Aktif
activated boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations CheckLocationList

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags CheckTagList

Denetimleri düzenlemek ve filtrelemek için etiketler.

Uyarı Ayarlarını Denetle
alertSettings CheckAlertSettings

Uyarı ayarları.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
Denetim Türü
checkType string

Denetimin türü.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Sıklık Uzaklığı
frequencyOffset integer

Frekans uzaklığı.

İsteği Denetle
request CheckRequest

Denetim isteği.

Senaryo
script string

Betik.

Ortam Değişken Listesini Denetle
environmentVariables CheckEnvironmentVariableList

Denetim yürütmesi sırasında ortam değişkenlerini ayarlamak için anahtar/değer çiftleri. Bunlar yalnızca Tarayıcı denetimleri için geçerlidir. Mümkün olduğunda genel ortam değişkenlerini kullanın.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

API denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

API denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Düşürülmüş Yanıt Süresi
degradedResponseTime number

Bir denetimin düşürülmüş olarak kabul edilmesi gereken milisaniye cinsinden yanıt süresi.

Maksimum Yanıt Süresi
maxResponseTime number

Bir denetimin başarısız olduğu düşünülmesi gereken milisaniye cinsinden yanıt süresi.

alertChannels
alertChannels CheckAlertChannels
Özel Konumlar
privateLocations privateLocations

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

Model8

Name Yol Tür Description
Eşya
CheckGroupCheck

Iddia

API denetimi onaylarının listesi.

Name Yol Tür Description
Eşya
string

headers

Üst bilgiler.

Name Yol Tür Description
Headers
object

Üst bilgiler.

params

Parametreler.

Name Yol Tür Description
Parametreler
object

Parametreler.

request

API isteği.

Name Yol Tür Description
method
method string
url
url string
veriler
data string
Headers
headers headers

Üst bilgiler.

Parametreler
params params

Parametreler.

Zamanlama

Zamanlamalar.

Name Yol Tür Description
Zamanlama
object

Zamanlamalar.

timingPhases

Zamanlama aşamaları.

Name Yol Tür Description
Zamanlama Aşamaları
object

Zamanlama aşamaları.

response

API yanıtı.

Name Yol Tür Description
Statü
status number

Durum.

Durum Metni
statusText string

Durum metni.

Body
body string

Ceset.

Headers
headers headers

Üst bilgiler.

Zamanlama
timings timings

Zamanlamalar.

Zamanlama Aşamaları
timingPhases timingPhases

Zamanlama aşamaları.

jobLog

İş günlüğü.

Name Yol Tür Description
İş Günlüğü
object

İş günlüğü.

jobAssets

Denetim çalıştırmasından oluşturulan varlıklar.

Name Yol Tür Description
Eşya
string

CheckResultAPI

API denetimi için yanıt verileri.

Name Yol Tür Description
Assertions
assertions assertions

API denetimi onaylarının listesi.

İstek
request request

API isteği.

Yanıt
response response

API yanıtı.

İstek Hatası
requestError string

İstekte bir hata oluşup oluşmadığı açıklanır.

İş Günlüğü
jobLog jobLog

İş günlüğü.

İş Varlıkları
jobAssets jobAssets

Denetim çalıştırmasından oluşturulan varlıklar.

Hata

Denetim çalıştırması ile ilgili hataların listesi.

Name Yol Tür Description
Eşya
string

Model9

Çalıştırma günlüğü sonuçlarını denetleyin.

Name Yol Tür Description
Eşya
string

traceSummary

İzleme özeti.

Name Yol Tür Description
İzleme Özeti
object

İzleme özeti.

pages

Denetim çalıştırması sırasında kullanılan sayfaların listesi.

Name Yol Tür Description
Eşya
string

CheckResultBrowser

Tarayıcı denetimi için yanıt verileri.

Name Yol Tür Description
Türü
type string

Denetimin kullandığı çerçeve türü.

Errors
errors errors

Denetim çalıştırması ile ilgili hataların listesi.

Bitiş Saati
endTime number

Denetim çalıştırmasının bitiş saati.

Başlangıç Saati
startTime number

Denetim çalıştırmasının başlangıç saati.

Çalışma Zamanı Sürümü
runtimeVersion string

Etkin çalışma zamanı sürümü.

Çalıştırma Günlüğünü Denetle
jobLog Model9

Çalıştırma günlüğü sonuçlarını denetleyin.

İş Varlıkları
jobAssets jobAssets

Denetim çalıştırmasından oluşturulan varlıklar.

İzleme Özeti
traceSummary traceSummary

İzleme özeti.

Sayfalar
pages pages

Denetim çalıştırması sırasında kullanılan sayfaların listesi.

CheckResult

Name Yol Tür Description
Kimlik
id string

Bu sonucun benzersiz tanımlayıcısı.

İsim
name string

Çekin adı.

Kimliği Denetle
checkId string

Denetimin tanımlayıcısı.

Hatalar Var
hasFailures boolean

Bu denetim çalıştırması sırasında herhangi bir hata oluşup oluşmadığını açıklar. BU, API veya tarayıcı denetimi davranışını değerlendirmek için ana odak noktanız olmalıdır. Başarısız olan onaylar, zaman aşımları veya başarısız olan betiklerin tümü bu değerin doğru olmasına çözümlenir.

Hatalar Var
hasErrors boolean

Checkly'nin arka uçta bir iç hata oluşup oluşmadığını açıklar. Bu, neredeyse tüm durumlarda yanlış olmalıdır.

Düzeyi Düşürüldü
isDegraded boolean

Denetimdeki degradedResponseTime alanı tarafından ayarlanan düşüş sınırını aşmışsa denetim düzeyi düşürülmüş olur. Yalnızca API denetimleri için geçerlidir.

Maksimum Yanıt Süresi Üzerinde
overMaxResponseTime boolean

Yanıt süresi, denetimdeki maxResponseTime alanı tarafından ayarlanan sınırın üzerindeyse true olarak ayarlayın. Yalnızca API denetimleri için geçerlidir.

Çalıştırma Konumu
runLocation string

Bu denetim sonucunun kaynağı olan veri merkezi konumu.

Başlangıç:
startedAt date-time

Başlangıç zamanı.

Durdurulan Yer
stoppedAt date-time

O sırada durduruldu.

Oluşturma Tarihi
created_at date-time

Oluşturulduğunda.

Yanıt Süresi
responseTime number

Bu denetimin ilgili bölümlerini yürütmek için geçen süreyi açıklar. Checkly arka ucundaki bu denetimi yürütmeye başlamak için gereken kurulum zamanlayıcı sistemi süresi bunun bir parçası değildir.

Sonuç API'lerini denetleme
apiCheckResult CheckResultAPI

API denetimi için yanıt verileri.

Tarayıcı Denetimi Sonucu
browserCheckResult CheckResultBrowser

Tarayıcı denetimi için yanıt verileri.

Çalıştırma Kimliğini Denetle
checkRunId number

Bu denetim sonucunu oluşturan belirli bir denetim çalıştırmasının tanımlayıcısı.

Çalışır
attempts number

Bu denetimin ne sıklıkta yeniden denendi? Çift denetim etkinleştirildiğinde bu değer 0'dan büyük olur.

CheckResultList

Name Yol Tür Description
Eşya
CheckResult

CheckStatus

Name Yol Tür Description
İsim
name string

Çekin adı.

Kimliği Denetle
checkId string

Bu durumun ait olduğu denetimin tanımlayıcısı.

Hatalar Var
hasFailures boolean

Bu denetimin şu anda başarısız olup olmadığını açıklar. API check-fail onaylarından herhangi biri doğruysa bu değer doğrudur. Tarayıcı denetimi her nedenden dolayı başarısız olursa, bu doğrudur.

Hatalar Var
hasErrors boolean

Normal işlem dışındaki bir hata nedeniyle bu denetimin başarısız olup olmadığını açıklar. Bu son derece nadir ve yalnızca Checkly arka uçta bir hata olduğunda olmalıdır.

Düzeyi Düşürüldü
isDegraded boolean

Denetimdeki degradedResponseTime alanı tarafından ayarlanan düşüş sınırını aşmışsa denetim düzeyi düşürülmüş olur. Yalnızca API denetimleri için geçerlidir.

En Uzun Çalıştırma
longestRun number

Bu denetim için şimdiye kadar kaydedilmiş en uzun yanıt süresi.

En Kısa Çalıştırma
shortestRun number

Bu denetim için kaydedilmiş en kısa yanıt süresi.

Son Çalıştırma Konumu
lastRunLocation string

Bu denetimin son çalıştırıldığı konum.

Son Denetim Çalıştırma Kimliği
lastCheckRunId string

Her denetim çalıştırması için benzersiz artırma tanımlayıcısı.

KALAN SSL Günleri
sslDaysRemaining number

Geçerli SSL sertifikasının süresi dolana kadar kaç gün kaldı.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

CheckStatusList

Name Yol Tür Description
Eşya
CheckStatus

Kontrol

Name Yol Tür Description
Kimlik
id string

Tanımlayıcı.

İsim
name string

Çekin adı.

Aktif
activated boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations CheckLocationList

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags CheckTagList

Denetimleri düzenlemek ve filtrelemek için etiketler.

Uyarı Ayarlarını Denetle
alertSettings CheckAlertSettings

Uyarı ayarları.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
Denetim Türü
checkType string

Denetimin türü.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Sıklık Uzaklığı
frequencyOffset integer

Frekans uzaklığı.

İsteği Denetle
request CheckRequest

Denetim isteği.

Senaryo
script string

Betik.

Ortam Değişken Listesini Denetle
environmentVariables CheckEnvironmentVariableList

Denetim yürütmesi sırasında ortam değişkenlerini ayarlamak için anahtar/değer çiftleri. Bunlar yalnızca Tarayıcı denetimleri için geçerlidir. Mümkün olduğunda genel ortam değişkenlerini kullanın.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

API denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

API denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Düşürülmüş Yanıt Süresi
degradedResponseTime number

Bir denetimin düşürülmüş olarak kabul edilmesi gereken milisaniye cinsinden yanıt süresi.

Maksimum Yanıt Süresi
maxResponseTime number

Bir denetimin başarısız olduğu düşünülmesi gereken milisaniye cinsinden yanıt süresi.

alertChannels
alertChannels CheckAlertChannels
Özel Konumlar
privateLocations privateLocations

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

Denetim Listesi

Name Yol Tür Description
Eşya
Check

Model14

Name Yol Tür Description
Eşya
KeyValue

Model15

Name Yol Tür Description
Eşya
KeyValue

Model16

Denetimin çalıştırılacak isteğini belirler.

Name Yol Tür Description
method
method string
URL
url string

URL adresi.

Yeniden yönlendirmeleri takip et
followRedirects boolean

Yeniden yönlendirmelerin izlenip izlenmeyeceği.

SSL'i atla
skipSSL boolean

SSL'nin atlanıp atlanmayacağı.

Body
body string

Ceset.

Vücut Tipi
bodyType string

Gövde türü.

headers
headers Model14
queryParameters
queryParameters Model15
Onay Listesi
assertions AssertionList

Özellik alanında kullanabileceğiniz normal ifadeler ve JSON yol tanımlayıcıları gibi belirli değerler için onaylarla ilgili ana Onay belgelerine bakın.

basicAuth
basicAuth BasicAuth

CheckAPI

Name Yol Tür Description
Kimlik
id string

Tanımlayıcı.

İsim
name string

Çekin adı.

Aktif
activated boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations CheckLocationList

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags CheckTagList

Denetimleri düzenlemek ve filtrelemek için etiketler.

Uyarı Ayarlarını Denetle
alertSettings CheckAlertSettings

Uyarı ayarları.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
İsteği Denetle
request Model16

Denetimin çalıştırılacak isteğini belirler.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Sıklık Uzaklığı
frequencyOffset integer

1 dakikanın altındaki denetim sıklıkları için saniyeler ayarlamak (yalnızca API denetimleri için) ve denetimleri 1 dakikadan fazla sıklık için bir zaman aralığına yaymak için kullanılır. Bu, şu şekilde çalışır: 0 sıklığına sahip denetimler frequencyOffset 10, 20 veya 30 olabilir; bu da her 10, 20 veya 30 saniyede bir çalıştırılacağı anlamına gelir. 60'tan küçük ve 60'a eşit bir frekansa sahip denetimler, Math.floor(frequency * 10) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin, 5 dakikada bir çalışan bir denetim için maksimum frequencyOffset 50'dir. Sıklık değeri 60'tan yüksek olan denetimler, Math.ceil(frequency / 60) formülüne göre 1 ile maksimum değer arasında frequencyOffset değerine sahip olabilir; örneğin 720 dakikada bir çalışan bir denetim için maksimum frequencyOffset 12'dir.

Kod Parçacığı Kimliğini Yırtın
tearDownSnippetId number

API denetiminin yırtılma aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Kod Parçacığı Kimliğini Ayarlama
setupSnippetId number

API denetiminin kurulum aşamasında kullanılacak kod parçacığına yönelik tanımlayıcı başvurusu.

Yerel Kurulum Betiği
localSetupScript string

Kurulum aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Yerel Yırtma Betiği
localTearDownScript string

Yırtılma aşamasında çalıştırılacak geçerli bir Node.js kodu parçası.

Düşürülmüş Yanıt Süresi
degradedResponseTime number

Bir denetimin düşürülmüş olarak kabul edilmesi gereken milisaniye cinsinden yanıt süresi.

Maksimum Yanıt Süresi
maxResponseTime number

Bir denetimin başarısız olduğu düşünülmesi gereken milisaniye cinsinden yanıt süresi.

Özel Konumlar
privateLocations privateLocations

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

Denetim Türü
checkType string

Denetim türü.

alertChannels
alertChannels CheckAlertChannels
Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

CheckBrowser

Name Yol Tür Description
Kimlik
id string

Tanımlayıcı.

İsim
name string

Çekin adı.

Aktif
activated boolean

Denetimin çalışıp çalışmadığını belirler.

Sessiz
muted boolean

Bir denetim başarısız olduğunda ve/veya kurtarıldığında herhangi bir bildirimin gönderilip gönderilmeyeceğini belirler.

Çift Denetim
doubleCheck boolean

Bunu true olarak ayarlamak, bir denetim başarısız bölgeden başarısız olduğunda ve denetimi başarısız olarak işaretlemeden önce rastgele seçilen başka bir bölgeden yeniden denemeyi tetikler.

Başarısız Olmalıdır
shouldFail boolean

Bir denetimin başarısız olduğu kabul edildiğinde davranışını tersine çevirmeye olanak tanır. 404 gibi bir hata durumunu doğrulamaya izin verir.

Konum Listesini Denetle
locations CheckLocationList

Bu denetimin çalıştırıldığı bir veya daha fazla veri merkezi konumundan oluşan bir dizi.

Etiket Listesini Denetle
tags CheckTagList

Denetimleri düzenlemek ve filtrelemek için etiketler.

Uyarı Ayarlarını Denetle
alertSettings CheckAlertSettings

Uyarı ayarları.

Genel Uyarı Ayarlarını Kullanma
useGlobalAlertSettings boolean

True olduğunda, bu denetimde tanımlanan uyarı ayarı değil hesap düzeyi uyarı ayarı kullanılır.

Grup Kimliği
groupId number

Bu denetimin parçası olduğu denetim grubunun tanımlayıcısı.

Grup Sırası
groupOrder number

Bir çek grubundaki bu denetimin konumu. Api'den veya CI/CD'den bir grup tetiklendiğinde hangi sıra denetimlerinin çalıştırileceğini belirler.

Çalışma Zamanı Kimliği
runtimeId string

Bu denetimi yürütmek için kullanılan çalışma zamanı sürümü ( sabit çalışma zamanı bağımlılıkları kümesi).

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
Denetim Türü
checkType string

Denetim türü.

Sıklık
frequency integer

Denetimin kaç dakika içinde çalıştırılması gerektiği.

Senaryo
script string

Puppeteer veya Playwright çerçeveleriyle tarayıcı etkileşimini açıklayan geçerli bir Node.js javascript kodu.

Özel Konumlar
privateLocations privateLocations

Denetimin çalıştırıldığı bir veya daha fazla özel konumdan oluşan bir dizi.

alertChannels
alertChannels CheckAlertChannels
Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

DashboardTagList

Panoda görüntülenmek üzere denetleyen bir veya daha fazla etiketin listesi.

Name Yol Tür Description
Eşya
string

Dashboard

Name Yol Tür Description
Özel Etki Alanı
customDomain string

Özel bir kullanıcı etki alanı, örneğin status.example.com. DNS ve SSL kullanımınızı güncelleştirme belgelerine bakın.

Özel URL
customUrl string

checklyhq.com altında bir alt etki alanı adı. Tüm kullanıcılar arasında benzersiz olması gerekir.

Logo
logo string

Görüntü dosyasını gösteren bir URL.

Favori simgesi (Favicon)
favicon string

Pano favicon olarak kullanılan bir görüntü dosyasına işaret eden URL.

Link
link string

Pano logosuna tıklandığında yeniden yönlendirmeye yönelik bir URL bağlantısı.

Header
header string

Panonuzun üst kısmında görüntülenen bir metin parçası.

Description
description string

Panonuzun üst bilgisinin veya başlığının altında görüntülenen metin parçası.

Genişlik
width string

Tam ekranın mı yoksa ortada odağın mı kullanılacağını belirler.

Yenileme Hızı
refreshRate number

Panoyu saniyeler içinde yenileme sıklığı.

Ilerlemek
paginate boolean

Sayfalandırmanın açık veya kapalı olduğunu belirler.

Sayfalama Oranı
paginationRate number

Saniyeler içinde sayfalandırmanın tetiklenme sıklığı.

Sayfa Başına Denetim sayısı
checksPerPage number

Sayfa başına görüntülenen denetim sayısı.

Ve işlecini kullanma
useTagsAndOperator boolean

Etiket arama için AND işleci ne zaman kullanılır?

Etiketleri Gizle
hideTags boolean

Panodaki etiketleri gösterin veya gizleyin.

Pano Etiket Listesi
tags DashboardTagList

Panoda görüntülenmek üzere denetleyen bir veya daha fazla etiketin listesi.

Pano Kimliği
dashboardId string

Pano tanımlayıcısı.

Panolar Listesi

Name Yol Tür Description
Eşya
Dashboard

Yer

Name Yol Tür Description
Bölge
region string

Bu konumun benzersiz tanımlayıcısı.

İsim
name string

Bu konumun kolay adı.

LocationList

Name Yol Tür Description
Eşya
Location

MaintenanceWindowTagList

Denetimler ve gruplar bakım penceresinin adları için geçerli olmalıdır.

Name Yol Tür Description
Eşya
string

Bakım Penceresi

Name Yol Tür Description
Kimlik
id number

Bakım penceresinin tanımlayıcısı.

İsim
name string

Bakım penceresi adı.

Bakım Penceresi Etiket Listesi
tags MaintenanceWindowTagList

Denetimler ve gruplar bakım penceresinin adları için geçerli olmalıdır.

Başlangıç:
startsAt date

Bakım penceresinin başlangıç tarihi.

Bitiş Tarihi:
endsAt date

Bakım penceresinin bitiş tarihi.

Yineleme Aralığı
repeatInterval number

İlk oluşumdan itibaren bakım penceresinin yineleme aralığı.

Birimi Yinele
repeatUnit string

Bakım penceresi için yineleme stratejisi.

Yinele Bitiş Tarihi
repeatEndsAt date

Bakım penceresinin yinelenmeyi durdurması gereken bitiş tarihi.

Oluşturma Tarihi
created_at date

Bakım penceresinin oluşturulma tarihi.

Güncelleştirme Tarihi:
updated_at date

Bakım penceresinin güncelleştirilmiş olduğu son tarih.

MaintenanceWindowList

Bakım penceresi listesi.

Name Yol Tür Description
Eşya
MaintenanceWindow

CheckAssignment

Name Yol Tür Description
Kimlik
id guid

Tanımlayıcı.

Kimliği Denetle
checkId guid

Denetimin tanımlayıcısı.

Özel Konum Kimliği
privateLocationId guid

Atanan özel konumun tanımlayıcısı.

checkAssignments

Bu özel konumun atandığını denetleyin.

Name Yol Tür Description
Eşya
CheckAssignment

GroupAssignment

Name Yol Tür Description
Kimlik
id guid

Tanımlayıcı.

Grup Kimliği
groupId number

Grubun tanımlayıcısı.

Özel Konum Kimliği
privateLocationId guid

Atanan özel konumun tanımlayıcısı.

groupAssignments

Bu özel konumun atadığı grup.

Name Yol Tür Description
Eşya
GroupAssignment

privateLocationKeys

Name Yol Tür Description
Kimlik
id guid

Tanımlayıcı.

Ham Anahtar
rawKey string

Ham anahtar.

Maskelenmiş Anahtar
maskedKey string

Maskelenmiş anahtar değeri.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date

Güncelleştirildiğinde.

keys

Name Yol Tür Description
Eşya
privateLocationKeys

privatelocationschema

Name Yol Tür Description
Kimlik
id guid

Tanımlayıcı.

İsim
name string

Özel konuma atanan ad.

Bilgi Bilgi Grubu Adı
slugName string

Geçerli bilgi bilgi grubu adı.

İkon
icon string

Özel konum simgesi.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date

Güncelleştirildiğinde.

Atamaları Denetle
checkAssignments checkAssignments

Bu özel konumun atandığını denetleyin.

Grup Atamaları
groupAssignments groupAssignments

Bu özel konumun atadığı grup.

keys
keys keys
Son Görülme
lastSeen date

Son görüldüğü tarih.

Aracı Sayısı
agentCount number

Aracı sayısı.

privateLocationsListSchema

Name Yol Tür Description
Eşya
privatelocationschema

commonPrivateLocationSchemaResponse

Name Yol Tür Description
Kimlik
id guid

Tanımlayıcı.

İsim
name string

Özel konuma atanan ad.

Bilgi Bilgi Grubu Adı
slugName string

Geçerli bilgi bilgi grubu adı.

İkon
icon string

Özel konum simgesi.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date

Güncelleştirildiğinde.

Atamaları Denetle
checkAssignments checkAssignments

Bu özel konumun atandığını denetleyin.

Grup Atamaları
groupAssignments groupAssignments

Bu özel konumun atadığı grup.

keys
keys keys

Zaman damga -ları

Name Yol Tür Description
Zaman Damgası
date-time

Zaman damgası.

queueSize

Kuyruk boyutu.

Name Yol Tür Description
Eşya
number

oldestScheduledCheckRun

Name Yol Tür Description
Eşya
number

privateLocationsMetricsHistoryResponseSchema

Name Yol Tür Description
Zaman damga -ları
timestamps timestamps
Kuyruk Boyutu
queueSize queueSize

Kuyruk boyutu.

oldestScheduledCheckRun
oldestScheduledCheckRun oldestScheduledCheckRun

ReportingTagList

Etiketleri denetleyin.

Name Yol Tür Description
Eşya
string

ReportingAggregate

Name Yol Tür Description
Başarı Oranı
successRatio number

Seçili tarih aralığı üzerindeki denetimin başarı oranı. Yüzde ondalık biçimindedir.

Average
avg number

Seçilen tarih aralığı üzerindeki denetimin milisaniye cinsinden ortalama yanıt süresi.

P95
p95 number

Seçili tarih aralığı üzerindeki denetimin P95 yanıt süresi milisaniye cinsinden.

P99
p99 number

Seçili tarih aralığı üzerindeki denetimin P99 yanıt süresi milisaniye cinsinden.

Raporlama

Name Yol Tür Description
İsim
name string

Adı denetleyin.

Kimliği Denetle
checkId string

Kimlik denetimi yapın.

Denetim Türü
checkType string

Denetim türü.

Devre dışı
deactivated boolean

Denetim devre dışı bırakıldı.

Raporlama Etiketi Listesi
tags ReportingTagList

Etiketleri denetleyin.

aggregate
aggregate ReportingAggregate

ReportingList

Name Yol Tür Description
Eşya
Reporting

Çalışma zamanı

Name Yol Tür Description
İsim
name string

Bu çalışma zamanının benzersiz adı.

Aşama
stage string

Çalışma zamanının geçerli yaşam aşaması.

Çalışma Zamanı Kullanım Süresi Sonu
runtimeEndOfLife string

Çalışma zamanının platformumuzdan kaldırılacağı tarih.

Varsayılan
default boolean

Bunun Checkly tarafından sağlanan geçerli varsayılan çalışma zamanı olup olmadığını gösterir.

Description
description string

Bu çalışma zamanındaki ana güncelleştirmelerin kısa, okunabilir bir açıklaması.

String
dependencies.string string

Dize.

RuntimeList

Name Yol Tür Description
Eşya
Runtime

Parçacığını

Name Yol Tür Description
Kimlik
id number

Tanımlayıcı.

İsim
name string

Kod parçacığı adı.

Senaryo
script string

API denetimi yaşam döngüsüyle etkileşim kuran veya tarayıcı denetimleri için kısmi olarak işlev gösteren Node.js kodunuz.

Oluşturma Tarihi
created_at date-time

Oluşturulduğunda.

Güncelleştirme Tarihi:
updated_at date-time

Güncelleştirildiğinde.

Kod Parçacığı Listesi

Name Yol Tür Description
Eşya
Snippet

CheckGroupTrigger

Name Yol Tür Description
Kimlik
id number

Tanımlayıcı.

Jeton
token string

Belirteç.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Çağrılan Yer
called_at date

Çağrıldığında.

Güncelleştirme Tarihi:
updated_at date

Güncelleştirildiğinde.

Grup Kimliği
groupId number

Grup tanımlayıcısı.

CheckTrigger

Name Yol Tür Description
Kimlik
id number

Tanımlayıcı.

Jeton
token string

Belirteç.

Oluşturma Tarihi
created_at date

Oluşturulduğunda.

Çağrılan Yer
called_at date

Çağrıldığında.

Güncelleştirme Tarihi:
updated_at date

Güncelleştirildiğinde.

Kimliği Denetle
checkId string

Denetim tanımlayıcısı.

object

Bu , 'object' türüdür.

String

Bu, 'string' temel veri türüdür.