适用于绕过请求的 REST API 终结点
使用 REST API 管理企业推送规则绕过请求。
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.
“List push rule bypass requests within an enterprise”的细粒度访问令牌
此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。
“List push rule bypass requests within an enterprise”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
enterprise string 必须The slug version of the enterprise name. You can also substitute this value with the enterprise id. |
名称, 类型, 说明 |
---|
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, 默认: 可以是以下选项之一: |
request_status string The status of the bypass request to filter on. When specified, only requests with this status will be returned. 默认: 可以是以下选项之一: |
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: |
“List push rule bypass requests within an enterprise”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
“List push rule bypass requests within an enterprise”的示例代码
如果你通过 GHE.com 访问 GitHub,请将 api.github.com
替换为你的企业在 api.SUBDOMAIN.ghe.com
上的专用子域。
请求示例
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"
}
]