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.
Repository Pre-receive Hooks
The Repository Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to a repository.
Atributos de objeto
| Nombre | Tipo | Descripción |
|---|---|---|
name (nombre) | secuencia | El nombre del gancho. |
enforcement | secuencia | El estado de imposición del gancho en este repositorio. |
configuration_url | secuencia | URL para la terminal en donde se configuró la imposición. |
Los valores posibles para enforcement son enabled, disabled y testing. El valor disabled indica que el gancho de pre-recepción no se ejecutará. El valor enabled indica que se ejecutará y rechazará cualquier carga que resulte en un estado diferente a zero. El valor testing indica que el script va a ejecutarse pero no va a causar que se rechace ninguna carga.
configuration_url podría ser un enlace a este repositorio, al propietario de su organización o a su configuración global. La autorización para acceder a esta terminal en configuration_url se determina a nivel de administrador de sitio o de propietario.
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.
Parámetros
| Encabezados |
|---|
| Nombre, Tipo, Descripción |
acceptstringSetting to |
| Parámetros de ruta |
| Nombre, Tipo, Descripción |
ownerstringRequeridoThe account owner of the repository. The name is not case sensitive. |
repostringRequeridoThe name of the repository. The name is not case sensitive. |
| Parámetros de consulta |
| Nombre, Tipo, Descripción |
per_pageintegerThe number of results per page (max 100). Predeterminado: |
pageintegerPage number of the results to fetch. Predeterminado: |
directionstringThe direction to sort the results by. Predeterminado: Puede ser una de las siguientes: |
sortstringPredeterminado: Puede ser una de las siguientes: |
Códigos de estado de respuesta HTTP
| Código de estado | Descripción |
|---|---|
200 | OK |
Ejemplos de código
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <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
Parámetros
| Encabezados |
|---|
| Nombre, Tipo, Descripción |
acceptstringSetting to |
| Parámetros de ruta |
| Nombre, Tipo, Descripción |
ownerstringRequeridoThe account owner of the repository. The name is not case sensitive. |
repostringRequeridoThe name of the repository. The name is not case sensitive. |
pre_receive_hook_idintegerRequeridoThe unique identifier of the pre-receive hook. |
Códigos de estado de respuesta HTTP
| Código de estado | Descripción |
|---|---|
200 | OK |
Ejemplos de código
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <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
Parámetros
| Encabezados |
|---|
| Nombre, Tipo, Descripción |
acceptstringSetting to |
| Parámetros de ruta |
| Nombre, Tipo, Descripción |
ownerstringRequeridoThe account owner of the repository. The name is not case sensitive. |
repostringRequeridoThe name of the repository. The name is not case sensitive. |
pre_receive_hook_idintegerRequeridoThe unique identifier of the pre-receive hook. |
| Parámetros de cuerpo |
| Nombre, Tipo, Descripción |
enforcementstringThe state of enforcement for the hook on this repository. Puede ser una de las siguientes: |
Códigos de estado de respuesta HTTP
| Código de estado | Descripción |
|---|---|
200 | OK |
Ejemplos de código
curl \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <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.
Parámetros
| Encabezados |
|---|
| Nombre, Tipo, Descripción |
acceptstringSetting to |
| Parámetros de ruta |
| Nombre, Tipo, Descripción |
ownerstringRequeridoThe account owner of the repository. The name is not case sensitive. |
repostringRequeridoThe name of the repository. The name is not case sensitive. |
pre_receive_hook_idintegerRequeridoThe unique identifier of the pre-receive hook. |
Códigos de estado de respuesta HTTP
| Código de estado | Descripción |
|---|---|
200 | Responds with effective values inherited from owner and/or global level. |
Ejemplos de código
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <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"
}