Skip to main content

Enterprise Server 3.21 actualmente está disponible como versión candidata para lanzamiento.

Ahora la API REST está versionada. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API REST para solicitudes de anulación de reglas de inserción de repositorios

Usa la API REST para administrar las solicitudes de omisión de las reglas de inserción de repositorios.

List repository push rule bypass requests

Lists the requests made by users of a repository to bypass push protection rules

Fine-grained access tokens for "List repository push rule bypass requests"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Contents" repository permissions (write)

Parámetros para "List repository push rule bypass requests"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
owner string Obligatorio

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

repo string Obligatorio

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

Parámetros de consulta
Nombre, Tipo, Descripción
reviewer string

Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.

requester string

Filter bypass requests by the handle of the GitHub user who requested the bypass.

time_period string

The time period to filter by.

For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).

Valor predeterminado: day

Puede ser uno de los siguientes: hour, day, week, month

request_status string

The status of the bypass request to filter on. When specified, only requests with this status will be returned.

Valor predeterminado: all

Puede ser uno de los siguientes: completed, cancelled, approved, expired, deleted, denied, open, all

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

HTTP response status codes for "List repository push rule bypass requests"

Status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Code samples for "List repository push rule bypass requests"

Request example

get/repos/{owner}/{repo}/bypass-requests/push-rules
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/bypass-requests/push-rules

Response

Status: 200
[ { "id": 21, "number": 42, "repository": { "id": 1, "name": "smile", "full_name": "octo-org/smile" }, "organization": { "id": 1, "name": "octo-org" }, "requester": { "actor_id": 12, "actor_name": "monalisa" }, "request_type": "push_ruleset_bypass", "data": [ { "ruleset_id": 410, "ruleset_name": "Exclude image files", "total_violations": 1, "rule_type": "file_extension_restriction" } ], "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", "status": "denied", "requester_comment": "Updating site images to follow changes in marketing. Part 1", "expires_at": "2024-07-08T08:43:03Z", "created_at": "2024-07-01T08:43:03Z", "responses": [ { "id": 42, "reviewer": { "actor_id": 4, "actor_name": "octocat" }, "status": "denied", "created_at": "2024-07-02T08:43:04Z" } ], "url": "https://HOSTNAME/repos/octo-org/smile/bypass-requests/push-rules/1", "html_url": "https://github.com/octo-org/smile/exemptions/1" }, { "id": 12, "number": 24, "repository": { "id": 1, "name": "smile", "full_name": "octo-org/smile" }, "organization": { "id": 1, "name": "octo-org" }, "requester": { "actor_id": 12, "actor_name": "monalisa" }, "request_type": "push_ruleset_bypass", "data": [ { "ruleset_id": 410, "ruleset_name": "Exclude image files", "total_violations": 1, "rule_type": "file_extension_restriction" } ], "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", "status": "denied", "requester_comment": "Updating site images to follow changes in marketing. Part 2", "expires_at": "2024-07-08T07:43:03Z", "created_at": "2024-07-01T07:43:03Z", "responses": [ { "id": 42, "reviewer": { "actor_id": 4, "actor_name": "octocat" }, "status": "denied", "created_at": "2024-07-02T08:43:04Z" } ], "url": "https://HOSTNAME/repos/octo-org/smile/bypass-requests/push-rules/2", "html_url": "https://github.com/octo-org/smile/exemptions/2" } ]

Get a repository push bypass request

Get information about a request to bypass push protection rules for a repository.

Fine-grained access tokens for "Get a repository push bypass request"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Contents" repository permissions (write)

Parámetros para "Get a repository push bypass request"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
owner string Obligatorio

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

repo string Obligatorio

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

bypass_request_number integer Obligatorio

The number that identifies the bypass request within the context of the given repository.

HTTP response status codes for "Get a repository push bypass request"

Status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Code samples for "Get a repository push bypass request"

Request example

get/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/bypass-requests/push-rules/BYPASS_REQUEST_NUMBER

Response

Status: 200
{ "id": 12, "number": 24, "repository": { "id": 1, "name": "smile", "full_name": "octo-org/smile" }, "organization": { "id": 1, "name": "octo-org" }, "requester": { "actor_id": 12, "actor_name": "monalisa" }, "request_type": "push_ruleset_bypass", "data": [ { "ruleset_id": 410, "ruleset_name": "Exclude image files", "total_violations": 1, "rule_type": "file_extension_restriction" } ], "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", "status": "denied", "requester_comment": "Updating site images to follow changes in marketing. Part 2", "expires_at": "2024-07-08T07:43:03Z", "created_at": "2024-07-01T07:43:03Z", "responses": [ { "id": 42, "reviewer": { "actor_id": 4, "actor_name": "octocat" }, "status": "denied", "created_at": "2024-07-02T08:43:04Z" } ], "url": "https://HOSTNAME/repos/octo-org/smile/bypass-requests/push-rules/2", "html_url": "https://github.com/octo-org/smile/exemptions/2" }