Pontos de extremidade da API REST para ganchos de pré-recebimento da organização

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

Esses pontos de extremidade só dão suporte à autenticação por meio de um personal access token (classic). Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".

Atributos do objeto

Nome	Tipo	Descrição
`name`	`string`	O nome do hook.
`enforcement`	`string`	O estado de aplicação para o hook neste repositório.
`allow_downstream_configuration`	`boolean`	Se os repositórios podem substituir a imposição.
`configuration_url`	`string`	URL 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

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.

Tokens de acesso refinados para "List pre-receive hooks for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Pre-receive hooks" organization permissions (read)

Parâmetros para "List pre-receive hooks for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`
`direction` string The direction to sort the results by. Padrão: `desc` Pode ser um dos: `asc`, `desc`
`sort` string The sort order for the response collection. Padrão: `created` Pode ser um dos: `created`, `updated`, `name`

Códigos de status de resposta HTTP para "List pre-receive hooks for an organization"

Código de status	Descrição
`200`	OK

Exemplos de código para "List pre-receive hooks for an organization"

Exemplo de solicitação

get/orgs/{org}/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/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

Tokens de acesso refinados para "Get a pre-receive hook for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Pre-receive hooks" organization permissions (read)

Parâmetros para "Get a pre-receive hook for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Obrigatório The unique identifier of the pre-receive hook.

Códigos de status de resposta HTTP para "Get a pre-receive hook for an organization"

Código de status	Descrição
`200`	OK

Exemplos de código para "Get a pre-receive hook for an organization"

Exemplo de solicitação

get/orgs/{org}/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/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

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

Tokens de acesso refinados para "Update pre-receive hook enforcement for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Pre-receive hooks" organization permissions (write)

Parâmetros para "Update pre-receive hook enforcement for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Obrigatório The unique identifier of the pre-receive hook.

Parâmetros do corpo
Nome, Tipo, Descrição
`enforcement` string The state of enforcement for the hook on this repository.
`allow_downstream_configuration` boolean Whether repositories can override enforcement.

Códigos de status de resposta HTTP para "Update pre-receive hook enforcement for an organization"

Código de status	Descrição
`200`	OK

Exemplos de código para "Update pre-receive hook enforcement for an organization"

Exemplo de solicitação

patch/orgs/{org}/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/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

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

Tokens de acesso refinados para "Remove pre-receive hook enforcement for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Pre-receive hooks" organization permissions (write)

Parâmetros para "Remove pre-receive hook enforcement for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Obrigatório The unique identifier of the pre-receive hook.

Códigos de status de resposta HTTP para "Remove pre-receive hook enforcement for an organization"

Código de status	Descrição
`200`	OK

Exemplos de código para "Remove pre-receive hook enforcement for an organization"

Exemplo de solicitação

delete/orgs/{org}/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/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
}