Перехватчики предварительного получения организации

Используйте REST API для просмотра и изменения принудительного применения перехватчиков предварительного получения, доступных для организации.

About organization pre-receive hooks

Object attributes

Name	Type	Description
`name`	`string`	The name of the hook.
`enforcement`	`string`	The state of enforcement for the hook on this repository.
`allow_downstream_configuration`	`boolean`	Whether repositories can override enforcement.
`configuration_url`	`string`	URL for the endpoint where enforcement is set.

Possible values for enforcement are enabled, disabled andtesting. disabled indicates the pre-receive hook will not run. enabled indicates it will run and reject any pushes that result in a non-zero status. testing means the script will run but will not cause any pushes to be rejected.

configuration_url may be a link to this endpoint or this hook's global configuration. Only site admins are able to access the global configuration.

List pre-receive hooks for an organization

Работа с 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.

Параметры для "List pre-receive hooks for an organization"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`per_page` integer The number of results per page (max 100). По умолчанию: `30`
`page` integer Page number of the results to fetch. По умолчанию: `1`
`direction` string The direction to sort the results by. По умолчанию: `desc` Может быть одним из: `asc`, `desc`
`sort` string The sort order for the response collection. По умолчанию: `created` Может быть одним из: `created`, `updated`, `name`

Коды состояния HTTP-ответа для "List pre-receive hooks for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "List pre-receive hooks for an organization"

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

curl -L \
  -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

Работа с GitHub Apps

Параметры для "Get a pre-receive hook for an organization"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Обязательно The unique identifier of the pre-receive hook.

Коды состояния HTTP-ответа для "Get a pre-receive hook for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "Get a pre-receive hook for an organization"

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

curl -L \
  -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

Работа с GitHub Apps

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

Параметры для "Update pre-receive hook enforcement for an organization"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Обязательно The unique identifier of the pre-receive hook.
Параметры запроса
Имя, Тип, Описание
`enforcement` string The state of enforcement for the hook on this repository.
`allow_downstream_configuration` boolean Whether repositories can override enforcement.

Коды состояния HTTP-ответа для "Update pre-receive hook enforcement for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "Update pre-receive hook enforcement for an organization"

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>" \
  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

Работа с GitHub Apps

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

Параметры для "Remove pre-receive hook enforcement for an organization"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Обязательно The unique identifier of the pre-receive hook.

Коды состояния HTTP-ответа для "Remove pre-receive hook enforcement for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "Remove pre-receive hook enforcement for an organization"

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>" \
  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
}