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’un dépôt
Utilisez l’API REST pour visualiser et modifier l’application des hooks de pré-réception qui sont disponibles pour un référentiel.
À propos des hooks de préréception du référentiel
| Nom | Type | Description |
|---|---|---|
name | string | Nom du hook. |
enforcement | string | État d’application du hook sur ce référentiel. |
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 référentiel, le propriétaire de l’organisation ou la configuration globale. L’autorisation d’accéder au point de terminaison sur configuration_url est déterminée au niveau du propriétaire ou de l’administrateur de site.
List pre-receive hooks for a repository
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.
Paramètres
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
| Paramètres de requête |
| Nom, Type, Description |
per_pageintegerThe number of results per page (max 100). Default: |
pageintegerPage number of the results to fetch. Default: |
directionstringThe direction to sort the results by. Default: Peut être: |
sortstringDefault: Peut être: |
Codes de statut de réponse HTTP
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooksResponse
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
Paramètres
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
pre_receive_hook_idintegerObligatoireThe unique identifier of the pre-receive hook. |
Codes de statut de réponse HTTP
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code
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_IDResponse
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
For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Paramètres
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
pre_receive_hook_idintegerObligatoireThe unique identifier of the pre-receive hook. |
| Paramètres du corps |
| Nom, Type, Description |
enforcementstringThe state of enforcement for the hook on this repository. Peut être: |
Codes de statut de réponse HTTP
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code
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
Deletes any overridden enforcement on this repository for the specified hook.
Responds with effective values inherited from owner and/or global level.
Paramètres
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
pre_receive_hook_idintegerObligatoireThe unique identifier of the pre-receive hook. |
Codes de statut de réponse HTTP
| Code d’état | Description |
|---|---|
200 | Responds with effective values inherited from owner and/or global level. |
Exemples de code
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_IDResponds 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"
}