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.
Crochets de préréception d’une organisation
Utilisez l’API REST pour visualiser et modifier l’application des hooks de pré-réception qui sont disponibles pour une organisation.
À propos des hooks de préréception de l’organisation
Attributs d’objet
Nom | Type | Description |
---|---|---|
name | string | Nom du hook. |
enforcement | string | État d’application du hook sur ce référentiel. |
allow_downstream_configuration | boolean | Si des référentiels peuvent remplacer l’application. |
configuration_url | string | URL du point de terminaison où l’application est définie. |
Les valeurs possibles pour enforcement
sont enabled
, disabled
et testing
. disabled
indique que le hook pré-réception ne s’exécute pas. enabled
indique qu’il s’exécute et rejette tous les envois qui entraînent un état différent de zéro. testing
signifie que le script s’exécute, mais n’entraîne pas de rejet des envois.
configuration_url
peut être un lien vers ce point de terminaison ou la configuration globale de ce hook. Seuls les administrateurs de site sont en mesure d’accéder à la configuration globale.
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.
Parameters
Headers |
---|
Nom, Type, Description |
accept stringSetting to |
Path parameters |
Nom, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
Query parameters |
Nom, Type, Description |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
direction stringThe direction to sort the results by. Default: Can be one of: |
sort stringThe sort order for the response collection. Default: Can be one of: |
HTTP response status codes
Status code | Description |
---|---|
200 | OK |
Code samples
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
Parameters
Headers |
---|
Nom, Type, Description |
accept stringSetting to |
Path parameters |
Nom, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
pre_receive_hook_id integerRequiredThe unique identifier of the pre-receive hook. |
HTTP response status codes
Status code | Description |
---|---|
200 | OK |
Code samples
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
Parameters
Headers |
---|
Nom, Type, Description |
accept stringSetting to |
Path parameters |
Nom, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
pre_receive_hook_id integerRequiredThe unique identifier of the pre-receive hook. |
Body parameters |
Nom, Type, Description |
enforcement stringThe state of enforcement for the hook on this repository. |
allow_downstream_configuration booleanWhether repositories can override enforcement. |
HTTP response status codes
Status code | Description |
---|---|
200 | OK |
Code samples
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.
Parameters
Headers |
---|
Nom, Type, Description |
accept stringSetting to |
Path parameters |
Nom, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
pre_receive_hook_id integerRequiredThe unique identifier of the pre-receive hook. |
HTTP response status codes
Status code | Description |
---|---|
200 | OK |
Code samples
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
}