Github API - Test Config

GET /enterprises/{enterprise}/secret-scanning/alerts
secret-scanning

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
To use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager.
List secret scanning alerts for an enterprise

Arguments
key enterprise

enterprise [scalar]

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

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 per-page

per-page [scalar]

The number of results per page (max 100).

API:
Github Open API
(version: 1.1.4)

key pagination-before

pagination-before [scalar]

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.

API:
Github Open API
(version: 1.1.4)

key pagination-after

pagination-after [scalar]

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.

API:
Github Open API
(version: 1.1.4)

Returns
200 application/json organization-secret-scanning-alert []

organization-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

repository simple-repository

resolution_comment string

The comment that was optionally added when this alert was closed

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)
404 not_found

not_found [scalar]

Resource not found

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)