API reference

On this page 240

Every endpoint this instance declares under /api, 194 of them, generated from the actions that implement them rather than written beside them. A hand-written reference is a second description of the same thing, and the second one is the one that goes stale.

Authentication is a bearer token unless an endpoint says otherwise:

curl -H "Authorization: Bearer $TOKEN" "$SERVER/api/repos/workflow-runs?owner=you&repo=yours"

A token carries scopes, and a repository the token cannot reach answers 404 rather than 403 - saying "forbidden" would confirm that a private repository exists.

204 of the 216 operations below declare their inputs on the action, and this page lists them. The rest validate inside the handler, so the page names the action instead of guessing - that number going up is the work, and a test holds it from going down.

Generated from OpenAPI 1.0.0.

Audit

`GET /api/audit`

Name	In	Required	Type
`organization_id`	query	optional	number
`actor_id`	query	optional	number
`owner`	query	optional	string
`repo`	query	optional	string
`action`	query	optional	string
`since`	query	optional	string
`until`	query	optional	string
`limit`	query	optional	number
`before`	query	optional	number
`format`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Auth

`POST /api/auth/atproto`

Name	In	Required	Type
`identifier`	body	required	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/auth/atproto/callback`

Name	In	Required	Type
`state`	query	optional	string
`code`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/auth/login`

Name	In	Required	Type
`code`	body	optional	string
`email`	body	optional	string
`next`	body	optional	string
`passkey`	body	optional	string
`password`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/auth/logout`

Inputs are not declared on Actions/Auth/LogoutAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/auth/password/reset`

Name	In	Required	Type
`email`	body	optional	string
`operation`	body	optional	string
`password`	body	optional	string
`token`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/auth/register`

Name	In	Required	Type
`email`	body	optional	string
`handle`	body	optional	string
`name`	body	optional	string
`next`	body	optional	string
`password`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/auth/sso`

Name	In	Required	Type
`code`	query	optional	string
`next`	query	optional	string
`state`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/auth/verify`

Name	In	Required	Type
`id`	query	optional	number
`token`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/auth/verify/resend`

Name	In	Required	Type
`id`	body	optional	number
`token`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/auth/{provider}`

Name	In	Required	Type
`provider`	path	required	string
`next`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/auth/{provider}/callback`

Name	In	Required	Type
`provider`	path	required	string
`code`	query	optional	string
`state`	query	optional	string
`error`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/auth/{provider}/callback`

Name	In	Required	Type
`provider`	path	required	string
`code`	body	optional	string
`state`	body	optional	string
`error`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Discover

`GET /api/discover`

Name	In	Required	Type
`before`	query	optional	number

Status	Means
`200`	The newest events first, and the cursor to ask for the ones before them.
`422`	Validation failed
`500`	Server error

Explore

`GET /api/explore`

Name	In	Required	Type
`topic`	query	optional	string
`language`	query	optional	string
`days`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Featured

`GET /api/featured`

Name	In	Required	Type
`limit`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Feed

`GET /api/feed`

Name	In	Required	Type
`before`	query	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Gh

`POST /api/gh/repos/{owner}/{repo}/issues/{number}/comments`

Name	In	Required	Type
`owner`	path	required	string
`repo`	path	required	string
`number`	path	required	string
`owner`	body	optional	string
`repo`	body	optional	string
`resource`	body	optional	string
`sha`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`201`	Created, in the shape Octokit expects: an id and the fields it sent back.
`401`	No credential, or one this instance does not recognise.
`404`	No such repository, or a resource this surface does not implement - the body names the three that exist.
`422`	Missing something GitHub would require too: `head_sha`, `state`, or `body`.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/gh/repos/{owner}/{repo}/statuses/{sha}`

Name	In	Required	Type
`owner`	path	required	string
`repo`	path	required	string
`sha`	path	required	string
`owner`	body	optional	string
`repo`	body	optional	string
`resource`	body	optional	string
`sha`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`201`	Created, in the shape Octokit expects: an id and the fields it sent back.
`401`	No credential, or one this instance does not recognise.
`404`	No such repository, or a resource this surface does not implement - the body names the three that exist.
`422`	Missing something GitHub would require too: `head_sha`, `state`, or `body`.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/gh/repos/{owner}/{repo}/{resource}`

Name	In	Required	Type
`owner`	path	required	string
`repo`	path	required	string
`resource`	path	required	string
`owner`	body	optional	string
`repo`	body	optional	string
`resource`	body	optional	string
`sha`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`201`	Created, in the shape Octokit expects: an id and the fields it sent back.
`401`	No credential, or one this instance does not recognise.
`404`	No such repository, or a resource this surface does not implement - the body names the three that exist.
`422`	Missing something GitHub would require too: `head_sha`, `state`, or `body`.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Health

`GET /api/health`

Name	In	Required	Type
`quick`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Insight

`GET /api/insight`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`days`	query	optional	number

Status	Means
`200`	The window, and every figure the operator screens show.
`404`	No such repository, or the caller may not read the instance-wide numbers.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Instance

`POST /api/instance/admin`

Name	In	Required	Type
`operation`	body	optional	string
`handle`	body	optional	string
`search`	body	optional	string
`id`	body	optional	number
`limit`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/instance/fleet`

Name	In	Required	Type
`operation`	body	optional	string
`name`	body	optional	string
`slug`	body	optional	string
`labels`	body	optional	string
`reason`	body	optional	string
`pool`	body	optional	number
`queue`	body	optional	number
`runner`	body	optional	number
`repository`	body	optional	number
`force`	body	optional	boolean
`required`	body	optional	boolean
`plugin`	body	optional	string
`allowlist`	body	optional	string
`capabilities`	body	optional	string
`pinned`	body	optional	boolean
`token`	body	optional	number
`expires`	body	optional	string
`user`	body	optional	number
`key`	body	optional	string
`value`	body	optional	string

Status	Means
`200`	The fleet as it now stands.
`404`	Not an administrator. The endpoint does not admit it exists.
`422`	The operation needs something it was not given.
`500`	Server error

`POST /api/instance/settings`

Name	In	Required	Type
`key`	body	optional	string
`value`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Mcp

`POST /api/mcp`

Inputs are not declared on Mcp/McpAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Metrics

`GET /api/metrics`

Inputs are not declared on Actions/Ops/MetricsAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Mirrors

`POST /api/mirrors/sync`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/mirrors/webhook`

Inputs are not declared on Actions/Mirror/MirrorWebhookAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Og

`GET /api/og`

Name	In	Required	Type
`path`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Openapi.json

`GET /api/openapi.json`

Inputs are not declared on Actions/Api/OpenApiAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Operations

`GET /api/operations/{id}`

Name	In	Required	Type
`id`	path	required	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/operations/{id}/cancel`

Name	In	Required	Type
`id`	path	required	string
`id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Orgs

`DELETE /api/orgs`

Name	In	Required	Type
`confirm`	query	optional	string
`organization_id`	query	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs`

Name	In	Required	Type
`billing_email`	body	optional	string
`description`	body	optional	string
`handle`	body	optional	string
`name`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/orgs`

Name	In	Required	Type
`handle`	body	optional	string
`organization_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/delete`

Name	In	Required	Type
`confirm`	body	optional	string
`organization_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/machine-accounts`

Name	In	Required	Type
`handle`	body	optional	string
`name`	body	optional	string
`organization_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`DELETE /api/orgs/members`

Name	In	Required	Type
`organization_id`	query	optional	custom
`user_id`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/members`

Name	In	Required	Type
`handle`	body	optional	string
`organization_id`	body	optional	custom
`role`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/members/accept`

Name	In	Required	Type
`operation`	body	optional	string
`organization_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/members/remove`

Name	In	Required	Type
`organization_id`	body	optional	custom
`user_id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/members/role`

Name	In	Required	Type
`organization_id`	body	optional	custom
`role`	body	optional	string
`user_id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/orgs/members/role`

Name	In	Required	Type
`organization_id`	body	optional	custom
`role`	body	optional	string
`user_id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/teams`

Name	In	Required	Type
`description`	body	optional	string
`name`	body	optional	string
`operation`	body	optional	string
`organization_id`	body	optional	custom
`parent_team_id`	body	optional	custom
`slug`	body	optional	string
`team_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/teams/members`

Name	In	Required	Type
`operation`	body	optional	string
`role`	body	optional	string
`team_id`	body	optional	custom
`user_id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/orgs/tokens`

Name	In	Required	Type
`organization_id`	query	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/orgs/update`

Name	In	Required	Type
`handle`	body	optional	string
`organization_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Owners

`GET /api/owners`

Name	In	Required	Type
`owner`	query	required	string
`q`	query	optional	string
`page`	query	optional	number
`per_page`	query	optional	number

Status	Means
`200`	The owner, one page of their repositories, and their profile README when they have written one.
`404`	No account or organization with that handle. An alias that has moved answers this too; follow `/{handle}` for the redirect.
`422`	Validation failed
`500`	Server error

Repos

`DELETE /api/repos`

Name	In	Required	Type
`owner`	query	required	string
`repo`	query	optional	string
`repository`	query	optional	string
`confirm`	query	optional	string

Status	Means
`200`	Deleted: the row and the repository on disk, together.
`401`	Unauthenticated.
`403`	Not yours to delete.
`404`	No such repository, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	The confirmation did not match the repository name. Deleting a repository takes the name, typed.
`500`	Server error

`POST /api/repos`

Name	In	Required	Type
`owner`	body	optional	string
`default_branch`	body	optional	string
`description`	body	optional	string
`gitignore`	body	optional	string
`host`	body	optional	string
`license`	body	optional	string
`license_holder`	body	optional	string
`name`	body	optional	string
`readme`	body	optional	custom
`visibility`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`allow_merge_commit`	body	optional	custom
`allow_rebase_merge`	body	optional	custom
`allow_squash_merge`	body	optional	custom
`default_branch`	body	optional	string
`default_merge_strategy`	body	optional	string
`delete_branch_on_merge`	body	optional	custom
`description`	body	optional	string
`homepage`	body	optional	string
`is_archived`	body	optional	custom
`is_template`	body	optional	custom
`name`	body	optional	string
`visibility`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/archive`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`format`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/attachments`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/badge`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`workflow`	query	optional	string
`branch`	query	optional	string
`label`	query	optional	string

Status	Means
`200`	The badge, as SVG. Grey `unknown` when there is nothing to report, whatever the reason.
`304`	Nothing has changed since the `ETag` the caller sent.
`422`	Validation failed
`500`	Server error

`GET /api/repos/blame`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`limit`	query	optional	number
`path`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/blob`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`path`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/blob/rows`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`count`	query	optional	number
`from`	query	optional	custom
`path`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/branches`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/checks`

Name	In	Required	Type
`owner`	query	required	string
`repository`	query	optional	string
`sha`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	Every check on the commit, and the one state that follows from them.
`401`	No credential, or one this instance does not recognise.
`404`	No such repository, or one this caller may not see - deliberately the same answer, because distinguishing them tells a stranger that a private repository exists.
`422`	Neither a commit sha nor a pull request number was named.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/checks`

Name	In	Required	Type
`owner`	body	required	string
`repository`	body	optional	string
`sha`	body	required	string
`kind`	body	optional	string

Status	Means
`200`	The run as it now stands. `ignored` is present when a late report was refused because a later one had already been recorded - which is not an error from the reporter's side, so it is not answered as one.
`201`	A check run or commit status was created.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	A malformed sha, an unknown state, or a completed run with no conclusion.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/collaborators`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`handle`	body	optional	string
`operation`	body	optional	string
`permission`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/commit`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`ref`	query	optional	string
`sha`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/commits`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`before`	query	optional	string
`limit`	query	optional	number
`path`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/compare`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`base`	query	optional	string
`head`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/coverage`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`sha`	body	required	string
`lcov`	body	optional	string

Status	Means
`200`	Successful response
`201`	The report, as this instance now holds it: the commit and the per-file coverage it will show in a diff.
`401`	Unauthenticated.
`403`	Reporting coverage needs the `checks` scope on a token that can reach this repository.
`404`	No such repository, or none this caller may see.
`413`	The report is larger than this instance accepts. A coverage file that big is usually a whole monorepo reported as one.
`422`	A full commit sha is required, and the body has to read as lcov. A truncated upload fails here rather than becoming a diff with no coverage.
`500`	Server error

`POST /api/repos/delete`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`confirm`	body	optional	string

Status	Means
`200`	Deleted: the row and the repository on disk, together.
`401`	Unauthenticated.
`403`	Not yours to delete.
`404`	No such repository, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	The confirmation did not match the repository name. Deleting a repository takes the name, typed.
`500`	Server error

`POST /api/repos/deploy-keys`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`can_write`	body	optional	string
`id`	body	optional	number
`key`	body	optional	string
`operation`	body	optional	string
`title`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/deployments`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`environment`	body	optional	string
`sha`	body	optional	string
`ref`	body	optional	string
`url`	body	optional	string
`state`	body	optional	string
`description`	body	optional	string
`stages`	body	optional	string
`health`	body	optional	string
`pull_request`	body	optional	number
`run`	body	optional	number
`reason`	body	optional	string
`id`	body	optional	number
`limit`	body	optional	number

Status	Means
`200`	The deployments this repository has, newest first.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	A deployment needs an environment and a commit.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/dispatches`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`event_type`	body	optional	string

Status	Means
`200`	Successful response
`201`	The runs that were created. An event type no workflow watches creates none, which is not an error.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	The event type is missing, too long, or the payload is not an object.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/environments`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`name`	body	optional	string
`wait_minutes`	body	optional	number
`require_checks`	body	optional	boolean
`branches`	body	optional	string
`description`	body	optional	string
`reviewer`	body	optional	string

Status	Means
`200`	The environments, or the one that changed.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such environment here, or no such person.
`422`	A name is required, and a wait timer is minutes.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/forks`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`to`	body	optional	string

Status	Means
`200`	Successful response
`201`	The fork, with its own owner and name.
`401`	Unauthenticated.
`404`	No such repository, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`409`	The destination owner already has a repository with that name.
`422`	Validation failed
`500`	Server error

`GET /api/repos/issues`

Name	In	Required	Type
`owner`	query	required	string
`repo`	query	optional	string
`repository`	query	optional	string
`state`	query	optional	string
`sort`	query	optional	string
`direction`	query	optional	string
`labels`	query	optional	string
`label`	query	optional	string
`assignee`	query	optional	string
`author`	query	optional	string
`milestone`	query	optional	string
`q`	query	optional	string
`search`	query	optional	string
`limit`	query	optional	number
`cursor`	query	optional	string

Status	Means
`200`	A page of issues, and the cursor for the next. `next` is null on the last page rather than a cursor that returns nothing.
`404`	No such repository or issue, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	Validation failed
`500`	Server error

`POST /api/repos/issues`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`title`	body	required	string
`body`	body	optional	string
`labels`	body	optional	array
`milestone_id`	body	optional	number

Status	Means
`200`	Successful response
`201`	The issue, with the number it was given.
`401`	Unauthenticated.
`404`	No such repository or issue, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	A title is required. An issue with no title is a row nobody can find again.
`500`	Server error

`PUT /api/repos/issues`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`body`	body	optional	string
`title`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/issues/assignees`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`number`	body	required	number
`assignees`	body	optional	array

Status	Means
`200`	The assignees as they now stand.
`401`	Unauthenticated.
`403`	Assigning somebody needs write access to the repository.
`404`	No such repository or issue, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	Validation failed
`500`	Server error

`POST /api/repos/issues/bulk`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`label`	body	optional	string
`milestone_id`	body	optional	number
`numbers`	body	optional	string
`operation`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`DELETE /api/repos/issues/comments`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`comment_id`	query	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/issues/comments`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`number`	body	required	number
`body`	body	required	string

Status	Means
`200`	Successful response
`201`	The comment, rendered.
`401`	Unauthenticated.
`403`	The issue is locked, and this caller is not somebody who may comment on a locked issue.
`404`	No such repository or issue, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	An empty comment. Nothing is not a remark.
`500`	Server error

`PUT /api/repos/issues/comments`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`body`	body	optional	string
`comment_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/issues/labels`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`number`	body	required	number
`labels`	body	optional	array

Status	Means
`200`	The labels as they now stand.
`401`	Unauthenticated.
`403`	Labelling needs write access to the repository.
`404`	No such repository or issue, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	Validation failed
`500`	Server error

`PUT /api/repos/issues/lock`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`number`	body	required	number
`locked`	body	optional	boolean

Status	Means
`200`	Whether the issue is now locked.
`401`	Unauthenticated.
`403`	Locking a conversation needs write access to the repository.
`404`	No such repository or issue, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	Validation failed
`500`	Server error

`PUT /api/repos/issues/milestone`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`milestone`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/issues/reactions`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`comment_id`	body	optional	custom
`content`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/issues/state`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`reason`	body	optional	string
`state`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/issues/tasks`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`checked`	body	optional	string
`comment_id`	body	optional	custom
`expected`	body	optional	string
`index`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/labels`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`color`	body	optional	string
`description`	body	optional	string
`id`	body	optional	number
`name`	body	optional	string
`operation`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/media`

Name	In	Required	Type
`owner`	query	required	string
`repo`	query	optional	string
`repository`	query	optional	string
`ref`	query	optional	string
`path`	query	required	string

Status	Means
`200`	The image, with the type its bytes say it is.
`404`	No such repository or file, or the file is not an image of a kind this serves. A private repository answers this rather than 403.
`413`	The file is larger than this endpoint will buffer. It is still available through `/repos/raw` as a download.
`422`	Validation failed
`500`	Server error
`503`	Too many git processes are already running. Try again shortly.

`POST /api/repos/milestones`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`description`	body	optional	string
`due_on`	body	optional	string
`id`	body	optional	number
`operation`	body	optional	string
`title`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pages`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`enabled`	body	optional	boolean
`source_branch`	body	optional	string
`domain`	body	optional	string
`visibility`	body	optional	string

Status	Means
`200`	The site’s settings and what is currently live.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`409`	Another repository already claims that domain.
`422`	The instance serves no Pages host, or the domain is not a domain.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/protected-branches`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`pattern`	body	optional	string
`allow_deletion`	body	optional	custom
`allow_force_push`	body	optional	custom
`dismiss_stale_reviews`	body	optional	custom
`require_conversation_resolution`	body	optional	custom
`require_human_approval_for_agents`	body	optional	custom
`require_linear_history`	body	optional	custom
`required_approvals`	body	optional	custom
`required_checks`	body	optional	custom
`require_up_to_date`	body	optional	custom
`enforce_admins`	body	optional	custom
`push_restrictions`	body	optional	custom
`push_restrictions_users`	body	optional	custom
`push_restrictions_teams`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`state`	query	optional	string
`author`	query	optional	string
`base`	query	optional	string
`per_page`	query	optional	number
`cursor`	query	optional	string
`fields`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`title`	body	required	string
`head`	body	required	string
`base`	body	optional	string
`body`	body	optional	string
`draft`	body	optional	boolean

Status	Means
`200`	Successful response
`201`	The pull request, with the number it was given.
`401`	Unauthenticated.
`404`	No such repository or pull request, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`409`	An open pull request from this head to this base already exists. Two of them would be two conversations about one change.
`422`	A title and a head branch are required, the head must exist, and it cannot be the base.
`500`	Server error

`PUT /api/repos/pulls`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/auto-merge`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`strategy`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/auto-merge/disarm`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/comments`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`path`	body	optional	string
`line`	body	optional	number
`side`	body	optional	string
`start_line`	body	optional	number
`body`	body	optional	string
`thread_id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/diff/blame`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`line`	query	optional	number
`path`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/diff/conflicts`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/diff/context`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`from`	query	optional	custom
`layout`	query	optional	string
`offset`	query	optional	custom
`path`	query	optional	string
`to`	query	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/diff/interdiff`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`path`	query	optional	string
`since`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/diff/manifest`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`highlight`	query	optional	string
`layout`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/diff/rows`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`from`	query	optional	string
`highlight`	query	optional	string
`layout`	query	optional	string
`open`	query	optional	string
`to`	query	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/diff/structured`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`path`	query	optional	string
`per_page`	query	optional	number
`offset`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/last-look`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/live`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/merge`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`number`	body	required	number
`strategy`	body	optional	string
`subject`	body	optional	string
`body_text`	body	optional	string

Status	Means
`200`	Merged, with the sha it landed as.
`401`	Unauthenticated.
`403`	Merging needs write access, and a protected branch may need more than that.
`404`	No such repository or pull request, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`409`	The merge did not apply: a conflict, or a head that moved since the check.
`422`	Unknown strategy, or one this repository does not allow.
`500`	Server error

`POST /api/repos/pulls/merge-stack`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`strategy`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/mergeability`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`force`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/restore-branch`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/review-requests`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`number`	body	required	number
`reviewer_id`	body	required	number
`reviewer_type`	body	optional	string

Status	Means
`200`	Successful response
`201`	The request. Asking twice is not an error and does not ask twice.
`401`	Unauthenticated.
`403`	Requesting a review needs access to the repository.
`404`	No such repository or pull request, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	A reviewer is a user or a team, and has to be one that exists.
`500`	Server error

`GET /api/repos/pulls/review-state`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/pulls/review-state/draft`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/review-state/since`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`since`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/review-state/stale`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/pulls/review-state/viewed`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`path`	body	optional	string
`viewed`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/pulls/reviews`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`state`	body	optional	string
`body`	body	optional	string
`comments`	body	optional	array

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/pulls/reviews/dismiss`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`reason`	body	optional	string
`review_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/show`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`fields`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/stack`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/pulls/state`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`state`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/pulls/suggested-reviewers`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/pulls/threads`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`resolved`	body	optional	string
`thread_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/raw`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`inline`	query	optional	string
`path`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/releases`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/releases`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`body`	body	optional	string
`is_draft`	body	optional	custom
`is_prerelease`	body	optional	string
`name`	body	optional	string
`operation`	body	optional	string
`tag_name`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/releases/assets`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`name`	query	optional	string
`ref`	query	optional	string
`tag_name`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/releases/assets`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`tag_name`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/repair-settings`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`enabled`	body	optional	boolean
`forbidden_paths`	body	optional	string
`steps`	body	optional	string
`max_attempts`	body	optional	number
`max_minutes`	body	optional	number
`max_cost`	body	optional	number

Status	Means
`200`	The effective policy: the defaults, with this repository's row merged over them.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	A budget below zero, which is a ceiling that can never be met.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/search`

Name	In	Required	Type
`owner`	query	required	string
`repository`	query	optional	string
`q`	query	required	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/secrets`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`scope`	body	optional	string
`reference`	body	optional	string
`environment`	body	optional	string
`key`	body	optional	string
`value`	body	optional	string

Status	Means
`200`	The names that exist, their scopes, and when each was last set. Never a value.
`401`	No credential, or one this instance does not recognise.
`403`	An instance-wide or owner-wide secret is not a repository administrator's to set.
`404`	No environment by that name here.
`422`	A name and a value are required, and the name has to be usable in a shell.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/settings`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`allow_merge_commit`	body	optional	custom
`allow_rebase_merge`	body	optional	custom
`allow_squash_merge`	body	optional	custom
`default_branch`	body	optional	string
`default_merge_strategy`	body	optional	string
`delete_branch_on_merge`	body	optional	custom
`description`	body	optional	string
`homepage`	body	optional	string
`is_archived`	body	optional	custom
`is_template`	body	optional	custom
`name`	body	optional	string
`visibility`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/stars`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string

Status	Means
`200`	The star was added or removed. `starred` says which, and `stars` is the count after it.
`302`	A browser form was answered with a redirect back to the page it came from. Scripts get the JSON above.
`401`	Unauthenticated. A star belongs to somebody.
`404`	No such repository, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	Validation failed
`500`	Server error

`GET /api/repos/tags`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/teams`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`permission`	body	optional	string
`team_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/tests`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`view`	query	optional	string
`suite`	query	optional	string
`branch`	query	optional	string
`run`	query	optional	number
`test`	query	optional	number
`state`	query	optional	string
`limit`	query	optional	number
`cursor`	query	optional	number

Status	Means
`200`	The rows asked for, newest first, with the cursor for the next page. `next` is null on the last one rather than a cursor that returns nothing.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	A view this instance does not have, or a page size outside what it will serve.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/tests/ingest`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`suite`	body	optional	string
`sha`	body	optional	string
`branch`	body	optional	string
`key`	body	optional	string
`format`	body	optional	string
`report`	body	optional	string

Status	Means
`200`	What was recorded, and the verdict this instance reaches once muted failures are set aside.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	The report could not be read. `reason` says what was wrong with it.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/tests/manage`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`suite`	body	optional	string
`test`	body	optional	number
`reason`	body	optional	string
`review`	body	optional	string
`who`	body	optional	string
`limit`	body	optional	number

Status	Means
`200`	The tests, or the one that changed.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such test in this repository, or none this caller may see.
`422`	A mute needs a reason and a review date.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/tests/monitors`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`monitor`	body	optional	number
`suite`	body	optional	string
`condition`	body	optional	string
`threshold`	body	optional	number
`window_days`	body	optional	number
`enabled`	body	optional	boolean

Status	Means
`200`	The monitors, or the one that changed, or what an evaluation found.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such monitor in this repository.
`422`	A threshold that means nothing for the chosen condition.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/tests/split`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`suite`	body	optional	string
`nodes`	body	optional	number
`index`	body	optional	number

Status	Means
`200`	The items this node should run, and a note when the split had little to work with.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	Nothing to split, or a node index outside the fleet.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/topics`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`topics`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/repos/topics`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`topics`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/transfer`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`to`	body	optional	string
`new_owner`	body	optional	string

Status	Means
`200`	Transferred. The repository is now under the new owner, and its old path redirects.
`401`	Unauthenticated.
`403`	Not yours to transfer, or not somewhere you may transfer it to.
`404`	No such repository, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	Validation failed
`500`	Server error

`GET /api/repos/tree`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`path`	query	optional	string
`ref`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/repos/variables`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`scope`	body	optional	string
`key`	body	optional	string
`value`	body	optional	string

Status	Means
`200`	Every effective variable, what set it, and what it overrode.
`401`	No credential, or one this instance does not recognise.
`403`	Only an administrator sets an instance-wide variable.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	A key is required, and the workflow level is the file rather than a row.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/watches`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`subscription`	body	optional	string

Status	Means
`200`	The subscription as it now stands.
`302`	A browser form was answered with a redirect back to the page it came from. Scripts get the JSON above.
`401`	Unauthenticated.
`404`	No such repository, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	The subscription is not one of `all`, `participating` or `ignore`.
`500`	Server error

`PUT /api/repos/watches`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`subscription`	body	optional	string

Status	Means
`200`	The subscription as it now stands.
`302`	A browser form was answered with a redirect back to the page it came from. Scripts get the JSON above.
`401`	Unauthenticated.
`404`	No such repository, or none this caller may see. A private repository answers this rather than 403, because a 403 confirms it exists.
`422`	The subscription is not one of `all`, `participating` or `ignore`.
`500`	Server error

`POST /api/repos/webhooks`

Name	In	Required	Type
`owner`	body	required	string
`repo`	body	optional	string
`repository`	body	optional	string
`operation`	body	optional	string
`id`	body	optional	number
`url`	body	optional	string
`secret`	body	optional	string
`content_type`	body	optional	string
`active`	body	optional	boolean
`limit`	body	optional	number
`events`	body	optional	custom

Status	Means
`200`	The webhook as it now stands, or its recent deliveries when `operation` is `deliveries`.
`201`	The webhook, with the secret shown once.
`401`	Unauthenticated.
`403`	Managing webhooks needs administration access to the repository.
`404`	No such repository or webhook, or none this caller may see.
`422`	A URL this instance will not deliver to, or an event name it does not send. The SSRF policy refuses loopback and private ranges unless the operator allowed the host.
`500`	Server error

`POST /api/repos/webhooks/redeliver`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`delivery_id`	body	optional	custom

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/repos/workflow-metrics`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`workflow`	query	optional	number
`days`	query	optional	number

Status	Means
`200`	The aggregate numbers, with the window they are of.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-notifications`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`user`	body	optional	string
`workflow`	body	optional	string
`branch`	body	optional	string
`job`	body	optional	string
`condition`	body	optional	string
`id`	body	optional	number

Status	Means
`200`	The rules this repository now has.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	The rule is missing something, or names a condition this instance does not have.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflow-runs`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`state`	query	optional	string
`branch`	query	optional	string
`sha`	query	optional	string
`workflow`	query	optional	number
`per_page`	query	optional	number
`cursor`	query	optional	string

Status	Means
`200`	Runs, newest first, with the cursor for the next page. `next` is null on the last one rather than a cursor that returns nothing.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	A state this instance does not have, answered with the list of the ones it does.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-runs/approve`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`job`	body	optional	custom

Status	Means
`200`	The gate as it now stands, and the run's state after it.
`303`	A browser gets its run page back; the same action serves the interface.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`409`	That job is not waiting for anybody: it never was a gate, or somebody already opened it.
`422`	A field the gate declared is missing or is not one of its options.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-runs/approve-fork`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`decision`	body	optional	string

Status	Means
`200`	The run as it now stands.
`303`	A browser gets its run page back; the same action serves the interface.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`409`	That run is not waiting for a decision: it never was held, or somebody has already decided.
`422`	The decision is `approve` or `refuse`.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflow-runs/artifact`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`id`	query	required	number

Status	Means
`200`	The bytes, as an attachment. X-Artifact-Digest carries the SHA-256 a client can check them against.
`401`	No credential, or one this instance does not recognise.
`404`	No such repository, no such artifact, or one belonging to a repository this caller may not see - deliberately the same answer.
`410`	The artifact expired. The row is gone and so are the bytes; the date was in every listing that ever showed it.
`422`	Validation failed
`500`	Server error

Response headers: X-Artifact-Digest.

`GET /api/repos/workflow-runs/artifacts`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`q`	query	optional	string

Status	Means
`200`	Every artifact this run still holds, with the digest to check a download against and the date each one stops being available.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or no run with that number.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflow-runs/artifacts/archive`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	A tar archive of every artifact this run still holds.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, no such run, or a run with nothing in it.
`410`	The rows are here but the bytes are gone, which is a disk that lost them rather than a run that produced nothing.
`413`	The set is larger than this instance will assemble in one archive. The individual downloads still work.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-runs/cancel`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`reason`	body	optional	string

Status	Means
`200`	The run as it now stands. `cancelled` is false when it had already finished, which is not an error: cancelling something that ended a moment ago is an ordinary thing to do.
`303`	A browser gets its run page back. The same action serves the interface, so it answers HTML callers with a redirect.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`409`	The run is in a state that cannot be cancelled.
`422`	No run number was named.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-runs/cancel-job`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`job`	body	optional	string
`reason`	body	optional	string

Status	Means
`200`	The job as it now stands, and what the run became.
`303`	A browser gets its run page back.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	No run number, or no job name.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-runs/event`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`event`	body	optional	string
`payload`	body	optional	string
`key`	body	optional	string

Status	Means
`200`	The event as recorded, and how many waiting jobs it ended. A repeat of a key already seen answers the same way rather than delivering twice.
`303`	A browser gets its run page back; the same action serves the interface.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	No event name, or a payload that is not an object.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflow-runs/log`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`job`	query	required	number
`after`	query	optional	number
`attempt`	query	optional	number

Status	Means
`200`	The job output after the cursor, and the cursor to pass next time. Unchanged when there is nothing new, rather than an empty page that looks like the end.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or a job that is not this one's - the job id is a number anybody can increment.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflow-runs/log-image`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number
`artifact`	query	optional	string

Status	Means
`200`	The image, inline, with the type its bytes say it is.
`404`	No artifact of that name in this run.
`410`	The artifact expired, or its stored copy is gone.
`415`	The bytes are not a format this will render in place. SVG is refused whatever it contains.
`422`	Validation failed
`500`	Server error

`POST /api/repos/workflow-runs/pause`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`action`	body	optional	string

Status	Means
`200`	The run as it now stands. `changed` is false when it was already in that state, which is not an error: two people pressing the same button is an ordinary afternoon.
`303`	A browser gets its run page back; the same action serves the interface.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`409`	A run that has finished, or one on its way out through a cancellation, cannot be held.
`422`	No run number was named.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-runs/rerun`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`number`	body	optional	number
`scope`	body	optional	string
`job`	body	optional	string
`step`	body	optional	string

Status	Means
`200`	The run, now on a new attempt, and how many jobs went back into the graph.
`303`	A browser gets its run page back.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`409`	The run has not finished. Two attempts of one job in flight is what the lease exists to prevent.
`422`	Nothing matched the scope: no failures to re-run, or no job by that name.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflow-runs/show`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`number`	query	optional	number

Status	Means
`200`	One run, its jobs and their steps, plus the workflow version it ran - so a reader can tell it from the file as it is today.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or no run with that number.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflow-templates`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`operation`	body	optional	string
`slug`	body	optional	string
`name`	body	optional	string
`description`	body	optional	string
`path`	body	optional	string
`source`	body	optional	string
`template`	body	optional	number
`branch`	body	optional	string
`overwrite`	body	optional	boolean

Status	Means
`200`	The owner's templates, or the commit that applied one.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such template, or no such repository.
`409`	That path already has a workflow, or the branch moved while this was writing.
`422`	The template is not a workflow this instance can run. `problems` says which lines.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflows`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`state`	query	optional	string
`per_page`	query	optional	number
`cursor`	query	optional	string

Status	Means
`200`	The workflows, by path, with the cursor for the next page. `next` is null on the last one rather than a cursor that returns nothing.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`422`	A state this instance does not have, answered with the list of the ones it does.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflows/dispatch`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`workflow`	body	optional	string
`ref`	body	optional	string
`key`	body	optional	string

Status	Means
`200`	Successful response
`201`	The run that was created.
`303`	A browser gets the run list back. The same action serves the interface, so it answers HTML callers with a redirect.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such repository, or one this caller may not see - deliberately the same answer.
`409`	The workflow does not accept `workflow_dispatch`.
`422`	The inputs do not match what the workflow declared. Every problem is listed, not just the first.
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`POST /api/repos/workflows/manage`

Name	In	Required	Type
`owner`	body	optional	string
`repo`	body	optional	string
`workflow`	body	optional	string
`operation`	body	optional	string
`reason`	body	optional	string

Status	Means
`200`	The workflow, and what it will and will not do now.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No workflow by that name or path in this repository.
`409`	That workflow is `removed`: its file is gone from the branch, so there is nothing to enable.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

`GET /api/repos/workflows/show`

Name	In	Required	Type
`owner`	query	optional	string
`repo`	query	optional	string
`workflow`	query	optional	string
`version`	query	optional	number

Status	Means
`200`	The workflow, every version it has had, and the named version's normalized graph.
`401`	No credential, or one this instance does not recognise.
`403`	The caller may see this repository but not do this to it, or their token does not carry the permission.
`404`	No such workflow in this repository, or no version by that id.
`422`	Validation failed
`500`	Server error

Response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Reviews

`GET /api/reviews/queue`

Inputs are not declared on Actions/Pull/ReviewQueueAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

Runner

`POST /api/runner/annotations`

Name	In	Required	Type
`summary`	body	optional	string
`context`	body	optional	string
`append`	body	optional	boolean

Status	Means
`200`	How many annotations were recorded, and the check they belong to.
`401`	The job token is not one this instance issued, or the job is not running.
`409`	The runner speaks a protocol version this server does not.
`422`	Validation failed
`500`	Server error

`POST /api/runner/artifacts`

Takes no parameters.

Status	Means
`200`	Successful response
`201`	The artifact, with the digest a client can check what it downloads against and the date it stops being available.
`401`	No job credential, or one this instance does not recognise.
`404`	The credential names a job whose run has gone.
`409`	This run already has an artifact under that name with different content. Replacing it silently would leave two people holding different files with one name.
`413`	Past the per-artifact or per-run ceiling. The message says which and by how much.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

Response headers: X-Runner-Protocol-Supported.

`POST /api/runner/artifacts/fetch`

Name	In	Required	Type
`name`	body	optional	string

Status	Means
`200`	The bytes, with X-Artifact-Digest so the job can check them.
`401`	No job credential, or one this instance does not recognise.
`404`	This run has no artifact by that name - or it expired, which is the same answer to a job that needed it.
`410`	The row is here but the bytes are gone, which is a disk that lost them rather than a name that was wrong.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

Response headers: X-Artifact-Digest.

`POST /api/runner/caches`

Takes no parameters.

Status	Means
`200`	Successful response
`201`	Stored, with the scope it was actually written to - which is the run's own, whatever the runner assumed.
`401`	No job credential, or one this instance does not recognise.
`403`	The runner named a scope this run may not write to.
`404`	The credential names a job whose run has gone.
`413`	Past the snapshot ceiling. Above it a cache costs more to move than the install it replaces.
`422`	No body, no key, or a digest that is not a sha-256.
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

`GET /api/runner/caches/restore`

Name	In	Required	Type
`key`	query	optional	string

Status	Means
`200`	The archive. `X-Cache-Scope` says whose it was and `X-Cache-Exact` whether it was this run's own rather than the fallback.
`204`	No snapshot for that key. A cold cache is not an error.
`401`	No job credential, or one this instance does not recognise.
`404`	The credential names a job whose run has gone.
`422`	No key.
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

Response headers: X-Cache-Scope, X-Cache-Exact, X-Cache-Digest.

`POST /api/runner/claim`

Takes no parameters.

Status	Means
`200`	Successful response
`401`	No credential, or one this instance does not recognise.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not. The body says which end is behind; every answer carries X-Runner-Protocol-Supported.
`500`	Server error

Response headers: X-Runner-Protocol-Supported.

`GET /api/runner/download`

Name	In	Required	Type
`target`	query	optional	string

Status	Means
`200`	The binary, as an octet stream.
`404`	This instance has not built a runner for that platform, and says which command builds it.
`422`	Validation failed
`500`	Server error

`POST /api/runner/heartbeat`

Name	In	Required	Type
`steps`	body	optional	array

Status	Means
`200`	The renewed lease, and how many step results this call recorded.
`401`	No credential, or one this instance does not recognise.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not. The body says which end is behind; every answer carries X-Runner-Protocol-Supported.
`500`	Server error

Response headers: X-Runner-Protocol-Supported.

`POST /api/runner/logs`

Name	In	Required	Type
`sequence`	body	required	number
`content`	body	optional	string
`stream`	body	optional	string

Status	Means
`200`	Successful response
`401`	No credential, or one this instance does not recognise.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not. The body says which end is behind; every answer carries X-Runner-Protocol-Supported.
`500`	Server error

Response headers: X-Runner-Protocol-Supported.

`POST /api/runner/metadata`

Name	In	Required	Type
`action`	body	optional	string
`key`	body	optional	string
`value`	body	optional	string
`if_version`	body	optional	number

Status	Means
`200`	The value, or everything this run has been told.
`401`	No job credential, or one this instance does not recognise.
`409`	Somebody else wrote this key first. The value that is actually there comes back with the refusal, so a job can merge and try again.
`413`	The value is larger than a value should be. That is a file, and a file is an artifact.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

`POST /api/runner/oidc`

Name	In	Required	Type
`audience`	body	optional	string

Status	Means
`200`	The token and how long it lasts. Present it as a bearer to whatever trusts this instance.
`401`	No job credential, or one this instance does not recognise.
`403`	An untrusted run - a fork's pull request - gets no identity token.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

`POST /api/runner/orchestrator`

Name	In	Required	Type
`sequence`	body	required	number
`kind`	body	optional	string
`name`	body	optional	string

Status	Means
`200`	What to do with this call.
`401`	No job credential, or one this instance does not recognise.
`404`	The credential names a job whose run has gone.
`409`	The program diverged from its journal, or a budget is spent. The run is over and the reason says which.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

`POST /api/runner/orchestrator/result`

Name	In	Required	Type
`entry_id`	body	required	number

Status	Means
`200`	Recorded.
`401`	No job credential, or one this instance does not recognise.
`404`	No such call, or one belonging to another run.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

`POST /api/runner/register`

Name	In	Required	Type
`name`	body	optional	string
`labels`	body	optional	string
`tags`	body	optional	string

Status	Means
`200`	Successful response
`201`	The runner, with its own credential. Shown once; the column holds a hash.
`401`	No registration token, or one that is unknown, revoked or expired.
`422`	Validation failed
`426`	This machine speaks a protocol version the server does not.
`500`	Server error

`POST /api/runner/report`

Name	In	Required	Type
`state`	body	optional	string
`error`	body	optional	string

Status	Means
`200`	Successful response
`401`	No credential, or one this instance does not recognise.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not. The body says which end is behind; every answer carries X-Runner-Protocol-Supported.
`500`	Server error

Response headers: X-Runner-Protocol-Supported.

`POST /api/runner/split`

Name	In	Required	Type
`suite`	body	optional	string
`nodes`	body	optional	number
`index`	body	optional	number

Status	Means
`200`	The items this node should run.
`401`	No credential, or one this instance does not recognise.
`409`	Nothing to split.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

Response headers: X-Runner-Protocol-Supported.

`POST /api/runner/upload`

Name	In	Required	Type
`steps`	body	required	string

Status	Means
`200`	The jobs that were added.
`401`	No credential, or one this instance does not recognise.
`409`	Refused: the run is finished, the budget is spent, or the document is not valid. `problems` lists what was wrong.
`422`	Validation failed
`426`	This runner speaks a protocol version the server does not.
`500`	Server error

Response headers: X-Runner-Protocol-Supported.

Search

`GET /api/search`

Name	In	Required	Type
`q`	query	optional	string
`scope`	query	optional	string
`page`	query	optional	number
`per_page`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/search/code`

Name	In	Required	Type
`q`	query	required	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

User

`GET /api/user`

Inputs are not declared on Actions/Identity/WhoAmIAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/atproto`

Name	In	Required	Type
`operation`	body	optional	string
`identifier`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/forge-credentials`

Name	In	Required	Type
`operation`	body	optional	string
`host`	body	optional	string
`provider`	body	optional	string
`token`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`DELETE /api/user/gpg-keys`

Name	In	Required	Type
`id`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/gpg-keys`

Name	In	Required	Type
`key`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/gpg-keys/delete`

Name	In	Required	Type
`id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`DELETE /api/user/keys`

Name	In	Required	Type
`id`	query	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/keys`

Name	In	Required	Type
`key`	body	optional	string
`title`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/keys/delete`

Name	In	Required	Type
`id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`GET /api/user/notifications`

Name	In	Required	Type
`reason`	query	optional	string
`repository`	query	optional	string
`unread`	query	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/notifications/mutes`

Name	In	Required	Type
`duration`	body	optional	string
`muted`	body	optional	string
`subject_id`	body	optional	custom
`subject_type`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/notifications/preferences`

Name	In	Required	Type
`channel`	body	optional	string
`delivery`	body	optional	string
`event`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/notifications/push`

Name	In	Required	Type
`auth`	body	optional	string
`endpoint`	body	optional	string
`operation`	body	optional	string
`p256dh`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/notifications/push/test`

Inputs are not declared on Actions/Notification/PushTestAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/notifications/read`

Name	In	Required	Type
`id`	body	optional	number
`ids`	body	optional	string
`mark_all`	body	optional	custom
`reason`	body	optional	string
`repository`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`PUT /api/user/notifications/schedule`

Name	In	Required	Type
`breaks_through`	body	optional	string
`days`	body	optional	number
`do_not_disturb_until`	body	optional	string
`ends_at`	body	optional	string
`starts_at`	body	optional	string
`timezone`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/passkeys`

Name	In	Required	Type
`operation`	body	optional	string
`id`	body	optional	custom
`credential`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/profile`

Name	In	Required	Type
`handle`	body	optional	string
`website`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/sessions`

Name	In	Required	Type
`operation`	body	optional	string
`id`	body	optional	number

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`DELETE /api/user/tokens`

Name	In	Required	Type
`id`	query	required	number
`reason`	query	optional	string

Status	Means
`200`	Revoked. The token stops working immediately, and the reason is kept for the audit log.
`401`	Unauthenticated.
`403`	Not yours to revoke.
`404`	No such token.
`422`	Validation failed
`500`	Server error

`GET /api/user/tokens`

Inputs are not declared on Actions/Tokens/ListTokensAction, so they are not listed here.

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

`POST /api/user/tokens`

Name	In	Required	Type
`name`	body	required	string
`selection`	body	optional	string
`expires_at`	body	optional	string
`organization_id`	body	optional	number
`machine_account_id`	body	optional	number
`permissions`	body	optional	array
`repository_ids`	body	optional	array

Status	Means
`200`	Successful response
`201`	The token, shown once. It is stored as a hash, so this is the only time the value exists.
`401`	Unauthenticated.
`403`	A token for an organization or a machine account needs the right to act for it.
`422`	A name is required, the selection must be one of the three, and an expiry that is not a date is refused rather than ignored.
`500`	Server error

`POST /api/user/tokens/revoke`

Name	In	Required	Type
`id`	body	required	number
`reason`	body	optional	string

Status	Means
`200`	Revoked. The token stops working immediately, and the reason is kept for the audit log.
`401`	Unauthenticated.
`403`	Not yours to revoke.
`404`	No such token.
`422`	Validation failed
`500`	Server error

`POST /api/user/tokens/rotate`

Name	In	Required	Type
`id`	body	required	number
`expires_at`	body	optional	string

Status	Means
`200`	The new token, shown once, with the old one revoked.
`401`	Unauthenticated.
`403`	Not yours to rotate.
`404`	No such token.
`422`	Validation failed
`500`	Server error

`POST /api/user/two-factor`

Name	In	Required	Type
`operation`	body	optional	string
`code`	body	optional	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error

View

`GET /api/view/{owner}/{repo}/{kind}/{ref}`

Name	In	Required	Type
`owner`	path	required	string
`repo`	path	required	string
`kind`	path	required	string
`ref`	path	required	string

Status	Means
`200`	Successful response
`422`	Validation failed
`500`	Server error