List code scanning alerts for a repository

Lists all open code scanning alerts for the default branch (usually main
or master). You must use an access token with the security_events scope to use
this endpoint. GitHub Apps must have the security_events read permission to use
this endpoint.

[ { "classification": "source", "created_at": "2019-08-24T14:15:22Z", "dismissed_at": "2019-08-24T14:15:22Z", "dismissed_by": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "dismissed_reason": null, "html_url": "http://example.com", "instance": { "analysis_key": "string", "classifications": [ "source" ], "commit_sha": "string", "environment": "string", "html_url": "string", "location": { "end_column": 0, "end_line": 0, "path": "string", "start_column": 0, "start_line": 0 }, "message": { "text": "string" }, "ref": "string", "state": "open" }, "number": 0, "rule": { "description": "string", "id": "string", "name": "string", "severity": "none" }, "state": "open", "tool": { "guid": "string", "name": "string", "version": "string" }, "url": "http://example.com" } ]

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Query 参数

tool_name

string

可选

The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

tool_guid

string

可选

The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

page

integer

可选

Page number of the results to fetch.

per_page

integer

可选

Results per page (max 100).

ref

string

可选

The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

state

string

可选

Set to open, fixed, or dismissed to list code scanning alerts in a specific state.

返回响应

🟢200Response

application/json

Body

array of:

classification

enum<string> | enum<null>

必需

A classification of the file. For example to identify it as generated.

枚举值:

sourcegeneratedtestlibrary

created_at

string <date-time>

只读必需

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

dismissed_at

string <date-time> | null

只读必需

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

dismissed_by

object (Simple User) | null

必需

Simple User

avatar_url

string <uri>

必需

示例值:

https://github.com/images/error/octocat_happy.gif

events_url

string

必需

示例值:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/followers

following_url

string

必需

示例值:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

必需

示例值:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

必需

示例值:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

必需

示例值:

https://github.com/octocat

integer

必需

示例值:

string

必需

示例值:

octocat

node_id

string

必需

示例值:

MDQ6VXNlcjE=

organizations_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/repos

site_admin

boolean

必需

starred_at

string

可选

示例值:

"2020-07-09T00:17:55Z"

starred_url

string

必需

示例值:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/subscriptions

type

string

必需

示例值:

User

url

string <uri>

必需

示例值:

https://api.github.com/users/octocat

dismissed_reason

enum<string> | enum<null>

必需

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

枚举值:

nullfalse positivewon't fixused in tests

html_url

string <uri>

只读必需

The GitHub URL of the alert resource.

instance

object (code-scanning-alert-instance)

必需

analysis_key

string

可选

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

classifications

array[string | null]

可选

Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.

枚举值:

sourcegeneratedtestlibrary

commit_sha

string

可选

environment

string

可选

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

html_url

string

可选

location

object (code-scanning-alert-location)

可选

Describe a region within a file for the alert.

message

object

可选

ref

string

可选

The full Git reference, formatted as refs/heads/<branch name>,
refs/pull/<number>/merge, or refs/pull/<number>/head.

state

enum<string>

可选

State of a code scanning alert.

枚举值:

opencloseddismissedfixed

number

integer

只读必需

The security alert number.

rule

object (code-scanning-alert-rule-summary)

必需

description

string

可选

A short description of the rule used to detect the alert.

string | null

可选

A unique identifier for the rule used to detect the alert.

name

string

可选

The name of the rule used to detect the alert.

severity

enum<string> | enum<null>

可选

The severity of the alert.

枚举值:

nonenotewarningerror

state

enum<string>

必需

State of a code scanning alert.

枚举值:

opencloseddismissedfixed

tool

object (code-scanning-analysis-tool)

必需

guid

string | null

可选

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

name

string

可选

The name of the tool used to generate the code scanning analysis.

version

string | null

可选

The version of the tool used to generate the code scanning analysis.

url

string <uri>

只读必需

The REST API URL of the alert resource.

🟠403403

🟠404404

🔴503503