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.
Enlaces de recepción previa de la organización
Usa la API REST para ver y modificar la aplicación de enlaces de recepción previa que están disponibles para una organización.
Acerca de los enlaces de recepción previa de la organización
Atributos de objeto
Nombre | Tipo | Descripción |
---|---|---|
name | string | El nombre del gancho. |
enforcement | string | El estado de imposición del gancho en este repositorio. |
allow_downstream_configuration | boolean | Si los repositorios pueden ignorar la imposición o no. |
configuration_url | string | URL para la terminal en donde se configuró la imposición. |
Los valores posibles de enforcement
son enabled
, disabled
y testing
. disabled
indica que no se ejecutará el enlace previo a la recepción. enabled
indica que se ejecutará y rechazará cualquier inserción que dé como resultado un estado distinto a cero. testing
indica que el script se ejecutará pero no rechazará ninguna inserción.
configuration_url
podría ser un enlace a este punto de conexión o ser la configuración global de este enlace. Solo los administradores de sistema pueden acceder a la configuración global.
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 |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
org stringRequiredThe organization name. The name is not case sensitive. |
Query parameters |
Nombre, Type, Descripción |
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 | Descripción |
---|---|
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 |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
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 | Descripción |
---|---|
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 |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
org stringRequiredThe organization name. The name is not case sensitive. |
pre_receive_hook_id integerRequiredThe unique identifier of the pre-receive hook. |
Body parameters |
Nombre, Type, Descripción |
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 | Descripción |
---|---|
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 |
---|
Nombre, Type, Descripción |
accept stringSetting to |
Path parameters |
Nombre, Type, Descripción |
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 | Descripción |
---|---|
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
}