Organization Pre-receive Hooks

The Organization Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to an organization.

Atributos de objeto

Nombre	Tipo	Descripción
`name (nombre)`	`secuencia`	El nombre del gancho.
`enforcement`	`secuencia`	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`	`secuencia`	URL para la terminal en donde se configuró la imposición.

Los valores posibles para enforcement son enabled, disabled y testing. El valor disabled indica que el gancho de pre-recepción no se ejecutará. El valor enabled indica que se ejecutará y rechazará cualquier carga que resulte en un estado diferente a zero. El valor testing indica que el script va a ejecutarse pero no va a causar que se rechace ninguna carga.

configuration_url may be a link to this endpoint or this hook's global configuration. Solo los administradores de sistema pueden acceder a la configuración global.

List pre-receive hooks for an organization

Funciona con GitHub Apps

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.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended. Ver aviso de previsualización
Parámetros de ruta
Nombre, Tipo, Descripción
`org`stringRequerido 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). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`
`direction`string The direction to sort the results by. Predeterminado: `desc` Puede ser una de las siguientes: `asc`, `desc`
`sort`string The sort order for the response collection. Predeterminado: `created` Puede ser una de las siguientes: `created`, `updated`, `name`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK

Ejemplos de código

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

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <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
  }
]

Aviso de previsualización

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview

Get a pre-receive hook for an organization

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended. Ver aviso de previsualización
Parámetros de ruta
Nombre, Tipo, Descripción
`org`stringRequerido The organization name. The name is not case sensitive.
`pre_receive_hook_id`integerRequerido The unique identifier of the pre-receive hook.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK

Ejemplos de código

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

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <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
}

Aviso de previsualización

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview

Update pre-receive hook enforcement for an organization

Funciona con GitHub Apps

For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended. Ver aviso de previsualización
Parámetros de ruta
Nombre, Tipo, Descripción
`org`stringRequerido The organization name. The name is not case sensitive.
`pre_receive_hook_id`integerRequerido The unique identifier of the pre-receive hook.
Parámetros de 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

Código de estado	Descripción
`200`	OK

Ejemplos de código

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

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <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
}

Aviso de previsualización

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview

Remove pre-receive hook enforcement for an organization

Funciona con GitHub Apps

Removes any overrides for this hook at the org level for this org.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended. Ver aviso de previsualización
Parámetros de ruta
Nombre, Tipo, Descripción
`org`stringRequerido The organization name. The name is not case sensitive.
`pre_receive_hook_id`integerRequerido The unique identifier of the pre-receive hook.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK

Ejemplos de código

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

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <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
}

Aviso de previsualización

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

To access the API you must provide a custom media type in the Accept header:

application/vnd.github.eye-scream-preview