List secret scanning alerts for an organization

Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
To use this endpoint, you must be an administrator or security manager for the organization, and you must use an 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.

[ { "created_at": "2019-08-24T14:15:22Z", "html_url": "http://example.com", "locations_url": "http://example.com", "number": 0, "push_protection_bypassed": true, "push_protection_bypassed_at": "2019-08-24T14:15:22Z", "push_protection_bypassed_by": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "repository": { "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "This your first repo!", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "fork": true, "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "full_name": "octocat/Hello-World", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "html_url": "https://github.com/octocat/Hello-World", "id": 1296269, "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "name": "Hello-World", "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "private": true, "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "url": "https://api.github.com/repos/octocat/Hello-World" }, "resolution": null, "resolution_comment": "string", "resolved_at": "2019-08-24T14:15:22Z", "resolved_by": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "secret": "string", "secret_type": "string", "secret_type_display_name": "string", "state": "open", "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com" } ]

Request

Path Params

org

string

required

The organization name. The name is not case sensitive.

Query Params

state

string

optional

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

secret_type

string

optional

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.

resolution

string

optional

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.

sort

string

optional

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

direction

string

optional

The direction to sort the results by.

page

integer

optional

Page number of the results to fetch.

per_page

integer

optional

The number of results per page (max 100).

before

string

optional

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.

after

string

optional

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.

Responses

🟢200Response

application/json

Body

array of:

created_at

string <date-time>

read-onlyoptional

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

html_url

string <uri>

read-onlyoptional

The GitHub URL of the alert resource.

locations_url

string <uri>

optional

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

number

integer

read-onlyoptional

The security alert number.

push_protection_bypassed

boolean | null

optional

Whether push protection was bypassed for the detected secret.

push_protection_bypassed_at

string <date-time> | null

optional

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

push_protection_bypassed_by

object (Simple User) | null

optional

A GitHub user.

avatar_url

string <uri>

required

Example:

https://github.com/images/error/octocat_happy.gif

string | null

optional

events_url

string

required

Example:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

required

Example:

https://api.github.com/users/octocat/followers

following_url

string

required

Example:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

required

Example:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

required

Example:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

required

Example:

https://github.com/octocat

integer

required

Example:

string

required

Example:

octocat

name

string | null

optional

node_id

string

required

Example:

MDQ6VXNlcjE=

organizations_url

string <uri>

required

Example:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

required

Example:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

required

Example:

https://api.github.com/users/octocat/repos

site_admin

boolean

required

starred_at

string

optional

Example:

"2020-07-09T00:17:55Z"

starred_url

string

required

Example:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

required

Example:

https://api.github.com/users/octocat/subscriptions

type

string

required

Example:

User

url

string <uri>

required

Example:

https://api.github.com/users/octocat

repository

object (Simple Repository)

optional

A GitHub repository.

archive_url

string

required

A template for the API URL to download the repository as an archive.

Example:

https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

assignees_url

string

required

A template for the API URL to list the available assignees for issues in the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

required

A template for the API URL to create or retrieve a raw Git blob in the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

required

A template for the API URL to get information about branches in the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/branches{/branch}

collaborators_url

string

required

A template for the API URL to get information about collaborators of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

required

A template for the API URL to get information about comments on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

required

A template for the API URL to get information about commits on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

required

A template for the API URL to compare two commits or refs.

Example:

https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

required

A template for the API URL to get the contents of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

required

A template for the API URL to list the contributors to the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/contributors

deployments_url

string <uri>

required

The API URL to list the deployments of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

required

The repository description.

Example:

This your first repo!

downloads_url

string <uri>

required

The API URL to list the downloads on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

required

The API URL to list the events of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/events

fork

boolean

required

Whether the repository is a fork.

forks_url

string <uri>

required

The API URL to list the forks of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/forks

full_name

string

required

The full, globally unique, name of the repository.

Example:

octocat/Hello-World

git_commits_url

string

required

A template for the API URL to get information about Git commits of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

required

A template for the API URL to get information about Git refs of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

required

A template for the API URL to get information about Git tags of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

hooks_url

string <uri>

required

The API URL to list the hooks on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

required

The URL to view the repository on GitHub.com.

Example:

https://github.com/octocat/Hello-World

integer

required

A unique identifier of the repository.

Example:

1296269

issue_comment_url

string

required

A template for the API URL to get information about issue comments on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

required

A template for the API URL to get information about issue events on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

required

A template for the API URL to get information about issues on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

required

A template for the API URL to get information about deploy keys on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

required

A template for the API URL to get information about labels of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/labels{/name}

languages_url

string <uri>

required

The API URL to get information about the languages of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/languages

merges_url

string <uri>

required

The API URL to merge branches in the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

required

A template for the API URL to get information about milestones of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/milestones{/number}

name

string

required

The name of the repository.

Example:

Hello-World

node_id

string

required

The GraphQL identifier of the repository.

Example:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

required

A template for the API URL to get information about notifications on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

owner

object (Simple User)

required

A GitHub user.

private

boolean

required

Whether the repository is private.

pulls_url

string

required

A template for the API URL to get information about pull requests on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/pulls{/number}

releases_url

string

required

A template for the API URL to get information about releases on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/releases{/id}

stargazers_url

string <uri>

required

The API URL to list the stargazers on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url

string

required

A template for the API URL to get information about statuses of a commit.

Example:

https://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_url

string <uri>

required

The API URL to list the subscribers on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

required

The API URL to subscribe to notifications for this repository.

Example:

https://api.github.com/repos/octocat/Hello-World/subscription

tags_url

string <uri>

required

The API URL to get information about tags on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

required

The API URL to list the teams on the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/teams

trees_url

string

required

A template for the API URL to create or retrieve a raw Git tree of the repository.

Example:

https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

url

string <uri>

required

The URL to get more information about the repository from the GitHub API.

Example:

https://api.github.com/repos/octocat/Hello-World

resolution

enum<string> | enum<null>

optional

Required when the state is resolved. The reason for resolving the alert.

Allowed values:

nullfalse_positivewont_fixrevokedused_in_tests

resolution_comment

string | null

optional

The comment that was optionally added when this alert was closed

resolved_at

string <date-time> | null

optional

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

resolved_by

object (Simple User) | null

optional

A GitHub user.

secret

string

optional

The secret that was detected.

secret_type

string

optional

The type of secret that secret scanning detected.

secret_type_display_name

string

optional

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

state

enum<string>

optional

Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.

Allowed values:

openresolved

updated_at

string <date-time> | null

read-onlyoptional

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

url

string <uri>

read-onlyoptional

The REST API URL of the alert resource.

🟠404404

🔴503503