PATCH

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

GitHub playground

Update a secret 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 secret scanning alert. You must provide `resolution` when you set the state to `resolved`.
resolution · optional · string — **Required when the `state` is `resolved`.** The reason for resolving the alert.
resolution_comment · optional · string — An optional comment when closing or reopening an alert. Cannot be updated or deleted.
assignee · optional · string — The username of the user to assign to the alert. Set to `null` to unassign the alert.
validity · optional · string — Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override.