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 crear, enumerar, actualizar y eliminar enlaces previos a la recepción.

Acerca de ganchos de pre-recepción

Estos puntos de conexión solo están disponibles para los administradores de sitios autenticados. Los usuarios normales recibirán una respuesta 404.

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».

Atributos de objeto

Ganchos de pre-recepción

Nombre	Escribir	Descripción
`name`	`string`	El nombre del gancho.
`script`	`string`	El script que ejecuta el gancho.
`script_repository`	`object`	El repositorio de GitHub en donde se mantiene el script.
`environment`	`object`	El ambiente de pre-recepción en donde se ejecuta el script.
`enforcement`	`string`	El estado de las imposiciones para este gancho.
`allow_downstream_configuration`	`boolean`	Si las imposiciones pueden o no ignorarse a nivel de organización o de repositorio.

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.

List pre-receive hooks

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

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "List pre-receive hooks"

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

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 property to sort the results by. Valor predeterminado: `created` Puede ser uno de los siguientes: `created`, `updated`, `name`

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

status code	Descripción
`200`	OK

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

Ejemplo de solicitud

get/admin/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/admin/pre-receive-hooks

Response

Status: 200

[
  {
    "id": 1,
    "name": "Check Commits",
    "enforcement": "disabled",
    "script": "scripts/commmit_check.sh",
    "script_repository": {
      "id": 595,
      "full_name": "DevIT/hooks",
      "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
      "html_url": "https://github.example.com/DevIT/hooks"
    },
    "environment": {
      "id": 2,
      "name": "DevTools Hook Env",
      "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
      "html_url": "https://github.example.com/admin/pre-receive-environments/2",
      "default_environment": false,
      "created_at": "2016-05-20T11:35:45-05:00",
      "hooks_count": 1,
      "download": {
        "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
        "state": "success",
        "downloaded_at": "2016-05-26T07:42:53-05:00",
        "message": null
      }
    },
    "allow_downstream_configuration": false
  }
]

Create a pre-receive hook

Tokens de acceso específicos para "Create a pre-receive hook"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Create a pre-receive hook"

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

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Requerido The name of the hook.
`script` string Requerido The script that the hook runs.
`script_repository` object Requerido The GitHub repository where the script is kept.
`environment` object Requerido The pre-receive environment where the script is executed.
`enforcement` string The state of enforcement for this hook. default: `disabled`
`allow_downstream_configuration` boolean Whether enforcement can be overridden at the org or repo level. default: `false`

Códigos de estado de respuesta HTTP para "Create a pre-receive hook"

status code	Descripción
`201`	Created

Ejemplos de código para "Create a pre-receive hook"

Ejemplo de solicitud

post/admin/pre-receive-hooks

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks \
  -d '{"name":"Check Commits","script":"scripts/commit_check.sh","enforcement":"disabled","allow_downstream_configuration":false,"script_repository":{"full_name":"DevIT/hooks"},"environment":{"id":2}}'

Response

Status: 201

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 2,
    "name": "DevTools Hook Env",
    "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
    "html_url": "https://github.example.com/admin/pre-receive-environments/2",
    "default_environment": false,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": false
}

Get a pre-receive hook

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

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

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

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
`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"

status code	Descripción
`200`	OK

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

Ejemplo de solicitud

get/admin/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/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Response

Status: 200

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 2,
    "name": "DevTools Hook Env",
    "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
    "html_url": "https://github.example.com/admin/pre-receive-environments/2",
    "default_environment": false,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": false
}

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
`pre_receive_hook_id` integer Requerido The unique identifier of the pre-receive hook.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string The name of the hook.
`script` string The script that the hook runs.
`script_repository` object The GitHub repository where the script is kept.
`environment` object The pre-receive environment where the script is executed.
`enforcement` string The state of enforcement for this hook.
`allow_downstream_configuration` boolean Whether enforcement can be overridden at the org or repo level.

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

status code	Descripción
`200`	OK

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

Ejemplo de solicitud

patch/admin/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/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
  -d '{"name":"Check Commits","environment":{"id":1},"allow_downstream_configuration":true}'

Response

Status: 200

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 1,
    "name": "Default",
    "image_url": "githubenterprise://internal",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1",
    "html_url": "https://github.example.com/admin/pre-receive-environments/1",
    "default_environment": true,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": true
}

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
`pre_receive_hook_id` integer Requerido The unique identifier of the pre-receive hook.

Códigos de estado de respuesta HTTP para "Delete a pre-receive hook"

status code	Descripción
`204`	No Content

Ejemplos de código para "Delete a pre-receive hook"

Ejemplo de solicitud

delete/admin/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/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Response

Status: 204

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

Acerca de ganchos de pre-recepción

Atributos de objeto

Ganchos de pre-recepción

List pre-receive hooks

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

Parámetros para "List pre-receive hooks"

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

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

Ejemplo de solicitud

Response

Create a pre-receive hook

Tokens de acceso específicos para "Create a pre-receive hook"

Parámetros para "Create a pre-receive hook"

Códigos de estado de respuesta HTTP para "Create a pre-receive hook"

Ejemplos de código para "Create a pre-receive hook"

Ejemplo de solicitud

Response

Get a pre-receive hook

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

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

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

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

Ejemplo de solicitud

Response

Update a pre-receive hook

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

Parámetros para "Update a pre-receive hook"

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

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

Ejemplo de solicitud

Response

Delete a pre-receive hook

Tokens de acceso específicos para "Delete a pre-receive hook"

Parámetros para "Delete a pre-receive hook"

Códigos de estado de respuesta HTTP para "Delete a pre-receive hook"

Ejemplos de código para "Delete a pre-receive hook"

Ejemplo de solicitud

Response