Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.

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를 사용하여 조직에서 사용할 수 있는 사전 수신 후크의 적용을 보고 수정합니다.

조직 사전 수신 후크 정보

개체 특성

NameType설명
namestring후크의 이름입니다.
enforcementstring이 리포지토리의 후크 적용 상태입니다.
allow_downstream_configurationboolean리포지토리가 적용을 재정의할 수 있는지 여부입니다.
configuration_urlstring적용이 설정된 엔드포인트의 URL입니다.

에 사용할 수 있는 enforcement 값은 , disabledtesting 입니다enabled. disabled는 사전 수신 후크가 실행되지 않음을 나타냅니다. enabled는 0이 아닌 상태가 되는 모든 푸시를 실행하고 거부함을 나타냅니다. testing은 스크립트가 실행되지만 푸시가 거부되지 않음을 의미합니다.

configuration_url은 이 엔드포인트 또는 이 후크의 전역 구성에 대한 링크일 수 있습니다. 사이트 관리자만 전역 구성에 액세스할 수 있습니다.

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.

매개 변수

헤더
Name, Type, 설명
acceptstring

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

쿼리 매개 변수
Name, Type, 설명
per_pageinteger

The number of results per page (max 100).

기본값: 30

pageinteger

Page number of the results to fetch.

기본값: 1

directionstring

The direction to sort the results by.

기본값: desc

다음 중 하나일 수 있습니다.: asc, desc

sortstring

The sort order for the response collection.

기본값: created

다음 중 하나일 수 있습니다.: created, updated, name

HTTP 응답 상태 코드

상태 코드Description
200

OK

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
acceptstring

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

pre_receive_hook_idinteger필수

The unique identifier of the pre-receive hook.

HTTP 응답 상태 코드

상태 코드Description
200

OK

코드 샘플

get/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
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

에서 작동 GitHub Apps

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

매개 변수

헤더
Name, Type, 설명
acceptstring

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

pre_receive_hook_idinteger필수

The unique identifier of the pre-receive hook.

본문 매개 변수
Name, Type, 설명
enforcementstring

The state of enforcement for the hook on this repository.

allow_downstream_configurationboolean

Whether repositories can override enforcement.

HTTP 응답 상태 코드

상태 코드Description
200

OK

코드 샘플

patch/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
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

에서 작동 GitHub Apps

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

매개 변수

헤더
Name, Type, 설명
acceptstring

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

pre_receive_hook_idinteger필수

The unique identifier of the pre-receive hook.

HTTP 응답 상태 코드

상태 코드Description
200

OK

코드 샘플

delete/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
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 }