최근에 REST API 설명서 중 일부를 이동했습니다. 원하는 항목을 찾을 수 없는 경우 동작 REST API 페이지를 사용해 볼 수 있습니다.
조직 사전 수신 후크
REST API를 사용하여 조직에서 사용할 수 있는 사전 수신 후크의 적용을 보고 수정합니다.
조직 사전 수신 후크 정보
개체 특성
Name | 형식 | 설명 |
---|---|---|
name | string | 후크의 이름입니다. |
enforcement | string | 이 리포지토리의 후크 적용 상태입니다. |
allow_downstream_configuration | boolean | 리포지토리가 적용을 재정의할 수 있는지 여부입니다. |
configuration_url | string | 적용이 설정된 엔드포인트의 URL입니다. |
에 사용할 수 있는 enforcement
값은 , disabled
및testing
입니다enabled
. disabled
는 사전 수신 후크가 실행되지 않음을 나타냅니다. enabled
는 0이 아닌 상태가 되는 모든 푸시를 실행하고 거부함을 나타냅니다. 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"에 대한 매개 변수
헤더 |
---|
속성, 형식, Description |
accept string Setting to |
경로 매개 변수 |
속성, 형식, Description |
org string 필수The organization name. The name is not case sensitive. |
쿼리 매개 변수 |
속성, 형식, Description |
per_page integer The number of results per page (max 100). 기본값: |
page integer Page number of the results to fetch. 기본값: |
direction string The direction to sort the results by. 기본값: 다음 중 하나일 수 있습니다.: |
sort string The sort order for the response collection. 기본값: 다음 중 하나일 수 있습니다.: |
"List pre-receive hooks for an organization"에 대한 HTTP 응답 상태 코드
상태 코드 | Description |
---|---|
200 | OK |
"List pre-receive hooks for an organization"에 대한 코드 샘플
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
"Get a pre-receive hook for an organization"에 대한 매개 변수
헤더 |
---|
속성, 형식, Description |
accept string Setting to |
경로 매개 변수 |
속성, 형식, 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. |
"Get a pre-receive hook for an organization"에 대한 HTTP 응답 상태 코드
상태 코드 | Description |
---|---|
200 | OK |
"Get a pre-receive hook for an organization"에 대한 코드 샘플
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
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"에 대한 매개 변수
헤더 |
---|
속성, 형식, Description |
accept string Setting to |
경로 매개 변수 |
속성, 형식, 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. |
"Update pre-receive hook enforcement for an organization"에 대한 HTTP 응답 상태 코드
상태 코드 | Description |
---|---|
200 | OK |
"Update pre-receive hook enforcement for an organization"에 대한 코드 샘플
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
Removes any overrides for this hook at the org level for this org.
"Remove pre-receive hook enforcement for an organization"에 대한 매개 변수
헤더 |
---|
속성, 형식, Description |
accept string Setting to |
경로 매개 변수 |
속성, 형식, 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. |
"Remove pre-receive hook enforcement for an organization"에 대한 HTTP 응답 상태 코드
상태 코드 | Description |
---|---|
200 | OK |
"Remove pre-receive hook enforcement for an organization"에 대한 코드 샘플
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
}