Hooks pre-receive da organização

A API de hooks pre-receive da organização permite que você veja e modifique a aplicação dos hooks pre-receive disponíveis para uma organização.

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 aplicação são habilitado, desabilitado etestando. desabilitado indica que o hook pre-receive não será executado. habilitado indica que será executado e rejeitará quaisquer pushes que resultem em um estado diferente de zero. testando significa que o script será executado, mas não fará com que quaisquer pushes sejam rejeitados.

configuration_url pode ser um link para este ponto de extremidade ou a configuração global deste hook. Apenas administradores do site podem acessar a configuração global.

List pre-receive hooks for an organization

Works with 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

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigató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). Padrão: `30`
`page`integer Page number of the results to fetch. Padrão: `1`
`direction`string The direction to sort the results by. Padrão: `desc` Pode ser uma das ações a seguir: `asc`, `desc`
`sort`string The sort order for the response collection. Padrão: `created` Pode ser uma das ações a seguir: `created`, `updated`, `name`

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

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

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

Get a pre-receive hook for an organization

Works with GitHub Apps

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.
`pre_receive_hook_id`integerObrigatório The unique identifier of the pre-receive hook.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

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

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

Update pre-receive hook enforcement for an organization

Works with 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

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.
`pre_receive_hook_id`integerObrigatório The unique identifier of the pre-receive hook.
Body parameters
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.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

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

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

Remove pre-receive hook enforcement for an organization

Works with GitHub Apps

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

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.
`pre_receive_hook_id`integerObrigatório The unique identifier of the pre-receive hook.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

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

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