Skip to content

列表 API 查询参数

监控类列表端点共享分页契约:page(默认 1)、per_page(默认 20,上限 100),响应统一为 { items, page, per_page, total }。本页列出各端点的专属过滤参数与取值约定。

GET /api/v1/work-items

参数取值说明
kindissue / pull_request工作项类型
stateopen / closedstate=closed 时默认按 display.closed_limit 设置限量
repository_id仓库 ID限定单仓
reviewapproved / changes_requested / pendingPR 审核结论;pending 映射为尚无审核记录(服务端存空串)
checkpassed / failed / pendingPR 检查状态;passed/failed 分别映射存储值 success/failurepending 匹配空串或 pending
ignoredtrue / all默认仅返回未忽略项;true 仅已忽略,all 含全部

review / check 的组合过滤在 SQL 层完成,分页与 total 均为过滤后结果。

GET /api/v1/notifications/outbox

参数取值说明
statuspending / sending / sent / dead通知投递状态(重试中的条目仍为 pending,由 attempt_count 体现)
channel_type渠道类型(如 telegram服务端解析为渠道 ID 集合后下推 SQL;无匹配渠道时返回空页且分页参数已归一化

POST /api/v1/notifications/outbox/retry-dead

一键重新排队全部失败投递,后端单次 UPDATE 完成(与逐条 POST /notifications/outbox/{id}/retry 同一字段语义:转 pending、立即到期、清空错误码与锁)。

参数取值说明
channel_type渠道类型(如 telegram),可选仅重新排队该渠道的 dead 投递;缺省重试全部渠道

响应 { "status": "queued", "retried": <重新排队条数> }。需管理员 Session 与 CSRF。

GET /api/v1/repositories

参数取值说明
typeinstallation / external仓库来源类型

GET /api/v1/events

参数取值说明
kind事件类型issuepull_requestworkflow_run
repository_id仓库 ID限定单仓

GET /api/v1/workflow-runs

参数取值说明
conclusionworkflow 结论(如 successfailureconclusion 列过滤
repository_id仓库 ID限定单仓

GET /api/v1/security-alerts

参数取值说明
alert_kinddependabot / code_scanning / secret_scanning告警来源
stateopen / dismissed / fixed / withdrawn告警状态;withdrawn(已撤回)由对账检测到源端告警消失后写入

GET /api/v1/starred-releases/trackers

参数取值说明
statetracking / inactive / disabled / unavailableStar Release 追踪状态;inactive(无 Release)默认 7 天复查,disabled 为手动停用

基于 VitePress 构建 · 默认 SQLite,可选 PostgreSQL