Pre-Receive-Hooks für Repositorys

Verwende die REST-API, um die Erzwingung der Pre-Receive-Hooks anzuzeigen und zu bearbeiten, die für ein Repository verfügbar sind.

Informationen zu Pre-Receive-Hooks für Repositorys

Name	type	BESCHREIBUNG
`name`	`string`	Der Name des Hooks.
`enforcement`	`string`	Der Status der Erzwingung für den Hook in diesem Repository.
`configuration_url`	`string`	URL für den Endpunkt, an dem die Erzwingung festgelegt ist.

Mögliche Werte für die Erzwingung sind enabled, disabled undtesting. disabled gibt an, dass der Pre-Receive-Hook nicht ausgeführt wird. enabled gibt an, dass alle Pushs ausgeführt und abgelehnt werden, die zu einem anderen Status als null (0) führen. testing bedeutet, dass das Skript zwar ausgeführt wird, aber keine Ablehnung von Pushs auslösen wird.

configuration_url kann ein Link zu diesem Repository, seinem Organisationsbesitzer oder der globalen Konfiguration sein. Die Autorisierung für den Zugriff auf den Endpunkt unter configuration_url wird auf Besitzer- oder Websiteadministratorebene bestimmt.

List pre-receive hooks for a repository

Works with GitHub Apps

List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Query parameters
Name, Type, BESCHREIBUNG
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`
`direction`string The direction to sort the results by. Default: `desc` Can be one of: `asc`, `desc`
`sort`string Default: `created` Can be one of: `created`, `updated`, `name`

HTTP response status codes

Status code	BESCHREIBUNG
`200`	OK

Code samples

get/repos/{owner}/{repo}/pre-receive-hooks

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks

Response

Status: 200

[
  {
    "id": 42,
    "name": "Check Commits",
    "enforcement": "disabled",
    "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
  }
]

Get a pre-receive hook for a repository

Works with GitHub Apps

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.

HTTP response status codes

Status code	BESCHREIBUNG
`200`	OK

Code samples

get/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Response

Status: 200

{
  "id": 42,
  "name": "Check Commits",
  "enforcement": "disabled",
  "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}

Update pre-receive hook enforcement for a repository

Works with GitHub Apps

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.
Body parameters
Name, Type, BESCHREIBUNG
`enforcement`string The state of enforcement for the hook on this repository. Can be one of: `enabled`, `disabled`, `testing`

HTTP response status codes

Status code	BESCHREIBUNG
`200`	OK

Code samples

patch/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
  -d '{"enforcement":"enabled"}'

Response

Status: 200

{
  "id": 42,
  "name": "Check Commits",
  "enforcement": "enabled",
  "configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42"
}

Remove pre-receive hook enforcement for a repository

Works with GitHub Apps

Deletes any overridden enforcement on this repository for the specified hook.

Responds with effective values inherited from owner and/or global level.

Parameters

Headers
Name, Type, BESCHREIBUNG
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, BESCHREIBUNG
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`pre_receive_hook_id`integerRequired The unique identifier of the pre-receive hook.

HTTP response status codes

Status code	BESCHREIBUNG
`200`	Responds with effective values inherited from owner and/or global level.

Code samples

delete/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Responds with effective values inherited from owner and/or global level.

Status: 200

{
  "id": 42,
  "name": "Check Commits",
  "enforcement": "disabled",
  "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}