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

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

Эти конечные точки поддерживают проверку подлинности только с помощью personal access token (classic). Дополнительные сведения см. в разделе Управление личными маркерами доступа.

Атрибуты объектов

Имя.	Тип	Описание
`name`	`string`	Имя перехватчика.
`enforcement`	`string`	Состояние принудительного применения перехватчика в этом репозитории.
`allow_downstream_configuration`	`boolean`	Возможность репозитория переопределять принудительное применение.
`configuration_url`	`string`	URL-адрес конечной точки, в которой задано принудительное применение.

Возможные значения: enforcement enabled``disabled и.testing disabled указывает, что перехватчик предварительного получения не будет выполняться. enabled указывает, что он будет выполняться и отклонять все отправки, результатом которых является переход в ненулевое состояние. testing означает, что скрипт будет выполняться, но отправки отклоняться не будут.

configuration_url может быть ссылкой на эту конечную точку или глобальную конфигурацию этого перехватчика. Получать доступ к глобальной конфигурации могут только администраторы сайта.

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.

Подробные маркеры доступа для "List pre-receive hooks for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Pre-receive hooks" organization permissions (read)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `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>" \
  -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

Подробные маркеры доступа для "Get a pre-receive hook for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Pre-receive hooks" organization permissions (read)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`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>" \
  -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

Подробные маркеры доступа для "Update pre-receive hook enforcement for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Pre-receive hooks" organization permissions (write)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`pre_receive_hook_id` integer Обязательное поле The unique identifier of the pre-receive hook.

Параметры запроса
Имя., Тип, Description
`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>" \
  -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.

Подробные маркеры доступа для "Remove pre-receive hook enforcement for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Pre-receive hooks" organization permissions (write)

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`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>" \
  -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
}