Update a code scanning alert

Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

curl --location --request PATCH 'https://api.github.com/repos///code-scanning/alerts/' \ --header 'Content-Type: application/json' \ --data-raw '{ "dismissed_reason": "false positive", "state": "dismissed" }'

{ "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", "instances": null, "number": 0, "rule": { "description": "string", "full_description": "string", "help": "string", "id": "string", "name": "string", "severity": "none", "tags": [ "string" ] }, "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

必需

alert_number

string

必需

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

Body 参数application/json

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

state

enum<string>

必需

Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

枚举值:

opendismissed

示例

返回响应

🟢200Response

application/json

Body

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.

instances

已废弃

number

integer

只读必需

The security alert number.

rule

object (code-scanning-alert-rule)

必需

description

string

可选

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

full_description

string

可选

description of the rule used to detect the alert.

help

string | null

可选

Detailed documentation for the rule as GitHub Flavored Markdown.

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