Skip to main content

Diese Version von GitHub Enterprise wurde eingestellt am 2023-01-18. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

Pre-Receive-Hooks für eine Organisation

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

Informationen zu Pre-Receive-Hooks für Organisationen

Objektattribute

NametypeBESCHREIBUNG
namestringDer Name des Hooks.
enforcementstringDer Status der Erzwingung für den Hook in diesem Repository.
allow_downstream_configurationbooleanGibt an, ob Repositorys die Erzwingung außer Kraft setzen können
configuration_urlstringURL für den Endpunkt, an dem die Erzwingung festgelegt ist.

Mögliche Werte für enforcement sind enabled, disabled und testing. 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 eine Verknüpfung zu diesem Endpunkt oder der globalen Konfiguration dieses Hooks sein. Nur Websiteadministratoren können auf die globale Konfiguration zugreifen.

List pre-receive hooks for an organization

Works with GitHub Apps

List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

Query parameters
Name, Type, BESCHREIBUNG
per_pageinteger

The number of results per page (max 100).

Default: 30

pageinteger

Page number of the results to fetch.

Default: 1

directionstring

The direction to sort the results by.

Default: desc

Can be one of: asc, desc

sortstring

The sort order for the response collection.

Default: created

Can be one of: created, updated, name

HTTP response status codes

Status codeBESCHREIBUNG
200

OK

Code samples

get/orgs/{org}/pre-receive-hooks
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/orgs/ORG/pre-receive-hooks

Response

Status: 200
[ { "id": 42, "name": "Check Commits", "enforcement": "disabled", "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42", "allow_downstream_configuration": true } ]

Get a pre-receive hook for an organization

Works with GitHub Apps

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

pre_receive_hook_idintegerRequired

The unique identifier of the pre-receive hook.

HTTP response status codes

Status codeBESCHREIBUNG
200

OK

Code samples

get/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/orgs/ORG/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/admin/pre-receive-hooks/42", "allow_downstream_configuration": true }

Update pre-receive hook enforcement for an organization

Works with GitHub Apps

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

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

pre_receive_hook_idintegerRequired

The unique identifier of the pre-receive hook.

Body parameters
Name, Type, BESCHREIBUNG
enforcementstring

The state of enforcement for the hook on this repository.

allow_downstream_configurationboolean

Whether repositories can override enforcement.

HTTP response status codes

Status codeBESCHREIBUNG
200

OK

Code samples

patch/orgs/{org}/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/orgs/ORG/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \ -d '{"enforcement":"enabled","allow_downstream_configuration":false}'

Response

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

Remove pre-receive hook enforcement for an organization

Works with GitHub Apps

Removes any overrides for this hook at the org level for this org.

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

pre_receive_hook_idintegerRequired

The unique identifier of the pre-receive hook.

HTTP response status codes

Status codeBESCHREIBUNG
200

OK

Code samples

delete/orgs/{org}/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/orgs/ORG/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/admin/pre-receive-hooks/42", "allow_downstream_configuration": true }