screenRIG
登录开始使用

API 参考

警报 API

警报：未解决的屏幕问题、确认、暂缓与静音

HTTP 参考。 由后端契约生成。浏览以下端点或下载 OpenAPI。

OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览

此分组有 6 个操作，由 api/openapi.yaml 生成。可按路径、操作或认证筛选。每个端点都会列出其输入；展开后可查看请求模板和响应代码。模板需要您自己的值和符合架构的请求体。

用你的值替换大写占位符。对于JSON请求，请保存符合request.json模式的请求体。Cookie示例使用经过身份验证会话的本地Cookie存储。

警报：未解决的屏幕问题、确认、暂缓与静音

GET/api/alerts

列出警报

列出项目的屏幕警报：每个屏幕和条件在持续期间各有一条（open），以及在套餐的事件保留期内已结束的警报（resolved）。

警报在其条件的事件到达时打开（screen.offline、display_disconnected、temperature_high 或 on_battery 健康变化、screen.storage_shortfall、停滞的 screen.manifest_upgrade、error 级别的 screen.status_changed、判定为停滞、空白或冻结的 screen.glass_changed），并在解除事件到达时解决；crashing 是提醒，不是警报。counts.attention 统计未被确认、暂缓或静音的未解决警报，即控制台显示的数字。

屏幕因后端发出的重启而重启时，在重启完成或发出后十分钟之前，不会开启 screen_offline 或 display_disconnected 警报；届时仍成立的条件会在那一刻开启其警报。未解决的警报在前，最新的在前；翻页时像之前一样传回 next_cursor。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
listAlerts

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
格式查询可选json（默认）以 JSON 返回报告。csv、xlsx 和 pdf 以附件形式返回相同的行（分页报告的每一页，最多 50000 行）。
状态查询可选
screen_id查询可选
before查询可选上一页的 next_cursor。
限制查询可选
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts'

响应

状态含义正文和头部
200一页警报。AlertList (application/json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
GET/api/alerts/{id}

获取警报

一条警报。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
getAlert

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
POST/api/alerts/{id}/acknowledge

确认警报

确认一条未解决的警报：已有人在处理。不带 until 时，警报保持已确认状态，直到解决；带 until（最多 30 天后）时，警报被暂缓，如果届时仍未解决，则在该时间点再次需要关注。在已确认或暂缓期间，通知中关于该警报且仍在保持时间内的提醒会被跳过（acknowledged）。

后一次确认会替换前一次确认。追加 screen.alert_acknowledged。已解决的警报会返回 alert_not_open。

身份验证
projectBearer 或 dashboardSession
请求主体
AlertAcknowledge
操作 ID
acknowledgeAlert

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。

请求主体字段

字段描述
until (可选, string)暂缓到该时间点，最多 30 天后。省略时：保持已确认，直到警报解决。format: "date-time"
请求模板和响应
shell · 请求模板
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)
409alert_not_open.问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
GET/api/alert-mutes

列出警报静音

列出项目中尚未结束的静音，最先结束的排在最前（最多 50 条）。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
listAlertMutes

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
POST/api/alert-mutes

创建警报静音

为维护让屏幕静音，直到某个最多 30 天后的时间点：包括 screen_ids 所指定的屏幕，以及在提醒到期时带有 tags 中任一标签的每个屏幕。它们的警报仍会打开和解决，并标记为 muted，且从不需要关注；每个通知中关于它们的提醒都会被跳过（muted）。

每个组织跨其所有项目最多有 50 条当前有效的静音（alert_mute_limit_reached）。追加 alert_mute.created。

身份验证
projectBearer 或 dashboardSession
请求主体
AlertMuteWrite
操作 ID
createAlertMute

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。

请求主体字段

字段描述
screen_ids (可选, array)
标签（可选，ScreenTags）

设备组选择器标签，0 到 16 个唯一且精确的标签，每个标签符合媒体标签语法。在 ScreenPatch 中，数组替换整个集合，空数组则清空；重复或格式错误的标签为 invalid_request。更改标签会提升屏幕版本（If-Match 保护），并附加 screen.updated，详情见 details.tags；不会更改清单版本。

标签永远不会出现在运行时清单中，也不会用于授权。

until（必填，字符串）最多 30 天后。format: "date-time"
note（可选，字符串）maxLength：200
请求模板和响应
shell · 请求模板
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)
409alert_mute_limit_reached 或 idempotency_mismatch。问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
删除/api/alert-mutes/{id}

删除警报静音

立即结束一条静音，并追加 alert_mute.deleted。

身份验证
projectBearer 或 dashboardSession
请求主体
无
操作 ID
deleteAlertMute

参数

名称发送必需？描述
ScreenRig-Projectheader可选已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。
id路径必填
Idempotency-Keyheader可选省略以进行新操作。提供并重用密钥以去重重试；CLI 自动管理密钥。
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)