provider code-scanning PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
@utdk/github /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
Update a code scanning alert
Updates the status of a single code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner path required
The account owner of the repository. The name is not case sensitive.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string
alert_number path required
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.
integer

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

codeScanning.updateAlert
PATCH/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
Updates the status of a single code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.

Parameters

required

The account owner of the repository. The name is not case sensitive.

required

The name of the repository without the `.git` extension. The name is not case sensitive.

required

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.

Input

Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.

**Required when the state is dismissed.** The reason for dismissing or closing the alert.

The dismissal comment associated with the dismissal of the alert.

If `true`, attempt to create an alert dismissal request.

The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.codeScanning.updateAlert()