Checkly (独立発行者) (プレビュー)

Checkly は、プログラム可能でで柔軟性が高く、JavaScript に対応した、モダンなスタックのための監視プラットフォームです。 重要なサイト トランザクションを監視および検証します。 チェックを実行するたびに、エラー トレース、スクリーンショット、パフォーマンス メトリックを自動的に収集します。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Troy Taylor
[URL] https://www.hitachisolutions.com
メール ttaylor@hitachisolutions.com
Connector Metadata
発行者 Troy Taylor
Web サイト https://www.checklyhq.com/
プライバシー ポリシー https://www.checklyhq.com/privacy
カテゴリー IT オペレーション

接続を作成する

コネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 説明設定 Required
Account ID securestring この API のアカウント ID。 True
API キー (ベアラー apiKey の形式) securestring この API の API キー (ベアラー apiKey の形式) True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

1 つの特定のランタイムの詳細を表示します

特定のランタイムに含まれるすべての NPM パッケージとそのバージョンの詳細を表示します。

API チェックの作成

新しい API チェックを作成します。 プランの上限を超えると 402 を返します。 globalAlertSetting を使用する場合、alertSettingnull にすることができます

API チェックの更新

API チェックを更新します。

すべてのアラート チャネルを一覧表示する

設定されたすべてのアラート チャネルとそれらのサブスクライブされたチェックを一覧表示します。

すべてのスニペットを一覧表示

アカウントの現在のスニペットをすべて一覧表示します。

すべてのダッシュボードを一覧表示

アカウントの現在のすべてのダッシュボードを一覧表示します。

すべてのチェック グループを一覧表示

アカウントの現在のすべてのチェック グループを一覧表示します。 checks プロパティは、チェックの UUID の配列で、参照に便利です。 これは読み取り専用のため、グループにチェックを追加するために使用することはできません。

すべてのチェックの状態を一覧表示

アカウントのすべてのチェックの現在の状態の情報を表示します。 チェックの状態レコードは、新しいチェック結果が入るたびに継続的に更新されます。

すべてのチェックを一覧表示

アカウントの現在のすべてのチェックを一覧表示します。

すべてのチェック結果を一覧表示

特定のチェックについて、完全な未加工のチェック結果を一覧表示します。 未加工の結果は 30 日間保持されます。 30 日後、それらは消去されます。 ただし、ロールアップされた結果は無期限に保持されます。 チェック タイプと結果タイプでフィルターして、リストを絞り込むことができます。 tofrom パラメーターを使用して、日付範囲 (UNIX タイムスタンプ (秒)) を指定します。 チェックの種類によっては、一部のフィールドが null になる場合があります。 この エンドポイント は、6 時間以内にデータを返します。 from と to のパラメーターが設定されている場合、それらは最大で 6 時間離れている必要があります。もし何も設定されていない場合、to パラメーターを現在、from パラメーターを 6 時間前とみなします。 to パラメーターのみが設定されている場合は、from を 6 時間早く設定します。 逆に、from パラメーターのみが設定されている場合、to パラメーターは 6 時間後と見なされます。 この エンドポイント にはレート制限が適用されており、最大 10 秒あたり 5 つのリクエストを送信できます。

すべてのブラウザ チェック メトリックのカスタマイズ可能なレポートを生成します

特定のブラウザー チェックについて、指定された時間枠で集計または非集計された統計情報を含むレポートを生成します。

すべてのメンテナンス期間を一覧表示

アカウントの現在のすべてのメンテナンス期間を一覧表示します。

すべての環境変数を一覧表示

アカウントの現在のすべての環境変数を一覧表示します。

すべての非公開のロケーションを一覧表示

アカウントの現在のすべての非公開のロケーションを一覧表示します。

アカウントに登録されているすべてのアラートを一覧表示

アカウントのすべてのアラートを一覧表示します。

アラート チャネルのサブスクリプションを更新する

アラート チャネルのサブスクリプションを更新します。 これを使用してアラート チャネルにチェックを追加し、そのチェックに対して不具合の発生および回復アラートが送信されるようにします。 注: サブスクリプション オブジェクトを渡す場合、checkId または groupId のみを指定できます。両方を指定することはできません。

アラート チャネルの作成

新しいアラート チャネルを作成します。

アラート チャネルの取得

特定のアラート チャネルの詳細を表示します。

アラート チャネルの更新

アラート チャネルを更新します。

アラート チャンネルの削除

アラート チャネルを完全に削除します。

グループの状態バッジの取得

グループの状態バッジを取得します。

グループ設定を適用した特定のグループ内の 1 つのチェックを取得する

特定のチェックグループ内の 1 つのチェックの詳細を、グループ設定を適用して表示します。

スニペットの作成

新しいスニペットを作成します。

スニペットの削除

スニペットを完全に削除します。

スニペットの取得

特定のスニペットの詳細を表示します。

スニペットの更新

スニペットを更新します。

ダッシュボードの削除

ダッシュボードを完全に削除します。

ダッシュボードの更新

ダッシュボードを更新します。 カスタム URL またはカスタム ドメインがすでに使用されている状態でダッシュボードを作成しようとすると、409 が返されます。

ダッシュボードを作成する

新しいダッシュボードを作成します。 カスタム URL またはカスタム ドメインがすでに使用されている状態でダッシュボードを作成しようとすると、409 が返されます。

チェック グループ トリガーの削除

チェック グループ トリガーを削除します。

チェック グループ トリガーの取得

チェック グループ トリガーを検索します。

チェック グループ トリガーを作成する

チェック グループ トリガーを作成します。

チェック グループの作成

新しいチェック グループを作成します。 個々のチェックの groupId プロパティを設定することで、グループにチェックを追加することができます。

チェック グループの削除

チェック グループを完全に削除します。 まだチェックが含まれている場合、チェック グループを削除することはできません。

チェック グループの取得

特定のチェックグループの詳細を表示します。

チェック グループの更新

チェック グループを更新します。

チェック トリガーの作成

チェック トリガーを作成します。

チェック トリガーの削除

チェック トリガーを削除します。

チェック トリガーの取得

チェック トリガーを検索します。

チェックおよびチェック グループの集計を含むレポートを作成する

指定された期間内のすべてのチェックまたはフィルターされたチェックの集合の統計情報を集約したレポートを作成します。

チェックの削除

API またはブラウザー チェックと、それに関連するすべてのステータス データと結果データを完全に削除します。

チェックの取得

特定の API またはブラウザー チェックの詳細を表示します。

チェックの更新 [非推奨]

[非推奨] このエンドポイントは 2022 年 7 月 4 日月曜日に削除される予定です。代わりに PUT /checks/api/{id} または PUT /checks/browser/{id} を使用してください。 新しい API やブラウザーのチェックを更新します。

チェックを作成する [非推奨]

[非推奨] このエンドポイントは 2022 年 7 月 4 日月曜日に削除される予定です。代わりに POST /checks/api または POST /checks/browser を使用してください。 新規 API またはブラウザのチェックを作成します。 プランの上限を超えると 402 を返します。 globalAlertSettings を使用する場合、alertSettingsnull にすることができます

チェック状態の詳細を取得する

特定のチェックの現在の状態の情報を表示します。

チェック結果の取得

特定のチェック結果の詳細を表示します。

ブラウザーのチェックを作成する

新規ブラウザーのチェックを作成します。 プランの上限を超えると 402 を返します。 globalAlertSetting を使用する場合、alertSettingnull にすることができます

ブラウザーのチェックを更新する

ブラウザーのチェックを更新します。

プライベート ロケーションの新しい API キーを生成する

プライベート ロケーションに API キーを作成します。

プライベートな場所を削除する

非公開のロケーションを完全に削除します。

メンテナンス期間の作成

アイン期メンテナンス期間を作成します。

メンテナンス期間の削除

メンテナンス期間を完全に削除します。

メンテナンス期間の取得

特定のメンテナンス期間の詳細を表示します。

メンテナンス期間の更新

メンテナンス期間を更新します。

対応するすべてのランタイムを一覧表示

サポートされているすべてのランタイムと、ブラウザー チェック用の含まれる NPM パッケージ、API チェック用のセットアップとティアダウン スクリプトを一覧表示します。

対応するすべてのロケーションを一覧表示

対応するすべてのロケーションを一覧表示します。

時間枠からプライベート ロケーションの正常性指標を取得する

時間枠からプライベート ロケーションの正常性指標を取得します。

特定のグループに属する、グループ設定が適用されたすべてのチェックを取得する

特定のチェックグループ内のすべてのチェックを、グループ設定を適用した状態で一覧表示します。

特定のチェックに対するアラートを一覧表示

特定のチェックに関するすべてのアラートを一覧表示します。

状態のバッジをチェックを取得する

状態のバッジをチェックを取得します。

環境変数の作成

新しい環境変数を作成します。

環境変数の削除

環境変数から完全に削除します。 キー フィールドを削除の識別子として使用します。

環境変数の取得

特定の環境変数の詳細を表示します。 キー フィールドを使用して選択します。

環境変数の更新

環境変数を更新します。 キー フィールドを更新の識別子として使用します。 値とロックされたプロパティのみを更新します。

非公開のロケーションの取得

特定の非公開のロケーションの詳細を表示します。

非公開のロケーションの既存の API キーを削除する

api キーを非公開のロケーションから完全に削除します。

非公開ロケーションの更新

非公開ロケーションを更新します。

非公開ロケーションを作成する

新しいプ非公開ロケーションを作成します。

1 つの特定のランタイムの詳細を表示します

特定のランタイムに含まれるすべての NPM パッケージとそのバージョンの詳細を表示します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

戻り値

Body
Runtime

API チェックの作成

新しい API チェックを作成します。 プランの上限を超えると 402 を返します。 globalAlertSetting を使用する場合、alertSettingnull にすることができます

パラメーター

名前 キー 必須 説明
アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name True string

チェックの名前です。

アクティブ化済み
activated True boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations array of string

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

アラートチャネル ID
alertChannelId True number

アラート チャネルの識別子です。

アクティブ化済み
activated True boolean

アクティブかどうか。

方法
method True string
[URL]
url True string

URL アドレス。

リダイレクトへの追従
followRedirects boolean

リダイレクトに追従するかどうか。

SSL のスキップ
skipSSL boolean

SSL をスキップするかどうか。

Body
body string

ボディ。

bodyType
bodyType string
Key
key True string

キー。

価値
value True string

値。

Locked
locked boolean

ロックされているかどうか。

Source
source string

ソース。

Property
property string

プロパティ。

比較
comparison string

比較。

Target
target string

ターゲット。

Username
username True string

ユーザー名。

Password
password True string

パスワード。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

ティアダウン スニペット ID
tearDownSnippetId number

API チェックのティアダウン フェーズで使用するスニペットへの識別子の参照。

スニペット ID を設定
setupSnippetId number

API チェックの設定フェーズで使用するスニペットへの識別子の参照。

オフセットの頻度
frequencyOffset integer

1分未満のチェック頻度の秒数を設定し、1 分を超える頻度の時間範囲にわたってチェックを分散するために使用されます。 これは次のように動作します: 頻度が 0 のチェックは、frequencyOffset を 10、20、30 に設定することができ、これは 10、20、30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、Math.floor (頻度 * 10) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、5 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 50 です。 頻度が 60 以上のチェックでは、Math.ceil (頻度 / 60) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、720 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 12 です。

ローカル セットアップ スクリプト
localSetupScript string

API チェックの設定フェーズで使用するスニペットへの識別子リファレンス。

ローカル ティアダウン スクリプト
localTearDownScript string

API チェックのティアダウン フェーズで使用するスニペットへの識別子リファレンス。

応答時間速度の低下
degradedResponseTime number

チェックが劣化したとみなされる応答時間をミリ秒単位で指定します。

最大応答時間
maxResponseTime number

チェックが失敗したとみなされる応答時間をミリ秒単位で指定します。

非公開のロケーション
privateLocations array of string

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

Body
CheckAPI

API チェックの更新

API チェックを更新します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name string

チェックの名前です。

アクティブ化済み
activated boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations array of string

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

アラートチャネル ID
alertChannelId True number

アラート チャネルの識別子です。

アクティブ化済み
activated True boolean

アクティブかどうか。

方法
method True string
[URL]
url True string

URL アドレス。

リダイレクトへの追従
followRedirects boolean

リダイレクトに追従するかどうか。

SSL のスキップ
skipSSL boolean

SSL をスキップするかどうか。

Body
body string

ボディ。

ボディ タイプ
bodyType string

ボディのタイプです。

Key
key True string

キー。

価値
value True string

値。

Locked
locked boolean

ロックされているかどうか。

Source
source string

ソース。

Property
property string

プロパティ。

比較
comparison string

比較。

Target
target string

ターゲット。

Username
username True string

ユーザー名。

Password
password True string

パスワード。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

ティアダウン スニペット ID
tearDownSnippetId number

API チェックのティアダウン フェーズで使用するスニペットへの識別子の参照。

スニペット ID を設定
setupSnippetId number

API チェックの設定フェーズで使用するスニペットへの識別子の参照。

オフセットの頻度
frequencyOffset integer

1分未満のチェック頻度の秒数を設定し、1 分を超える頻度の時間範囲にわたってチェックを分散するために使用されます。 これは次のように動作します: 頻度が 0 のチェックは、frequencyOffset を 10、20、30 に設定することができ、これは 10、20、30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、Math.floor (頻度 * 10) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、5 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 50 です。 頻度が 60 以上のチェックでは、Math.ceil (頻度 / 60) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、720 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 12 です。

ローカル セットアップ スクリプト
localSetupScript string

API チェックの設定フェーズで使用するスニペットへの識別子リファレンス。

ローカル ティアダウン スクリプト
localTearDownScript string

API チェックのティアダウン フェーズで使用するスニペットへの識別子リファレンス。

応答時間速度の低下
degradedResponseTime number

チェックが劣化したとみなされる応答時間をミリ秒単位で指定します。

最大応答時間
maxResponseTime number

チェックが失敗したとみなされる応答時間をミリ秒単位で指定します。

非公開のロケーション
privateLocations array of string

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

Body
CheckAPI

すべてのアラート チャネルを一覧表示する

設定されたすべてのアラート チャネルとそれらのサブスクライブされたチェックを一覧表示します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

戻り値

アイテム
AlertChannelList

すべてのスニペットを一覧表示

アカウントの現在のスニペットをすべて一覧表示します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

戻り値

アイテム
SnippetList

すべてのダッシュボードを一覧表示

アカウントの現在のすべてのダッシュボードを一覧表示します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

戻り値

アイテム
DashboardsList

すべてのチェック グループを一覧表示

アカウントの現在のすべてのチェック グループを一覧表示します。 checks プロパティは、チェックの UUID の配列で、参照に便利です。 これは読み取り専用のため、グループにチェックを追加するために使用することはできません。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

戻り値

アイテム
CheckGroupList

すべてのチェックの状態を一覧表示

アカウントのすべてのチェックの現在の状態の情報を表示します。 チェックの状態レコードは、新しいチェック結果が入るたびに継続的に更新されます。

戻り値

アイテム
CheckStatusList

すべてのチェックを一覧表示

アカウントの現在のすべてのチェックを一覧表示します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

API チェック URL フィルター
apiCheckUrlFilterPattern string

API チェックの URL に含まれる文字列 (www.myapp.com などのドメイン) で結果をフィルターします。 API チェックのみを返します。

戻り値

アイテム
CheckList

すべてのチェック結果を一覧表示

特定のチェックについて、完全な未加工のチェック結果を一覧表示します。 未加工の結果は 30 日間保持されます。 30 日後、それらは消去されます。 ただし、ロールアップされた結果は無期限に保持されます。 チェック タイプと結果タイプでフィルターして、リストを絞り込むことができます。 tofrom パラメーターを使用して、日付範囲 (UNIX タイムスタンプ (秒)) を指定します。 チェックの種類によっては、一部のフィールドが null になる場合があります。 この エンドポイント は、6 時間以内にデータを返します。 from と to のパラメーターが設定されている場合、それらは最大で 6 時間離れている必要があります。もし何も設定されていない場合、to パラメーターを現在、from パラメーターを 6 時間前とみなします。 to パラメーターのみが設定されている場合は、from を 6 時間早く設定します。 逆に、from パラメーターのみが設定されている場合、to パラメーターは 6 時間後と見なされます。 この エンドポイント にはレート制限が適用されており、最大 10 秒あたり 5 つのリクエストを送信できます。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

送信者
from date

この UNIX タイムスタンプ (>= 日付) 以降のドキュメントを選択します。 既定は現在から - 6時間です。

受信先
to date

この UNIX タイムスタンプ (<日付) までのアラートを選択します。 既定は開始から 6 時間後です。

場所
location string

「eu-west-1」など、データセンターの場所を指定して、場所でフィルターします

検査のタイプ
checkType string

チェックの種類。

失敗がある
hasFailures boolean

チェックの結果に 1 つ以上の失敗があります。

戻り値

アイテム
CheckResultList

すべてのブラウザ チェック メトリックのカスタマイズ可能なレポートを生成します

特定のブラウザー チェックについて、指定された時間枠で集計または非集計された統計情報を含むレポートを生成します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

送信者
from date

Unix タイムスタンプ形式でのレポートウィンドウのカスタム開始時刻です。 タイムスタンプからカスタムを設定すると、presetWindow の使用が上書きされます。

受信先
to date

Unix タイムスタンプ形式でのレポートウィンドウのカスタム終了時刻です。 タイムスタンプからカスタムを設定すると、presetWindow の使用が上書きされます。

プリセット ウィンドウ
presetWindow string

プリセット レポート ウィンドウは、よく使用されるウィンドウに関するレポートをすばやく生成するために使用されます。 カスタムの to と from タイムスタンプを使用して上書きできます。

集計のサイクル間隔
aggregationInterval number

メトリクスの集計に使用する時間間隔 (分単位) です。 たとえば、5 分は 300、24 時間は 1440 です。

グループ化
groupBy string

系列データをグループ化する方法を決定します。

状態でフィルター処理
filterByStatus array

状態sを使用して、失敗または成功したチェック結果データのチェックをフィルターします。

メトリック
metrics array

ブラウザ チェックのメトリクス オプション。

戻り値

属性です。

属性
object

すべてのメンテナンス期間を一覧表示

アカウントの現在のすべてのメンテナンス期間を一覧表示します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

戻り値

メンテナンス期間のリストです。

アイテム
MaintenanceWindowList

すべての環境変数を一覧表示

アカウントの現在のすべての環境変数を一覧表示します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

戻り値

すべての非公開のロケーションを一覧表示

アカウントの現在のすべての非公開のロケーションを一覧表示します。

戻り値

アカウントに登録されているすべてのアラートを一覧表示

アカウントのすべてのアラートを一覧表示します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

送信者
from date

この UNIX タイムスタンプ (>= 日付) 以降のドキュメントを選択します。 既定は現在から - 6時間です。

受信先
to date

この UNIX タイムスタンプ (<日付) までのアラートを選択します。 既定は開始から 6 時間後です。

戻り値

アイテム
CheckAlertList

アラート チャネルのサブスクリプションを更新する

アラート チャネルのサブスクリプションを更新します。 これを使用してアラート チャネルにチェックを追加し、そのチェックに対して不具合の発生および回復アラートが送信されるようにします。 注: サブスクリプション オブジェクトを渡す場合、checkId または groupId のみを指定できます。両方を指定することはできません。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

チェック ID
checkId guid

checkId または groupId のいずれかを渡すことができますが、両方を渡すことはできません。

Group ID
groupId number

checkId または groupId のいずれかを渡すことができますが、両方を渡すことはできません。

アクティブ化済み
activated True boolean

アクティブかどうか。

戻り値

アラート チャネルの作成

新しいアラート チャネルを作成します。

パラメーター

名前 キー 必須 説明
ID
id number

識別子。

チェック ID
checkId guid

チェックの識別子です。

Group ID
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 証明書に関するアラートを開始するか。

戻り値

アラート チャネルの取得

特定のアラート チャネルの詳細を表示します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

戻り値

アラート チャネルの更新

アラート チャネルを更新します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

ID
id number

識別子。

チェック ID
checkId guid

チェックの識別子です。

Group ID
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 証明書に関するアラートを開始するか。

戻り値

アラート チャンネルの削除

アラート チャネルを完全に削除します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

グループの状態バッジの取得

グループの状態バッジを取得します。

パラメーター

名前 キー 必須 説明
Group ID
groupId True integer

グループの識別子。

スタイル
style string

フォント スタイル。

Theme
theme string

テーマ。

応答時間
responseTime boolean

応答時間です。

戻り値

返答
string

グループ設定を適用した特定のグループ内の 1 つのチェックを取得する

特定のチェックグループ内の 1 つのチェックの詳細を、グループ設定を適用して表示します。

パラメーター

名前 キー 必須 説明
Group ID
groupId True integer

グループの識別子。

チェック ID
checkId True string

チェックの識別子です。

戻り値

スニペットの作成

新しいスニペットを作成します。

パラメーター

名前 キー 必須 説明
件名
name True string

スニペットの名前です。

スクリプト
script True string

API チェックのライフサイクルと相互作用する、またはブラウザ チェックの一環として機能する Node.js コードです。

戻り値

Body
Snippet

スニペットの削除

スニペットを完全に削除します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

スニペットの取得

特定のスニペットの詳細を表示します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

戻り値

Body
Snippet

スニペットの更新

スニペットを更新します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

件名
name True string

スニペットの名前です。

スクリプト
script True string

API チェックのライフサイクルと相互作用する、またはブラウザ チェックの一環として機能する Node.js コードです。

戻り値

Body
Snippet

ダッシュボードの削除

ダッシュボードを完全に削除します。

パラメーター

名前 キー 必須 説明
ID
dashboardId True string

ダッシュボードの識別子です。

ダッシュボードの更新

ダッシュボードを更新します。 カスタム URL またはカスタム ドメインがすでに使用されている状態でダッシュボードを作成しようとすると、409 が返されます。

パラメーター

名前 キー 必須 説明
ID
dashboardId True string

ダッシュボードの識別子です。

カスタム URL
customUrl string

checklyhq.com の配下のサブドメイン名。 すべてのユーザーで一意である必要があります。

Custom Domain
customDomain string

status.example.com などのカスタム ユーザー ドメイン。 DNS と SSL の使用状況の更新については、ドキュメントを参照してください。

Logo
logo string

画像ファイルを指し示す URL。

ファビコン
favicon string

ダッシュボードのファビコンとして使用される画像ファイルを指す URL。

Link
link string

ダッシュボードのロゴをクリックしたときにリダイレクトする URL リンク。

ヘッダー
header string

ダッシュボードの上部に表示されるテキスト。

説明設定
description string

ダッシュボードのヘッダーやタイトルの下に表示されるテキストです。

Width
width string

画面全体を使用するか、中央にフォーカスするかを決定します。

更新間隔
refreshRate number

ダッシュボードを更新する頻度 (秒単位)。

ページ付け
paginate boolean

ページ区切りのオンかオフかを決定します。

ページ区切りの割合
paginationRate number

ページ区切りをトリガーする頻度 (秒単位)。

ページごとのチェック
checksPerPage number

1 ページに表示されるチェックの数。

And 演算子の使用
useTagsAndOperator boolean

タグの検索に AND 演算子を使用する場合。

タグの非表示
hideTags boolean

ダッシュボードでタグを表示または非表示にします。

ダッシュボード タグ リスト
tags array of string

ダッシュボードに表示するチェックをフィルターする 1 つ以上のタグのリストです。

戻り値

Body
Dashboard

ダッシュボードを作成する

新しいダッシュボードを作成します。 カスタム URL またはカスタム ドメインがすでに使用されている状態でダッシュボードを作成しようとすると、409 が返されます。

パラメーター

名前 キー 必須 説明
カスタム URL
customUrl string

checklyhq.com の配下のサブドメイン名。 すべてのユーザーで一意である必要があります。

Custom Domain
customDomain string

status.example.com などのカスタム ユーザー ドメイン。 DNS と SSL の使用状況の更新については、ドキュメントを参照してください。

Logo
logo string

画像ファイルを指し示す URL。

ファビコン
favicon string

ダッシュボードのファビコンとして使用される画像ファイルを指す URL。

Link
link string

ダッシュボードのロゴをクリックしたときにリダイレクトする URL リンク。

ヘッダー
header string

ダッシュボードの上部に表示されるテキスト。

説明設定
description string

ダッシュボードのヘッダーやタイトルの下に表示されるテキストです。

Width
width string

画面全体を使用するか、中央にフォーカスするかを決定します。

更新間隔
refreshRate number

ダッシュボードを更新する頻度 (秒単位)。

ページ付け
paginate boolean

ページ区切りのオンかオフかを決定します。

ページ区切りの割合
paginationRate number

ページ区切りをトリガーする頻度 (秒単位)。

ページごとのチェック
checksPerPage number

1 ページに表示されるチェックの数。

And 演算子の使用
useTagsAndOperator boolean

タグの検索に AND 演算子を使用する場合。

タグの非表示
hideTags boolean

ダッシュボードでタグを表示または非表示にします。

ダッシュボード タグ リスト
tags array of string

ダッシュボードに表示するチェックをフィルターする 1 つ以上のタグのリストです。

戻り値

Body
Dashboard

チェック グループ トリガーの削除

チェック グループ トリガーを削除します。

パラメーター

名前 キー 必須 説明
Group ID
groupId True integer

グループの識別子。

チェック グループ トリガーの取得

チェック グループ トリガーを検索します。

パラメーター

名前 キー 必須 説明
Group ID
groupId True integer

グループの識別子。

戻り値

チェック グループ トリガーを作成する

チェック グループ トリガーを作成します。

パラメーター

名前 キー 必須 説明
Group ID
groupId True integer

グループの識別子。

戻り値

チェック グループの作成

新しいチェック グループを作成します。 個々のチェックの groupId プロパティを設定することで、グループにチェックを追加することができます。

パラメーター

名前 キー 必須 説明
アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name True string

チェック グループの名前。

アクティブ化済み
activated boolean

グループ内のチェックが実行中か否かを判定します。

ミュート
muted boolean

このグループ内のチェックが失敗または回復した際に、何らかの通知を送信するかどうかを決定します。

チェック グループ タグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

チェック グループ ロケーション リスト
locations array of string

チェックを実行する 1 つまたは複数のデータ センターの場所の配列。

同時実行
concurrency number

CI/CD または API からチェック グループをトリガーするときに、同時に呼び出されるチェックの数を決定します。

[URL]
url string

すべてのグループ チェックで {{GROUP_BASE_URL}} 変数で参照できる、このグループのベース URL。

Key
key True string

キー。

価値
value True string

値。

Locked
locked boolean

ロックされているかどうか。

Source
source string

ソース。

Property
property string

プロパティ。

比較
comparison string

比較。

Target
target string

ターゲット。

Username
username True string

ユーザー名。

Password
password True string

パスワード。

グループ ブラウザのチェックの既定値の確認
browserCheckDefaults object

グループ ブラウザのチェックの既定値を確認します。

ランタイム ID
runtimeId string

このグループのチェックを実行するために使用する実行時バージョン、つまり固定された実行時依存性のセットです。

Key
key True string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

ダブル検査
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェック グループで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

アラートチャネル ID
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

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

Body
CheckGroup

チェック グループの削除

チェック グループを完全に削除します。 まだチェックが含まれている場合、チェック グループを削除することはできません。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

チェック グループの取得

特定のチェックグループの詳細を表示します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

戻り値

Body
CheckGroup

チェック グループの更新

チェック グループを更新します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name string

チェック グループの名前。

アクティブ化済み
activated boolean

グループ内のチェックが実行中か否かを判定します。

ミュート
muted boolean

このグループ内のチェックが失敗または回復した際に、何らかの通知を送信するかどうかを決定します。

チェック グループ タグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

チェック グループ ロケーション リスト
locations array of string

チェックを実行する 1 つまたは複数のデータ センターの場所の配列。

同時実行
concurrency number

CI/CD または API からチェック グループをトリガーするときに、同時に呼び出されるチェックの数を決定します。

[URL]
url string

すべてのグループ チェックで {{GROUP_BASE_URL}} 変数で参照できる、このグループのベース URL。

Key
key True string

キー。

価値
value True string

値。

Locked
locked boolean

ロックされているかどうか。

Source
source string

ソース。

Property
property string

プロパティ。

比較
comparison string

比較。

Target
target string

ターゲット。

Username
username True string

ユーザー名。

Password
password True string

パスワード。

グループ ブラウザのチェックの既定値の確認
browserCheckDefaults object

グループ ブラウザのチェックの既定値を確認します。

ランタイム ID
runtimeId string

このグループのチェックを実行するために使用する実行時バージョン、つまり固定された実行時依存性のセットです。

Key
key True string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

ダブル検査
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェック グループで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

アラートチャネル ID
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

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

Body
CheckGroup

チェック トリガーの作成

チェック トリガーを作成します。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

戻り値

チェック トリガーの削除

チェック トリガーを削除します。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

チェック トリガーの取得

チェック トリガーを検索します。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

戻り値

チェックおよびチェック グループの集計を含むレポートを作成する

指定された期間内のすべてのチェックまたはフィルターされたチェックの集合の統計情報を集約したレポートを作成します。

パラメーター

名前 キー 必須 説明
送信者
from date

Unix タイムスタンプ形式でのレポートウィンドウのカスタム開始時刻です。 タイムスタンプからカスタムを設定すると、presetWindow の使用が上書きされます。

受信先
to date

Unix タイムスタンプ形式でのレポートウィンドウのカスタム終了時刻です。 タイムスタンプからカスタムを設定すると、presetWindow の使用が上書きされます。

プリセット ウィンドウ
presetWindow string

プリセット レポート ウィンドウは、よく使用されるウィンドウに関するレポートをすばやく生成するために使用されます。 カスタムの to と from タイムスタンプを使用して上書きできます。

タグでフィルター
filterByTags array

タグを使用して、レポートに表示するチェックをフィルターします。

非アクティブ
deactivated boolean

アクティブ化された状態でチェックをフィルターします。

戻り値

アイテム
ReportingList

チェックの削除

API またはブラウザー チェックと、それに関連するすべてのステータス データと結果データを完全に削除します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

チェックの取得

特定の API またはブラウザー チェックの詳細を表示します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

戻り値

Body
Check

チェックの更新 [非推奨]

[非推奨] このエンドポイントは 2022 年 7 月 4 日月曜日に削除される予定です。代わりに PUT /checks/api/{id} または PUT /checks/browser/{id} を使用してください。 新しい API やブラウザーのチェックを更新します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name string

チェックの名前です。

アクティブ化済み
activated boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations array of string

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

アラートチャネル ID
alertChannelId True number

アラート チャネルの識別子です。

アクティブ化済み
activated True boolean

アクティブかどうか。

チェックのタイプ
checkType string

チェックの種類。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

オフセットの頻度
frequencyOffset integer

1分未満のチェック頻度 (APIチェックのみ) の秒数を設定し、1 分を超える頻度の時間範囲にわたってチェックを分散するために使用されます。 これは次のように動作します: 頻度が 0 のチェックは、frequencyOffset を 10、20、30 に設定することができ、これは 10、20、30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、Math.floor (頻度 * 10) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、5 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 50 です。 頻度が 60 以上のチェックでは、Math.ceil (頻度 / 60) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、720 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 12 です。

チェックの要求
request True object

チェックの要求。

スクリプト
script True string

スクリプト:

Key
key True string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

スニペット ID を設定
setupSnippetId number

API チェックの設定フェーズで使用するスニペットへの識別子の参照。

ティアダウン スニペット ID
tearDownSnippetId number

API チェックのティアダウン フェーズで使用するスニペットへの識別子の参照。

ローカル セットアップ スクリプト
localSetupScript string

API チェックの設定フェーズで使用するスニペットへの識別子リファレンス。

ローカル ティアダウン スクリプト
localTearDownScript string

API チェックのティアダウン フェーズで使用するスニペットへの識別子リファレンス。

応答時間速度の低下
degradedResponseTime number

チェックが劣化したとみなされる応答時間をミリ秒単位で指定します。

最大応答時間
maxResponseTime number

チェックが失敗したとみなされる応答時間をミリ秒単位で指定します。

非公開のロケーション
privateLocations array of string

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

Body
Check

チェックを作成する [非推奨]

[非推奨] このエンドポイントは 2022 年 7 月 4 日月曜日に削除される予定です。代わりに POST /checks/api または POST /checks/browser を使用してください。 新規 API またはブラウザのチェックを作成します。 プランの上限を超えると 402 を返します。 globalAlertSettings を使用する場合、alertSettingsnull にすることができます

パラメーター

名前 キー 必須 説明
アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name True string

チェックの名前です。

アクティブ化済み
activated True boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations array of string

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

アラートチャネル ID
alertChannelId True number

アラート チャネルの識別子です。

アクティブ化済み
activated True boolean

アクティブかどうか。

チェックのタイプ
checkType True string

チェックの種類。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

オフセットの頻度
frequencyOffset integer

1分未満のチェック頻度 (APIチェックのみ) の秒数を設定し、1 分を超える頻度の時間範囲にわたってチェックを分散するために使用されます。 これは次のように動作します: 頻度が 0 のチェックは、frequencyOffset を 10、20、30 に設定することができ、これは 10、20、30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、Math.floor (頻度 * 10) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、5 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 50 です。 頻度が 60 以上のチェックでは、Math.ceil (頻度 / 60) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、720 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 12 です。

チェックの要求
request object

チェックの要求。

スクリプト
script True string

スクリプト:

Key
key True string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

スニペット ID を設定
setupSnippetId number

API チェックの設定フェーズで使用するスニペットへの識別子の参照。

ティアダウン スニペット ID
tearDownSnippetId number

API チェックのティアダウン フェーズで使用するスニペットへの識別子の参照。

ローカル セットアップ スクリプト
localSetupScript string

API チェックの設定フェーズで使用するスニペットへの識別子リファレンス。

ローカル ティアダウン スクリプト
localTearDownScript string

API チェックのティアダウン フェーズで使用するスニペットへの識別子リファレンス。

応答時間速度の低下
degradedResponseTime number

チェックが劣化したとみなされる応答時間をミリ秒単位で指定します。

最大応答時間
maxResponseTime number

チェックが失敗したとみなされる応答時間をミリ秒単位で指定します。

非公開のロケーション
privateLocations array of string

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

Body
Check

チェック状態の詳細を取得する

特定のチェックの現在の状態の情報を表示します。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

戻り値

チェック結果の取得

特定のチェック結果の詳細を表示します。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

チェック結果 ID
checkResultId True string

転送結果の識別子です。

戻り値

ブラウザーのチェックを作成する

新規ブラウザーのチェックを作成します。 プランの上限を超えると 402 を返します。 globalAlertSetting を使用する場合、alertSettingnull にすることができます

パラメーター

名前 キー 必須 説明
アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name True string

チェックの名前です。

アクティブ化済み
activated True boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations array of string

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

アラートチャネル ID
alertChannelId True number

アラート チャネルの識別子です。

アクティブ化済み
activated True boolean

アクティブかどうか。

Key
key True string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

スクリプト
script True string

Puppeteer または Playwright フレームワークとブラウザとのやりとりを記述した、有効な Node.js の javascript コードの一部です。

非公開のロケーション
privateLocations array of string

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

ブラウザーのチェックを更新する

ブラウザーのチェックを更新します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

アラートの自動割り当て
autoAssignAlerts boolean

新しいチェックが作成されたときに、既存のすべてのアラートチャネルの購読者として自動的に追加されるかどうかを決定します。

件名
name string

チェックの名前です。

アクティブ化済み
activated boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations array of string

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags array of string

チェックを整理し、フィルターするためのタグです。

エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

アラートチャネル ID
alertChannelId True number

アラート チャネルの識別子です。

アクティブ化済み
activated True boolean

アクティブかどうか。

Key
key True string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

スクリプト
script string

Puppeteer または Playwright フレームワークとブラウザとのやりとりを記述した、有効な Node.js の javascript コードの一部です。

非公開のロケーション
privateLocations array of string

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

戻り値

プライベート ロケーションの新しい API キーを生成する

プライベート ロケーションに API キーを作成します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

戻り値

プライベートな場所を削除する

非公開のロケーションを完全に削除します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

メンテナンス期間の作成

アイン期メンテナンス期間を作成します。

パラメーター

名前 キー 必須 説明
件名
name True string

メンテナンス期間の名称。

メンテナンス期間の設定のタグ リスト
tags array of string

チェックとグループのメンテナンス期間の名前が適用されます。

開始日
startsAt True date

メンテナンス期間の開始日です。

終了日
endsAt True date

メンテナンス期間の終了日です。

繰り返しの間隔
repeatInterval number

最初の発生からのメンテナンス期間の繰り返し間隔です。

繰り返しの単位
repeatUnit True string

メンテナンス期間の繰り返し戦略です。

繰り返しの終了日
repeatEndsAt date

メンテナンス期間の繰り返しを停止する終了日です。

戻り値

メンテナンス期間の削除

メンテナンス期間を完全に削除します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

メンテナンス期間の取得

特定のメンテナンス期間の詳細を表示します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

戻り値

メンテナンス期間の更新

メンテナンス期間を更新します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

件名
name True string

メンテナンス期間の名称。

メンテナンス期間の設定のタグ リスト
tags array of string

チェックとグループのメンテナンス期間の名前が適用されます。

開始日
startsAt True date

メンテナンス期間の開始日です。

終了日
endsAt True date

メンテナンス期間の終了日です。

繰り返しの間隔
repeatInterval number

最初の発生からのメンテナンス期間の繰り返し間隔です。

繰り返しの単位
repeatUnit True string

メンテナンス期間の繰り返し戦略です。

繰り返しの終了日
repeatEndsAt date

メンテナンス期間の繰り返しを停止する終了日です。

戻り値

対応するすべてのランタイムを一覧表示

サポートされているすべてのランタイムと、ブラウザー チェック用の含まれる NPM パッケージ、API チェック用のセットアップとティアダウン スクリプトを一覧表示します。

戻り値

アイテム
RuntimeList

対応するすべてのロケーションを一覧表示

対応するすべてのロケーションを一覧表示します。

戻り値

アイテム
LocationList

時間枠からプライベート ロケーションの正常性指標を取得する

時間枠からプライベート ロケーションの正常性指標を取得します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

送信者
from True date

この UNIX のタイム スタンプで始まるメトリックを選択します。 15 日以内である必要があります。

受信先
to True date

この UNIX タイムスタンプまでのメトリックを選択します。

戻り値

特定のグループに属する、グループ設定が適用されたすべてのチェックを取得する

特定のチェックグループ内のすべてのチェックを、グループ設定を適用した状態で一覧表示します。

パラメーター

名前 キー 必須 説明
ID
id True integer

識別子。

Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

戻り値

アイテム
Model8

特定のチェックに対するアラートを一覧表示

特定のチェックに関するすべてのアラートを一覧表示します。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

Limit
limit integer

検索結果の件数を制限します。

回数
page number

ページ番号。

送信者
from date

この UNIX タイムスタンプ (>= 日付) 以降のドキュメントを選択します。 既定は現在から - 6時間です。

受信先
to date

この UNIX タイムスタンプ (<日付) までのアラートを選択します。 既定は開始から 6 時間後です。

戻り値

アイテム
CheckAlertList

状態のバッジをチェックを取得する

状態のバッジをチェックを取得します。

パラメーター

名前 キー 必須 説明
チェック ID
checkId True string

チェックの識別子です。

スタイル
style string

フォント スタイル。

Theme
theme string

テーマ。

応答時間
responseTime boolean

応答時間です。

戻り値

返答
string

環境変数の作成

新しい環境変数を作成します。

パラメーター

名前 キー 必須 説明
Key
key True string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

戻り値

環境変数の削除

環境変数から完全に削除します。 キー フィールドを削除の識別子として使用します。

パラメーター

名前 キー 必須 説明
Key
key True string

キー。

環境変数の取得

特定の環境変数の詳細を表示します。 キー フィールドを使用して選択します。

パラメーター

名前 キー 必須 説明
Key
key True string

キー。

戻り値

環境変数の更新

環境変数を更新します。 キー フィールドを更新の識別子として使用します。 値とロックされたプロパティのみを更新します。

パラメーター

名前 キー 必須 説明
Key
key True string

キー。

Key
key string

環境変数のキー (この値は変更できません)。

価値
value True string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

戻り値

非公開のロケーションの取得

特定の非公開のロケーションの詳細を表示します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

戻り値

非公開のロケーションの既存の API キーを削除する

api キーを非公開のロケーションから完全に削除します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

キー ID
keyId True string

キー識別子。

非公開ロケーションの更新

非公開ロケーションを更新します。

パラメーター

名前 キー 必須 説明
ID
id True string

識別子。

件名
name True string

非公開ロケーションに割り当てられている名前です。

Icon
icon string

アイコン。

戻り値

非公開ロケーションを作成する

新しいプ非公開ロケーションを作成します。

パラメーター

名前 キー 必須 説明
件名
name True string

非公開ロケーションに割り当てられている名前です。

スラッグ名
slugName True string

有効なスラッグ名です。

Icon
icon string

アイコン。

戻り値

定義

AlertChannelConfig

アラート チャネルの構成

名前 パス 説明
アラート チャネル構成
object

アラート チャネルの構成

AlertChanelSubscription

名前 パス 説明
ID
id number

識別子。

チェック ID
checkId guid

チェックの識別子です。

Group ID
groupId number

グループの識別子。

アクティブ化済み
activated boolean

アクティブかどうか。

AlertChanelSubscriptionList

すべてのチェックは、このチャンネルに登録されています。

名前 パス 説明
アイテム
AlertChanelSubscription

AlertChannel

名前 パス 説明
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

更新時刻。

AlertChannelList

名前 パス 説明
アイテム
AlertChannel

CheckAlert

名前 パス 説明
ID
id string

このアラートの一意識別子です。

件名
name string

チェックの名前です。

チェック ID
checkId string

このアラートが属するチェックの識別子です。

通知の種類
alertType string

アラートのタイプです。

検査のタイプ
checkType string

チェックの種類。

実行ロケーション
runLocation string

このチェックアラートがどのデータ センターで発生したかを表わします。

応答時間
responseTime number

このチェックの関連部分の実行にかかった時間を示します。 Checkly のバックエンドでこのチェックの実行を開始するために必要なセットアップ タイマー システムの時間は、これには含まれません。

Error
error string

アラートをトリガーとなった失敗したチェックの一部である特定のエラーメッセージ。

状態コード
statusCode string

応答の状態コード。 API チェックにのみ適用されます。

作成日
created_at date

このチェック アラートが作成された日付と時間です。

開始した
startedAt date

このチェック アラートが開始した日付と時間です。

CheckAlertList

名前 パス 説明
アイテム
CheckAlert

CheckGroupTagList

チェックを整理し、フィルターするためのタグです。

名前 パス 説明
アイテム
string

CheckGroupLocationList

チェックを実行する 1 つまたは複数のデータ センターの場所の配列。

名前 パス 説明
アイテム
string

KeyValue

名前 パス 説明
Key
key string

キー。

価値
value string

値。

Locked
locked boolean

ロックされているかどうか。

HeaderList

名前 パス 説明
アイテム
KeyValue

QueryParameterList

名前 パス 説明
アイテム
KeyValue

アサーション

名前 パス 説明
Source
source string

ソース。

Property
property string

プロパティ。

比較
comparison string

比較。

Target
target string

ターゲット。

AssertionList

プロパティフィールドで使用できる正規表現や JSON パス記述子などの具体的な値については、アサーションに関する Checkly のメイン ドキュメントをご確認ください。

名前 パス 説明
アイテム
Assertion

BasicAuth

名前 パス 説明
Username
username string

ユーザー名。

Password
password string

パスワード。

CheckGroupAPICheckDefaults

名前 パス 説明
[URL]
url string

すべてのグループ チェックで {{GROUP_BASE_URL}} 変数で参照できる、このグループのベース URL。

headers
headers HeaderList
queryParameters
queryParameters QueryParameterList
アサーション リスト
assertions AssertionList

プロパティフィールドで使用できる正規表現や JSON パス記述子などの具体的な値については、アサーションに関する Checkly のメイン ドキュメントをご確認ください。

basicAuth
basicAuth BasicAuth

CheckGroupBrowserCheckDefaults

チェック グループ ブラウザのチェックの既定値

名前 パス 説明
チェック グループ ブラウザのチェックの既定値
object

チェック グループ ブラウザのチェックの既定値

EnvironmentVariable

名前 パス 説明
Key
key string

環境変数のキー (この値は変更できません)。

価値
value string

環境変数の値。

Locked
locked boolean

UI でのみ使用し、パスワードのように値を非表示にします。

EnvironmentVariableList

名前 パス 説明
アイテム
EnvironmentVariable

AlertSettingsRunBasedEscalation

名前 パス 説明
失敗した実行のしきい値
failedRunThreshold number

チェックの連続した失敗が何回発生した際に、アラート通知を送信するか。

AlertSettingsTimeBasedEscalation

名前 パス 説明
分フェールセーフのしきい値
minutesFailingThreshold number

チェックが失敗し始めてから何分後にアラートが送信されるかを設定します。

AlertSettingsReminders

名前 パス 説明
Amount
amount number

最初のアラート通知後に送信するリマインダーの数。

Interval
interval number

リマインダーを送信する間隔を設定します。

AlertSettingsSSLCertificates

[非推奨] sslCertificates は廃止され、現在使用されていません。 将来のバージョンで削除されるため、使用しないでください。

名前 パス 説明
有効化
enabled boolean

SSL 証明書の有効期限が切れた場合に、アラート通知を送信するかどうかを設定します。

アラートのしきい値
alertThreshold integer

どのタイミングで SSL 証明書に関するアラートを開始するか。

CheckGroupAlertSettings

通知の設定。

名前 パス 説明
エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
reminders
reminders AlertSettingsReminders
アラートの設定 SSL 証明書
sslCertificates AlertSettingsSSLCertificates

[非推奨] sslCertificates は廃止され、現在使用されていません。 将来のバージョンで削除されるため、使用しないでください。

Model1

アラート チャネル サブスクリプション。

名前 パス 説明
アラートチャネル ID
alertChannelId number

アラート チャネルの識別子です。

アクティブ化済み
activated boolean

アクティブかどうか。

AlertChannelSubscriptionCreateList

アラート チャネル サブスクリプションのリスト。

名前 パス 説明
アラート チャネル サブスクリプション
Model1

アラート チャネル サブスクリプション。

privateLocations

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

名前 パス 説明
アイテム
string

CheckGroup

名前 パス 説明
ID
id number

識別子。

件名
name string

チェック グループの名前。

アクティブ化済み
activated boolean

グループ内のチェックが実行中か否かを判定します。

ミュート
muted boolean

このグループ内のチェックが失敗または回復した際に、何らかの通知を送信するかどうかを決定します。

チェック グループ タグ リスト
tags CheckGroupTagList

チェックを整理し、フィルターするためのタグです。

チェック グループ ロケーション リスト
locations CheckGroupLocationList

チェックを実行する 1 つまたは複数のデータ センターの場所の配列。

同時実行
concurrency number

CI/CD または API からチェック グループをトリガーするときに、同時に呼び出されるチェックの数を決定します。

apiCheckDefaults
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 のコードです。

ランタイム ID
runtimeId string

このグループのチェックを実行するために使用する実行時バージョン、つまり固定された実行時依存性のセットです。

非公開のロケーション
privateLocations privateLocations

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

作成日
created_at date

作成日時。

更新日
updated_at date-time

更新時刻。

CheckGroupList

名前 パス 説明
アイテム
CheckGroup

CheckLocationList

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

名前 パス 説明
アイテム
string

CheckTagList

チェックを整理し、フィルターするためのタグです。

名前 パス 説明
アイテム
string

CheckAlertSettings

通知の設定。

名前 パス 説明
エスカレーションの種類
escalationType string

使用するエスカレーションのタイプを決定します。

runBasedEscalation
runBasedEscalation AlertSettingsRunBasedEscalation
timeBasedEscalation
timeBasedEscalation AlertSettingsTimeBasedEscalation
reminders
reminders AlertSettingsReminders
アラートの設定 SSL 証明書
sslCertificates AlertSettingsSSLCertificates

[非推奨] sslCertificates は廃止され、現在使用されていません。 将来のバージョンで削除されるため、使用しないでください。

CheckAlertChannelSubscription

名前 パス 説明
アラートチャネル ID
alertChannelId number

アラート チャネルの識別子です。

アクティブ化済み
activated boolean

アクティブかどうか。

CheckAlertChannelSubscriptionList

名前 パス 説明
アイテム
CheckAlertChannelSubscription

CheckRequest

チェックの要求。

名前 パス 説明
チェックの要求
object

チェックの要求。

CheckEnvironmentVariableList

チェック実行時に環境変数を設定するキーと値のペアです。 これらはブラウザー チェックにのみ関連します。 可能な限り、グローバル環境変数を使用します。

名前 パス 説明
アイテム
EnvironmentVariable

CheckAlertEmail

名前 パス 説明
番地
address string

住所。

CheckAlertEmailList

名前 パス 説明
アイテム
CheckAlertEmail

Model4

名前 パス 説明
アイテム
KeyValue

Model5

名前 パス 説明
アイテム
KeyValue

CheckAlertWebhook

名前 パス 説明
件名
name string

名前。

[URL]
url string

URL アドレス。

メソッド
method string

方法。

headers
headers Model4
queryParameters
queryParameters Model5

CheckAlertWebhookList

名前 パス 説明
アイテム
CheckAlertWebhook

CheckAlertSlack

名前 パス 説明
[URL]
url string

URL アドレス。

CheckAlertSlackList

名前 パス 説明
アイテム
CheckAlertSlack

CheckAlertSMS

名前 パス 説明
回数
number string

番号。

件名
name string

名前。

CheckAlertSMSList

名前 パス 説明
アイテム
CheckAlertSMS

CheckAlertChannels

名前 パス 説明
メールアドレス
email CheckAlertEmailList
Webhook
webhook CheckAlertWebhookList
Slack
slack CheckAlertSlackList
sms
sms CheckAlertSMSList

CheckGroupCheck

名前 パス 説明
ID
id string

識別子。

件名
name string

チェックの名前です。

アクティブ化済み
activated boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations CheckLocationList

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags CheckTagList

チェックを整理し、フィルターするためのタグです。

アラート設定のチェック
alertSettings CheckAlertSettings

通知の設定。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
チェックのタイプ
checkType string

チェックの種類。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

オフセットの頻度
frequencyOffset integer

頻度のオフセット。

チェックの要求
request CheckRequest

チェックの要求。

スクリプト
script string

スクリプト:

環境変数を一覧をチェック
environmentVariables CheckEnvironmentVariableList

チェック実行時に環境変数を設定するキーと値のペアです。 これらはブラウザー チェックにのみ関連します。 可能な限り、グローバル環境変数を使用します。

スニペット ID を設定
setupSnippetId number

API チェックの設定フェーズで使用するスニペットへの識別子の参照。

ティアダウン スニペット ID
tearDownSnippetId number

API チェックのティアダウン フェーズで使用するスニペットへの識別子の参照。

ローカル セットアップ スクリプト
localSetupScript string

API チェックの設定フェーズで使用するスニペットへの識別子リファレンス。

ローカル ティアダウン スクリプト
localTearDownScript string

API チェックのティアダウン フェーズで使用するスニペットへの識別子リファレンス。

応答時間速度の低下
degradedResponseTime number

チェックが劣化したとみなされる応答時間をミリ秒単位で指定します。

最大応答時間
maxResponseTime number

チェックが失敗したとみなされる応答時間をミリ秒単位で指定します。

alertChannels
alertChannels CheckAlertChannels
非公開のロケーション
privateLocations privateLocations

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

作成日
created_at date

作成日時。

更新日
updated_at date-time

更新時刻。

Model8

名前 パス 説明
アイテム
CheckGroupCheck

アサーション

API チェックインのアサーション一覧。

名前 パス 説明
アイテム
string

headers

ヘッダー。

名前 パス 説明
ヘッダー
object

ヘッダー。

params

パラメーター。

名前 パス 説明
パラメーター
object

パラメーター。

request

API へのリクエストです。

名前 パス 説明
方法
method string
url
url string
データ
data string
ヘッダー
headers headers

ヘッダー。

パラメーター
params params

パラメーター。

タイミング

タイミング。

名前 パス 説明
タイミング
object

タイミング。

timingPhases

タイミング フェーズ。

名前 パス 説明
タイミング フェーズ
object

タイミング フェーズ。

返答

API 応答。

名前 パス 説明
ステータス
status number

状態。

状態テキスト
statusText string

状態のテキスト。

Body
body string

ボディ。

ヘッダー
headers headers

ヘッダー。

タイミング
timings timings

タイミング。

タイミング フェーズ
timingPhases timingPhases

タイミング フェーズ。

jobLog

ジョブのログ。

名前 パス 説明
ジョブ ログ
object

ジョブのログ。

jobAssets

チェックの実行で生成されたアセット。

名前 パス 説明
アイテム
string

CheckResultAPI

API チェックの応答データ。

名前 パス 説明
アサーション
assertions assertions

API チェックインのアサーション一覧。

Request
request request

API へのリクエストです。

回答
response response

API 応答。

要求エラー
requestError string

リクエストでエラーが発生したかどうかを記述します。

ジョブ ログ
jobLog jobLog

ジョブのログ。

ジョブ資産
jobAssets jobAssets

チェックの実行で生成されたアセット。

errors

チェック実行時のエラーのリスト。

名前 パス 説明
アイテム
string

Model9

実行ログの結果を確認します。

名前 パス 説明
アイテム
string

traceSummary

トレースの概要です。

名前 パス 説明
トレースの概要
object

トレースの概要です。

pages

チェックの実行で使用したページの一覧です。

名前 パス 説明
アイテム
string

CheckResultBrowser

ブラウザー チェックの応答データ。

名前 パス 説明
タイプ
type string

チェックで使用しているフレームワークのタイプ。

エラー
errors errors

チェック実行時のエラーのリスト。

End Time
endTime number

チェック実行の終了時間

Start Time
startTime number

チェック実行の開始時間。

ランタイム バージョン
runtimeVersion string

ランタイム バージョンの有効化。

実行ログの確認
jobLog Model9

実行ログの結果を確認します。

ジョブ資産
jobAssets jobAssets

チェックの実行で生成されたアセット。

トレースの概要
traceSummary traceSummary

トレースの概要です。

Pages
pages pages

チェックの実行で使用したページの一覧です。

CheckResult

名前 パス 説明
ID
id string

この結果の一意識別子。

件名
name string

チェックの名前です。

チェック ID
checkId string

チェックの識別子。

失敗がある
hasFailures boolean

このチェック実行中にエラーが発生したかどうかを示します。 これは、API やブラウザーのチェック動作を評価する際に、最も重視すべき点です。 失敗したアサーション、タイムアウト、失敗したスクリプトはすべてこの値が true になるように解決されます。

エラーあり
hasErrors boolean

Checkly のバックエンドで内部エラーが発生したかどうかを示します。 これは、ほとんどすべての場合で false となるはずです。

非推奨である
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

ブラウザー チェックの応答データ。

チェックの実行 ID
checkRunId number

この検査結果を作成した特定のチェック実行の識別子です。

試行回数
attempts number

このチェックが何回再試行されたかを示します。 ダブル チェックが有効な場合、これは 0 よりも大きくなります。

CheckResultList

名前 パス 説明
アイテム
CheckResult

CheckStatus

名前 パス 説明
件名
name string

チェックの名前です。

チェック ID
checkId string

この状態が属するチェックの識別子です。

失敗がある
hasFailures boolean

このチェックが現在失敗しているかどうかを示します。 API チェックのアサーションに失敗した場合、この値は true になります。 何らかの理由でブラウザーのチェックに失敗した場合、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

更新時刻。

CheckStatusList

名前 パス 説明
アイテム
CheckStatus

オン

名前 パス 説明
ID
id string

識別子。

件名
name string

チェックの名前です。

アクティブ化済み
activated boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations CheckLocationList

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags CheckTagList

チェックを整理し、フィルターするためのタグです。

アラート設定のチェック
alertSettings CheckAlertSettings

通知の設定。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
チェックのタイプ
checkType string

チェックの種類。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

オフセットの頻度
frequencyOffset integer

頻度のオフセット。

チェックの要求
request CheckRequest

チェックの要求。

スクリプト
script string

スクリプト:

環境変数を一覧をチェック
environmentVariables CheckEnvironmentVariableList

チェック実行時に環境変数を設定するキーと値のペアです。 これらはブラウザー チェックにのみ関連します。 可能な限り、グローバル環境変数を使用します。

スニペット ID を設定
setupSnippetId number

API チェックの設定フェーズで使用するスニペットへの識別子の参照。

ティアダウン スニペット ID
tearDownSnippetId number

API チェックのティアダウン フェーズで使用するスニペットへの識別子の参照。

ローカル セットアップ スクリプト
localSetupScript string

API チェックの設定フェーズで使用するスニペットへの識別子リファレンス。

ローカル ティアダウン スクリプト
localTearDownScript string

API チェックのティアダウン フェーズで使用するスニペットへの識別子リファレンス。

応答時間速度の低下
degradedResponseTime number

チェックが劣化したとみなされる応答時間をミリ秒単位で指定します。

最大応答時間
maxResponseTime number

チェックが失敗したとみなされる応答時間をミリ秒単位で指定します。

alertChannels
alertChannels CheckAlertChannels
非公開のロケーション
privateLocations privateLocations

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

作成日
created_at date

作成日時。

更新日
updated_at date-time

更新時刻。

CheckList

名前 パス 説明
アイテム
Check

Model14

名前 パス 説明
アイテム
KeyValue

Model15

名前 パス 説明
アイテム
KeyValue

Model16

チェックが実行されるリクエストを決定します。

名前 パス 説明
方法
method string
[URL]
url string

URL アドレス。

リダイレクトへの追従
followRedirects boolean

リダイレクトに追従するかどうか。

SSL のスキップ
skipSSL boolean

SSL をスキップするかどうか。

Body
body string

ボディ。

ボディ タイプ
bodyType string

ボディのタイプです。

headers
headers Model14
queryParameters
queryParameters Model15
アサーション リスト
assertions AssertionList

プロパティフィールドで使用できる正規表現や JSON パス記述子などの具体的な値については、アサーションに関する Checkly のメイン ドキュメントをご確認ください。

basicAuth
basicAuth BasicAuth

CheckAPI

名前 パス 説明
ID
id string

識別子。

件名
name string

チェックの名前です。

アクティブ化済み
activated boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations CheckLocationList

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags CheckTagList

チェックを整理し、フィルターするためのタグです。

アラート設定のチェック
alertSettings CheckAlertSettings

通知の設定。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
チェックの要求
request Model16

チェックが実行されるリクエストを決定します。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

オフセットの頻度
frequencyOffset integer

1分未満のチェック頻度 (APIチェックのみ) の秒数を設定し、1 分を超える頻度の時間範囲にわたってチェックを分散するために使用されます。 これは次のように動作します: 頻度が 0 のチェックは、frequencyOffset を 10、20、30 に設定することができ、これは 10、20、30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、Math.floor (頻度 * 10) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、5 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 50 です。 頻度が 60 以上のチェックでは、Math.ceil (頻度 / 60) の式に基づく 1 から最大値の間の frequencyOffset を持つことができます。たとえば、720 分ごとに実行されるチェックの場合、frequencyOffset の最大値は 12 です。

ティアダウン スニペット ID
tearDownSnippetId number

API チェックのティアダウン フェーズで使用するスニペットへの識別子の参照。

スニペット ID を設定
setupSnippetId number

API チェックの設定フェーズで使用するスニペットへの識別子の参照。

ローカル セットアップ スクリプト
localSetupScript string

API チェックの設定フェーズで使用するスニペットへの識別子リファレンス。

ローカル ティアダウン スクリプト
localTearDownScript string

API チェックのティアダウン フェーズで使用するスニペットへの識別子リファレンス。

応答時間速度の低下
degradedResponseTime number

チェックが劣化したとみなされる応答時間をミリ秒単位で指定します。

最大応答時間
maxResponseTime number

チェックが失敗したとみなされる応答時間をミリ秒単位で指定します。

非公開のロケーション
privateLocations privateLocations

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

チェックのタイプ
checkType string

チェックの種類です。

alertChannels
alertChannels CheckAlertChannels
作成日
created_at date

作成日時。

更新日
updated_at date-time

更新時刻。

CheckBrowser

名前 パス 説明
ID
id string

識別子。

件名
name string

チェックの名前です。

アクティブ化済み
activated boolean

チェックが実行されているかどうかを判断します。

ミュート
muted boolean

チェックの失敗や回復時に通知を出すかどうかを設定します。

ダブルチェック
doubleCheck boolean

この値を true に設定すると、チェックに失敗したときに、失敗した地域とランダムに選ばれた別の地域から再試行が行われ、チェックが失敗したとマークされます。

失格の見込み
shouldFail boolean

チェックが失敗とみなされるときの動作を反転できます。 404 などのエラー ステータスを検証できます。

チェックの場所の一覧
locations CheckLocationList

このチェックを実行する 1 つまたは複数のデータ センターの場所の配列。

チェックタグ リスト
tags CheckTagList

チェックを整理し、フィルターするためのタグです。

アラート設定のチェック
alertSettings CheckAlertSettings

通知の設定。

グローバル アラートの設定を使用する
useGlobalAlertSettings boolean

true の場合、このチェックで定義されたアラート設定ではなく、アカウント レベルのアラート設定が使用されます。

Group ID
groupId number

このチェックが属するチェック グループの識別子。

グループの順序
groupOrder number

チェックグループ内でのこのチェックの位置。 API や CI/CD からグループがトリガーされたときに、どのような順序でチェックを実行するかを決定します。

ランタイム ID
runtimeId string

このチェックを実行するために使用される実行時バージョン、つまり固定された実行時依存性のセット。

alertChannelSubscriptions
alertChannelSubscriptions CheckAlertChannelSubscriptionList
チェックのタイプ
checkType string

チェックの種類です。

頻度
frequency integer

チェックを実行する頻度 (分単位)。

スクリプト
script string

Puppeteer または Playwright フレームワークとブラウザとのやりとりを記述した、有効な Node.js の javascript コードの一部です。

非公開のロケーション
privateLocations privateLocations

チェックを実行する 1 つまたは複数の非公開ロケーションの配列。

alertChannels
alertChannels CheckAlertChannels
作成日
created_at date

作成日時。

更新日
updated_at date-time

更新時刻。

DashboardTagList

ダッシュボードに表示するチェックをフィルターする 1 つ以上のタグのリストです。

名前 パス 説明
アイテム
string

ダッシュボード​

名前 パス 説明
Custom Domain
customDomain string

status.example.com などのカスタム ユーザー ドメイン。 DNS と SSL の使用状況の更新については、ドキュメントを参照してください。

カスタム URL
customUrl string

checklyhq.com の配下のサブドメイン名。 すべてのユーザーで一意である必要があります。

Logo
logo string

画像ファイルを指し示す URL。

ファビコン
favicon string

ダッシュボードのファビコンとして使用される画像ファイルを指す URL。

Link
link string

ダッシュボードのロゴをクリックしたときにリダイレクトする URL リンク。

ヘッダー
header string

ダッシュボードの上部に表示されるテキスト。

説明設定
description string

ダッシュボードのヘッダーやタイトルの下に表示されるテキストです。

Width
width string

画面全体を使用するか、中央にフォーカスするかを決定します。

更新間隔
refreshRate number

ダッシュボードを更新する頻度 (秒単位)。

ページ付け
paginate boolean

ページ区切りのオンかオフかを決定します。

ページ区切りの割合
paginationRate number

ページ区切りをトリガーする頻度 (秒単位)。

ページごとのチェック
checksPerPage number

1 ページに表示されるチェックの数。

And 演算子の使用
useTagsAndOperator boolean

タグの検索に AND 演算子を使用する場合。

タグの非表示
hideTags boolean

ダッシュボードでタグを表示または非表示にします。

ダッシュボード タグ リスト
tags DashboardTagList

ダッシュボードに表示するチェックをフィルターする 1 つ以上のタグのリストです。

ダッシュボード ID
dashboardId string

ダッシュボードの識別子です。

DashboardsList

名前 パス 説明
アイテム
Dashboard

場所

名前 パス 説明
Region
region string

このロケーションの一意の識別子

件名
name string

このロケーションのフレンドリ名。

LocationList

名前 パス 説明
アイテム
Location

MaintenanceWindowTagList

チェックとグループのメンテナンス期間の名前が適用されます。

名前 パス 説明
アイテム
string

MaintenanceWindow

名前 パス 説明
ID
id number

メンテナンス期間の識別子です。

件名
name string

メンテナンス期間の名称。

メンテナンス期間の設定のタグ リスト
tags MaintenanceWindowTagList

チェックとグループのメンテナンス期間の名前が適用されます。

開始日
startsAt date

メンテナンス期間の開始日です。

終了日
endsAt date

メンテナンス期間の終了日です。

繰り返しの間隔
repeatInterval number

最初の発生からのメンテナンス期間の繰り返し間隔です。

繰り返しの単位
repeatUnit string

メンテナンス期間の繰り返し戦略です。

繰り返しの終了日
repeatEndsAt date

メンテナンス期間の繰り返しを停止する終了日です。

作成日
created_at date

メンテナンス期間の作成日です。

更新日
updated_at date

メンテナンス期間が最後に更新された日付です。

MaintenanceWindowList

メンテナンス期間のリストです。

名前 パス 説明
アイテム
MaintenanceWindow

CheckAssignment

名前 パス 説明
ID
id guid

識別子。

チェック ID
checkId guid

チェックの識別子。

非公開のロケーション ID
privateLocationId guid

割り当てられた非公開のロケーションの識別子。

checkAssignments

この非公開ロケーションが割り当てたチェックです。

名前 パス 説明
アイテム
CheckAssignment

GroupAssignment

名前 パス 説明
ID
id guid

識別子。

Group ID
groupId number

グループの識別子。

非公開のロケーション ID
privateLocationId guid

割り当てられた非公開のロケーションの識別子。

groupAssignments

この非公開ロケーションが割り当てたグループです。

名前 パス 説明
アイテム
GroupAssignment

privateLocationKeys

名前 パス 説明
ID
id guid

識別子。

生キー
rawKey string

未加工のキーです。

マスキングされたキー
maskedKey string

マスキングされたキーの値です。

作成日
created_at date

作成日時。

更新日
updated_at date

更新時刻。

キー

名前 パス 説明
アイテム
privateLocationKeys

privatelocationschema

名前 パス 説明
ID
id guid

識別子。

件名
name string

非公開ロケーションに割り当てられている名前です。

スラッグ名
slugName string

有効なスラッグ名です。

Icon
icon string

非公開のロケーション アイコンです。

作成日
created_at date

作成日時。

更新日
updated_at date

更新時刻。

割り当てのチェック
checkAssignments checkAssignments

この非公開ロケーションが割り当てたチェックです。

グループの割り当て
groupAssignments groupAssignments

この非公開ロケーションが割り当てたグループです。

キー
keys keys
最後の表示
lastSeen date

最後に確認された日付です。

エージェントのカウント
agentCount number

エージェントのカウントです。

privateLocationsListSchema

名前 パス 説明
アイテム
privatelocationschema

commonPrivateLocationSchemaResponse

名前 パス 説明
ID
id guid

識別子。

件名
name string

非公開ロケーションに割り当てられている名前です。

スラッグ名
slugName string

有効なスラッグ名です。

Icon
icon string

非公開のロケーション アイコンです。

作成日
created_at date

作成日時。

更新日
updated_at date

更新時刻。

割り当てのチェック
checkAssignments checkAssignments

この非公開ロケーションが割り当てたチェックです。

グループの割り当て
groupAssignments groupAssignments

この非公開ロケーションが割り当てたグループです。

キー
keys keys

タイムスタンプ

名前 パス 説明
Timestamp
date-time

タイムスタンプ。

queueSize

キューのサイズです。

名前 パス 説明
アイテム
number

oldestScheduledCheckRun

名前 パス 説明
アイテム
number

privateLocationsMetricsHistoryResponseSchema

名前 パス 説明
タイムスタンプ
timestamps timestamps
キューのサイズ
queueSize queueSize

キューのサイズです。

oldestScheduledCheckRun
oldestScheduledCheckRun oldestScheduledCheckRun

ReportingTagList

タグのチェック。

名前 パス 説明
アイテム
string

ReportingAggregate

名前 パス 説明
成功の割合
successRatio number

選択された日付範囲におけるチェックの成功率です。 パーセンテージは小数形式です。

Average
avg number

選択した日付範囲でのチェックの平均応答時間 (ミリ秒)。

P95
p95 number

選択した日付範囲でのチェックの P95 応答時間 (ミリ秒)。

P99
p99 number

選択した日付範囲でのチェックの P99 応答時間 (ミリ秒)。

レポート中

名前 パス 説明
件名
name string

チェックの名前。

チェック ID
checkId string

チェック の ID です。

チェックのタイプ
checkType string

チェックのタイプです。

非アクティブ
deactivated boolean

非アクティブ化されたチェック。

レポート タグ リスト
tags ReportingTagList

タグのチェック。

aggregate
aggregate ReportingAggregate

ReportingList

名前 パス 説明
アイテム
Reporting

実行時

名前 パス 説明
件名
name string

このランタイムを表す一意の名前です。

段階
stage string

ランタイムの現在のライフ ステージです。

ランタイムの寿命
runtimeEndOfLife string

プラットフォームからランタイムが削除される日付です。

既定
default boolean

Checkly が提供する現在の既定のランタイムであるかどうかを示します。

説明設定
description string

このランタイムの主なアップデートに関する、簡潔な、分かりやすい説明です。

String
dependencies.string string

文字列です。

RuntimeList

名前 パス 説明
アイテム
Runtime

スニペット

名前 パス 説明
ID
id number

識別子。

件名
name string

スニペットの名前です。

スクリプト
script string

API チェックのライフサイクルと相互作用する、またはブラウザ チェックの一環として機能する Node.js コードです。

作成日
created_at date-time

作成日時。

更新日
updated_at date-time

更新時刻。

SnippetList

名前 パス 説明
アイテム
Snippet

CheckGroupTrigger

名前 パス 説明
ID
id number

識別子。

Token
token string

トークンです。

作成日
created_at date

作成日時。

呼び出し先
called_at date

呼び出された日時です。

更新日
updated_at date

更新時刻。

Group ID
groupId number

グループの識別子。

CheckTrigger

名前 パス 説明
ID
id number

識別子。

Token
token string

トークンです。

作成日
created_at date

作成日時。

呼び出し先
called_at date

呼び出された日時です。

更新日
updated_at date

更新時刻。

チェック ID
checkId string

チェックの識別子です。

オブジェクト

’オブジェクト’ 型です。

string

これは基本的なデータ型 '文字列' です。