API 参考 / audit

审计日志（cursor 分页）· **未上线**

GET /api/v1/projects/{projectId}/audit-logs · listAuditLogs

本端点尚未实现，当前恒返回 501（B-00329）。 它是全仓库唯一还留在 stub_handlers.go 里的 占位实现。合同保留形状是为了把「已声明但未实现」这件事本身写清楚——此前合同只声明 200 + 403、 公开 API 参考页还给出可复制的 curl 示例，而线上实际吐 501，API/Agent 用户按合同调用必然扑空。

项目管理员角色确实带 view_audit 权限，但那目前只在平台运营面的 GET /admin/audit-logs 上兑现（那条正常返回 200）。项目面的这条要等真正实现后再把 501 从本合同移除。

实现后的语义（保留供参考）：需要 view_audit，按 created_at 倒序，cursor 分页。

（不用 deprecated: true 标记：那表示「不要再用了」，与「还没上线」是两回事， 标错会让调用方以为有替代端点。）

鉴权：项目 API Token（Authorization: Bearer wfp_…）。详见 Agent 接入。

listAuditLogs 即将上线

这个接口已经写进 API 合同，但还没有在本环境实现：现在调用会返回 501，不会有数据。合同与字段表可以照常用来预先对接，别把它排进正在跑的流程里。

参数

projectId（必填）
string
limit
integer
cursor
string

响应字段 · 200

items（必填）
AuditLog[]
items[].id（必填）
string
items[].action（必填）
string
items[].actorId（必填）
string
items[].actorName
string
items[].targetType
string
items[].targetId
string
items[].metadata
object
items[].createdAt（必填）
string
nextCursor（必填）
string

错误

请求示例（curl）

curl -X GET "https://你的项目.workflow.games/api/v1/projects/{projectId}/audit-logs?limit=…&cursor=…" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "id": "018f3c2e-0000-7000-8000-000000000000",
      "action": "示例文本",
      "actorId": "018f3c2e-0000-7000-8000-000000000000",
      "createdAt": "示例文本"
    }
  ],
  "nextCursor": "示例文本"
}

合同真值：OpenAPI 3.1（0.1.0）。

相关：Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…