Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de API de REST para enlaces previos a la recepció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

Nota:

Estos puntos de conexión solo admiten la autenticación mediante personal access token (classic). Para más información, consulta Administración de tokens de acceso personal.

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.

Tokens de acceso específicos para "List pre-receive hooks for an organization"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Organization pre-receive hooks" organization permissions (read)

Parámetros para "List pre-receive hooks for an organization"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`
`direction` string The direction to sort the results by. Valor predeterminado: `desc` Puede ser uno de los siguientes: `asc`, `desc`
`sort` string The sort order for the response collection. Valor predeterminado: `created` Puede ser uno de los siguientes: `created`, `updated`, `name`

Códigos de estado de respuesta HTTP para "List pre-receive hooks for an organization"

status code	Descripción
`200`	OK

Ejemplos de código para "List pre-receive hooks for an organization"

Ejemplo de solicitud

get/orgs/{org}/pre-receive-hooks

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

Tokens de acceso específicos para "Get a pre-receive hook for an organization"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Organization pre-receive hooks" organization permissions (read)

Parámetros para "Get a pre-receive hook for an organization"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Requerido The unique identifier of the pre-receive hook.

Códigos de estado de respuesta HTTP para "Get a pre-receive hook for an organization"

status code	Descripción
`200`	OK

Ejemplos de código para "Get a pre-receive hook for an organization"

Ejemplo de solicitud

get/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

Tokens de acceso específicos para "Update pre-receive hook enforcement for an organization"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Organization pre-receive hooks" organization permissions (write)

Parámetros para "Update pre-receive hook enforcement for an organization"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Requerido The unique identifier of the pre-receive hook.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`enforcement` string The state of enforcement for the hook on this repository.
`allow_downstream_configuration` boolean Whether repositories can override enforcement.

Códigos de estado de respuesta HTTP para "Update pre-receive hook enforcement for an organization"

status code	Descripción
`200`	OK

Ejemplos de código para "Update pre-receive hook enforcement for an organization"

Ejemplo de solicitud

patch/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

Tokens de acceso específicos para "Remove pre-receive hook enforcement for an organization"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Organization pre-receive hooks" organization permissions (write)

Parámetros para "Remove pre-receive hook enforcement for an organization"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Requerido The unique identifier of the pre-receive hook.

Códigos de estado de respuesta HTTP para "Remove pre-receive hook enforcement for an organization"

status code	Descripción
`200`	OK

Ejemplos de código para "Remove pre-receive hook enforcement for an organization"

Ejemplo de solicitud

delete/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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
}