Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
secret-scanning

Get a bypass request for secret scanning

Gets a specific request to bypass secret scanning push protection in a repository.

Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens (classic) need the security_events scope to use this endpoint.

get/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}

Path parameters

ownerstring required

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

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

bypass_request_numberinteger required

The number that identifies the bypass request in a repository.

Response

A single bypass request.

idinteger

The unique identifier of the bypass request.

numberinteger

The number uniquely identifying the bypass request within its repository.

request_typestring

The type of request.

resource_identifierstring

The unique identifier for the request type of the bypass request. For example, a commit SHA.

status'pending' | 'denied' | 'approved' | 'cancelled' | 'completed' | 'expired' | 'open'

The status of the bypass request.

requester_commentstring nullable

The comment the requester provided when creating the bypass request.

expires_atstring date-time

The date and time the bypass request will expire.

created_atstring date-time

The date and time the bypass request was created.

urlstring uri
html_urlstring uri

The URL to view the bypass request in a browser.

Example response

{
  "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132",
  "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1",
  "html_url": "https://github.com/octo-org/smile/exemptions/1"
}