Checkly (独立した発行元) (プレビュー)

Checkly は、最新のスタックの監視プラットフォームです。プログラミング可能で柔軟で、愛に満ちた JavaScript です。 重要なサイト トランザクションを監視して検証します。 実行するたびに、エラー トレース、スクリーンショット、パフォーマンス メトリックが自動的に収集されます。

このコネクタは、次の製品とリージョンで使用できます。

サービス	クラス	リージョン
コピロット スタジオ	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
ロジック アプリ	Standard	次を除くすべての Logic Apps リージョン :      - Azure Government リージョン      - Azure China リージョン      - 米国国防総省 (DoD)
Power Apps	Premium	次を除くすべての Power Apps リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
Power Automate	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)

お問い合わせ
名前	トロイ・テイラー
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

コネクタ メタデータ
Publisher	トロイ・テイラー
Website	https://www.checklyhq.com/
プライバシー ポリシー	https://www.checklyhq.com/privacy
カテゴリ	IT 運用

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

デフォルト	接続を作成するためのパラメーター。	すべてのリージョン	共有不可

デフォルト

適用対象: すべてのリージョン

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

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

名前	タイプ	Description	必須
アカウント ID	securestring	この API のアカウント ID。	正しい
API キー ('Bearer apiKey' の形式)	securestring	この API の API キー ('Bearer apiKey' の形式)	正しい

調整制限

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

アクション

1 つの特定のランタイムの詳細を表示します	含まれるすべての NPM パッケージの詳細と、1 つの特定のランタイムのバージョンが表示されます。
API チェックを作成する	新しい API チェックを作成します。 プランの制限を超えると、 402 が返されます。 globalAlertSettingを使用する場合、alertSettingはnull
API チェックを更新する	API チェックを更新します。
すべてのアラート チャネルを一覧表示する	構成されているすべてのアラート チャネルとそのサブスクライブ済みチェックを一覧表示します。
すべてのスニペットを一覧表示する	アカウント内のすべての現在のスニペットを一覧表示します。
すべてのダッシュボードを一覧表示する	アカウント内のすべての現在のダッシュボードを一覧表示します。
すべてのチェック グループを一覧表示する	アカウント内の現在のチェック グループをすべて一覧表示します。 checks プロパティは、参照に便利なチェック UUID の配列です。 これは読み取り専用であり、グループにチェックを追加するために使用することはできません。
すべてのチェックを一覧表示する	アカウント内の現在のチェックをすべて一覧表示します。
すべてのチェック状態を一覧表示する	アカウントのすべてのチェックの現在の状態情報を表示します。 チェックステータスレコードは、新しいチェック結果が入ると継続的に更新されます。
すべてのチェック結果を一覧表示します	特定のチェックの完全な未加工のチェック結果を一覧表示します。 生の結果を 30 日間保持します。 30 日後に消去されます。 ただし、ロールアップされた結果は無期限に保持されます。 チェックの種類と結果の種類でフィルター処理して、リストを絞り込むことができます。 日付範囲を指定するには、 to パラメーターと from パラメーターを使用します (UNIX タイムスタンプ (秒単位)。 チェックの種類によっては、一部のフィールドが null になる場合があります。 このエンドポイントは、6 時間以内にデータを返します。 パラメーターとの間でパラメーターが設定されている場合は、最大 6 時間離れている必要があります。何も設定されていない場合は、to param が現在であり、param から 6 時間前であると見なします。 to param のみが設定されている場合は、6 時間前に設定されます。 逆に、from param のみが設定されている場合は、to param を 6 時間後と見なします。 レート制限はこのエンドポイントに適用され、最大で 5 回/10 秒の要求を送信できます。
すべてのブラウザー チェック メトリックに対してカスタマイズ可能なレポートを生成します	特定のブラウザー チェックの集計された統計または集計されていない統計を指定した時間枠でレポートを生成します。
すべてのプライベートな場所を一覧表示する	アカウント内のすべてのプライベートな場所を一覧表示します。
すべてのメンテナンス期間を一覧表示する	アカウント内のすべてのメンテナンス期間を一覧表示します。
すべての環境変数を一覧表示する	アカウント内の現在の環境変数をすべて一覧表示します。
アカウントのすべてのアラートを一覧表示する	アカウントのすべてのアラートを一覧表示します。
アラート チャネルのサブスクリプションを更新する	アラート チャネルのサブスクリプションを更新します。 これを使用してアラート チャネルにチェックを追加し、エラーと回復のアラートがそのチェックに対して送信されるようにします。 注: サブスクリプション オブジェクトを渡すときは、checkId または groupId のみを指定でき、両方を指定することはできません。
アラート チャネルを作成する	新しいアラート チャネルを作成します。
アラート チャネルを削除する	アラート チャネルを完全に削除します。
アラート チャネルを取得する	特定のアラート チャネルの詳細を表示します。
アラート チャネルを更新する	アラート チャネルを更新します。
グループの状態バッジを取得する	グループの状態バッジを取得します。
グループ設定が適用された特定のグループで 1 つのチェックを取得する	グループ設定が適用された特定のチェック グループに 1 つのチェックの詳細を表示します。
グループ設定が適用された特定のグループ内のすべてのチェックを取得する	グループ設定が適用された特定のチェック グループ内のすべてのチェックを一覧表示します。
サポートされているすべてのランタイムを一覧表示します	サポートされているすべてのランタイムと、ブラウザー チェック用の付属の NPM パッケージと、API チェック用のセットアップ スクリプトと破棄スクリプトを一覧表示します。
サポートされているすべての場所を一覧表示します	サポートされているすべての場所を一覧表示します。
スニペットを作成する	新しいスニペットを作成します。
スニペットを削除する	スニペットを完全に削除します。
スニペットを取得する	特定のスニペットの詳細を表示します。
スニペットを更新する	スニペットを更新します。
ダッシュボードの更新	ダッシュボードを更新します。 既に取得されているカスタム URL またはカスタム ドメインを使用してダッシュボードを作成しようとすると、409 が返されます。
ダッシュボードを作成する	新しいダッシュボードを作成します。 既に取得されているカスタム URL またはカスタム ドメインを使用してダッシュボードを作成しようとすると、409 が返されます。
ダッシュボードを削除する	ダッシュボードを完全に削除します。
チェック グループ トリガーを作成する	チェック グループ トリガーを作成します。
チェック グループ トリガーを削除する	チェック グループ トリガーを削除します。
チェック グループ トリガーを取得する	チェック グループ トリガーを検索します。
チェック グループを作成する	新しいチェック グループを作成します。 個々のチェックの groupId プロパティを設定することで、グループにチェックを追加できます。
チェック グループを削除する	チェック グループを完全に削除します。 チェック グループにまだチェックが含まれている場合は、削除できません。
チェック グループを取得する	特定のチェック グループの詳細を表示します。
チェック グループを更新する	チェック グループを更新します。
チェック トリガーを作成する	チェック トリガーを作成します。
チェック トリガーを削除する	チェック トリガーを削除します。
チェック トリガーを取得する	チェック トリガーを検索します。
チェックおよびチェック グループの集計統計を含むレポートを生成します	すべてのチェックに対して集計された統計を含むレポート、または指定された時間枠でフィルター処理されたチェックのセットを含むレポートを生成します。
チェックの作成 [非推奨]	[非推奨]このエンドポイントは、2022 年 7 月 4 日月曜日に削除されます。 代わりに、POST /checks/api または POST /checks/browser を使用します。 新しい API またはブラウザー のチェックを作成します。 プランの制限を超えると、 402 が返されます。 globalAlertSettingsを使用する場合、alertSettingsはnull
チェックを削除する	API またはブラウザーのチェックとそれに関連するすべての状態と結果データを完全に削除します。
チェックを取得する	特定の API またはブラウザー チェックの詳細を表示します。
チェックを更新する [非推奨]	[非推奨]このエンドポイントは、2022 年 7 月 4 日月曜日に削除されます。 代わりに、PUT /checks/api/{id} または PUT /checks/browser/{id} を使用します。 新しい API またはブラウザー のチェックを更新します。
チェック結果を取得する	特定のチェック結果の詳細を表示します。
ブラウザー チェックを作成する	新しいブラウザー チェックを作成します。 プランの制限を超えると、 402 が返されます。 globalAlertSettingを使用する場合、alertSettingはnull
ブラウザーのチェックを更新する	ブラウザーのチェックを更新します。
プライベートな場所の新しい API キーを生成する	プライベートの場所に API キーを作成します。
プライベートな場所の既存の API キーを削除する	プライベートな場所から API キーを完全に削除します。
プライベートな場所を作成する	新しいプライベートの場所を作成します。
プライベートな場所を削除する	プライベートな場所を完全に削除します。
プライベートな場所を取得する	特定のプライベートな場所の詳細を表示します。
プライベートな場所を更新する	プライベートな場所を更新します。
メンテナンス期間を作成する	新しいメンテナンス期間を作成します。
メンテナンス期間を削除する	メンテナンス期間を完全に削除します。
メンテナンス期間を取得する	特定のメンテナンス期間の詳細を表示します。
メンテナンス期間を更新する	メンテナンス期間を更新します。
時間枠からプライベートな場所の正常性メトリックを取得する	時間のウィンドウからプライベートな場所の正常性メトリックを取得します。
特定のチェックのアラートを一覧表示する	特定のチェックのすべてのアラートを一覧表示します。
状態の確認の詳細を取得する	特定のチェックの現在の状態情報を表示します。
状態の確認バッジを取得する	状態の確認バッジを取得します。
環境変数を作成する	新しい環境変数を作成します。
環境変数を削除する	環境変数を完全に削除します。 キー フィールドを削除の識別子として使用します。
環境変数を取得する	特定の環境変数の詳細を表示します。 選択にキー フィールドを使用します。
環境変数を更新する	環境変数を更新します。 キー フィールドを更新の識別子として使用します。 値とロックされたプロパティのみを更新します。

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

操作 ID:

GetV1RuntimesId

含まれるすべての NPM パッケージの詳細と、1 つの特定のランタイムのバージョンが表示されます。

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。

戻り値

Body

Runtime

API チェックを作成する

操作 ID:

PostV1ChecksApi

新しい API チェックを作成します。 プランの制限を超えると、 402 が返されます。 globalAlertSettingを使用する場合、alertSettingはnull

パラメーター

名前	キー	必須	型	説明
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name	True	string	チェックの名前。
Activated	activated	True	boolean	チェックが実行されているかどうかを判断します。
Muted	muted		boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck		boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail		boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations		array of string	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
エスカレーションの種類	escalationType		string	使用するエスカレーションの種類を決定します。
失敗した実行のしきい値	failedRunThreshold		number	失敗した連続チェックの実行回数が経過したら、アラート通知を送信する必要があります。
失敗した分数のしきい値	minutesFailingThreshold		number	確認が失敗し始めてから数分後に、アラートを送信する必要があります。
金額	amount		number	最初のアラート通知の後に送信するアラームの数。
インターバル	interval		number	アラームを送信する間隔。
Enabled	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
グローバル アラート設定を使用する	useGlobalAlertSettings		boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	groupId		number	このチェックの一部であるチェック グループの識別子。
グループの順序	groupOrder		number	チェック グループ内のこのチェックの位置。 これは、API または CI/CD からグループがトリガーされたときに実行される順序チェックを決定します。
ランタイム ID	runtimeId		string	ランタイム バージョン (つまり、このチェックの実行に使用されるランタイム依存関係の固定セット)。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	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		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 のチェックでは、frequencyOffset を 10、20、または 30 にすることができます。これは、10 秒、20 秒、または 30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、数式 Math.floor(frequency * 10) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、5 分ごとに実行されるチェックの場合、最大 frequencyOffset は 50 です。 頻度が 60 より高いチェックでは、数式 Math.ceil(frequency/ 60) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、720 分ごとに実行されるチェックの場合、最大 frequencyOffset は 12 です。
ローカル セットアップ スクリプト	localSetupScript		string	セットアップ フェーズで実行する Node.js コードの有効な部分。
ローカル破棄スクリプト	localTearDownScript		string	破棄フェーズで実行する Node.js コードの有効な部分。
応答時間の低下	degradedResponseTime		number	チェックが低下していると見なされる応答時間 (ミリ秒単位)。
最大応答時間	maxResponseTime		number	チェックが失敗したと見なされる応答時間 (ミリ秒単位)。
プライベートな場所	privateLocations		array of string	チェックを実行する 1 つ以上のプライベートな場所の配列。

戻り値

Body

CheckAPI

API チェックを更新する

操作 ID:

PutV1ChecksApiId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name		string	チェックの名前。
Activated	activated		boolean	チェックが実行されているかどうかを判断します。
Muted	muted		boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck		boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail		boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations		array of string	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
エスカレーションの種類	escalationType		string	使用するエスカレーションの種類を決定します。
失敗した実行のしきい値	failedRunThreshold		number	失敗した連続チェックの実行回数が経過したら、アラート通知を送信する必要があります。
失敗した分数のしきい値	minutesFailingThreshold		number	確認が失敗し始めてから数分後に、アラートを送信する必要があります。
金額	amount		number	最初のアラート通知の後に送信するアラームの数。
インターバル	interval		number	アラームを送信する間隔。
Enabled	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
グローバル アラート設定を使用する	useGlobalAlertSettings		boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	groupId		number	このチェックの一部であるチェック グループの識別子。
グループの順序	groupOrder		number	チェック グループ内のこのチェックの位置。 これは、API または CI/CD からグループがトリガーされたときに実行される順序チェックを決定します。
ランタイム ID	runtimeId		string	ランタイム バージョン (つまり、このチェックの実行に使用されるランタイム依存関係の固定セット)。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	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		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 のチェックでは、frequencyOffset を 10、20、または 30 にすることができます。これは、10 秒、20 秒、または 30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、数式 Math.floor(frequency * 10) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、5 分ごとに実行されるチェックの場合、最大 frequencyOffset は 50 です。 頻度が 60 より高いチェックでは、数式 Math.ceil(frequency/ 60) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、720 分ごとに実行されるチェックの場合、最大 frequencyOffset は 12 です。
ローカル セットアップ スクリプト	localSetupScript		string	セットアップ フェーズで実行する Node.js コードの有効な部分。
ローカル破棄スクリプト	localTearDownScript		string	破棄フェーズで実行する Node.js コードの有効な部分。
応答時間の低下	degradedResponseTime		number	チェックが低下していると見なされる応答時間 (ミリ秒単位)。
最大応答時間	maxResponseTime		number	チェックが失敗したと見なされる応答時間 (ミリ秒単位)。
プライベートな場所	privateLocations		array of string	チェックを実行する 1 つ以上のプライベートな場所の配列。

戻り値

Body

CheckAPI

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

操作 ID:

GetV1Alertchannels

構成されているすべてのアラート チャネルとそのサブスクライブ済みチェックを一覧表示します。

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。

戻り値

アイテム

AlertChannelList

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

操作 ID:

GetV1Snippets

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

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。

戻り値

アイテム

SnippetList

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

操作 ID:

GetV1Dashboards

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

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。

戻り値

アイテム

DashboardsList

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

操作 ID:

GetV1Checkgroups

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

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。

戻り値

アイテム

CheckGroupList

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

操作 ID:

GetV1Checks

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

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。
API Check URL フィルター	apiCheckUrlFilterPattern		string	例えば、www.myapp.comのようなドメインなど、API チェックの URL に含まれる文字列で結果をフィルター処理 します 。 API チェックのみを返します。

戻り値

アイテム

CheckList

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

操作 ID:

GetV1Checkstatuses

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

戻り値

アイテム

CheckStatusList

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

操作 ID:

GetV1CheckresultsCheckid

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

パラメーター

名前	キー	必須	型	説明
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	チェック結果に 1 つ以上のエラーがあります。

戻り値

アイテム

CheckResultList

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

操作 ID:

GetV2ReportingBrowserchecksId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。
より	from		date	Unix タイムスタンプ形式のレポート ウィンドウのカスタム開始時刻。 タイムスタンプからカスタムを設定すると、presetWindow の使用がオーバーライドされます。
移行先	to		date	Unix タイムスタンプ形式のレポート ウィンドウのカスタム終了時刻。 カスタムをタイムスタンプに設定すると、presetWindow の使用がオーバーライドされます。
[プリセット] ウィンドウ	presetWindow		string	既定のレポート ウィンドウは、一般的に使用されるウィンドウでレポートをすばやく生成するために使用されます。 タイムスタンプとの間でカスタムを使用してオーバーライドできます。
集計間隔	aggregationInterval		number	メトリックを分単位で集計するために使用する時間間隔。 たとえば、5 分は 300、24 時間は 1440 です。
グループ化	groupBy		string	系列データのグループ化方法を決定します。
状態でフィルター処理	filterByStatus		array	状態を使用して、失敗または成功したチェック結果データのチェックをフィルター処理します。
Metrics	metrics		array	ブラウザー チェックのメトリック オプション。

戻り値

属性。

Attributes

object

すべてのプライベートな場所を一覧表示する

操作 ID:

GetV1Privatelocations

アカウント内のすべてのプライベートな場所を一覧表示します。

戻り値

アイテム

privateLocationsListSchema

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

操作 ID:

GetV1Maintenancewindows

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

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。

戻り値

メンテナンス期間の一覧。

アイテム

MaintenanceWindowList

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

操作 ID:

GetV1Variables

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

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。

戻り値

アイテム

EnvironmentVariableList

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

操作 ID:

GetV1Checkalerts

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

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。
より	from		date	この UNIX タイムスタンプ (> = 日付) からドキュメントを選択します。 既定値は現在 - 6 時間です。
移行先	to		date	この UNIX タイムスタンプ (< 日付) までのアラートを選択します。 既定値は 6 時間後です。

戻り値

アイテム

CheckAlertList

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

操作 ID:

PutV1AlertchannelsIdSubscriptions

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。
ID を確認する	checkId		guid	checkId または groupId を渡すことができますが、両方を渡すわけではありません。
グループ識別子	groupId		number	checkId または groupId を渡すことができますが、両方を渡すわけではありません。
Activated	activated	True	boolean	アクティブ化されているかどうか。

戻り値

Body

AlertChanelSubscription

アラート チャネルを作成する

操作 ID:

PostV1Alertchannels

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

パラメーター

名前	キー	必須	型	説明
ID	id		number	識別子。
ID を確認する	checkId		guid	チェック識別子。
グループ識別子	groupId		number	グループ識別子。
Activated	activated	True	boolean	アクティブ化されているかどうか。
タイプ	type	True	string	型。
アラート チャネルの構成の作成	config	True	object	アラート チャネルによって構成が作成されます。
回復の送信	sendRecovery		boolean	回復を送信するかどうか。
送信エラー	sendFailure		boolean	送信エラーかどうか。
低下した送信	sendDegraded		boolean	送信が機能低下したかどうか。
SSL の有効期限	sslExpiry		boolean	期限切れの SSL 証明書に対してアラートを送信する必要があるかどうかを判断します。
SSL の有効期限のしきい値	sslExpiryThreshold		integer	SSL 証明書のアラートを開始する時点。

戻り値

Body

AlertChannel

アラート チャネルを削除する

操作 ID:

DeleteV1AlertchannelsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

アラート チャネルを取得する

操作 ID:

GetV1AlertchannelsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

戻り値

Body

AlertChannel

アラート チャネルを更新する

操作 ID:

PutV1AlertchannelsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。
ID	id		number	識別子。
ID を確認する	checkId		guid	チェック識別子。
グループ識別子	groupId		number	グループ識別子。
Activated	activated	True	boolean	アクティブ化されているかどうか。
タイプ	type	True	string	型。
アラート チャネルの構成の作成	config	True	object	アラート チャネルによって構成が作成されます。
回復の送信	sendRecovery		boolean	回復を送信するかどうか。
送信エラー	sendFailure		boolean	送信エラーかどうか。
低下した送信	sendDegraded		boolean	送信が機能低下したかどうか。
SSL の有効期限	sslExpiry		boolean	期限切れの SSL 証明書に対してアラートを送信する必要があるかどうかを判断します。
SSL の有効期限のしきい値	sslExpiryThreshold		integer	SSL 証明書のアラートを開始する時点。

戻り値

Body

AlertChannel

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

操作 ID:

GetV1BadgesGroupsGroupid

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

パラメーター

名前	キー	必須	型	説明
グループ識別子	groupId	True	integer	グループ識別子。
Style	style		string	スタイル。
テーマ	theme		string	テーマ。
応答時間	responseTime		boolean	応答時間。

戻り値

response

string

グループ設定が適用された特定のグループで 1 つのチェックを取得する

操作 ID:

GetV1CheckgroupsGroupidChecksCheckid

グループ設定が適用された特定のチェック グループに 1 つのチェックの詳細を表示します。

パラメーター

名前	キー	必須	型	説明
グループ識別子	groupId	True	integer	グループ識別子。
ID を確認する	checkId	True	string	チェック識別子。

戻り値

Body

CheckGroupCheck

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

操作 ID:

GetV1CheckgroupsIdChecks

グループ設定が適用された特定のチェック グループ内のすべてのチェックを一覧表示します。

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。

戻り値

アイテム

Model8

サポートされているすべてのランタイムを一覧表示します

操作 ID:

GetV1Runtimes

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

戻り値

アイテム

RuntimeList

サポートされているすべての場所を一覧表示します

操作 ID:

GetV1Locations

サポートされているすべての場所を一覧表示します。

戻り値

アイテム

LocationList

スニペットを作成する

操作 ID:

PostV1Snippets

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

パラメーター

名前	キー	必須	型	説明
名前	name	True	string	スニペット名。
スクリプト	script	True	string	API チェックライフサイクルと対話する Node.js コード、またはブラウザー チェックの一部として機能します。

戻り値

Body

Snippet

スニペットを削除する

操作 ID:

DeleteV1SnippetsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

スニペットを取得する

操作 ID:

GetV1SnippetsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

戻り値

Body

Snippet

スニペットを更新する

操作 ID:

PutV1SnippetsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。
名前	name	True	string	スニペット名。
スクリプト	script	True	string	API チェックライフサイクルと対話する Node.js コード、またはブラウザー チェックの一部として機能します。

戻り値

Body

Snippet

ダッシュボードの更新

操作 ID:

PutV1DashboardsDashboardid

ダッシュボードを更新します。 既に取得されているカスタム 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	favicon		string	ダッシュボード favicon として使用されるイメージ ファイルを指す URL。
Link	link		string	ダッシュボードのロゴがクリックされたときにリダイレクトする URL リンク。
Header	header		string	ダッシュボードの上部に表示されるテキスト。
Description	description		string	ダッシュボードのヘッダーまたはタイトルの下に表示されるテキストの一部。
Width	width		string	全画面表示を使用するか、中央にフォーカスを置くかを指定します。
更新レート	refreshRate		number	ダッシュボードを秒単位で更新する頻度。
改ページ位置	paginate		boolean	改ページ位置のオンとオフを決定します。
改ページ位置の変更率	paginationRate		number	改ページ位置を秒単位でトリガーする頻度。
ページあたりのチェック数	checksPerPage		number	ページごとに表示されるチェックの数。
Use And Operator	useTagsAndOperator		boolean	タグ検索に AND 演算子を使用する場合。
タグを非表示にする	hideTags		boolean	ダッシュボードでタグを表示または非表示にします。
ダッシュボード タグリスト	tags		array of string	ダッシュボードに表示するチェックをフィルター処理する 1 つ以上のタグの一覧。

戻り値

Body

Dashboard

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

操作 ID:

PostV1Dashboards

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

パラメーター

名前	キー	必須	型	説明
カスタム URL	customUrl		string	checklyhq.com のサブドメイン名。 すべてのユーザーで一意である必要があります。
Custom Domain	customDomain		string	カスタム ユーザー ドメイン (例: status.example.com)。 DNS と SSL の使用状況の更新に関するドキュメントを参照してください。
Logo	logo		string	イメージ ファイルを指す URL。
Favicon	favicon		string	ダッシュボード favicon として使用されるイメージ ファイルを指す URL。
Link	link		string	ダッシュボードのロゴがクリックされたときにリダイレクトする URL リンク。
Header	header		string	ダッシュボードの上部に表示されるテキスト。
Description	description		string	ダッシュボードのヘッダーまたはタイトルの下に表示されるテキストの一部。
Width	width		string	全画面表示を使用するか、中央にフォーカスを置くかを指定します。
更新レート	refreshRate		number	ダッシュボードを秒単位で更新する頻度。
改ページ位置	paginate		boolean	改ページ位置のオンとオフを決定します。
改ページ位置の変更率	paginationRate		number	改ページ位置を秒単位でトリガーする頻度。
ページあたりのチェック数	checksPerPage		number	ページごとに表示されるチェックの数。
Use And Operator	useTagsAndOperator		boolean	タグ検索に AND 演算子を使用する場合。
タグを非表示にする	hideTags		boolean	ダッシュボードでタグを表示または非表示にします。
ダッシュボード タグリスト	tags		array of string	ダッシュボードに表示するチェックをフィルター処理する 1 つ以上のタグの一覧。

戻り値

Body

Dashboard

ダッシュボードを削除する

操作 ID:

DeleteV1DashboardsDashboardid

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

パラメーター

名前	キー	必須	型	説明
ID	dashboardId	True	string	ダッシュボード識別子。

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

操作 ID:

PostV1TriggersCheckgroupsGroupid

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

パラメーター

名前	キー	必須	型	説明
グループ識別子	groupId	True	integer	グループ識別子。

戻り値

Body

CheckGroupTrigger

チェック グループ トリガーを削除する

操作 ID:

DeleteV1TriggersCheckgroupsGroupid

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

パラメーター

名前	キー	必須	型	説明
グループ識別子	groupId	True	integer	グループ識別子。

チェック グループ トリガーを取得する

操作 ID:

GetV1TriggersCheckgroupsGroupid

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

パラメーター

名前	キー	必須	型	説明
グループ識別子	groupId	True	integer	グループ識別子。

戻り値

Body

CheckGroupTrigger

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

操作 ID:

PostV1Checkgroups

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

パラメーター

名前	キー	必須	型	説明
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name	True	string	チェック グループの名前。
Activated	activated		boolean	グループ内のチェックが実行されているかどうかを判断します。
Muted	muted		boolean	このグループのチェックインが失敗したり回復したりしたときに通知が送信されるかどうかを判断します。
グループ タグ リストの確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
グループの場所の一覧を確認する	locations		array of string	チェックを実行する 1 つ以上のデータ センターの場所の配列。
Concurrency	concurrency		number	CI/CD または API からチェック グループをトリガーするときに同時に呼び出されるチェックの数を決定します。
URL	url		string	すべてのグループ チェックで {{GROUP_BASE_URL}} 変数で参照できる、このグループのベース 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	チェック グループ作成ブラウザーチェックの既定値。
ランタイム ID	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	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	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:

DeleteV1CheckgroupsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

チェック グループを取得する

操作 ID:

GetV1CheckgroupsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

戻り値

Body

CheckGroup

チェック グループを更新する

操作 ID:

PutV1CheckgroupsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name		string	チェック グループの名前。
Activated	activated		boolean	グループ内のチェックが実行されているかどうかを判断します。
Muted	muted		boolean	このグループのチェックインが失敗したり回復したりしたときに通知が送信されるかどうかを判断します。
グループ タグ リストの確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
グループの場所の一覧を確認する	locations		array of string	チェックを実行する 1 つ以上のデータ センターの場所の配列。
Concurrency	concurrency		number	CI/CD または API からチェック グループをトリガーするときに同時に呼び出されるチェックの数を決定します。
URL	url		string	すべてのグループ チェックで {{GROUP_BASE_URL}} 変数で参照できる、このグループのベース 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	チェック グループ作成ブラウザーチェックの既定値。
ランタイム ID	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	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	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:

PostV1TriggersChecksCheckid

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

パラメーター

名前	キー	必須	型	説明
ID を確認する	checkId	True	string	チェック識別子。

戻り値

Body

CheckTrigger

チェック トリガーを削除する

操作 ID:

DeleteV1TriggersChecksCheckid

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

パラメーター

名前	キー	必須	型	説明
ID を確認する	checkId	True	string	チェック識別子。

チェック トリガーを取得する

操作 ID:

GetV1TriggersChecksCheckid

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

パラメーター

名前	キー	必須	型	説明
ID を確認する	checkId	True	string	チェック識別子。

戻り値

Body

CheckTrigger

チェックおよびチェック グループの集計統計を含むレポートを生成します

操作 ID:

GetV1Reporting

すべてのチェックに対して集計された統計を含むレポート、または指定された時間枠でフィルター処理されたチェックのセットを含むレポートを生成します。

パラメーター

名前	キー	必須	型	説明
より	from		date	Unix タイムスタンプ形式のレポート ウィンドウのカスタム開始時刻。 タイムスタンプからカスタムを設定すると、presetWindow の使用がオーバーライドされます。
移行先	to		date	Unix タイムスタンプ形式のレポート ウィンドウのカスタム終了時刻。 カスタムをタイムスタンプに設定すると、presetWindow の使用がオーバーライドされます。
[プリセット] ウィンドウ	presetWindow		string	既定のレポート ウィンドウは、一般的に使用されるウィンドウでレポートをすばやく生成するために使用されます。 タイムスタンプとの間でカスタムを使用してオーバーライドできます。
タグによるフィルター処理	filterByTags		array	タグを使用して、レポートに表示するチェックをフィルター処理します。
Deactivated	deactivated		boolean	アクティブな状態でチェックをフィルター処理します。

戻り値

アイテム

ReportingList

チェックの作成 [非推奨]

操作 ID:

PostV1Checks

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

パラメーター

名前	キー	必須	型	説明
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name	True	string	チェックの名前。
Activated	activated	True	boolean	チェックが実行されているかどうかを判断します。
Muted	muted		boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck		boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail		boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations		array of string	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
エスカレーションの種類	escalationType		string	使用するエスカレーションの種類を決定します。
失敗した実行のしきい値	failedRunThreshold		number	失敗した連続チェックの実行回数が経過したら、アラート通知を送信する必要があります。
失敗した分数のしきい値	minutesFailingThreshold		number	確認が失敗し始めてから数分後に、アラートを送信する必要があります。
金額	amount		number	最初のアラート通知の後に送信するアラームの数。
インターバル	interval		number	アラームを送信する間隔。
Enabled	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
グローバル アラート設定を使用する	useGlobalAlertSettings		boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	groupId		number	このチェックの一部であるチェック グループの識別子。
グループの順序	groupOrder		number	チェック グループ内のこのチェックの位置。 これは、API または CI/CD からグループがトリガーされたときに実行される順序チェックを決定します。
ランタイム ID	runtimeId		string	ランタイム バージョン (つまり、このチェックの実行に使用されるランタイム依存関係の固定セット)。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	activated	True	boolean	アクティブ化されているかどうか。
種類の確認	checkType	True	string	チェックの種類。
頻度	frequency		integer	チェックを実行する頻度 (分単位)。
周波数オフセット	frequencyOffset		integer	チェック頻度を 1 分未満に設定する (API チェックの場合のみ) 秒を設定し、1 分間の頻度の時間範囲でチェックを分散するために使用されます。 これは次のように機能します。頻度が 0 のチェックでは、frequencyOffset を 10、20、または 30 にすることができます。これは、10 秒、20 秒、または 30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、数式 Math.floor(frequency * 10) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、5 分ごとに実行されるチェックの場合、最大 frequencyOffset は 50 です。 頻度が 60 より高いチェックでは、数式 Math.ceil(frequency/ 60) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、720 分ごとに実行されるチェックの場合、最大 frequencyOffset は 12 です。
要求の確認	request		object	チェック要求。
スクリプト	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	チェックを実行する 1 つ以上のプライベートな場所の配列。

戻り値

Body

Check

チェックを削除する

操作 ID:

DeleteV1ChecksId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。

チェックを取得する

操作 ID:

GetV1ChecksId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。

戻り値

Body

Check

チェックを更新する [非推奨]

操作 ID:

PutV1ChecksId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name		string	チェックの名前。
Activated	activated		boolean	チェックが実行されているかどうかを判断します。
Muted	muted		boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck		boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail		boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations		array of string	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
エスカレーションの種類	escalationType		string	使用するエスカレーションの種類を決定します。
失敗した実行のしきい値	failedRunThreshold		number	失敗した連続チェックの実行回数が経過したら、アラート通知を送信する必要があります。
失敗した分数のしきい値	minutesFailingThreshold		number	確認が失敗し始めてから数分後に、アラートを送信する必要があります。
金額	amount		number	最初のアラート通知の後に送信するアラームの数。
インターバル	interval		number	アラームを送信する間隔。
Enabled	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
グローバル アラート設定を使用する	useGlobalAlertSettings		boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	groupId		number	このチェックの一部であるチェック グループの識別子。
グループの順序	groupOrder		number	チェック グループ内のこのチェックの位置。 これは、API または CI/CD からグループがトリガーされたときに実行される順序チェックを決定します。
ランタイム ID	runtimeId		string	ランタイム バージョン (つまり、このチェックの実行に使用されるランタイム依存関係の固定セット)。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	activated	True	boolean	アクティブ化されているかどうか。
種類の確認	checkType		string	チェックの種類。
頻度	frequency		integer	チェックを実行する頻度 (分単位)。
周波数オフセット	frequencyOffset		integer	チェック頻度を 1 分未満に設定する (API チェックの場合のみ) 秒を設定し、1 分間の頻度の時間範囲でチェックを分散するために使用されます。 これは次のように機能します。頻度が 0 のチェックでは、frequencyOffset を 10、20、または 30 にすることができます。これは、10 秒、20 秒、または 30 秒ごとに実行されることを意味します。 頻度が 60 以下のチェックでは、数式 Math.floor(frequency * 10) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、5 分ごとに実行されるチェックの場合、最大 frequencyOffset は 50 です。 頻度が 60 より高いチェックでは、数式 Math.ceil(frequency/ 60) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、720 分ごとに実行されるチェックの場合、最大 frequencyOffset は 12 です。
要求の確認	request	True	object	チェック要求。
スクリプト	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	チェックを実行する 1 つ以上のプライベートな場所の配列。

戻り値

Body

Check

チェック結果を取得する

操作 ID:

GetV1CheckresultsCheckidCheckresultid

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

パラメーター

名前	キー	必須	型	説明
ID を確認する	checkId	True	string	チェック識別子。
結果 ID の確認	checkResultId	True	string	チェック結果識別子。

戻り値

Body

CheckResult

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

操作 ID:

PostV1ChecksBrowser

新しいブラウザー チェックを作成します。 プランの制限を超えると、 402 が返されます。 globalAlertSettingを使用する場合、alertSettingはnull

パラメーター

名前	キー	必須	型	説明
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name	True	string	チェックの名前。
Activated	activated	True	boolean	チェックが実行されているかどうかを判断します。
Muted	muted		boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck		boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail		boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations		array of string	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
エスカレーションの種類	escalationType		string	使用するエスカレーションの種類を決定します。
失敗した実行のしきい値	failedRunThreshold		number	失敗した連続チェックの実行回数が経過したら、アラート通知を送信する必要があります。
失敗した分数のしきい値	minutesFailingThreshold		number	確認が失敗し始めてから数分後に、アラートを送信する必要があります。
金額	amount		number	最初のアラート通知の後に送信するアラームの数。
インターバル	interval		number	アラームを送信する間隔。
Enabled	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
グローバル アラート設定を使用する	useGlobalAlertSettings		boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	groupId		number	このチェックの一部であるチェック グループの識別子。
グループの順序	groupOrder		number	チェック グループ内のこのチェックの位置。 これは、API または CI/CD からグループがトリガーされたときに実行される順序チェックを決定します。
ランタイム ID	runtimeId		string	ランタイム バージョン (つまり、このチェックの実行に使用されるランタイム依存関係の固定セット)。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	activated	True	boolean	アクティブ化されているかどうか。
Key	key	True	string	環境変数のキー (この値は変更できません)。
価値	value	True	string	環境変数の値。
ロックされています	locked		boolean	パスワードのような値を非表示にするために UI でのみ使用されます。
頻度	frequency		integer	チェックを実行する頻度 (分単位)。
スクリプト	script	True	string	Puppeteer または Playwright フレームワークとのブラウザーの対話を記述する、Node.js javascript コードの有効な部分。
プライベートな場所	privateLocations		array of string	チェックを実行する 1 つ以上のプライベートな場所の配列。

戻り値

Body

CheckBrowser

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

操作 ID:

PutV1ChecksBrowserId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。
アラートの自動割り当て	autoAssignAlerts		boolean	新しいチェックが、作成時にすべての既存のアラート チャネルにサブスクライバーとして自動的に追加されるかどうかを決定します。
名前	name		string	チェックの名前。
Activated	activated		boolean	チェックが実行されているかどうかを判断します。
Muted	muted		boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck		boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail		boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations		array of string	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags		array of string	チェックを整理およびフィルター処理するためのタグ。
エスカレーションの種類	escalationType		string	使用するエスカレーションの種類を決定します。
失敗した実行のしきい値	failedRunThreshold		number	失敗した連続チェックの実行回数が経過したら、アラート通知を送信する必要があります。
失敗した分数のしきい値	minutesFailingThreshold		number	確認が失敗し始めてから数分後に、アラートを送信する必要があります。
金額	amount		number	最初のアラート通知の後に送信するアラームの数。
インターバル	interval		number	アラームを送信する間隔。
Enabled	enabled		boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold		integer	SSL 証明書のアラートを開始する時点。
グローバル アラート設定を使用する	useGlobalAlertSettings		boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	groupId		number	このチェックの一部であるチェック グループの識別子。
グループの順序	groupOrder		number	チェック グループ内のこのチェックの位置。 これは、API または CI/CD からグループがトリガーされたときに実行される順序チェックを決定します。
ランタイム ID	runtimeId		string	ランタイム バージョン (つまり、このチェックの実行に使用されるランタイム依存関係の固定セット)。
アラート チャネル ID	alertChannelId	True	number	アラート チャネル識別子。
Activated	activated	True	boolean	アクティブ化されているかどうか。
Key	key	True	string	環境変数のキー (この値は変更できません)。
価値	value	True	string	環境変数の値。
ロックされています	locked		boolean	パスワードのような値を非表示にするために UI でのみ使用されます。
頻度	frequency		integer	チェックを実行する頻度 (分単位)。
スクリプト	script		string	Puppeteer または Playwright フレームワークとのブラウザーの対話を記述する、Node.js javascript コードの有効な部分。
プライベートな場所	privateLocations		array of string	チェックを実行する 1 つ以上のプライベートな場所の配列。

戻り値

Body

CheckBrowser

プライベートな場所の新しい API キーを生成する

操作 ID:

PostV1PrivatelocationsIdKeys

プライベートの場所に API キーを作成します。

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。

戻り値

Body

privateLocationKeys

プライベートな場所の既存の API キーを削除する

操作 ID:

DeleteV1PrivatelocationsIdKeysKeyid

プライベートな場所から API キーを完全に削除します。

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。
キー ID	keyId	True	string	キー識別子。

プライベートな場所を作成する

操作 ID:

PostV1Privatelocations

新しいプライベートの場所を作成します。

パラメーター

名前	キー	必須	型	説明
名前	name	True	string	プライベートの場所に割り当てられた名前。
スラッグ名	slugName	True	string	有効なスラッグ名。
Icon	icon		string	アイコン。

戻り値

Body

commonPrivateLocationSchemaResponse

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

操作 ID:

DeleteV1PrivatelocationsId

プライベートな場所を完全に削除します。

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。

プライベートな場所を取得する

操作 ID:

GetV1PrivatelocationsId

特定のプライベートな場所の詳細を表示します。

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。

戻り値

Body

privatelocationschema

プライベートな場所を更新する

操作 ID:

PutV1PrivatelocationsId

プライベートな場所を更新します。

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。
名前	name	True	string	プライベートの場所に割り当てられた名前。
Icon	icon		string	アイコン。

戻り値

Body

commonPrivateLocationSchemaResponse

メンテナンス期間を作成する

操作 ID:

PostV1Maintenancewindows

新しいメンテナンス期間を作成します。

パラメーター

名前	キー	必須	型	説明
名前	name	True	string	メンテナンス期間の名前。
メンテナンス 期間のタグの一覧	tags		array of string	チェックとグループのメンテナンス期間の名前を適用する必要があります。
開始位置	startsAt	True	date	メンテナンス期間の開始日。
終了位置	endsAt	True	date	メンテナンス期間の終了日。
繰り返し間隔	repeatInterval		number	最初に発生したメンテナンス期間の繰り返し間隔。
繰り返し単位	repeatUnit	True	string	メンテナンス期間の繰り返し戦略。
繰り返しの終了位置	repeatEndsAt		date	メンテナンス期間の繰り返しを停止する終了日。

戻り値

Body

MaintenanceWindow

メンテナンス期間を削除する

操作 ID:

DeleteV1MaintenancewindowsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

メンテナンス期間を取得する

操作 ID:

GetV1MaintenancewindowsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。

戻り値

Body

MaintenanceWindow

メンテナンス期間を更新する

操作 ID:

PutV1MaintenancewindowsId

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

パラメーター

名前	キー	必須	型	説明
ID	id	True	integer	識別子。
名前	name	True	string	メンテナンス期間の名前。
メンテナンス 期間のタグの一覧	tags		array of string	チェックとグループのメンテナンス期間の名前を適用する必要があります。
開始位置	startsAt	True	date	メンテナンス期間の開始日。
終了位置	endsAt	True	date	メンテナンス期間の終了日。
繰り返し間隔	repeatInterval		number	最初に発生したメンテナンス期間の繰り返し間隔。
繰り返し単位	repeatUnit	True	string	メンテナンス期間の繰り返し戦略。
繰り返しの終了位置	repeatEndsAt		date	メンテナンス期間の繰り返しを停止する終了日。

戻り値

Body

MaintenanceWindow

時間枠からプライベートな場所の正常性メトリックを取得する

操作 ID:

GetV1PrivatelocationsIdMetrics

時間のウィンドウからプライベートな場所の正常性メトリックを取得します。

パラメーター

名前	キー	必須	型	説明
ID	id	True	string	識別子。
より	from	True	date	この UNIX タイムスタンプから始まるメトリックを選択します。 15 日以内である必要があります。
移行先	to	True	date	この UNIX タイムスタンプまでのメトリックを選択します。

戻り値

Body

privateLocationsMetricsHistoryResponseSchema

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

操作 ID:

GetV1CheckalertsCheckid

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

パラメーター

名前	キー	必須	型	説明
ID を確認する	checkId	True	string	チェック識別子。
極限	limit		integer	結果の数を制限します。
Number	page		number	ページ番号。
より	from		date	この UNIX タイムスタンプ (> = 日付) からドキュメントを選択します。 既定値は現在 - 6 時間です。
移行先	to		date	この UNIX タイムスタンプ (< 日付) までのアラートを選択します。 既定値は 6 時間後です。

戻り値

アイテム

CheckAlertList

状態の確認の詳細を取得する

操作 ID:

GetV1CheckstatusesCheckid

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

パラメーター

名前	キー	必須	型	説明
ID を確認する	checkId	True	string	チェック識別子。

戻り値

Body

CheckStatus

状態の確認バッジを取得する

操作 ID:

GetV1BadgesChecksCheckid

状態の確認バッジを取得します。

パラメーター

名前	キー	必須	型	説明
ID を確認する	checkId	True	string	チェック識別子。
Style	style		string	スタイル。
テーマ	theme		string	テーマ。
応答時間	responseTime		boolean	応答時間。

戻り値

response

string

環境変数を作成する

操作 ID:

PostV1Variables

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

パラメーター

名前	キー	必須	型	説明
Key	key	True	string	環境変数のキー (この値は変更できません)。
価値	value	True	string	環境変数の値。
ロックされています	locked		boolean	パスワードのような値を非表示にするために UI でのみ使用されます。

戻り値

Body

EnvironmentVariable

環境変数を削除する

操作 ID:

DeleteV1VariablesKey

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

パラメーター

名前	キー	必須	型	説明
Key	key	True	string	そのカギ。

環境変数を取得する

操作 ID:

GetV1VariablesKey

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

パラメーター

名前	キー	必須	型	説明
Key	key	True	string	そのカギ。

戻り値

Body

EnvironmentVariable

環境変数を更新する

操作 ID:

PutV1VariablesKey

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

パラメーター

名前	キー	必須	型	説明
Key	key	True	string	そのカギ。
Key	key		string	環境変数のキー (この値は変更できません)。
価値	value	True	string	環境変数の値。
ロックされています	locked		boolean	パスワードのような値を非表示にするために UI でのみ使用されます。

戻り値

Body

EnvironmentVariable

定義

AlertChannelConfig

アラート チャネルの構成。

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

AlertChanelSubscription

名前	パス	型	説明
ID	id	number	識別子。
ID を確認する	checkId	guid	チェック識別子。
グループ識別子	groupId	number	グループ識別子。
Activated	activated	boolean	アクティブ化されているかどうか。

AlertChanelSubscriptionList

このチャネルにサブスクライブされているすべてのチェック。

名前	パス	型	説明
アイテム		AlertChanelSubscription

AlertChannel

名前	パス	型	説明
ID	id	number	識別子。
タイプ	type	string	アラート チャネルの種類 (電子メールまたは SLACK など)。
アラート チャネルの構成	config	AlertChannelConfig	アラート チャネルの構成。
アラート チャネル サブスクリプションの一覧	subscriptions	AlertChanelSubscriptionList	このチャネルにサブスクライブされているすべてのチェック。
回復の送信	sendRecovery	boolean	回復を送信するかどうか。
送信エラー	sendFailure	boolean	送信エラーかどうか。
低下した送信	sendDegraded	boolean	送信が機能低下したかどうか。
SSL の有効期限	sslExpiry	boolean	期限切れの SSL 証明書に対してアラートを送信する必要があるかどうかを判断します。
SSL の有効期限のしきい値	sslExpiryThreshold	integer	SSL 証明書のアラートを開始する時点。
Created At	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	string	アラートをトリガーする失敗したチェックの一部であった特定のエラー メッセージ。
状態コード	statusCode	string	応答の状態コード。 API チェックにのみ適用されます。
Created At	created_at	date	このチェック アラートが作成された日付と時刻。
開始日	startedAt	date	このチェック アラートが開始された日付と時刻。

CheckAlertList

名前	パス	型	説明
アイテム		CheckAlert

CheckGroupTagList

チェックを整理およびフィルター処理するためのタグ。

名前	パス	型	説明
アイテム		string

CheckGroupLocationList

チェックを実行する 1 つ以上のデータ センターの場所の配列。

名前	パス	型	説明
アイテム		string

KeyValue

名前	パス	型	説明
Key	key	string	そのカギ。
価値	value	string	値。
ロックされています	locked	boolean	ロックされているかどうか。

HeaderList

名前	パス	型	説明
アイテム		KeyValue

QueryParameterList

名前	パス	型	説明
アイテム		KeyValue

主張

名前	パス	型	説明
情報源	source	string	ソース。
プロパティ	property	string	プロパティ。
Comparison	comparison	string	比較。
目標	target	string	ターゲット。

AssertionList

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

名前	パス	型	説明
アイテム		Assertion

BasicAuth

名前	パス	型	説明
ユーザー名	username	string	ユーザー名。
パスワード	password	string	パスワード。

CheckGroupAPICheckDefaults

名前	パス	型	説明
URL	url	string	すべてのグループ チェックで {{GROUP_BASE_URL}} 変数で参照できる、このグループのベース URL。
headers	headers	HeaderList
クエリパラメータ	queryParameters	QueryParameterList
アサーション リスト	assertions	AssertionList	プロパティ フィールドで使用できる正規表現や JSON パス記述子などの特定の値については、アサーションに関する主な Checkly ドキュメントを確認してください。
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

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

名前	パス	型	説明
グループ ブラウザーの既定値を確認する		object	グループ ブラウザーのチェックの既定値。

EnvironmentVariable

名前	パス	型	説明
Key	key	string	環境変数のキー (この値は変更できません)。
価値	value	string	環境変数の値。
ロックされています	locked	boolean	パスワードのような値を非表示にするために UI でのみ使用されます。

EnvironmentVariableList

名前	パス	型	説明
アイテム		EnvironmentVariable

AlertSettingsRunBasedEscalation

名前	パス	型	説明
失敗した実行のしきい値	failedRunThreshold	number	失敗した連続チェックの実行回数が経過したら、アラート通知を送信する必要があります。

AlertSettingsTimeBasedEscalation

名前	パス	型	説明
失敗した分数のしきい値	minutesFailingThreshold	number	確認が失敗し始めてから数分後に、アラートを送信する必要があります。

AlertSettingsReminders

名前	パス	型	説明
金額	amount	number	最初のアラート通知の後に送信するアラームの数。
インターバル	interval	number	アラームを送信する間隔。

AlertSettingsSSLCertificates

[非推奨] sslCertificates は非推奨であり、使用されなくなりました。 今後のバージョンでは削除されます。無視してください。

名前	パス	型	説明
Enabled	enabled	boolean	期限切れの SSL 証明書に対してアラート通知を送信するかどうかを決定します。
アラートのしきい値	alertThreshold	integer	SSL 証明書のアラートを開始する時点。

CheckGroupAlertSettings

アラートの設定。

名前	パス	型	説明
エスカレーションの種類	escalationType	string	使用するエスカレーションの種類を決定します。
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
アラーム	reminders	AlertSettingsReminders
アラート設定の SSL 証明書	sslCertificates	AlertSettingsSSLCertificates	[非推奨] sslCertificates は非推奨であり、使用されなくなりました。 今後のバージョンでは削除されます。無視してください。

Model1

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

名前	パス	型	説明
アラート チャネル ID	alertChannelId	number	アラート チャネル識別子。
Activated	activated	boolean	アクティブ化されているかどうか。

AlertChannelSubscriptionCreateList

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

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

privateLocations

チェックを実行する 1 つ以上のプライベートな場所の配列。

名前	パス	型	説明
アイテム		string

CheckGroup

名前	パス	型	説明
ID	id	number	識別子。
名前	name	string	チェック グループの名前。
Activated	activated	boolean	グループ内のチェックが実行されているかどうかを判断します。
Muted	muted	boolean	このグループのチェックインが失敗したり回復したりしたときに通知が送信されるかどうかを判断します。
グループ タグ リストの確認	tags	CheckGroupTagList	チェックを整理およびフィルター処理するためのタグ。
グループの場所の一覧を確認する	locations	CheckGroupLocationList	チェックを実行する 1 つ以上のデータ センターの場所の配列。
Concurrency	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	created_at	date	作成時に指定します。
更新日時	updated_at	date-time	更新日時:

CheckGroupList

名前	パス	型	説明
アイテム		CheckGroup

CheckLocationList

このチェックを実行する 1 つ以上のデータ センターの場所の配列。

名前	パス	型	説明
アイテム		string

CheckTagList

チェックを整理およびフィルター処理するためのタグ。

名前	パス	型	説明
アイテム		string

CheckAlertSettings

アラートの設定。

名前	パス	型	説明
エスカレーションの種類	escalationType	string	使用するエスカレーションの種類を決定します。
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
アラーム	reminders	AlertSettingsReminders
アラート設定の SSL 証明書	sslCertificates	AlertSettingsSSLCertificates	[非推奨] sslCertificates は非推奨であり、使用されなくなりました。 今後のバージョンでは削除されます。無視してください。

CheckAlertChannelSubscription

名前	パス	型	説明
アラート チャネル ID	alertChannelId	number	アラート チャネル識別子。
Activated	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	Model5

CheckAlertWebhookList

名前	パス	型	説明
アイテム		CheckAlertWebhook

CheckAlertSlack

名前	パス	型	説明
URL	url	string	URL アドレス。

CheckAlertSlackList

名前	パス	型	説明
アイテム		CheckAlertSlack

CheckAlertSMS

名前	パス	型	説明
Number	number	string	数値。
名前	name	string	名前。

CheckAlertSMSList

名前	パス	型	説明
アイテム		CheckAlertSMS

CheckAlertChannels

名前	パス	型	説明
メール	email	CheckAlertEmailList
Webhook	webhook	CheckAlertWebhookList
スラック	slack	CheckAlertSlackList
ショートメッセージサービス (SMS)	sms	CheckAlertSMSList

CheckGroupCheck

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	チェックの名前。
Activated	activated	boolean	チェックが実行されているかどうかを判断します。
Muted	muted	boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck	boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail	boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations	CheckLocationList	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags	CheckTagList	チェックを整理およびフィルター処理するためのタグ。
アラート設定の確認	alertSettings	CheckAlertSettings	アラートの設定。
グローバル アラート設定を使用する	useGlobalAlertSettings	boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	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	セットアップ フェーズで実行する Node.js コードの有効な部分。
ローカル破棄スクリプト	localTearDownScript	string	破棄フェーズで実行する Node.js コードの有効な部分。
応答時間の低下	degradedResponseTime	number	チェックが低下していると見なされる応答時間 (ミリ秒単位)。
最大応答時間	maxResponseTime	number	チェックが失敗したと見なされる応答時間 (ミリ秒単位)。
alertChannels	alertChannels	CheckAlertChannels
プライベートな場所	privateLocations	privateLocations	チェックを実行する 1 つ以上のプライベートな場所の配列。
Created At	created_at	date	作成時に指定します。
更新日時	updated_at	date-time	更新日時:

Model8

名前	パス	型	説明
アイテム		CheckGroupCheck

アサーション

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

名前	パス	型	説明
アイテム		string

headers

ヘッダー。

名前	パス	型	説明
Headers		object	ヘッダー。

params

パラメーター。

名前	パス	型	説明
Params		object	パラメーター。

要求

API の要求。

名前	パス	型	説明
メソッド	method	string
URL	url	string
データ	data	string
Headers	headers	headers	ヘッダー。
Params	params	params	パラメーター。

タイミング

タイミング。

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

timingPhases

タイミング フェーズ。

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

response

API 応答。

名前	パス	型	説明
ステータス	status	number	状態。
状態テキスト	statusText	string	状態テキスト。
Body	body	string	本文。
Headers	headers	headers	ヘッダー。
タイミング	timings	timings	タイミング。
タイミング フェーズ	timingPhases	timingPhases	タイミング フェーズ。

jobLog

ジョブ ログ。

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

jobAssets

チェック実行から生成された資産。

名前	パス	型	説明
アイテム		string

CheckResultAPI

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

名前	パス	型	説明
Assertions	assertions	assertions	API チェック アサーションの一覧。
リクエスト	request	request	API の要求。
[応答]	response	response	API 応答。
要求エラー	requestError	string	要求でエラーが発生したかどうかを説明します。
ジョブ ログ	jobLog	jobLog	ジョブ ログ。
ジョブ資産	jobAssets	jobAssets	チェック実行から生成された資産。

エラー

チェックの実行に関するエラーの一覧。

名前	パス	型	説明
アイテム		string

Model9

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

名前	パス	型	説明
アイテム		string

traceSummary

トレースの概要。

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

pages

チェック実行で使用されるページの一覧。

名前	パス	型	説明
アイテム		string

CheckResultBrowser

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

名前	パス	型	説明
タイプ	type	string	チェックで使用されているフレームワークの種類。
Errors	errors	errors	チェックの実行に関するエラーの一覧。
終了時刻	endTime	number	チェック実行の終了時刻。
開始時刻	startTime	number	チェック実行の開始時刻。
ランタイム バージョン	runtimeVersion	string	アクティブなランタイム バージョン。
実行ログの確認	jobLog	Model9	実行ログの結果を確認します。
ジョブ資産	jobAssets	jobAssets	チェック実行から生成された資産。
トレースの概要	traceSummary	traceSummary	トレースの概要。
ページ	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	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	created_at	date	作成時に指定します。
更新日時	updated_at	date-time	更新日時:

CheckStatusList

名前	パス	型	説明
アイテム		CheckStatus

確認

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	チェックの名前。
Activated	activated	boolean	チェックが実行されているかどうかを判断します。
Muted	muted	boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck	boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail	boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations	CheckLocationList	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags	CheckTagList	チェックを整理およびフィルター処理するためのタグ。
アラート設定の確認	alertSettings	CheckAlertSettings	アラートの設定。
グローバル アラート設定を使用する	useGlobalAlertSettings	boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	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	セットアップ フェーズで実行する Node.js コードの有効な部分。
ローカル破棄スクリプト	localTearDownScript	string	破棄フェーズで実行する Node.js コードの有効な部分。
応答時間の低下	degradedResponseTime	number	チェックが低下していると見なされる応答時間 (ミリ秒単位)。
最大応答時間	maxResponseTime	number	チェックが失敗したと見なされる応答時間 (ミリ秒単位)。
alertChannels	alertChannels	CheckAlertChannels
プライベートな場所	privateLocations	privateLocations	チェックを実行する 1 つ以上のプライベートな場所の配列。
Created At	created_at	date	作成時に指定します。
更新日時	updated_at	date-time	更新日時:

チェックリスト

名前	パス	型	説明
アイテム		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	Model15
アサーション リスト	assertions	AssertionList	プロパティ フィールドで使用できる正規表現や JSON パス記述子などの特定の値については、アサーションに関する主な Checkly ドキュメントを確認してください。
basicAuth	basicAuth	BasicAuth

CheckAPI

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	チェックの名前。
Activated	activated	boolean	チェックが実行されているかどうかを判断します。
Muted	muted	boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck	boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail	boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations	CheckLocationList	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags	CheckTagList	チェックを整理およびフィルター処理するためのタグ。
アラート設定の確認	alertSettings	CheckAlertSettings	アラートの設定。
グローバル アラート設定を使用する	useGlobalAlertSettings	boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	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(frequency * 10) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、5 分ごとに実行されるチェックの場合、最大 frequencyOffset は 50 です。 頻度が 60 より高いチェックでは、数式 Math.ceil(frequency/ 60) に基づいて frequencyOffset を 1 から最大値の間に設定できます。つまり、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	チェックを実行する 1 つ以上のプライベートな場所の配列。
種類の確認	checkType	string	チェックの種類。
alertChannels	alertChannels	CheckAlertChannels
Created At	created_at	date	作成時に指定します。
更新日時	updated_at	date-time	更新日時:

CheckBrowser

名前	パス	型	説明
ID	id	string	識別子。
名前	name	string	チェックの名前。
Activated	activated	boolean	チェックが実行されているかどうかを判断します。
Muted	muted	boolean	チェックが失敗した場合や回復したときに通知が送信されるかどうかを判断します。
ダブル チェック	doubleCheck	boolean	これを true に設定すると、失敗したリージョンとランダムに選択された別のリージョンからチェックが失敗した場合に再試行がトリガーされ、その後、チェックが失敗としてマークされます。
失敗する必要がある	shouldFail	boolean	チェックが失敗したと見なされたときの動作を反転できます。 404 などのエラー状態を検証できます。
場所の一覧を確認する	locations	CheckLocationList	このチェックを実行する 1 つ以上のデータ センターの場所の配列。
タグ 一覧の確認	tags	CheckTagList	チェックを整理およびフィルター処理するためのタグ。
アラート設定の確認	alertSettings	CheckAlertSettings	アラートの設定。
グローバル アラート設定を使用する	useGlobalAlertSettings	boolean	true の場合、このチェックで定義されているアラート設定ではなく、アカウント レベルのアラート設定が使用されます。
グループ識別子	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	created_at	date	作成時に指定します。
更新日時	updated_at	date-time	更新日時:

DashboardTagList

ダッシュボードに表示するチェックをフィルター処理する 1 つ以上のタグの一覧。

名前	パス	型	説明
アイテム		string

Dashboard

名前	パス	型	説明
Custom Domain	customDomain	string	カスタム ユーザー ドメイン (例: status.example.com)。 DNS と SSL の使用状況の更新に関するドキュメントを参照してください。
カスタム URL	customUrl	string	checklyhq.com のサブドメイン名。 すべてのユーザーで一意である必要があります。
Logo	logo	string	イメージ ファイルを指す URL。
Favicon	favicon	string	ダッシュボード favicon として使用されるイメージ ファイルを指す URL。
Link	link	string	ダッシュボードのロゴがクリックされたときにリダイレクトする URL リンク。
Header	header	string	ダッシュボードの上部に表示されるテキスト。
Description	description	string	ダッシュボードのヘッダーまたはタイトルの下に表示されるテキストの一部。
Width	width	string	全画面表示を使用するか、中央にフォーカスを置くかを指定します。
更新レート	refreshRate	number	ダッシュボードを秒単位で更新する頻度。
改ページ位置	paginate	boolean	改ページ位置のオンとオフを決定します。
改ページ位置の変更率	paginationRate	number	改ページ位置を秒単位でトリガーする頻度。
ページあたりのチェック数	checksPerPage	number	ページごとに表示されるチェックの数。
Use And Operator	useTagsAndOperator	boolean	タグ検索に AND 演算子を使用する場合。
タグを非表示にする	hideTags	boolean	ダッシュボードでタグを表示または非表示にします。
ダッシュボード タグリスト	tags	DashboardTagList	ダッシュボードに表示するチェックをフィルター処理する 1 つ以上のタグの一覧。
ダッシュボード ID	dashboardId	string	ダッシュボード識別子。

DashboardsList

名前	パス	型	説明
アイテム		Dashboard

ロケーション

名前	パス	型	説明
リージョン	region	string	この場所の一意識別子。
名前	name	string	この場所のフレンドリ名。

LocationList

名前	パス	型	説明
アイテム		Location

MaintenanceWindowTagList

チェックとグループのメンテナンス期間の名前を適用する必要があります。

名前	パス	型	説明
アイテム		string

メンテナンスウィンドウ

名前	パス	型	説明
ID	id	number	メンテナンス期間の識別子。
名前	name	string	メンテナンス期間の名前。
メンテナンス 期間のタグの一覧	tags	MaintenanceWindowTagList	チェックとグループのメンテナンス期間の名前を適用する必要があります。
開始位置	startsAt	date	メンテナンス期間の開始日。
終了位置	endsAt	date	メンテナンス期間の終了日。
繰り返し間隔	repeatInterval	number	最初に発生したメンテナンス期間の繰り返し間隔。
繰り返し単位	repeatUnit	string	メンテナンス期間の繰り返し戦略。
繰り返しの終了位置	repeatEndsAt	date	メンテナンス期間の繰り返しを停止する終了日。
Created At	created_at	date	メンテナンス期間の作成日。
更新日時	updated_at	date	メンテナンス期間が更新された最後の日付。

MaintenanceWindowList

メンテナンス期間の一覧。

名前	パス	型	説明
アイテム		MaintenanceWindow

CheckAssignment

名前	パス	型	説明
ID	id	guid	識別子。
ID を確認する	checkId	guid	チェックの識別子。
プライベートロケーション ID	privateLocationId	guid	割り当てられたプライベートの場所の識別子。

checkAssignments

このプライベートな場所が割り当てられているチェック。

名前	パス	型	説明
アイテム		CheckAssignment

GroupAssignment

名前	パス	型	説明
ID	id	guid	識別子。
グループ識別子	groupId	number	グループの識別子。
プライベートロケーション ID	privateLocationId	guid	割り当てられたプライベートの場所の識別子。

groupAssignments

このプライベートな場所が割り当てたグループ。

名前	パス	型	説明
アイテム		GroupAssignment

privateLocationKeys

名前	パス	型	説明
ID	id	guid	識別子。
生キー	rawKey	string	生のキー。
マスクされたキー	maskedKey	string	マスクされたキー値。
Created At	created_at	date	作成時に指定します。
更新日時	updated_at	date	更新日時:

keys

名前	パス	型	説明
アイテム		privateLocationKeys

privatelocationschema

名前	パス	型	説明
ID	id	guid	識別子。
名前	name	string	プライベートの場所に割り当てられた名前。
スラッグ名	slugName	string	有効なスラッグ名。
Icon	icon	string	プライベートの場所アイコン。
Created At	created_at	date	作成時に指定します。
更新日時	updated_at	date	更新日時:
割り当てを確認する	checkAssignments	checkAssignments	このプライベートな場所が割り当てられているチェック。
グループの割り当て	groupAssignments	groupAssignments	このプライベートな場所が割り当てたグループ。
keys	keys	keys
最終表示	lastSeen	date	最後に表示された日付。
エージェント数	agentCount	number	エージェントの数。

privateLocationsListSchema

名前	パス	型	説明
アイテム		privatelocationschema

commonPrivateLocationSchemaResponse

名前	パス	型	説明
ID	id	guid	識別子。
名前	name	string	プライベートの場所に割り当てられた名前。
スラッグ名	slugName	string	有効なスラッグ名。
Icon	icon	string	プライベートの場所アイコン。
Created At	created_at	date	作成時に指定します。
更新日時	updated_at	date	更新日時:
割り当てを確認する	checkAssignments	checkAssignments	このプライベートな場所が割り当てられているチェック。
グループの割り当て	groupAssignments	groupAssignments	このプライベートな場所が割り当てたグループ。
keys	keys	keys

タイムスタンプ

名前	パス	型	説明
タイムスタンプ		date-time	タイムスタンプ。

queueSize

キューのサイズ。

名前	パス	型	説明
アイテム		number

oldestScheduledCheckRun

名前	パス	型	説明
アイテム		number

privateLocationsMetricsHistoryResponseSchema

名前	パス	型	説明
タイムスタンプ	timestamps	timestamps
キュー サイズ	queueSize	queueSize	キューのサイズ。
oldestScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

タグを確認します。

名前	パス	型	説明
アイテム		string

ReportingAggregate

名前	パス	型	説明
成功率	successRatio	number	選択した日付範囲に対するチェックの成功率。 パーセンテージは 10 進形式です。
平均	avg	number	選択した日付範囲に対するチェックの平均応答時間 (ミリ秒)。
P95	p95	number	選択した日付範囲に対するチェックの P95 応答時間 (ミリ秒)。
P99	p99	number	選択した日付範囲に対するチェックの P99 応答時間 (ミリ秒単位)。

レポーティング

名前	パス	型	説明
名前	name	string	名前を確認します。
ID を確認する	checkId	string	ID を確認します。
種類の確認	checkType	string	種類を確認します。
Deactivated	deactivated	boolean	非アクティブ化を確認します。
レポート タグ リスト	tags	ReportingTagList	タグを確認します。
集約	aggregate	ReportingAggregate

ReportingList

名前	パス	型	説明
アイテム		Reporting

ランタイム

名前	パス	型	説明
名前	name	string	このランタイムの一意の名前。
段階	stage	string	ランタイムの現在のライフ ステージ。
ランタイムの有効期間終了	runtimeEndOfLife	string	ランタイムがプラットフォームから削除される日付。
既定値	default	boolean	これが Checkly によって提供される現在の既定のランタイムであるかどうかを示します。
Description	description	string	このランタイムの主要な更新プログラムについて、人間が判読できる短い説明。
String	dependencies.string	string	文字列。

RuntimeList

名前	パス	型	説明
アイテム		Runtime

抜粋

名前	パス	型	説明
ID	id	number	識別子。
名前	name	string	スニペット名。
スクリプト	script	string	API チェックライフサイクルと対話する Node.js コード、またはブラウザー チェックの一部として機能します。
Created At	created_at	date-time	作成時に指定します。
更新日時	updated_at	date-time	更新日時:

SnippetList

名前	パス	型	説明
アイテム		Snippet

CheckGroupTrigger

名前	パス	型	説明
ID	id	number	識別子。
トークン	token	string	トークン。
Created At	created_at	date	作成時に指定します。
[呼び出し位置]	called_at	date	呼び出されたとき。
更新日時	updated_at	date	更新日時:
グループ識別子	groupId	number	グループ識別子。

CheckTrigger

名前	パス	型	説明
ID	id	number	識別子。
トークン	token	string	トークン。
Created At	created_at	date	作成時に指定します。
[呼び出し位置]	called_at	date	呼び出されたとき。
更新日時	updated_at	date	更新日時:
ID を確認する	checkId	string	チェック識別子。

オブジェクト

これは型 'object' です。

文字列

これは基本的なデータ型 'string' です。