共用方式為


Checkly (獨立發行者) (預覽版)

Checkly 是現代堆棧的監控平台:可編程、靈活且充滿愛心的 JavaScript。 監控和驗證您的關鍵網站交易。 在您執行的每次檢查中自動收集錯誤追蹤、螢幕截圖和效能指標。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 進階 除下列區域外的所有 Power Apps 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
連絡人​​
名稱 特洛伊·泰勒
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
連接器中繼資料
Publisher 特洛伊·泰勒
網站 https://www.checklyhq.com/
隱私策略 https://www.checklyhq.com/privacy
類別 資訊科技營運

正在建立連線

連接器支援下列驗證類型:

預設值 建立連線的參數。 所有區域 不可共享

預設

適用:所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
帳戶識別碼 securestring 此API的帳戶ID。
API 金鑰 (格式為「持有人 apiKey」) securestring 此 API 的 API 金鑰 (格式為「持有人 apiKey」)

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

列出您帳戶的所有警示

列出您帳戶的所有警示。

列出所有儀表板

列出您帳戶中所有目前的儀表板。

列出所有支援的位置

列出所有支援的位置。

列出所有支援的執行階段

列出所有支援的執行階段,以及用於瀏覽器檢查的包含的 NPM 套件,以及用於 API 檢查的設定和拆解指令碼。

列出所有檢查

列出您帳戶中的所有當前支票。

列出所有檢查狀態

顯示您帳戶中所有支票的當前狀態資訊。 檢查狀態記錄會隨著新的檢查結果的出現而不斷更新。

列出所有檢查結果

列出特定檢查的完整原始檢查結果。 我們將原始結果保留 30 天。 30 天后,它們被刪除。 但是,我們會無限期地保留匯總結果。 您可以依檢查類型和結果類型進行篩選,以縮小清單範圍。 使用 和 from 參數to來指定日期範圍 (UNIX 時間戳記 (以秒為單位)。 視檢查類型而定,某些欄位可能是 Null。 此端點將在六小時的時間範圍內傳回資料。 如果設定了 from 和 to 參數,則它們最多必須相隔六個小時。如果未設定任何參數,我們會將 to param 視為現在,而 from param 則視為六小時前。 如果只設定了 to 參數,我們將設定為提前六小時。 相反,如果只設定了 from 參數,我們將認為 to 參數是六個小時後。 速率限制會套用至此端點,您最多可以傳送 5 個要求 / 10 秒。

列出所有檢查群組

列出您帳戶中所有目前的支票群組。 checks 屬性是檢查 UUID 的陣列,方便參考。 它是唯讀的,您無法使用它來將檢查新增至群組。

列出所有環境變數

列出您帳戶中所有目前的環境變數。

列出所有私人位置

列出您帳戶中的所有私人位置。

列出所有程式碼片段

列出您帳戶中所有目前的程式碼片段。

列出所有維護時段

列出您帳戶中的所有維護時段。

列出所有警示通道

列出所有已設定的警示通道及其訂閱的檢查。

列出特定檢查的警示

列出特定檢查的所有警示。

刪除儀表板

永久移除儀表板。

刪除支票

永久移除 API 或瀏覽器檢查及其所有相關狀態和結果資料。

刪除檢查群組

永久移除檢查群組。 如果檢查群組仍包含檢查,則無法刪除檢查群組。

刪除檢查群組觸發程式

刪除檢查群組觸發程式。

刪除檢查觸發程序

刪除檢查觸發程式。

刪除環境變數

永久移除環境變數。 使用索引鍵欄位作為刪除的識別碼。

刪除程式碼片段

永久移除程式碼片段。

刪除維護時段

永久移除維護時段。

刪除警示通道

永久移除警示通道。

取得檢查狀態徽章

獲取檢查狀態徽章。

取得檢查群組觸發程序

尋找檢查群組觸發程式。

取得檢查觸發器

尋找檢查觸發程式。

取得群組狀態徽章

取得群組狀態徽章。

建立 API 檢查

建立新的 API 檢查。 當您超過計劃限制時,將返回 a 402 。 使用 時 globalAlertSetting,可以 alertSettingnull

建立儀表板

建立新的儀表板。 嘗試使用已佔用的自訂 URL 或自訂網域建立儀表板時,會傳回 409。

建立檢查 [已棄用]

[已棄用]此端點將於 2022 年 7 月 4 日星期一移除。 請改用 POST /checks/apiPOST /checks/browser 建立新的 API 或瀏覽器檢查。 當您超過計劃限制時,將返回 a 402 。 使用 時 globalAlertSettings,可以 alertSettingsnull

建立檢查群組

建立新的檢查群組。 您可以設定個別檢查的 groupId 屬性,將檢查新增至群組。

建立檢查群組觸發程式

建立檢查群組觸發程式。

建立檢查觸發程式

建立檢查觸發程式。

建立瀏覽器檢查

建立新的瀏覽器檢查。 當您超過計劃限制時,將返回 a 402 。 使用 時 globalAlertSetting,可以 alertSettingnull

建立環境變數

建立新的環境變數。

建立私人位置

建立新的私人位置。

建立程式碼片段

建立新的程式碼片段。

建立維護時段

建立新的維護時段。

建立警示通道

建立新的警示通道。

從時間範圍取得私人位置健康情況指標

從時間範圍取得私人位置健康情況指標。

擷取已套用群組設定的特定群組中的一個檢查

顯示特定檢查群組中一個檢查的詳細資料,並套用群組設定。

擷取已套用群組設定的特定群組中的所有檢查

列出特定檢查群組中套用群組設定的所有檢查。

擷取支票

顯示特定 API 或瀏覽器檢查的詳細資料。

擷取檢查狀態詳細資料

顯示特定檢查的現行狀態資訊。

擷取檢查結果

顯示特定檢查結果的詳細資料。

擷取檢查群組

顯示特定檢查群組的詳細資料。

擷取環境變數

顯示特定環境變數的詳細資料。 使用索引鍵欄位進行選取。

擷取私人位置

顯示特定私人位置的詳細資料。

擷取程式碼片段

顯示特定程式碼片段的詳細資料。

擷取維護時段

顯示特定維護時段的詳細資料。

擷取警示通道

顯示特定警示通道的詳細資料。

更新 API 檢查

更新 API 檢查。

更新儀表板

更新儀表板。 嘗試使用已佔用的自訂 URL 或自訂網域建立儀表板時,會傳回 409。

更新檢查 [已棄用]

[已棄用]此端點將於 2022 年 7 月 4 日星期一移除。 請改用 PUT /checks/api/{id}PUT /checks/browser/{id} 更新新的 API 或瀏覽器檢查。

更新檢查群組

更新檢查群組。

更新瀏覽器檢查

更新瀏覽器檢查。

更新環境變數

更新環境變數。 使用索引鍵欄位作為更新的識別碼。 只會更新值和鎖定的屬性。

更新私人位置

更新私人位置。

更新程式碼片段

更新程式碼片段。

更新維護時段

更新維護時段。

更新警示通道

更新警示通道。

更新警示通道的訂閱

更新警示通道的訂閱。 使用此選項可將檢查新增至警示通道,以便傳送該檢查的失敗及回復警示。 注意:傳遞訂閱物件時,您只能指定 checkId 或 groupId,不能同時指定兩者。

為所有瀏覽器檢查指標生成可自定義的報告

產生報告,其中包含指定時間範圍內特定瀏覽器檢查的彙總或非彙總統計資料。

為私人位置產生新的 API 金鑰

在私人位置上建立 API 金鑰。

產生包含檢查和檢查群組彙總統計資料的報告

產生報告,其中包含指定時間範圍內所有檢查的彙總統計資料或一組經過篩選的檢查。

移除私人位置

永久移除私人位置。

移除私人位置的現有 API 金鑰

從私人位置永久移除 API 金鑰。

顯示一個特定執行階段的詳細資料

顯示所有包含的 NPM 套件的詳細資料,以及其中一個特定執行階段的版本。

列出您帳戶的所有警示

列出您帳戶的所有警示。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

寄件者
from date

從此 UNIX 時間戳記(= 日期)>中選擇文件。 預設為現在 - 6 小時。

發往
to date

選取截至此 UNIX 時間戳記 ( 日期)< 的警示。 預設為 6 小時後。

傳回

列出所有儀表板

列出您帳戶中所有目前的儀表板。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

傳回

列出所有支援的位置

列出所有支援的位置。

傳回

物品
LocationList

列出所有支援的執行階段

列出所有支援的執行階段,以及用於瀏覽器檢查的包含的 NPM 套件,以及用於 API 檢查的設定和拆解指令碼。

傳回

物品
RuntimeList

列出所有檢查

列出您帳戶中的所有當前支票。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

API 檢查 URL 過濾器
apiCheckUrlFilterPattern string

依 API 檢查 URL 中包含的字串篩選結果,例如 www.myapp.com。 只會傳回 API 檢查。

傳回

物品
CheckList

列出所有檢查狀態

顯示您帳戶中所有支票的當前狀態資訊。 檢查狀態記錄會隨著新的檢查結果的出現而不斷更新。

傳回

列出所有檢查結果

列出特定檢查的完整原始檢查結果。 我們將原始結果保留 30 天。 30 天后,它們被刪除。 但是,我們會無限期地保留匯總結果。 您可以依檢查類型和結果類型進行篩選,以縮小清單範圍。 使用 和 from 參數to來指定日期範圍 (UNIX 時間戳記 (以秒為單位)。 視檢查類型而定,某些欄位可能是 Null。 此端點將在六小時的時間範圍內傳回資料。 如果設定了 from 和 to 參數,則它們最多必須相隔六個小時。如果未設定任何參數,我們會將 to param 視為現在,而 from param 則視為六小時前。 如果只設定了 to 參數,我們將設定為提前六小時。 相反,如果只設定了 from 參數,我們將認為 to 參數是六個小時後。 速率限制會套用至此端點,您最多可以傳送 5 個要求 / 10 秒。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

限制
limit integer

限制結果數量。

Number
page number

頁碼。

寄件者
from date

從此 UNIX 時間戳記(= 日期)>中選擇文件。 預設為現在 - 6 小時。

發往
to date

選取截至此 UNIX 時間戳記 ( 日期)< 的警示。 預設為 6 小時後。

地點
location string

提供資料中心位置,例如 eu-west-1 以依位置篩選

檢查類型
checkType string

檢查的類型。

有失敗
hasFailures boolean

檢查結果有一或多個失敗。

傳回

列出所有檢查群組

列出您帳戶中所有目前的支票群組。 checks 屬性是檢查 UUID 的陣列,方便參考。 它是唯讀的,您無法使用它來將檢查新增至群組。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

傳回

列出所有環境變數

列出您帳戶中所有目前的環境變數。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

傳回

列出所有私人位置

列出您帳戶中的所有私人位置。

傳回

列出所有程式碼片段

列出您帳戶中所有目前的程式碼片段。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

傳回

物品
SnippetList

列出所有維護時段

列出您帳戶中的所有維護時段。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

傳回

維護時段清單。

列出所有警示通道

列出所有已設定的警示通道及其訂閱的檢查。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

限制結果數量。

Number
page number

頁碼。

傳回

列出特定檢查的警示

列出特定檢查的所有警示。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

限制
limit integer

限制結果數量。

Number
page number

頁碼。

寄件者
from date

從此 UNIX 時間戳記(= 日期)>中選擇文件。 預設為現在 - 6 小時。

發往
to date

選取截至此 UNIX 時間戳記 ( 日期)< 的警示。 預設為 6 小時後。

傳回

刪除儀表板

永久移除儀表板。

參數

名稱 機碼 必要 類型 Description
ID
dashboardId True string

儀表板識別碼。

刪除支票

永久移除 API 或瀏覽器檢查及其所有相關狀態和結果資料。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

刪除檢查群組

永久移除檢查群組。 如果檢查群組仍包含檢查,則無法刪除檢查群組。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

刪除檢查群組觸發程式

刪除檢查群組觸發程式。

參數

名稱 機碼 必要 類型 Description
群組識別碼
groupId True integer

群組識別碼。

刪除檢查觸發程序

刪除檢查觸發程式。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

刪除環境變數

永久移除環境變數。 使用索引鍵欄位作為刪除的識別碼。

參數

名稱 機碼 必要 類型 Description
Key
key True string

關鍵。

刪除程式碼片段

永久移除程式碼片段。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

刪除維護時段

永久移除維護時段。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

刪除警示通道

永久移除警示通道。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

取得檢查狀態徽章

獲取檢查狀態徽章。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

Style
style string

風格。

Theme
theme string

主題。

回應時間
responseTime boolean

回應時間。

傳回

response
string

取得檢查群組觸發程序

尋找檢查群組觸發程式。

參數

名稱 機碼 必要 類型 Description
群組識別碼
groupId True integer

群組識別碼。

傳回

取得檢查觸發器

尋找檢查觸發程式。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

傳回

身體
CheckTrigger

取得群組狀態徽章

取得群組狀態徽章。

參數

名稱 機碼 必要 類型 Description
群組識別碼
groupId True integer

群組識別碼。

Style
style string

風格。

Theme
theme string

主題。

回應時間
responseTime boolean

回應時間。

傳回

response
string

建立 API 檢查

建立新的 API 檢查。 當您超過計劃限制時,將返回 a 402 。 使用 時 globalAlertSetting,可以 alertSettingnull

參數

名稱 機碼 必要 類型 Description
自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name True string

支票的名稱。

已啟用
activated True boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations array of string

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags array of string

用於組織和過濾檢查的標籤。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

方法
method True string
URL
url True string

URL 位址。

跟隨重定向
followRedirects boolean

是否遵循重定向。

略過 SSL
skipSSL boolean

是否跳過 SSL。

身體
body string

身體。

身體類型
bodyType string
Key
key True string

關鍵。

價值觀
value True string

值。

鎖定
locked boolean

是否鎖定。

來源
source string

來源。

房產
property string

屬性。

Comparison
comparison string

比較。

標的
target string

目標。

用戶名稱
username True string

用戶名稱。

密碼
password True string

密碼。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

拆除程式碼片段 ID
tearDownSnippetId number

要在 API 檢查的拆解階段中使用的程式碼片段的識別碼參考。

設定程式碼片段ID
setupSnippetId number

要在 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

頻率偏移
frequencyOffset integer

用於設定 1 分鐘以下的檢查頻率的秒數,以及將超過 1 分鐘的頻率分散在時間範圍內的檢查。 其運作方式如下:頻率為 0 的檢查可以具有 10、20 或 30 的 FrequecyOffset ,這表示它們將每 10、20 或 30 秒執行一次。 頻率小於等於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.floor(frequency * 10),也就是說,對於每 5 分鐘執行一次的檢查,最大 frequencyOffset 為 50。 頻率高於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.ceil(frequency / 60),也就是說,對於每 720 分鐘執行一次的檢查,最大 frequencyOffset 為 12。

本機安裝指令碼
localSetupScript string

在設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在拆解階段執行的有效 Node.js 程式碼片段。

降低的回應時間
degradedResponseTime number

應將檢查視為降級的回應時間(以毫秒為單位)。

最大回應時間
maxResponseTime number

應將檢查視為失敗的回應時間 (以毫秒為單位)。

私人地點
privateLocations array of string

要執行檢查的一或多個私人位置陣列。

傳回

身體
CheckAPI

建立儀表板

建立新的儀表板。 嘗試使用已佔用的自訂 URL 或自訂網域建立儀表板時,會傳回 409。

參數

名稱 機碼 必要 類型 Description
自訂網址
customUrl string

checklyhq.com 下的子網域名稱。 所有使用者都需要是唯一的。

Custom Domain
customDomain string

自訂使用者網域,例如 status.example.com。 請參閱有關更新 DNS 和 SSL 使用情況的文件。

商標
logo string

指向影像檔案的 URL。

網站圖示(favicon)
favicon string

指向用作儀表板網站標識的影像檔案的 URL。

Link
link string

按一下儀表板標誌時要重新導向的 URL 連結。

Header
header string

顯示在儀表板頂端的一段文字。

Description
description string

顯示在儀表板標題或標題下方的一段文字。

寬度
width string

決定是使用全螢幕還是對焦於中央。

刷新率
refreshRate number

以秒為單位重新整理儀表板的頻率。

分頁
paginate boolean

分頁的決定是開啟或關閉。

分頁率
paginationRate number

觸發分頁的頻率(以秒為單位)。

每頁檢查數
checksPerPage number

每頁顯示的檢查數。

使用和運算子
useTagsAndOperator boolean

何時使用 AND 運算子進行標籤查詢。

隱藏標籤
hideTags boolean

在儀表板上顯示或隱藏標籤。

儀表板標籤清單
tags array of string

一或多個標籤的清單,可篩選要顯示在儀表板上的檢查。

傳回

身體
Dashboard

建立檢查 [已棄用]

[已棄用]此端點將於 2022 年 7 月 4 日星期一移除。 請改用 POST /checks/apiPOST /checks/browser 建立新的 API 或瀏覽器檢查。 當您超過計劃限制時,將返回 a 402 。 使用 時 globalAlertSettings,可以 alertSettingsnull

參數

名稱 機碼 必要 類型 Description
自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name True string

支票的名稱。

已啟用
activated True boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations array of string

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags array of string

用於組織和過濾檢查的標籤。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

檢查類型
checkType True string

檢查的類型。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

頻率偏移
frequencyOffset integer

用於設定 1 分鐘以下檢查頻率的秒數 (僅適用於 API 檢查),以及將超過 1 分鐘的頻率分散到時間範圍內。 其運作方式如下:頻率為 0 的檢查可以具有 10、20 或 30 的 FrequecyOffset ,這表示它們將每 10、20 或 30 秒執行一次。 頻率小於等於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.floor(frequency * 10),也就是說,對於每 5 分鐘執行一次的檢查,最大 frequencyOffset 為 50。 頻率高於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.ceil(frequency / 60),也就是說,對於每 720 分鐘執行一次的檢查,最大 frequencyOffset 為 12。

檢查請求
request object

檢查請求。

Script
script True string

劇本。

Key
key True string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

設定程式碼片段ID
setupSnippetId number

要在 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

拆除程式碼片段 ID
tearDownSnippetId number

要在 API 檢查的拆解階段中使用的程式碼片段的識別碼參考。

本機安裝指令碼
localSetupScript string

在設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在拆解階段執行的有效 Node.js 程式碼片段。

降低的回應時間
degradedResponseTime number

應將檢查視為降級的回應時間(以毫秒為單位)。

最大回應時間
maxResponseTime number

應將檢查視為失敗的回應時間 (以毫秒為單位)。

私人地點
privateLocations array of string

要執行檢查的一或多個私人位置陣列。

傳回

身體
Check

建立檢查群組

建立新的檢查群組。 您可以設定個別檢查的 groupId 屬性,將檢查新增至群組。

參數

名稱 機碼 必要 類型 Description
自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name True string

檢查群組的名稱。

已啟用
activated boolean

判斷群組中的檢查是否正在執行。

靜音
muted boolean

決定當此群組中的檢查失敗和/或復原時,是否會傳送任何通知。

檢查群組標籤清單
tags array of string

用於組織和過濾檢查的標籤。

檢查群組位置列表
locations array of string

一或多個要執行檢查的資料中心位置陣列。

Concurrency
concurrency number

決定從 CI/CD 或透過 API 觸發檢查群組時同時呼叫的檢查數目。

URL
url string

此群組的基底 URL,您可以在所有群組檢查中使用 {{GROUP_BASE_URL}} 變數來參考。

Key
key True string

關鍵。

價值觀
value True string

值。

鎖定
locked boolean

是否鎖定。

來源
source string

來源。

房產
property string

屬性。

Comparison
comparison string

比較。

標的
target string

目標。

用戶名稱
username True string

用戶名稱。

密碼
password True string

密碼。

檢查群組建立瀏覽器檢查預設值
browserCheckDefaults object

檢查群組建立瀏覽器檢查預設值。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此組中的檢查。

Key
key True string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是在此檢查群組上定義的警示設定。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

設定程式碼片段ID
setupSnippetId number

此群組中 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

拆除程式碼片段 ID
tearDownSnippetId number

此群組中 API 檢查的拆解階段中使用的程式碼片段的識別碼參照。

本機安裝指令碼
localSetupScript string

在此群組中 API 檢查的設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在此群組中 API 檢查的拆解階段執行的有效 Node.js 程式碼片段。

檢查私人位置
privateLocations array of string

一或多個要執行檢查的專用位置陣列。

傳回

身體
CheckGroup

建立檢查群組觸發程式

建立檢查群組觸發程式。

參數

名稱 機碼 必要 類型 Description
群組識別碼
groupId True integer

群組識別碼。

傳回

建立檢查觸發程式

建立檢查觸發程式。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

傳回

身體
CheckTrigger

建立瀏覽器檢查

建立新的瀏覽器檢查。 當您超過計劃限制時,將返回 a 402 。 使用 時 globalAlertSetting,可以 alertSettingnull

參數

名稱 機碼 必要 類型 Description
自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name True string

支票的名稱。

已啟用
activated True boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations array of string

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags array of string

用於組織和過濾檢查的標籤。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

Key
key True string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

Script
script True string

一段有效的 Node.js javascript 程式碼,描述瀏覽器與 Puppeteer 或 Playwright 框架的互動。

私人地點
privateLocations array of string

要執行檢查的一或多個私人位置陣列。

傳回

身體
CheckBrowser

建立環境變數

建立新的環境變數。

參數

名稱 機碼 必要 類型 Description
Key
key True string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

傳回

建立私人位置

建立新的私人位置。

參數

名稱 機碼 必要 類型 Description
名稱
name True string

指派給私人位置的名稱。

Slug 名稱
slugName True string

有效的 slug 名稱。

Icon
icon string

圖示。

傳回

建立程式碼片段

建立新的程式碼片段。

參數

名稱 機碼 必要 類型 Description
名稱
name True string

程式碼片段名稱。

Script
script True string

您的 Node.js 程式碼,可與 API 檢查生命週期互動,或作為瀏覽器檢查的部分程式碼。

傳回

身體
Snippet

建立維護時段

建立新的維護時段。

參數

名稱 機碼 必要 類型 Description
名稱
name True string

維護時段名稱。

維護時段標籤清單
tags array of string

檢查和群組維護時段的名稱應該套用。

起價
startsAt True date

維護時段的開始日期。

結束於
endsAt True date

維護時段的結束日期。

重複間隔
repeatInterval number

從第一次發生開始的維護時段的重複間隔。

重複單元
repeatUnit True string

維護時段的重複策略。

重複結束於
repeatEndsAt date

維護時段應停止重複的結束日期。

傳回

建立警示通道

建立新的警示通道。

參數

名稱 機碼 必要 類型 Description
ID
id number

識別碼。

檢查 ID
checkId guid

檢查識別碼。

群組識別碼
groupId number

群組識別碼。

已啟用
activated True boolean

是否激活。

類型
type True string

型別。

警示通道建立設定
config True object

警示通道建立組態。

傳送復原
sendRecovery boolean

是否發送恢復。

傳送失敗
sendFailure boolean

是否發送失敗。

傳送降級
sendDegraded boolean

是否發送降級。

SSL 到期
sslExpiry boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示。

SSL 到期臨界值
sslExpiryThreshold integer

何時開始對 SSL 憑證發出警示。

傳回

身體
AlertChannel

從時間範圍取得私人位置健康情況指標

從時間範圍取得私人位置健康情況指標。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

寄件者
from True date

選取以此 UNIX 時間戳記開頭的度量。 必須少於 15 天前。

發往
to True date

選取最多此 UNIX 時間戳記的度量。

傳回

擷取已套用群組設定的特定群組中的一個檢查

顯示特定檢查群組中一個檢查的詳細資料,並套用群組設定。

參數

名稱 機碼 必要 類型 Description
群組識別碼
groupId True integer

群組識別碼。

檢查 ID
checkId True string

檢查識別碼。

傳回

擷取已套用群組設定的特定群組中的所有檢查

列出特定檢查群組中套用群組設定的所有檢查。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

限制
limit integer

限制結果數量。

Number
page number

頁碼。

傳回

物品
Model8

擷取支票

顯示特定 API 或瀏覽器檢查的詳細資料。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

傳回

身體
Check

擷取檢查狀態詳細資料

顯示特定檢查的現行狀態資訊。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

傳回

身體
CheckStatus

擷取檢查結果

顯示特定檢查結果的詳細資料。

參數

名稱 機碼 必要 類型 Description
檢查 ID
checkId True string

檢查識別碼。

檢查結果 ID
checkResultId True string

檢查結果識別碼。

傳回

身體
CheckResult

擷取檢查群組

顯示特定檢查群組的詳細資料。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

傳回

身體
CheckGroup

擷取環境變數

顯示特定環境變數的詳細資料。 使用索引鍵欄位進行選取。

參數

名稱 機碼 必要 類型 Description
Key
key True string

關鍵。

傳回

擷取私人位置

顯示特定私人位置的詳細資料。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

傳回

擷取程式碼片段

顯示特定程式碼片段的詳細資料。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

傳回

身體
Snippet

擷取維護時段

顯示特定維護時段的詳細資料。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

傳回

擷取警示通道

顯示特定警示通道的詳細資料。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

傳回

身體
AlertChannel

更新 API 檢查

更新 API 檢查。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name string

支票的名稱。

已啟用
activated boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations array of string

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags array of string

用於組織和過濾檢查的標籤。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

方法
method True string
URL
url True string

URL 位址。

追蹤重新導向
followRedirects boolean

是否遵循重定向。

略過 SSL
skipSSL boolean

是否跳過 SSL。

身體
body string

身體。

體型
bodyType string

體型。

Key
key True string

關鍵。

價值觀
value True string

值。

鎖定
locked boolean

是否鎖定。

來源
source string

來源。

房產
property string

屬性。

Comparison
comparison string

比較。

標的
target string

目標。

用戶名稱
username True string

用戶名稱。

密碼
password True string

密碼。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

拆除程式碼片段 ID
tearDownSnippetId number

要在 API 檢查的拆解階段中使用的程式碼片段的識別碼參考。

設定程式碼片段ID
setupSnippetId number

要在 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

頻率偏移
frequencyOffset integer

用於設定 1 分鐘以下的檢查頻率的秒數,以及將超過 1 分鐘的頻率分散在時間範圍內的檢查。 其運作方式如下:頻率為 0 的檢查可以具有 10、20 或 30 的 FrequecyOffset ,這表示它們將每 10、20 或 30 秒執行一次。 頻率小於等於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.floor(frequency * 10),也就是說,對於每 5 分鐘執行一次的檢查,最大 frequencyOffset 為 50。 頻率高於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.ceil(frequency / 60),也就是說,對於每 720 分鐘執行一次的檢查,最大 frequencyOffset 為 12。

本機安裝指令碼
localSetupScript string

在設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在拆解階段執行的有效 Node.js 程式碼片段。

降低的回應時間
degradedResponseTime number

應將檢查視為降級的回應時間(以毫秒為單位)。

最大回應時間
maxResponseTime number

應將檢查視為失敗的回應時間 (以毫秒為單位)。

私人地點
privateLocations array of string

要執行檢查的一或多個私人位置陣列。

傳回

身體
CheckAPI

更新儀表板

更新儀表板。 嘗試使用已佔用的自訂 URL 或自訂網域建立儀表板時,會傳回 409。

參數

名稱 機碼 必要 類型 Description
ID
dashboardId True string

儀表板識別碼。

自訂網址
customUrl string

checklyhq.com 下的子網域名稱。 所有使用者都需要是唯一的。

Custom Domain
customDomain string

自訂使用者網域,例如 status.example.com。 請參閱有關更新 DNS 和 SSL 使用情況的文件。

商標
logo string

指向影像檔案的 URL。

網站圖示(favicon)
favicon string

指向用作儀表板網站標識的影像檔案的 URL。

Link
link string

按一下儀表板標誌時要重新導向的 URL 連結。

Header
header string

顯示在儀表板頂端的一段文字。

Description
description string

顯示在儀表板標題或標題下方的一段文字。

寬度
width string

決定是使用全螢幕還是對焦於中央。

刷新率
refreshRate number

以秒為單位重新整理儀表板的頻率。

分頁
paginate boolean

分頁的決定是開啟或關閉。

分頁率
paginationRate number

觸發分頁的頻率(以秒為單位)。

每頁檢查數
checksPerPage number

每頁顯示的檢查數。

使用和運算子
useTagsAndOperator boolean

何時使用 AND 運算子進行標籤查詢。

隱藏標籤
hideTags boolean

在儀表板上顯示或隱藏標籤。

儀表板標籤清單
tags array of string

一或多個標籤的清單,可篩選要顯示在儀表板上的檢查。

傳回

身體
Dashboard

更新檢查 [已棄用]

[已棄用]此端點將於 2022 年 7 月 4 日星期一移除。 請改用 PUT /checks/api/{id}PUT /checks/browser/{id} 更新新的 API 或瀏覽器檢查。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name string

支票的名稱。

已啟用
activated boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations array of string

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags array of string

用於組織和過濾檢查的標籤。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

檢查類型
checkType string

檢查的類型。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

頻率偏移
frequencyOffset integer

用於設定 1 分鐘以下檢查頻率的秒數 (僅適用於 API 檢查),以及將超過 1 分鐘的頻率分散到時間範圍內。 其運作方式如下:頻率為 0 的檢查可以具有 10、20 或 30 的 FrequecyOffset ,這表示它們將每 10、20 或 30 秒執行一次。 頻率小於等於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.floor(frequency * 10),也就是說,對於每 5 分鐘執行一次的檢查,最大 frequencyOffset 為 50。 頻率高於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.ceil(frequency / 60),也就是說,對於每 720 分鐘執行一次的檢查,最大 frequencyOffset 為 12。

檢查請求
request True object

檢查請求。

Script
script True string

劇本。

Key
key True string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

設定程式碼片段ID
setupSnippetId number

要在 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

拆除程式碼片段 ID
tearDownSnippetId number

要在 API 檢查的拆解階段中使用的程式碼片段的識別碼參考。

本機安裝指令碼
localSetupScript string

在設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在拆解階段執行的有效 Node.js 程式碼片段。

降低的回應時間
degradedResponseTime number

應將檢查視為降級的回應時間(以毫秒為單位)。

最大回應時間
maxResponseTime number

應將檢查視為失敗的回應時間 (以毫秒為單位)。

私人地點
privateLocations array of string

要執行檢查的一或多個私人位置陣列。

傳回

身體
Check

更新檢查群組

更新檢查群組。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name string

檢查群組的名稱。

已啟用
activated boolean

判斷群組中的檢查是否正在執行。

靜音
muted boolean

決定當此群組中的檢查失敗和/或復原時,是否會傳送任何通知。

檢查群組標籤清單
tags array of string

用於組織和過濾檢查的標籤。

檢查群組位置列表
locations array of string

一或多個要執行檢查的資料中心位置陣列。

Concurrency
concurrency number

決定從 CI/CD 或透過 API 觸發檢查群組時同時呼叫的檢查數目。

URL
url string

此群組的基底 URL,您可以在所有群組檢查中使用 {{GROUP_BASE_URL}} 變數來參考。

Key
key True string

關鍵。

價值觀
value True string

值。

鎖定
locked boolean

是否鎖定。

來源
source string

來源。

房產
property string

屬性。

Comparison
comparison string

比較。

標的
target string

目標。

用戶名稱
username True string

用戶名稱。

密碼
password True string

密碼。

檢查群組建立瀏覽器檢查預設值
browserCheckDefaults object

檢查群組建立瀏覽器檢查預設值。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此組中的檢查。

Key
key True string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是在此檢查群組上定義的警示設定。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

設定程式碼片段ID
setupSnippetId number

此群組中 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

拆除程式碼片段 ID
tearDownSnippetId number

此群組中 API 檢查的拆解階段中使用的程式碼片段的識別碼參照。

本機安裝指令碼
localSetupScript string

在此群組中 API 檢查的設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在此群組中 API 檢查的拆解階段執行的有效 Node.js 程式碼片段。

檢查私人位置
privateLocations array of string

一或多個要執行檢查的專用位置陣列。

傳回

身體
CheckGroup

更新瀏覽器檢查

更新瀏覽器檢查。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

自動指派警示
autoAssignAlerts boolean

決定新檢查在建立時是否會自動新增為所有現有警示通道的訂閱者。

名稱
name string

支票的名稱。

已啟用
activated boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations array of string

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags array of string

用於組織和過濾檢查的標籤。

呈報類型
escalationType string

決定要使用的呈報類型。

失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

警示通道識別碼
alertChannelId True number

警示通道識別碼。

已啟用
activated True boolean

是否激活。

Key
key True string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

Script
script string

一段有效的 Node.js javascript 程式碼,描述瀏覽器與 Puppeteer 或 Playwright 框架的互動。

私人地點
privateLocations array of string

要執行檢查的一或多個私人位置陣列。

傳回

身體
CheckBrowser

更新環境變數

更新環境變數。 使用索引鍵欄位作為更新的識別碼。 只會更新值和鎖定的屬性。

參數

名稱 機碼 必要 類型 Description
Key
key True string

關鍵。

Key
key string

環境變數的索引鍵(此值無法變更)。

價值觀
value True string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

傳回

更新私人位置

更新私人位置。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

名稱
name True string

指派給私人位置的名稱。

Icon
icon string

圖示。

傳回

更新程式碼片段

更新程式碼片段。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

名稱
name True string

程式碼片段名稱。

Script
script True string

您的 Node.js 程式碼,可與 API 檢查生命週期互動,或作為瀏覽器檢查的部分程式碼。

傳回

身體
Snippet

更新維護時段

更新維護時段。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

名稱
name True string

維護時段名稱。

維護時段標籤清單
tags array of string

檢查和群組維護時段的名稱應該套用。

起價
startsAt True date

維護時段的開始日期。

結束於
endsAt True date

維護時段的結束日期。

重複間隔
repeatInterval number

從第一次發生開始的維護時段的重複間隔。

重複單元
repeatUnit True string

維護時段的重複策略。

重複結束於
repeatEndsAt date

維護時段應停止重複的結束日期。

傳回

更新警示通道

更新警示通道。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

ID
id number

識別碼。

檢查 ID
checkId guid

檢查識別碼。

群組識別碼
groupId number

群組識別碼。

已啟用
activated True boolean

是否激活。

類型
type True string

型別。

警示通道建立設定
config True object

警示通道建立組態。

傳送復原
sendRecovery boolean

是否發送恢復。

傳送失敗
sendFailure boolean

是否發送失敗。

傳送降級
sendDegraded boolean

是否發送降級。

SSL 到期
sslExpiry boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示。

SSL 到期臨界值
sslExpiryThreshold integer

何時開始對 SSL 憑證發出警示。

傳回

身體
AlertChannel

更新警示通道的訂閱

更新警示通道的訂閱。 使用此選項可將檢查新增至警示通道,以便傳送該檢查的失敗及回復警示。 注意:傳遞訂閱物件時,您只能指定 checkId 或 groupId,不能同時指定兩者。

參數

名稱 機碼 必要 類型 Description
ID
id True integer

識別碼。

檢查 ID
checkId guid

您可以傳遞 checkId 或 groupId,但不能同時傳遞兩者。

群組識別碼
groupId number

您可以傳遞 checkId 或 groupId,但不能同時傳遞兩者。

已啟用
activated True boolean

是否激活。

傳回

為所有瀏覽器檢查指標生成可自定義的報告

產生報告,其中包含指定時間範圍內特定瀏覽器檢查的彙總或非彙總統計資料。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

寄件者
from date

以 Unix 時間戳記格式自訂報告視窗的開始時間。 設定自訂 from 時間戳記會覆寫任何 presetWindow 的使用。

發往
to date

以 Unix 時間戳記格式自訂報告視窗的結束時間。 將自訂設定為時間戳記會覆寫任何 presetWindow 的使用。

預設視窗
presetWindow string

預設報告視窗用於快速產生常用視窗的報告。 可以使用自訂 to 和 from 時間戳記來覆寫。

彙總間隔
aggregationInterval number

用於彙總指標的時間間隔 (以分鐘為單位)。 例如,5 分鐘是 300,24 小時是 1440。

分組依據
groupBy string

決定如何分組數列資料。

依狀態篩選
filterByStatus array

使用狀態來篩選檢查失敗或成功的檢查結果資料。

Metrics
metrics array

瀏覽器檢查的指標選項。

傳回

屬性。

Attributes
object

為私人位置產生新的 API 金鑰

在私人位置上建立 API 金鑰。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

傳回

產生包含檢查和檢查群組彙總統計資料的報告

產生報告,其中包含指定時間範圍內所有檢查的彙總統計資料或一組經過篩選的檢查。

參數

名稱 機碼 必要 類型 Description
寄件者
from date

以 Unix 時間戳記格式自訂報告視窗的開始時間。 設定自訂 from 時間戳記會覆寫任何 presetWindow 的使用。

發往
to date

以 Unix 時間戳記格式自訂報告視窗的結束時間。 將自訂設定為時間戳記會覆寫任何 presetWindow 的使用。

預設視窗
presetWindow string

預設報告視窗用於快速產生常用視窗的報告。 可以使用自訂 to 和 from 時間戳記來覆寫。

按標籤過濾
filterByTags array

使用標籤來篩選您要在報表中看到的檢查。

已停用
deactivated boolean

依已啟用狀態篩選檢查。

傳回

物品
ReportingList

移除私人位置

永久移除私人位置。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

移除私人位置的現有 API 金鑰

從私人位置永久移除 API 金鑰。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

金鑰ID
keyId True string

金鑰識別碼。

顯示一個特定執行階段的詳細資料

顯示所有包含的 NPM 套件的詳細資料,以及其中一個特定執行階段的版本。

參數

名稱 機碼 必要 類型 Description
ID
id True string

識別碼。

傳回

身體
Runtime

定義

AlertChannelConfig

警示通道的設定。

名稱 路徑 類型 Description
警示通道設定
object

警示通道的設定。

AlertChanel訂閱

名稱 路徑 類型 Description
ID
id number

識別碼。

檢查 ID
checkId guid

檢查識別碼。

群組識別碼
groupId number

群組識別碼。

已啟用
activated boolean

是否激活。

AlertChanel訂閱清單

所有支票都訂閱了該頻道。

名稱 路徑 類型 Description
物品
AlertChanelSubscription

警報頻道

名稱 路徑 類型 Description
ID
id number

識別碼。

類型
type string

警示通道的類型,即 EMAIL 或 SLACK。

警示通道設定
config AlertChannelConfig

警示通道的設定。

警示頻道訂閱清單
subscriptions AlertChanelSubscriptionList

所有支票都訂閱了該頻道。

傳送復原
sendRecovery boolean

是否發送恢復。

傳送失敗
sendFailure boolean

是否發送失敗。

傳送降級
sendDegraded boolean

是否發送降級。

SSL 到期
sslExpiry boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示。

SSL 到期臨界值
sslExpiryThreshold integer

何時開始對 SSL 憑證發出警示。

創建於
created_at date-time

建立時。

更新於
updated_at date-time

更新時。

警示通道清單

名稱 路徑 類型 Description
物品
AlertChannel

檢查警報

名稱 路徑 類型 Description
ID
id string

此警示的唯一識別碼。

名稱
name string

支票的名稱。

檢查 ID
checkId string

檢查此警示所屬的識別碼。

警示類型
alertType string

警示的類型。

檢查類型
checkType string

檢查的類型。

運行位置
runLocation string

此檢查警示是從哪個資料中心位置觸發的。

回應時間
responseTime number

描述執行此檢查相關部分所花費的時間。 在 Checkly 後端開始執行此檢查所需的任何設定計時器系統時間都不是其中的一部分。

錯誤
error string

觸發警示的失敗檢查中的任何特定錯誤訊息。

狀態代碼
statusCode string

回應的狀態碼。 僅適用於 API 檢查。

創建於
created_at date

建立此檢查警示的日期和時間。

開始於
startedAt date

此檢查警示的啟動日期和時間。

檢查警示清單

名稱 路徑 類型 Description
物品
CheckAlert

檢查群組標籤清單

用於組織和過濾檢查的標籤。

名稱 路徑 類型 Description
物品
string

檢查群組位置清單

一或多個要執行檢查的資料中心位置陣列。

名稱 路徑 類型 Description
物品
string

KeyValue

名稱 路徑 類型 Description
Key
key string

關鍵。

價值觀
value string

值。

鎖定
locked boolean

是否鎖定。

標頭清單

名稱 路徑 類型 Description
物品
KeyValue

QueryParameter清單

名稱 路徑 類型 Description
物品
KeyValue

斷言

名稱 路徑 類型 Description
來源
source string

來源。

房產
property string

屬性。

Comparison
comparison string

比較。

標的
target string

目標。

斷言清單

請查看斷言的主要 Checkly 檔案,以取得您可以在屬性欄位中使用的特定值,例如正規表示式和 JSON 路徑描述元。

名稱 路徑 類型 Description
物品
Assertion

BasicAuth

名稱 路徑 類型 Description
用戶名稱
username string

用戶名稱。

密碼
password string

密碼。

CheckGroupAPICheck預設值

名稱 路徑 類型 Description
URL
url string

此群組的基底 URL,您可以在所有群組檢查中使用 {{GROUP_BASE_URL}} 變數來參考。

headers
headers HeaderList
queryParameters 查詢參數
queryParameters QueryParameterList
斷言清單
assertions AssertionList

請查看斷言的主要 Checkly 檔案,以取得您可以在屬性欄位中使用的特定值,例如正規表示式和 JSON 路徑描述元。

basicAuth
basicAuth BasicAuth

CheckGroupBrowserCheckDefaults

檢查群組瀏覽器檢查預設值。

名稱 路徑 類型 Description
檢查群組瀏覽器檢查預設值
object

檢查群組瀏覽器檢查預設值。

EnvironmentVariable

名稱 路徑 類型 Description
Key
key string

環境變數的索引鍵(此值無法變更)。

價值觀
value string

環境變數的值。

鎖定
locked boolean

僅在 UI 中用於隱藏值,例如密碼。

環境變數清單

名稱 路徑 類型 Description
物品
EnvironmentVariable

AlertSettingsRunBasedEscalation

名稱 路徑 類型 Description
失敗執行臨界值
failedRunThreshold number

在連續檢查執行失敗的次數之後,應傳送警示通知。

AlertSettingsTimeBasedEscalation

名稱 路徑 類型 Description
失敗分鐘數臨界值
minutesFailingThreshold number

檢查開始失敗後多少分鐘後,應傳送警示。

AlertSettings提醒

名稱 路徑 類型 Description
總數
amount number

在初始警示通知之後要傳送多少提醒。

間隔
interval number

應以什麼時間間隔發送提醒。

AlertSettingsSSLCertificates(AlertSettingsSSLCertificates)

[已棄用] sslCertificates 已被取代,不再使用。 請忽略它,將在未來的版本中刪除。

名稱 路徑 類型 Description
已啟用
enabled boolean

決定是否應該針對即將到期的 SSL 憑證傳送警示通知。

警示臨界值
alertThreshold integer

何時開始對 SSL 憑證發出警示。

檢查群組警示設定

警示設定。

名稱 路徑 類型 Description
呈報類型
escalationType string

決定要使用的呈報類型。

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
溫馨提示
reminders AlertSettingsReminders
警示設定 SSL 憑證
sslCertificates AlertSettingsSSLCertificates

[已棄用] sslCertificates 已被取代,不再使用。 請忽略它,將在未來的版本中刪除。

型號1

警報頻道訂閱。

名稱 路徑 類型 Description
警示通道識別碼
alertChannelId number

警示通道識別碼。

已啟用
activated boolean

是否激活。

AlertChannelSubscriptionCreateList

警示通道訂閱清單。

名稱 路徑 類型 Description
警報頻道訂閱
Model1

警報頻道訂閱。

私人位置

要執行檢查的一或多個私人位置陣列。

名稱 路徑 類型 Description
物品
string

CheckGroup

名稱 路徑 類型 Description
ID
id number

識別碼。

名稱
name string

檢查群組的名稱。

已啟用
activated boolean

判斷群組中的檢查是否正在執行。

靜音
muted boolean

決定當此群組中的檢查失敗和/或復原時,是否會傳送任何通知。

檢查群組標籤清單
tags CheckGroupTagList

用於組織和過濾檢查的標籤。

檢查群組位置列表
locations CheckGroupLocationList

一或多個要執行檢查的資料中心位置陣列。

Concurrency
concurrency number

決定從 CI/CD 或透過 API 觸發檢查群組時同時呼叫的檢查數目。

apiCheck預設值
apiCheckDefaults CheckGroupAPICheckDefaults
檢查群組瀏覽器檢查預設值
browserCheckDefaults CheckGroupBrowserCheckDefaults

檢查群組瀏覽器檢查預設值。

environmentVariables
environmentVariables EnvironmentVariableList
仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是在此檢查群組上定義的警示設定。

檢查群組警報設定
alertSettings CheckGroupAlertSettings

警示設定。

警示通道訂閱建立清單
alertChannelSubscriptions AlertChannelSubscriptionCreateList

警示通道訂閱清單。

設定程式碼片段ID
setupSnippetId number

此群組中 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

拆除程式碼片段 ID
tearDownSnippetId number

此群組中 API 檢查的拆解階段中使用的程式碼片段的識別碼參照。

本機安裝指令碼
localSetupScript string

在此群組中 API 檢查的設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在此群組中 API 檢查的拆解階段執行的有效 Node.js 程式碼片段。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此組中的檢查。

私人地點
privateLocations privateLocations

要執行檢查的一或多個私人位置陣列。

創建於
created_at date

建立時。

更新於
updated_at date-time

更新時。

檢查組列表

名稱 路徑 類型 Description
物品
CheckGroup

檢查位置清單

一或多個要執行此檢查的資料中心位置陣列。

名稱 路徑 類型 Description
物品
string

檢查標籤清單

用於組織和過濾檢查的標籤。

名稱 路徑 類型 Description
物品
string

檢查警示設定

警示設定。

名稱 路徑 類型 Description
呈報類型
escalationType string

決定要使用的呈報類型。

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
溫馨提示
reminders AlertSettingsReminders
警示設定 SSL 憑證
sslCertificates AlertSettingsSSLCertificates

[已棄用] sslCertificates 已被取代,不再使用。 請忽略它,將在未來的版本中刪除。

檢查AlertChannelSubscription

名稱 路徑 類型 Description
警示通道識別碼
alertChannelId number

警示通道識別碼。

已啟用
activated boolean

是否激活。

檢查AlertChannelSubscriptionList

名稱 路徑 類型 Description
物品
CheckAlertChannelSubscription

檢查請求

檢查請求。

名稱 路徑 類型 Description
檢查請求
object

檢查請求。

檢查環境變數清單

用於在檢查執行期間設定環境變數的索引鍵/值組。 這些僅與瀏覽器檢查相關。 盡可能使用全域環境變數。

名稱 路徑 類型 Description
物品
EnvironmentVariable

檢查警報電子郵件

名稱 路徑 類型 Description
Address
address string

位址。

檢查警報電子郵件列表

名稱 路徑 類型 Description
物品
CheckAlertEmail

型號4

名稱 路徑 類型 Description
物品
KeyValue

型號5

名稱 路徑 類型 Description
物品
KeyValue

檢查警報Webhook

名稱 路徑 類型 Description
名稱
name string

名稱。

URL
url string

URL 位址。

方法
method string

方法。

headers
headers Model4
queryParameters 查詢參數
queryParameters Model5

檢查警示Webhook清單

名稱 路徑 類型 Description
物品
CheckAlertWebhook

檢查警報鬆弛

名稱 路徑 類型 Description
URL
url string

URL 位址。

檢查警示SlackList

名稱 路徑 類型 Description
物品
CheckAlertSlack

檢查警報短信

名稱 路徑 類型 Description
Number
number string

數字。

名稱
name string

名稱。

檢查警報短信清單

名稱 路徑 類型 Description
物品
CheckAlertSMS

檢查警示通道

名稱 路徑 類型 Description
電子郵件
email CheckAlertEmailList
Webhook
webhook CheckAlertWebhookList
slack CheckAlertSlackList
簡訊
sms CheckAlertSMSList

檢查組檢查

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

支票的名稱。

已啟用
activated boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations CheckLocationList

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags CheckTagList

用於組織和過濾檢查的標籤。

檢查警報設定
alertSettings CheckAlertSettings

警示設定。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

alertChannel訂閱
alertChannelSubscriptions CheckAlertChannelSubscriptionList
檢查類型
checkType string

檢查的類型。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

頻率偏移
frequencyOffset integer

頻率偏移。

檢查請求
request CheckRequest

檢查請求。

Script
script string

劇本。

檢查環境變數清單
environmentVariables CheckEnvironmentVariableList

用於在檢查執行期間設定環境變數的索引鍵/值組。 這些僅與瀏覽器檢查相關。 盡可能使用全域環境變數。

設定程式碼片段ID
setupSnippetId number

要在 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

拆除程式碼片段 ID
tearDownSnippetId number

要在 API 檢查的拆解階段中使用的程式碼片段的識別碼參考。

本機安裝指令碼
localSetupScript string

在設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在拆解階段執行的有效 Node.js 程式碼片段。

降低的回應時間
degradedResponseTime number

應將檢查視為降級的回應時間(以毫秒為單位)。

最大回應時間
maxResponseTime number

應將檢查視為失敗的回應時間 (以毫秒為單位)。

alertChannels
alertChannels CheckAlertChannels
私人地點
privateLocations privateLocations

要執行檢查的一或多個私人位置陣列。

創建於
created_at date

建立時。

更新於
updated_at date-time

更新時。

型號8

名稱 路徑 類型 Description
物品
CheckGroupCheck

斷言

API 檢查主張清單。

名稱 路徑 類型 Description
物品
string

headers

標題。

名稱 路徑 類型 Description
Headers
object

標題。

參數

參數。

名稱 路徑 類型 Description
參數
object

參數。

要求

API 的要求。

名稱 路徑 類型 Description
方法
method string
url
url string
資料
data string
Headers
headers headers

標題。

參數
params params

參數。

時序

時機。

名稱 路徑 類型 Description
時序
object

時機。

timing階段

計時階段。

名稱 路徑 類型 Description
計時階段
object

計時階段。

response

API 回應。

名稱 路徑 類型 Description
地位
status number

狀態。

狀態文字
statusText string

狀態文字。

身體
body string

身體。

Headers
headers headers

標題。

時序
timings timings

時機。

計時階段
timingPhases timingPhases

計時階段。

工作日誌

工作日誌。

名稱 路徑 類型 Description
工作日誌
object

工作日誌。

工作資產

從檢查執行產生的資產。

名稱 路徑 類型 Description
物品
string

檢查結果API

API 檢查的回應資料。

名稱 路徑 類型 Description
Assertions
assertions assertions

API 檢查主張清單。

Request
request request

API 的要求。

回應
response response

API 回應。

請求錯誤
requestError string

描述要求是否發生錯誤。

工作日誌
jobLog jobLog

工作日誌。

工作資產
jobAssets jobAssets

從檢查執行產生的資產。

錯誤

檢查執行中的錯誤清單。

名稱 路徑 類型 Description
物品
string

型號9

檢查執行記錄結果。

名稱 路徑 類型 Description
物品
string

追蹤摘要

追蹤摘要。

名稱 路徑 類型 Description
追蹤摘要
object

追蹤摘要。

pages

檢查執行中使用的頁面清單。

名稱 路徑 類型 Description
物品
string

檢查結果瀏覽器

瀏覽器檢查的回應資料。

名稱 路徑 類型 Description
類型
type string

檢查所使用的架構類型。

Errors
errors errors

檢查執行中的錯誤清單。

結束時間
endTime number

檢查執行的結束時間。

開始時間
startTime number

檢查執行的開始時間。

運行時間版本
runtimeVersion string

作用中執行階段版本。

檢查執行日誌
jobLog Model9

檢查執行記錄結果。

工作資產
jobAssets jobAssets

從檢查執行產生的資產。

追蹤摘要
traceSummary traceSummary

追蹤摘要。

頁面
pages pages

檢查執行中使用的頁面清單。

檢查結果

名稱 路徑 類型 Description
ID
id string

此結果的唯一識別碼。

名稱
name string

支票的名稱。

檢查 ID
checkId string

檢查的識別碼。

有失敗
hasFailures boolean

描述在此檢查執行期間是否發生任何失敗。 這應該是您評估 API 或瀏覽器檢查行為的主要重點。 失敗的判斷提示、逾時或失敗的指令碼都會解析為此值為 true。

有錯誤
hasErrors boolean

描述 Checkly 的後端是否發生內部錯誤。 在幾乎所有情況下,這都應該是錯誤的。

已降級
isDegraded boolean

如果檢查超過檢查上 degradedResponseTime 欄位所設定的降級限制,則會降級。 僅適用於 API 檢查。

超過最大響應時間
overMaxResponseTime boolean

如果回應時間超過檢查上 maxResponseTime 欄位所設定的限制,則設為 true。 僅適用於 API 檢查。

運行位置
runLocation string

此檢查結果源自哪個資料中心位置。

開始於
startedAt date-time

時間開始了。

停在
stoppedAt date-time

時間停止了。

創建於
created_at date-time

建立時。

回應時間
responseTime number

描述執行此檢查相關部分所花費的時間。 在 Checkly 後端開始執行此檢查所需的任何設定計時器系統時間都不是其中的一部分。

檢查結果 API
apiCheckResult CheckResultAPI

API 檢查的回應資料。

瀏覽器檢查結果
browserCheckResult CheckResultBrowser

瀏覽器檢查的回應資料。

檢查執行標識碼
checkRunId number

建立此檢查結果之特定檢查執行的識別碼。

嘗試
attempts number

重試此檢查的頻率。 啟用雙重檢查時,這將大於 0。

檢查結果清單

名稱 路徑 類型 Description
物品
CheckResult

檢查狀態

名稱 路徑 類型 Description
名稱
name string

支票的名稱。

檢查 ID
checkId string

檢查此狀態所屬的識別碼。

有失敗
hasFailures boolean

描述此檢查目前是否失敗。 如果 API 檢查失敗的任何判斷提示,則此值為 true。 如果瀏覽器檢查因任何原因失敗,這是正確的。

有錯誤
hasErrors boolean

描述是否由於正常操作之外的某些錯誤,此檢查失敗。 這應該極為罕見,並且僅在 Checkly 後端發生錯誤時才會出現。

已降級
isDegraded boolean

如果檢查超過檢查上 degradedResponseTime 欄位所設定的降級限制,則會降級。 僅適用於 API 檢查。

最長的運行
longestRun number

此檢查有記錄以來最長的響應時間。

最短運行
shortestRun number

此檢查有記錄以來最短的響應時間。

上次運行位置
lastRunLocation string

上次執行此檢查的位置。

上次檢查執行 ID
lastCheckRunId string

每個檢查執行的唯一遞增識別碼。

剩餘 SSL 天數
sslDaysRemaining number

距離目前的 SSL 憑證到期還剩多少天。

創建於
created_at date

建立時。

更新於
updated_at date-time

更新時。

檢查狀態清單

名稱 路徑 類型 Description
物品
CheckStatus

檢查

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

支票的名稱。

已啟用
activated boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations CheckLocationList

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags CheckTagList

用於組織和過濾檢查的標籤。

檢查警報設定
alertSettings CheckAlertSettings

警示設定。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

alertChannel訂閱
alertChannelSubscriptions CheckAlertChannelSubscriptionList
檢查類型
checkType string

檢查的類型。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

頻率偏移
frequencyOffset integer

頻率偏移。

檢查請求
request CheckRequest

檢查請求。

Script
script string

劇本。

檢查環境變數清單
environmentVariables CheckEnvironmentVariableList

用於在檢查執行期間設定環境變數的索引鍵/值組。 這些僅與瀏覽器檢查相關。 盡可能使用全域環境變數。

設定程式碼片段ID
setupSnippetId number

要在 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

拆除程式碼片段 ID
tearDownSnippetId number

要在 API 檢查的拆解階段中使用的程式碼片段的識別碼參考。

本機安裝指令碼
localSetupScript string

在設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在拆解階段執行的有效 Node.js 程式碼片段。

降低的回應時間
degradedResponseTime number

應將檢查視為降級的回應時間(以毫秒為單位)。

最大回應時間
maxResponseTime number

應將檢查視為失敗的回應時間 (以毫秒為單位)。

alertChannels
alertChannels CheckAlertChannels
私人地點
privateLocations privateLocations

要執行檢查的一或多個私人位置陣列。

創建於
created_at date

建立時。

更新於
updated_at date-time

更新時。

檢查清單

名稱 路徑 類型 Description
物品
Check

型號14

名稱 路徑 類型 Description
物品
KeyValue

型號15

名稱 路徑 類型 Description
物品
KeyValue

型號16

決定要執行檢查的要求。

名稱 路徑 類型 Description
方法
method string
URL
url string

URL 位址。

追蹤重新導向
followRedirects boolean

是否遵循重定向。

略過 SSL
skipSSL boolean

是否跳過 SSL。

身體
body string

身體。

體型
bodyType string

體型。

headers
headers Model14
queryParameters 查詢參數
queryParameters Model15
斷言清單
assertions AssertionList

請查看斷言的主要 Checkly 檔案,以取得您可以在屬性欄位中使用的特定值,例如正規表示式和 JSON 路徑描述元。

basicAuth
basicAuth BasicAuth

檢查API

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

支票的名稱。

已啟用
activated boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations CheckLocationList

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags CheckTagList

用於組織和過濾檢查的標籤。

檢查警報設定
alertSettings CheckAlertSettings

警示設定。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

alertChannel訂閱
alertChannelSubscriptions CheckAlertChannelSubscriptionList
檢查請求
request Model16

決定要執行檢查的要求。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

頻率偏移
frequencyOffset integer

用於設定 1 分鐘以下檢查頻率的秒數 (僅適用於 API 檢查),以及將超過 1 分鐘的頻率分散到時間範圍內。 其運作方式如下:頻率為 0 的檢查可以具有 10、20 或 30 的 FrequecyOffset ,這表示它們將每 10、20 或 30 秒執行一次。 頻率小於等於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.floor(frequency * 10),也就是說,對於每 5 分鐘執行一次的檢查,最大 frequencyOffset 為 50。 頻率高於 60 的檢查可以具有介於 1 和最大值之間的 frequencyOffset,根據公式 Math.ceil(frequency / 60),也就是說,對於每 720 分鐘執行一次的檢查,最大 frequencyOffset 為 12。

拆除程式碼片段 ID
tearDownSnippetId number

要在 API 檢查的拆解階段中使用的程式碼片段的識別碼參考。

設定程式碼片段ID
setupSnippetId number

要在 API 檢查的設定階段中使用的程式碼片段的識別碼參考。

本機安裝指令碼
localSetupScript string

在設定階段執行的有效 Node.js 程式碼片段。

本地拆解腳本
localTearDownScript string

在拆解階段執行的有效 Node.js 程式碼片段。

降低的回應時間
degradedResponseTime number

應將檢查視為降級的回應時間(以毫秒為單位)。

最大回應時間
maxResponseTime number

應將檢查視為失敗的回應時間 (以毫秒為單位)。

私人地點
privateLocations privateLocations

要執行檢查的一或多個私人位置陣列。

檢查類型
checkType string

檢查類型。

alertChannels
alertChannels CheckAlertChannels
創建於
created_at date

建立時。

更新於
updated_at date-time

更新時。

檢查瀏覽器

名稱 路徑 類型 Description
ID
id string

識別碼。

名稱
name string

支票的名稱。

已啟用
activated boolean

判斷檢查是否正在執行。

靜音
muted boolean

決定檢查失敗和/或復原時是否要傳送任何通知。

仔細檢查
doubleCheck boolean

將此設定為 true 會在檢查失敗時觸發重試,當檢查失敗區域和另一個隨機選取的區域失敗,再將檢查標示為失敗。

應該失敗
shouldFail boolean

允許反轉檢查被視為失敗時的行為。 允許驗證錯誤狀態,例如 404。

查看位置列表
locations CheckLocationList

一或多個要執行此檢查的資料中心位置陣列。

檢查標籤清單
tags CheckTagList

用於組織和過濾檢查的標籤。

檢查警報設定
alertSettings CheckAlertSettings

警示設定。

使用全域警示設定
useGlobalAlertSettings boolean

如果為true,則會使用帳戶層級警示設定,而不是此檢查上定義的警示設定。

群組識別碼
groupId number

此檢查所屬檢查群組的識別碼。

團體訂單
groupOrder number

此檢查在檢查群組中的位置。 它決定從 API 或 CI/CD 觸發群組時執行檢查的順序。

執行階段識別碼
runtimeId string

運行時版本,即固定的運行時依賴項集,用於執行此檢查。

alertChannel訂閱
alertChannelSubscriptions CheckAlertChannelSubscriptionList
檢查類型
checkType string

檢查類型。

頻率
frequency integer

檢查應執行的頻率(以分鐘為單位)。

Script
script string

一段有效的 Node.js javascript 程式碼,描述瀏覽器與 Puppeteer 或 Playwright 框架的互動。

私人地點
privateLocations privateLocations

要執行檢查的一或多個私人位置陣列。

alertChannels
alertChannels CheckAlertChannels
創建於
created_at date

建立時。

更新於
updated_at date-time

更新時。

儀表板標籤清單

一或多個標籤的清單,可篩選要顯示在儀表板上的檢查。

名稱 路徑 類型 Description
物品
string

Dashboard

名稱 路徑 類型 Description
Custom Domain
customDomain string

自訂使用者網域,例如 status.example.com。 請參閱有關更新 DNS 和 SSL 使用情況的文件。

自訂網址
customUrl string

checklyhq.com 下的子網域名稱。 所有使用者都需要是唯一的。

商標
logo string

指向影像檔案的 URL。

網站圖示(favicon)
favicon string

指向用作儀表板網站標識的影像檔案的 URL。

Link
link string

按一下儀表板標誌時要重新導向的 URL 連結。

Header
header string

顯示在儀表板頂端的一段文字。

Description
description string

顯示在儀表板標題或標題下方的一段文字。

寬度
width string

決定是使用全螢幕還是對焦於中央。

刷新率
refreshRate number

以秒為單位重新整理儀表板的頻率。

分頁
paginate boolean

分頁的決定是開啟或關閉。

分頁率
paginationRate number

觸發分頁的頻率(以秒為單位)。

每頁檢查數
checksPerPage number

每頁顯示的檢查數。

使用和運算子
useTagsAndOperator boolean

何時使用 AND 運算子進行標籤查詢。

隱藏標籤
hideTags boolean

在儀表板上顯示或隱藏標籤。

儀表板標籤清單
tags DashboardTagList

一或多個標籤的清單,可篩選要顯示在儀表板上的檢查。

儀表板 ID
dashboardId string

儀表板識別碼。

儀表板清單

名稱 路徑 類型 Description
物品
Dashboard

地點

名稱 路徑 類型 Description
區域
region string

此位置的唯一識別碼。

名稱
name string

這個位置的易記名稱。

位置列表

名稱 路徑 類型 Description
物品
Location

維護視窗標籤清單

檢查和群組維護時段的名稱應該套用。

名稱 路徑 類型 Description
物品
string

MaintenanceWindow (維護視窗)

名稱 路徑 類型 Description
ID
id number

維護時段的識別碼。

名稱
name string

維護時段名稱。

維護時段標籤清單
tags MaintenanceWindowTagList

檢查和群組維護時段的名稱應該套用。

起價
startsAt date

維護時段的開始日期。

結束於
endsAt date

維護時段的結束日期。

重複間隔
repeatInterval number

從第一次發生開始的維護時段的重複間隔。

重複單元
repeatUnit string

維護時段的重複策略。

重複結束於
repeatEndsAt date

維護時段應停止重複的結束日期。

創建於
created_at date

維護時段的建立日期。

更新於
updated_at date

更新維護時段的最後日期。

維護視窗清單

維護時段清單。

名稱 路徑 類型 Description
物品
MaintenanceWindow

檢查指派

名稱 路徑 類型 Description
ID
id guid

識別碼。

檢查 ID
checkId guid

檢查的識別碼。

私人位置 ID
privateLocationId guid

指派的專用位置的識別碼。

checkAssignments

此私人位置已指派的檢查。

名稱 路徑 類型 Description
物品
CheckAssignment

群組指派

名稱 路徑 類型 Description
ID
id guid

識別碼。

群組識別碼
groupId number

群組的識別碼。

私人位置 ID
privateLocationId guid

指派的專用位置的識別碼。

群組指派

此私人位置已指派的群組。

名稱 路徑 類型 Description
物品
GroupAssignment

privateLocation金鑰

名稱 路徑 類型 Description
ID
id guid

識別碼。

原始金鑰
rawKey string

原始鑰匙。

蒙面鑰匙
maskedKey string

遮罩的索引鍵值。

創建於
created_at date

建立時。

更新於
updated_at date

更新時。

鑰匙

名稱 路徑 類型 Description
物品
privateLocationKeys

privateLocation模式

名稱 路徑 類型 Description
ID
id guid

識別碼。

名稱
name string

指派給私人位置的名稱。

Slug 名稱
slugName string

有效的 slug 名稱。

Icon
icon string

私人位置圖示。

創建於
created_at date

建立時。

更新於
updated_at date

更新時。

檢查指派
checkAssignments checkAssignments

此私人位置已指派的檢查。

小組作業
groupAssignments groupAssignments

此私人位置已指派的群組。

鑰匙
keys keys
最後一次出現
lastSeen date

最後一次看到的日期。

代理程式計數
agentCount number

代理程式計數。

privateLocationsListSchema

名稱 路徑 類型 Description
物品
privatelocationschema

commonPrivateLocationSchemaResponse

名稱 路徑 類型 Description
ID
id guid

識別碼。

名稱
name string

指派給私人位置的名稱。

Slug 名稱
slugName string

有效的 slug 名稱。

Icon
icon string

私人位置圖示。

創建於
created_at date

建立時。

更新於
updated_at date

更新時。

檢查指派
checkAssignments checkAssignments

此私人位置已指派的檢查。

小組作業
groupAssignments groupAssignments

此私人位置已指派的群組。

鑰匙
keys keys

時間戳記

名稱 路徑 類型 Description
時間戳
date-time

時間戳記。

佇列大小

佇列大小。

名稱 路徑 類型 Description
物品
number

oldestScheduledCheckRun

名稱 路徑 類型 Description
物品
number

privateLocationsMetricsHistoryResponseSchema

名稱 路徑 類型 Description
時間戳記
timestamps timestamps
佇列大小
queueSize queueSize

佇列大小。

oldestScheduledCheckRun
oldestScheduledCheckRun oldestScheduledCheckRun

報告標籤清單

檢查標籤。

名稱 路徑 類型 Description
物品
string

報告彙總

名稱 路徑 類型 Description
成功率
successRatio number

所選日期範圍內檢查的成功率。 百分比為十進制形式。

平均
avg number

所選日期範圍內檢查的平均回應時間(以毫秒為單位)。

頁95
p95 number

P95 檢查在所選日期範圍內的回應時間(以毫秒為單位)。

頁99
p99 number

P99 檢查在所選日期範圍內的回應時間(以毫秒為單位)。

報告

名稱 路徑 類型 Description
名稱
name string

檢查名稱。

檢查 ID
checkId string

檢查 ID。

檢查類型
checkType string

檢查類型。

已停用
deactivated boolean

勾選已停用。

報告標籤清單
tags ReportingTagList

檢查標籤。

彙總
aggregate ReportingAggregate

報告清單

名稱 路徑 類型 Description
物品
Reporting

執行時間

名稱 路徑 類型 Description
名稱
name string

此執行階段的唯一名稱。

階段
stage string

執行階段的目前生命週期。

執行階段生命週期結束
runtimeEndOfLife string

運行時將從我們的平台中刪除的日期。

預設
default boolean

指出這是否是 Checkly 所提供的目前預設執行階段。

Description
description string

此執行階段中主要更新的簡短、人類可讀的描述。

繩子
dependencies.string string

字串。

執行時間清單

名稱 路徑 類型 Description
物品
Runtime

程式碼片段

名稱 路徑 類型 Description
ID
id number

識別碼。

名稱
name string

程式碼片段名稱。

Script
script string

您的 Node.js 程式碼,可與 API 檢查生命週期互動,或作為瀏覽器檢查的部分程式碼。

創建於
created_at date-time

建立時。

更新於
updated_at date-time

更新時。

片段列表

名稱 路徑 類型 Description
物品
Snippet

檢查群組觸發程式

名稱 路徑 類型 Description
ID
id number

識別碼。

代幣
token string

權杖。

創建於
created_at date

建立時。

被叫到
called_at date

當被召喚時。

更新於
updated_at date

更新時。

群組識別碼
groupId number

群組識別碼。

檢查觸發器

名稱 路徑 類型 Description
ID
id number

識別碼。

代幣
token string

權杖。

創建於
created_at date

建立時。

被叫到
called_at date

當被召喚時。

更新於
updated_at date

更新時。

檢查 ID
checkId string

檢查識別碼。

物件

這是類型 'object'。

字串

這是基本資料類型「string」。