Github API - Test Config

Flexydox
PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
repos
secret-scanning

Updates the status of a secret scanning alert in an eligible repository.
To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.
For public repositories, you may instead use the public_repo scope.

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.
Update a secret scanning alert

Arguments
key owner

owner [scalar]

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

API:
Github Open API
(version: 1.1.4)

https://api.github.com

key repo

repo [scalar]

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

API:
Github Open API
(version: 1.1.4)

https://api.github.com

key alert-number

alert-number [scalar]

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.

API:
Github Open API
(version: 1.1.4)

https://api.github.com

Returns
200 application/json secret-scanning-alert

secret-scanning-alert [object]

Attributes
created_at alert-created-at

html_url alert-html-url

locations_url string

The REST API URL of the code locations for this alert.

number alert-number

push_protection_bypassed boolean

Whether push protection was bypassed for the detected secret.

push_protection_bypassed_at string

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

push_protection_bypassed_by nullable-simple-user

resolution secret-scanning-alert-resolution

resolution_comment string

An optional comment to resolve an alert.

resolved_at string

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

resolved_by nullable-simple-user

secret string

The secret that was detected.

secret_type string

The type of secret that secret scanning detected.

secret_type_display_name string

User-friendly name for the detected secret, matching the secret_type.
For a list of built-in patterns, see "Secret scanning patterns."

state secret-scanning-alert-state

updated_at nullable-alert-updated-at

url alert-url

API:
Github Open API
(version: 1.1.4)

https://api.github.com
503 service_unavailable

service_unavailable [scalar]

Service unavailable

API:
Github Open API
(version: 1.1.4)

https://api.github.com
API:
Github Open API
(version: 1.1.4)

https://api.github.com