OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 6 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
アラート:スクリーンの未解決の問題、確認、スヌーズ、ミュート
アラート一覧
プロジェクトのスクリーンのアラートを一覧表示します。スクリーンと条件ごとに1件で、継続している間のもの(open)と、プランのイベント保持期間内に終了したもの(resolved)が対象です。
アラートは、その条件のイベントが届いたときに発生し(screen.offline、display_disconnected、temperature_high または on_battery のヘルス変更、screen.storage_shortfall、停滞している screen.manifest_upgrade、エラーレベルの screen.status_changed、判定が停止・空白・固まりの screen.glass_changed)、解消のイベントで解決されます。crashing は通知であり、アラートではありません。counts.attention は、確認済み・スヌーズ中・ミュート中のいずれでもない未解決のアラートの数で、ダッシュボードに表示される数です。
バックエンドが送信した再起動のためにスクリーンが再起動している間、再起動が完了するか送信から10分が経過するまで、screen_offline や display_disconnected のアラートは発生しません。その時点で条件が続いていれば、その瞬間にアラートが発生します。未解決のアラートが新しい順に先頭に来ます。次のページには、これまでどおり next_cursor を渡してください。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| フォーマット | クエリ | オプション | json(既定)はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します(ページ分割されたレポートは全ページ、最大 50000 行)。 |
| 状態 | クエリ | オプション | |
| screen_id | クエリ | オプション | |
| before | クエリ | オプション | 前のページの next_cursor。 |
| 制限 | クエリ | オプション |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | アラートの1ページ分。 | AlertList (application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
アラートを取得
アラート1件。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | アラート。 | Alert (application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
アラートを確認
未解決のアラートを確認します:誰かが対応中です。until を指定しない場合、アラートは解決されるまで確認済みのままです。until を指定した場合(最大30日先まで)はスヌーズされ、その時刻になってもまだ未解決であれば、再び要対応になります。確認済みまたはスヌーズ中は、そのアラートに関する通知の送信のうち、まだ待機時間内にあるものはスキップされます(acknowledged)。
後の確認が先の確認を置き換えます。screen.alert_acknowledged を追加します。解決済みのアラートは alert_not_open です。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| until(任意、string) | この時刻までスヌーズします(最大30日先まで)。省略した場合は、アラートが解決されるまで確認済みになります。format: "date-time" |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/alerts/RESOURCE_ID/acknowledge'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 確認済みのアラート。 | Alert (application/json) |
| 409 | alert_not_open. | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
アラートのミュート一覧
終了していないプロジェクトのミュートを、終了時刻が近い順に一覧表示します(最大50件)。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | プロジェクトの現在のミュート。 | AlertMuteList (application/json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
アラートのミュートを作成
メンテナンスのため、指定した時刻(最大30日先まで)までスクリーンをミュートします。対象は、screen_ids で指定したスクリーンと、通知の送信時点で tags のいずれかが付いているすべてのスクリーンです。これらのスクリーンのアラートは引き続き発生・解決しますが、muted としてマークされ、要対応にはなりません。それらに関する通知の送信はすべてスキップされます(muted)。
組織の現在のミュートは、すべてのプロジェクトを合わせて最大50件です(alert_mute_limit_reached)。alert_mute.created を追加します。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| screen_ids(任意、array) | |
| タグ(オプション、ScreenTags) | フリートセレクタータグ(0〜16件の一意なタグ、各タグはメディアタグ構文に準拠)。ScreenPatch では配列全体が置き換えられ、空配列で全タグがクリアされます。重複や不正なタグはinvalid_requestです。タグを変更するとスクリーンのリビジョンが更新され(If-Matchで保護)、screen.updatedにdetails.tagsが追加されます。マニフェストリビジョンは変更されません。 タグはランタイムマニフェストにも認証にも決して含まれません。 |
| until(必須、文字列) | 最大30日先まで。format: "date-time" |
| note(任意、文字列) | maxLength:200 |
リクエストテンプレートとレスポンス
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/alert-mutes'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | 作成されました。 | AlertMute (application/json) |
| 409 | alert_mute_limit_reached または idempotency_mismatch。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
アラートのミュートを削除
ミュートを今すぐ終了し、alert_mute.deleted を追加します。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| Idempotency-Key | ヘッダー | オプション | 新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。 |
リクエストテンプレートとレスポンス
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 204 | 終了しました。 | 本文なし |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |