REST API endpoints for secret scanning

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.9

Free, Pro, & Team

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Domain name

Who can use this feature?

Actions

Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

Enter a search term to find it in the GitHub Docs.

REST API endpoints for secret scanning - GitHub Enterprise Server 3.9 Docs

Use the REST API to retrieve and update secret alerts from a repository.

Quickstart

About the REST API

Comparing GitHub's APIs

API Versions

Breaking changes

OpenAPI description

Getting started

Rate limits

Pagination

Libraries

Best practices

Troubleshooting

Timezones

CORS and JSONP

Issue event types

GitHub event types

Using the REST API

Authenticating

Keeping API credentials secure

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Authentication

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Building a CI server

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

Organization

Announcement banners

GitHub Apps

Installations

OAuth authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check runs

Check suites

Checks

Code scanning

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Alerts

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency graph

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Code security and analysis

Global webhooks

LDAP

License

Manage GHES

Management Console

Organization pre-receive hooks

Organizations

Pre-receive environments

Pre-receive hooks

Repository pre-receive hooks

SCIM

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

OAuth app authorizations

Custom roles

Members

Outside collaborators

Security managers

Packages

Pages

Boards

Cards

Columns

Projects (classic)

Pull requests

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Emails

Followers

GPG keys

Git SSH keys

Social accounts

SSH signing keys

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

Hello-World

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 <code>repo</code> scope or <code>security_events</code> scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a <a href="https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization">security manager</a>.

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

enterprise

Set to <code>open</code> or <code>resolved</code> to only list secret scanning alerts in a specific state.

state

A comma-separated list of secret types to return. By default all secret types are returned.
See "<a href="https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security">Secret scanning patterns</a>"
for a complete list of secret types.

secret_type

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

resolution

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

sort

The direction to sort the results by.

direction

The number of results per page (max 100). For more information, see "<a href="https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

per_page

A cursor, as given in the <a href="https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. If specified, the query only searches for results before this cursor. For more information, see "<a href="https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

before

A cursor, as given in the <a href="https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. If specified, the query only searches for results after this cursor. For more information, see "<a href="https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

after

List secret scanning alerts for an enterprise

Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
The authenticated user must be an administrator or security manager for the organization to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>security_events</code> scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the <code>public_repo</code> scope instead.

The organization name. The name is not case sensitive.

The page number of the results to fetch. For more information, see "<a href="https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

page

A cursor, as given in the <a href="https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. 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.

A cursor, as given in the <a href="https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. 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.

List secret scanning alerts for an organization