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
Name | type | BESCHREIBUNG |
---|---|---|
name | string | Der Name des Hooks. |
enforcement | string | Der Status der Erzwingung für den Hook in diesem Repository. |
allow_downstream_configuration | boolean | Gibt an, ob Repositorys die Erzwingung außer Kraft setzen können |
configuration_url | string | URL 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
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.
Parameter
Header |
---|
Name, type, BESCHREIBUNG |
accept stringSetting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
org stringErforderlichThe organization name. The name is not case sensitive. |
Abfrageparameter |
Name, type, BESCHREIBUNG |
per_page integerThe number of results per page (max 100). Standard: |
page integerPage number of the results to fetch. Standard: |
direction stringThe direction to sort the results by. Standard: Kann eine der Folgenden sein: |
sort stringThe sort order for the response collection. Standard: Kann eine der Folgenden sein: |
HTTP-Antwortstatuscodes
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele
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
Parameter
Header |
---|
Name, type, BESCHREIBUNG |
accept stringSetting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
org stringErforderlichThe organization name. The name is not case sensitive. |
pre_receive_hook_id integerErforderlichThe unique identifier of the pre-receive hook. |
HTTP-Antwortstatuscodes
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele
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
For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement
and allow_downstream_configuration
Parameter
Header |
---|
Name, type, BESCHREIBUNG |
accept stringSetting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
org stringErforderlichThe organization name. The name is not case sensitive. |
pre_receive_hook_id integerErforderlichThe unique identifier of the pre-receive hook. |
Textparameter |
Name, type, BESCHREIBUNG |
enforcement stringThe state of enforcement for the hook on this repository. |
allow_downstream_configuration booleanWhether repositories can override enforcement. |
HTTP-Antwortstatuscodes
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele
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
Removes any overrides for this hook at the org level for this org.
Parameter
Header |
---|
Name, type, BESCHREIBUNG |
accept stringSetting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
org stringErforderlichThe organization name. The name is not case sensitive. |
pre_receive_hook_id integerErforderlichThe unique identifier of the pre-receive hook. |
HTTP-Antwortstatuscodes
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele
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
}