{"meta":{"title":"Puntos de conexión de API de REST para enlaces previos a la recepción del repositorio","intro":"Usa la API REST para ver y modificar la aplicación de enlaces previos a la recepción que están disponibles para un repositorio.","product":"REST API","breadcrumbs":[{"href":"/es/enterprise-server@3.17/rest","title":"REST API"},{"href":"/es/enterprise-server@3.17/rest/enterprise-admin","title":"Administración empresarial"},{"href":"/es/enterprise-server@3.17/rest/enterprise-admin/repo-pre-receive-hooks","title":"Ganchos de pre-recepción del repositorio"}],"documentType":"article"},"body":"# Puntos de conexión de API de REST para enlaces previos a la recepción del repositorio\n\nUsa la API REST para ver y modificar la aplicación de enlaces previos a la recepción que están disponibles para un repositorio.\n\n## Acerca de los enlaces previos a la recepción del repositorio\n\n> \\[!NOTE]\n> 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](/es/enterprise-server@3.17/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).\n\n| Nombre              | Tipo     | Descripción                                               |\n| ------------------- | -------- | --------------------------------------------------------- |\n| `name`              | `string` | El nombre del gancho.                                     |\n| `enforcement`       | `string` | El estado de imposición del gancho en este repositorio.   |\n| `configuration_url` | `string` | URL para la terminal en donde se configuró la imposición. |\n\nLos valores posibles para la *aplicación* son `enabled`, `disabled` y `testing`.\n`disabled` indica que no se ejecutará el enlace previo a la recepción.\n`enabled` indica que se ejecutará y rechazará cualquier inserción que dé como resultado un estado distinto de cero.\n`testing` indica que el script se ejecutará pero no provocará el rechazo de ningún envío.\n\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 el acceso al punto final en `configuration_url` se determina a nivel de propietario o de administrador del sitio.\n\n> \\[!NOTE]\n> Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2022-11-28`. Curl examples below omit these standard headers for brevity.\n\n## List pre-receive hooks for a repository\n\n```\nGET /repos/{owner}/{repo}/pre-receive-hooks\n```\n\nList 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.\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`owner`** (string) (required)\n  The account owner of the repository. The name is not case sensitive.\n\n* **`repo`** (string) (required)\n  The name of the repository without the .git extension. The name is not case sensitive.\n\n* **`per_page`** (integer)\n  The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"\n  Default: `30`\n\n* **`page`** (integer)\n  The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"\n  Default: `1`\n\n* **`direction`** (string)\n  The direction to sort the results by.\n  Default: `desc`\n  Can be one of: `asc`, `desc`\n\n* **`sort`** (string)\n  Default: `created`\n  Can be one of: `created`, `updated`, `name`\n\n### HTTP response status codes\n\n* **200** - OK\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X GET \\\n  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks\n```\n\n**Response schema (Status: 200):**\n\nArray of objects:\n\n* `id`: integer\n* `name`: string\n* `enforcement`: string\n* `configuration_url`: string\n\n## Get a pre-receive hook for a repository\n\n```\nGET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}\n```\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`owner`** (string) (required)\n  The account owner of the repository. The name is not case sensitive.\n\n* **`repo`** (string) (required)\n  The name of the repository without the .git extension. The name is not case sensitive.\n\n* **`pre_receive_hook_id`** (integer) (required)\n  The unique identifier of the pre-receive hook.\n\n### HTTP response status codes\n\n* **200** - OK\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X GET \\\n  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID\n```\n\n**Response schema (Status: 200):**\n\n* `id`: integer\n* `name`: string\n* `enforcement`: string\n* `configuration_url`: string\n\n## Update pre-receive hook enforcement for a repository\n\n```\nPATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}\n```\n\nFor pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`owner`** (string) (required)\n  The account owner of the repository. The name is not case sensitive.\n\n* **`repo`** (string) (required)\n  The name of the repository without the .git extension. The name is not case sensitive.\n\n* **`pre_receive_hook_id`** (integer) (required)\n  The unique identifier of the pre-receive hook.\n\n#### Body parameters\n\n* **`enforcement`** (string)\n  The state of enforcement for the hook on this repository.\n  Can be one of: `enabled`, `disabled`, `testing`\n\n### HTTP response status codes\n\n* **200** - OK\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X PATCH \\\n  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \\\n  -d '{\n  \"enforcement\": \"enabled\"\n}'\n```\n\n**Response schema (Status: 200):**\n\nSame response schema as [Get a pre-receive hook for a repository](#get-a-pre-receive-hook-for-a-repository).\n\n## Remove pre-receive hook enforcement for a repository\n\n```\nDELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}\n```\n\nDeletes any overridden enforcement on this repository for the specified hook.\nResponds with effective values inherited from owner and/or global level.\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`owner`** (string) (required)\n  The account owner of the repository. The name is not case sensitive.\n\n* **`repo`** (string) (required)\n  The name of the repository without the .git extension. The name is not case sensitive.\n\n* **`pre_receive_hook_id`** (integer) (required)\n  The unique identifier of the pre-receive hook.\n\n### HTTP response status codes\n\n* **200** - Responds with effective values inherited from owner and/or global level.\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X DELETE \\\n  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID\n```\n\n**Response schema (Status: 200):**\n\nSame response schema as [Get a pre-receive hook for a repository](#get-a-pre-receive-hook-for-a-repository)."}