Github API - Test Config

GET /repos/{owner}/{repo}/secret-scanning/alerts
repos
secret-scanning

Lists secret scanning alerts for an eligible repository, from newest to oldest.
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 read permission to use this endpoint.
List secret scanning alerts for a repository

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)

key repo

repo [scalar]

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

API:
Github Open API
(version: 1.1.4)

key secret-scanning-alert-state

secret-scanning-alert-state [scalar]

Set to open or resolved to only list secret scanning alerts in a specific state.

API:
Github Open API
(version: 1.1.4)

key secret-scanning-alert-secret-type

secret-scanning-alert-secret-type [scalar]

A comma-separated list of secret types to return. By default all secret types are returned.
See "Secret scanning patterns"
for a complete list of secret types.

API:
Github Open API
(version: 1.1.4)

key secret-scanning-alert-resolution

secret-scanning-alert-resolution [scalar]

A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.

API:
Github Open API
(version: 1.1.4)

key secret-scanning-alert-sort

secret-scanning-alert-sort [scalar]

The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.

API:
Github Open API
(version: 1.1.4)

key direction

direction [scalar]

The direction to sort the results by.

API:
Github Open API
(version: 1.1.4)

key page

page [scalar]

Page number of the results to fetch.

API:
Github Open API
(version: 1.1.4)

key per-page

per-page [scalar]

The number of results per page (max 100).

API:
Github Open API
(version: 1.1.4)

key secret-scanning-pagination-before-org-repo

secret-scanning-pagination-before-org-repo [scalar]

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.

API:
Github Open API
(version: 1.1.4)

key secret-scanning-pagination-after-org-repo

secret-scanning-pagination-after-org-repo [scalar]

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.

API:
Github Open API
(version: 1.1.4)

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_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."

url alert-url

API:
Github Open API
(version: 1.1.4)
503 service_unavailable

service_unavailable [scalar]

Service unavailable

API:
Github Open API
(version: 1.1.4)
API:
Github Open API
(version: 1.1.4)