OpenAPI YAMLOpenAPI JSON问题 YAMLAPI 概览
此分组有 4 个操作，由 api/openapi.yaml 生成。可按路径、操作或认证筛选。每个端点都会列出其输入；展开后可查看请求模板和响应代码。模板需要您自己的值和符合架构的请求体。
用你的值替换大写占位符。对于JSON请求，请保存符合request.json模式的请求体。Cookie示例使用经过身份验证会话的本地Cookie存储。
审计日志：每一次配置变更及其变更前和变更后、可验证的哈希链，以及 CSV、XLSX 和 PDF 导出
列出审计日志
按从新到旧列出项目的配置变更：谁在何时通过哪个界面更改了什么，附带字段级的变更前和变更后，所有套餐均保留 400 天。
可按 actor (id)、actor_kind、source、resource_type 和 resource_id、action（精确匹配，或以 * 结尾的前缀）、field（如 /label 的 JSON 指针前缀）以及 since/until 时间窗口筛选；用 cursor 翻页。format 为 csv、xlsx 或 pdf 时，会用报告渲染器将筛选后的日志写成文件（每个已更改字段一行，从旧到新，除非 since 另有指定，否则为最近 30 天；链头和保留下限都在文件中，因此它可作为 audit verify 的锚点）。
机密（令牌、密钥、密码、Webhook 和数据源凭据）显示为 (redacted)；其他所有值都是存储的值。条目由各服务在完成变更的事务中写入；没有任何东西会写入、更新或删除条目。
需要项目权限；仪表板会话以项目所有者、组织管理员或正在查看该项目的员工身份读取它。读取和导出日志属于审计日志，Enterprise 计划包含该功能；计划不含该功能的项目会被拒绝并返回 feature_not_in_plan（402）。每个计划都会记录其更改。
参数
| 名称 | 发送 | 必需？ | 描述 |
|---|---|---|---|
| ScreenRig-Project | header | 可选 | 已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。 |
| 操作者 | 查询 | 可选 | 操作者的 ID（用户、代理或服务客户端）。 |
| actor_kind | 查询 | 可选 | |
| 来源 | 查询 | 可选 | |
| resource_type | 查询 | 可选 | |
| resource_id | 查询 | 可选 | |
| 操作 | 查询 | 可选 | 操作代码，如 screen.update，或前缀，如 playlist.*。 |
| field | 查询 | 可选 | JSON 指针：更改过此成员或其下级成员的条目，例如 /label。 |
| 自从 | 查询 | 可选 | |
| 直到 | 查询 | 可选 | |
| 游标 | 查询 | 可选 | 上一页的 next_cursor，使用相同过滤条件。不透明。 |
| 限制 | 查询 | 可选 | |
| 格式 | 查询 | 可选 | json（默认）以 JSON 返回报告。csv、xlsx 和 pdf 以附件形式返回相同的行（分页报告的每一页，最多 50000 行）。 |
请求模板和响应
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 一页条目，对于 csv、xlsx 和 pdf 则是筛选后日志的文件。 | AuditList (application/json), string (text/csv), string (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), string (application/pdf) |
| 400 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
| 402 | feature_not_in_plan — 审计日志属于 Enterprise 计划；该问题指明功能、账户所在的计划和 required_plan。 | 问题 (application/problem+json) |
| 404 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
| 默认 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
获取审计链头
项目审计链的链头（最后一个已入链条目的 seq 和 hash）、链的起点保留下限，以及等待入链的条目数。请将链头保存为锚点，之后传给 GET /api/audit/verify，以证明此前的历史没有被改写或删除。
这是审计日志功能的一部分，Enterprise 计划包含该功能；计划不含该功能的项目会被拒绝并返回 feature_not_in_plan（402）。
参数
| 名称 | 发送 | 必需？ | 描述 |
|---|---|---|---|
| ScreenRig-Project | header | 可选 | 已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。 |
请求模板和响应
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/head'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 链头。 | AuditHead (application/json) |
| 402 | feature_not_in_plan — 审计日志属于 Enterprise 计划；该问题指明功能、账户所在的计划和 required_plan。 | 问题 (application/problem+json) |
| 404 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
| 默认 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
验证审计日志
在一个范围内重新计算审计哈希链，并报告有问题之处（如果有的话）。
每个已链接条目的哈希都根据其存储的内容重新计算，每个条目必须与前一个条目相链接，seq 必须从保留下限起连续，最后一个条目必须是链头。anchor（来自早先导出或 head 的 SEQ:HASH）还能证明该 seq 处的条目未被更改，且链未在其之下被截断。
一次调用最多检查 5000 个条目；请从 next_seq 开始，用 from_seq 继续。这是审计日志功能的一部分，Enterprise 计划包含该功能；计划不含该功能的项目会被拒绝并返回 feature_not_in_plan（402）。
参数
| 名称 | 发送 | 必需？ | 描述 |
|---|---|---|---|
| ScreenRig-Project | header | 可选 | 已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。 |
| from_seq | 查询 | 可选 | 要检查的第一个链位置。默认为保留的最旧位置。 |
| 限制 | 查询 | 可选 | |
| 锚点 | 查询 | 可选 | 您保存的链头的 SEQ:HASH。 |
请求模板和响应
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/verify'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 验证结果。 | AuditVerifyResult (application/json) |
| 400 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
| 402 | feature_not_in_plan — 审计日志属于 Enterprise 计划；该问题指明功能、账户所在的计划和 required_plan。 | 问题 (application/problem+json) |
| 404 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
| 默认 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
获取审计条目
一个审计条目及其字段级变更。这是审计日志功能的一部分，Enterprise 计划包含该功能；计划不含该功能的项目会被拒绝并返回 feature_not_in_plan（402）。
参数
| 名称 | 发送 | 必需？ | 描述 |
|---|---|---|---|
| ScreenRig-Project | header | 可选 | 已弃用一个版本。必须与 JWT 项目授权保持一致；添加弃用和警告头。无令牌交换。 |
| id | 路径 | 必填 |
请求模板和响应
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/RESOURCE_ID'响应
| 状态 | 含义 | 正文和头部 |
|---|---|---|
| 200 | 条目。 | AuditEntry (application/json) |
| 402 | feature_not_in_plan — 审计日志属于 Enterprise 计划；该问题指明功能、账户所在的计划和 required_plan。 | 问题 (application/problem+json) |
| 404 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |
| 默认 | 稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。 | 问题 (application/problem+json) |