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.
Перехватчики предварительного получения организации
Используйте REST API для просмотра и изменения принудительного применения перехватчиков предварительного получения, доступных для организации.
Сведения о перехватчиках предварительного получения организации
Атрибуты объектов
Имя | Тип | Описание |
---|---|---|
name | string | Имя перехватчика. |
enforcement | string | Состояние принудительного применения перехватчика в этом репозитории. |
allow_downstream_configuration | boolean | Возможность репозитория переопределять принудительное применение. |
configuration_url | string | URL-адрес конечной точки, в которой задано принудительное применение. |
Возможные значения для enforcement
: enabled
иtesting``disabled
. 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.
Параметры
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
org stringОбязательноThe organization name. The name is not case sensitive. |
Параметры запроса |
Имя, Тип, Описание |
per_page integerThe number of results per page (max 100). Значение по умолчанию: |
page integerPage number of the results to fetch. Значение по умолчанию: |
direction stringThe direction to sort the results by. Значение по умолчанию: Может быть одним из: |
sort stringThe sort order for the response collection. Значение по умолчанию: Может быть одним из: |
Коды состояния HTTP-ответа
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода
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
Параметры
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
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-ответа
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода
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
For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement
and allow_downstream_configuration
Параметры
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
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 stringThe state of enforcement for the hook on this repository. |
allow_downstream_configuration booleanWhether repositories can override enforcement. |
Коды состояния HTTP-ответа
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода
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
Removes any overrides for this hook at the org level for this org.
Параметры
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
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-ответа
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода
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
}