Skip to content

v2.0 Wave A: Document job list query parameters #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trivedi-vatsal merged 1 commit into from
Sep 2, 2026
Merged

v2.0 Wave A: Document job list query parameters #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/content/docs/using/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,18 @@ aliases that mirror `PATCH` / `DELETE` for the HTML UI are omitted.

| Method | Path | Purpose |
|---|---|---|
| `GET` | `/api/v1/jobs` | List jobs |
| `GET` | `/api/v1/jobs` | List jobs (`repo`, `status`, `limit`, `offset`) |
| `GET` | `/api/v1/jobs/{id}` | Job detail |
| `GET` | `/api/v1/jobs/{id}/logs` | Full log (session, or shareable opt-in) |
| `POST` | `/api/v1/jobs/{id}/rerun` | New job, new Check Run |
| `POST` | `/api/v1/jobs/{id}/cancel` | Cancel a running job |

`GET /api/v1/jobs` returns `{ "jobs": [...] }`, newest first. Omit `repo` and
`status` to list every job. `repo` is an exact `owner/name`. `status` must be
one of `queued`, `in_progress`, `success`, `failure`, `skipped`, `cancelled`,
`error`; any other value is `400`. `limit` defaults to 100 (max 500). `offset`
skips that many rows.

## Public

| Method | Path | Purpose |
Expand Down