PATCH

Try PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number} — GitHub API

GitHub playground

Update a code scanning alert

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive. alert_number · required · integer 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

5 body fields

state · required · string — Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.
dismissed_reason · optional · string — **Required when the state is dismissed.** The reason for dismissing or closing the alert.
dismissed_comment · optional · string — The dismissal comment associated with the dismissal of the alert.
create_request · optional · boolean — If `true`, attempt to create an alert dismissal request.
assignees · optional · string[] — The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.