Puntos de conexión de API de REST para enlaces previos a la recepción del repositorio

Acerca de los enlaces previos a la recepción del repositorio

Note

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

Nombre	Escribir	Descripción
`name`	`string`	El nombre del gancho.
`enforcement`	`string`	El estado de imposición del gancho en este repositorio.
`configuration_url`	`string`	URL para la terminal en donde se configuró la imposición.

Los valores posibles para la aplicación 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 vínculo a este repositorio, al propietario de su organización o a su configuración global. La autorización para acceder a este punto de conexión en configuration_url se determina en el nivel de administrador del 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.

Tokens de acceso específicos para "List pre-receive hooks for a repository"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Pre-receive hooks" repository permissions (read)

Parámetros para "List pre-receive hooks for a repository"

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
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. 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 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 a repository"

status code	Descripción
`200`	OK

Ejemplos de código para "List pre-receive hooks for a repository"

Ejemplo de solicitud

get/repos/{owner}/{repo}/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/repos/OWNER/REPO/pre-receive-hooks

Response

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

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

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Pre-receive hooks" repository permissions (read)

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

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
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. 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 a repository"

status code	Descripción
`200`	OK

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

Ejemplo de solicitud

get/repos/{owner}/{repo}/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/repos/OWNER/REPO/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/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

Tokens de acceso específicos para "Update pre-receive hook enforcement for a repository"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Pre-receive hooks" repository permissions (write)

Parámetros para "Update pre-receive hook enforcement for a repository"

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
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. 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. Puede ser uno de los siguientes: `enabled`, `disabled`, `testing`

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

status code	Descripción
`200`	OK

Ejemplos de código para "Update pre-receive hook enforcement for a repository"

Ejemplo de solicitud

patch/repos/{owner}/{repo}/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/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.

Tokens de acceso específicos para "Remove pre-receive hook enforcement for a repository"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Pre-receive hooks" repository permissions (write)

Parámetros para "Remove pre-receive hook enforcement for a repository"

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
`owner` string Requerido The account owner of the repository. The name is not case sensitive.
`repo` string Requerido The name of the repository without the `.git` extension. 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 a repository"

status code	Descripción
`200`	Responds with effective values inherited from owner and/or global level.

Ejemplos de código para "Remove pre-receive hook enforcement for a repository"

Ejemplo de solicitud

delete/repos/{owner}/{repo}/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/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Responds 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"
}