Skip to main content
Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API REST para las solicitudes de omisión

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

List push rule bypass requests within an enterprise

Lists the requests made by users of a repository to bypass push protection rules within an enterprise.

Tokens de acceso específicos para "List push rule bypass requests within an enterprise"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "List push rule bypass requests within an enterprise"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
enterprise string Requerido

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

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

The name of the organization to filter on.

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 insights 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, expired, 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

Códigos de estado de respuesta HTTP para "List push rule bypass requests within an enterprise"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "List push rule bypass requests within an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/bypass-requests/push-rules
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/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://api.github.com/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://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2", "html_url": "https://github.com/octo-org/smile/exemptions/2" } ]