代码质量的 REST API 端点

List code quality findings for a repository

Lists code quality findings for a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

“List code quality findings for a repository”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Code quality" repository permissions (read)

“”List code quality findings for a repository 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository without the `.git` extension. The name is not case sensitive.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`direction` string The direction to sort the results by. 默认: `desc` 可以是以下选项之一: `asc`, `desc`
`before` string A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
`after` string A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
`state` string If specified, only code quality findings with this state will be returned. 可以是以下选项之一: `open`, `dismissed`

“List code quality findings for a repository”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`403`	Response if the user is not authorized to access Code quality for this repository.
`404`	Resource not found
`503`	Service unavailable

“List code quality findings for a repository”的代码示例

请求示例

get/repos/{owner}/{repo}/code-quality/findings

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/code-quality/findings

Response

Status: 200

[
  {
    "number": 42,
    "state": "open",
    "url": "https://api.github.com/repos/octocat/hello-world/code-quality/findings/42",
    "rule": {
      "id": "java/useless-null-check",
      "title": "Useless null check",
      "description": "Checking whether an expression is null when that expression cannot possibly be null is useless.",
      "severity": "warning",
      "category": "maintainability"
    },
    "location": {
      "path": "java/UselessNullCheck.java",
      "start_line": 9,
      "start_column": 4,
      "end_line": 9,
      "end_column": 18
    },
    "message": {
      "text": "This check is useless. o cannot be null at this check, since it is guarded by instanceof.",
      "markdown": "This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25)."
    },
    "created_at": "2026-01-23T12:34:56Z"
  }
]

Get a code quality finding

Gets a single code quality finding.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

“Get a code quality finding”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Code quality" repository permissions (read)

“”Get a code quality finding 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository without the `.git` extension. The name is not case sensitive.
`finding_number` integer 必须 The number that identifies a finding.

“Get a code quality finding”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`403`	Response if the user is not authorized to access Code quality for this repository.
`404`	Resource not found
`503`	Service unavailable

“Get a code quality finding”的代码示例

请求示例

get/repos/{owner}/{repo}/code-quality/findings/{finding_number}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/code-quality/findings/FINDING_NUMBER

Response

Status: 200

{
  "number": 42,
  "state": "open",
  "url": "https://api.github.com/repos/octocat/hello-world/code-quality/findings/42",
  "rule": {
    "id": "java/useless-null-check",
    "title": "Useless null check",
    "description": "Checking whether an expression is null when that expression cannot possibly be null is useless.",
    "help": "# Useless null check\nSometimes you can guarantee that a particular variable will never be null. For example when that variable has just been assigned a newly created object or is the exception caught by a `catch` clause. A null check on such a variable is ...",
    "severity": "warning",
    "category": "maintainability"
  },
  "location": {
    "path": "java/UselessNullCheck.java",
    "start_line": 9,
    "start_column": 4,
    "end_line": 9,
    "end_column": 18
  },
  "message": {
    "text": "This check is useless. o cannot be null at this check, since it is guarded by instanceof.",
    "markdown": "This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25)."
  },
  "created_at": "2026-01-23T12:34:56Z"
}

Get a code quality setup configuration

Gets a code quality setup configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

“Get a code quality setup configuration”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Administration" repository permissions (write)

“”Get a code quality setup configuration 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository without the `.git` extension. The name is not case sensitive.

“Get a code quality setup configuration”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`403`	Response if the user is not authorized to access Code quality for this repository.
`404`	Resource not found
`503`	Service unavailable

“Get a code quality setup configuration”的代码示例

请求示例

get/repos/{owner}/{repo}/code-quality/setup

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/code-quality/setup

Response

Status: 200

{
  "state": "configured",
  "languages": [
    "javascript-typescript",
    "python"
  ],
  "runner_type": "standard",
  "runner_label": null,
  "updated_at": "2023-01-01T00:00:00Z",
  "schedule": "weekly"
}

Update a code quality setup configuration

Updates a code quality setup configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

“Update a code quality setup configuration”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Administration" repository permissions (write)

“”Update a code quality setup configuration 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository without the `.git` extension. The name is not case sensitive.

主体参数
名称, 类型, 说明
`state` string The desired state of code quality setup. 可以是以下选项之一: `configured`, `not-configured`
`runner_type` string Runner type to be used. 可以是以下选项之一: `standard`, `labeled`
`runner_label` string or null Runner label to be used if the runner type is labeled.
`languages` array of strings Languages to be analyzed. Supported values are: `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`

“Update a code quality setup configuration”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`202`	Accepted
`403`	Response if the repository is archived or if Code quality is not enabled for this repository
`404`	Resource not found
`409`	Response if there is already a code quality setup configuration update in progress
`422`	Response if the configuration change cannot be made
`503`	Service unavailable

“Update a code quality setup configuration”的代码示例

请求示例

patch/repos/{owner}/{repo}/code-quality/setup

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/code-quality/setup \
  -d '{"state":"configured","languages":["javascript-typescript","python","ruby"]}'

Response

Status: 202

{
  "run_id": 42,
  "run_url": "https://api.github.com/repos/octocat/hello-world/actions/runs/42"
}