TODOCS - GitHub Enterprise Cloud Docs

List repository push rule bypass requests

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

Jetons d’accès affinés pour « List repository push rule bypass requests »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Contents" repository permissions (write)

Paramètres pour « List repository push rule bypass requests »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`owner` string Obligatoire The account owner of the repository. The name is not case sensitive.
`repo` string Obligatoire The name of the repository without the `.git` extension. The name is not case sensitive.

Paramètres de requête
Nom, Type, Description
`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). Default: `day` Peut être: `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. Default: `all` Peut être: `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." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

Codes d’état de la réponse HTTP pour « List repository push rule bypass requests »

Code d’état	Description
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemples de code pour « List repository push rule bypass requests »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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: 2022-11-28" \
  https://api.github.com/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://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"
  }
]

Get a repository push bypass request

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

Jetons d’accès affinés pour « Get a repository push bypass request »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Contents" repository permissions (write)

Paramètres pour « Get a repository push bypass request »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`owner` string Obligatoire The account owner of the repository. The name is not case sensitive.
`repo` string Obligatoire The name of the repository without the `.git` extension. The name is not case sensitive.
`bypass_request_number` integer Obligatoire The number that identifies the bypass request within the context of the given repository.

Codes d’état de la réponse HTTP pour « Get a repository push bypass request »

Code d’état	Description
`200`	OK
`404`	Resource not found
`500`	Internal Error

Exemples de code pour « Get a repository push bypass request »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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: 2022-11-28" \
  https://api.github.com/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://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2",
  "html_url": "https://github.com/octo-org/smile/exemptions/2"
}