Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

Hooks de pré-recebimento da organização

Use a API REST para exibir e modificar a aplicação dos ganchos de pré-recebimento disponíveis para uma organização.

Sobre os ganchos de pré-recebimento de organização

Atributos do objeto

NomeTipoDescrição
namestringO nome do hook.
enforcementstringO estado de aplicação para o hook neste repositório.
allow_downstream_configurationbooleanSe os repositórios podem substituir a imposição.
configuration_urlstringURL para o ponto de extremidade em que a aplicação é definida.

Os valores possíveis para enforcement são enabled, disabled e testing. disabled indica que o gancho de pré-recebimento não será executado. enabled indica que ele será executado e rejeitará os pushes que resultem em um status diferente de zero. testing significa que o script será executado, mas não fará com que nenhum push seja rejeitado.

configuration_url pode ser um link para esse ponto de extremidade ou para a configuração global desse gancho. Apenas administradores do site podem acessar a configuração global.

List pre-receive hooks for an organization

Funciona com 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

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

Parâmetros de consulta
Nome, Type, Descrição
per_pageinteger

The number of results per page (max 100).

Padrão: 30

pageinteger

Page number of the results to fetch.

Padrão: 1

directionstring

The direction to sort the results by.

Padrão: desc

Pode ser um dos: asc, desc

sortstring

The sort order for the response collection.

Padrão: created

Pode ser um dos: created, updated, name

Códigos de status de resposta HTTP

Código de statusDescrição
200

OK

Exemplos de código

get/orgs/{org}/pre-receive-hooks
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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 } ]

Get a pre-receive hook for an organization

Funciona com GitHub Apps

Parâmetros

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

pre_receive_hook_idintegerObrigatório

The unique identifier of the pre-receive hook.

Códigos de status de resposta HTTP

Código de statusDescrição
200

OK

Exemplos de código

get/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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 }

Update pre-receive hook enforcement for an organization

Funciona com 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

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

pre_receive_hook_idintegerObrigatório

The unique identifier of the pre-receive hook.

Parâmetros do corpo
Nome, Type, Descrição
enforcementstring

The state of enforcement for the hook on this repository.

allow_downstream_configurationboolean

Whether repositories can override enforcement.

Códigos de status de resposta HTTP

Código de statusDescrição
200

OK

Exemplos de código

patch/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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 }

Remove pre-receive hook enforcement for an organization

Funciona com GitHub Apps

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

Parâmetros

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

pre_receive_hook_idintegerObrigatório

The unique identifier of the pre-receive hook.

Códigos de status de resposta HTTP

Código de statusDescrição
200

OK

Exemplos de código

delete/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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 }