이 버전의 GitHub Enterprise는 다음 날짜에 중단되었습니다. 2023-03-15. 중요한 보안 문제에 대해서도 패치 릴리스가 이루어지지 않습니다. 성능 향상, 향상된 보안, 새로운 기능을 위해 최신 버전의 GitHub Enterprise로 업그레이드합니다. 업그레이드에 대한 도움말은 GitHub Enterprise 지원에 문의하세요.
최근에 REST API 설명서 중 일부를 이동했습니다. 원하는 항목을 찾을 수 없는 경우 동작 REST API 페이지를 사용해 볼 수 있습니다.
리포지토리 사전 수신 후크
REST API를 사용하여 리포지토리에 사용할 수 있는 사전 수신 후크의 적용을 보고 수정합니다.
리포지토리 사전 수신 후크 정보
| 속성 | 형식 | 설명 |
|---|---|---|
name | string | 후크의 이름입니다. |
enforcement | string | 이 리포지토리의 후크 적용 상태입니다. |
configuration_url | string | 적용이 설정된 엔드포인트의 URL입니다. |
적용 가능한 값은 enabled, disabled 및 testing입니다. disabled는 사전 수신 후크가 실행되지 않음을 나타냅니다. enabled는 0이 아닌 상태가 되는 모든 푸시를 실행하고 거부함을 나타냅니다. testing은 스크립트가 실행되지만 푸시가 거부되지 않음을 의미합니다.
configuration_url은 이 리포지토리에 대한 링크일 수 있으며, 조직 소유자 또는 전역 구성입니다. configuration_url의 엔드포인트에 대한 액세스 권한 부여는 소유자 또는 사이트 관리자 수준에서 결정됩니다.
List pre-receive hooks for a repository
List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
"List pre-receive hooks for a repository"에 대한 매개 변수
| 헤더 |
|---|
| 이름, 형식, Description |
accept string Setting to |
| 경로 매개 변수 |
| 이름, 형식, Description |
owner string 필수The account owner of the repository. The name is not case sensitive. |
repo string 필수The name of the repository. 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 기본값: 다음 중 하나일 수 있습니다.: |
"List pre-receive hooks for a repository"에 대한 HTTP 응답 상태 코드
| 상태 코드 | Description |
|---|---|
200 | OK |
"List pre-receive hooks for a repository"에 대한 코드 샘플
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooksResponse
Status: 200[
{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}
]Get a pre-receive hook for a repository
"Get a pre-receive hook for a repository"에 대한 매개 변수
| 헤더 |
|---|
| 이름, 형식, Description |
accept string Setting to |
| 경로 매개 변수 |
| 이름, 형식, Description |
owner string 필수The account owner of the repository. The name is not case sensitive. |
repo string 필수The name of the repository. 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 a repository"에 대한 HTTP 응답 상태 코드
| 상태 코드 | Description |
|---|---|
200 | OK |
"Get a pre-receive hook for a repository"에 대한 코드 샘플
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_IDResponse
Status: 200{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}Update pre-receive hook enforcement for a repository
For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
"Update pre-receive hook enforcement for a repository"에 대한 매개 변수
| 헤더 |
|---|
| 이름, 형식, Description |
accept string Setting to |
| 경로 매개 변수 |
| 이름, 형식, Description |
owner string 필수The account owner of the repository. The name is not case sensitive. |
repo string 필수The name of the repository. 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. 다음 중 하나일 수 있습니다.: |
"Update pre-receive hook enforcement for a repository"에 대한 HTTP 응답 상태 코드
| 상태 코드 | Description |
|---|---|
200 | OK |
"Update pre-receive hook enforcement for a repository"에 대한 코드 샘플
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
-d '{"enforcement":"enabled"}'Response
Status: 200{
"id": 42,
"name": "Check Commits",
"enforcement": "enabled",
"configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42"
}Remove pre-receive hook enforcement for a repository
Deletes any overridden enforcement on this repository for the specified hook.
Responds with effective values inherited from owner and/or global level.
"Remove pre-receive hook enforcement for a repository"에 대한 매개 변수
| 헤더 |
|---|
| 이름, 형식, Description |
accept string Setting to |
| 경로 매개 변수 |
| 이름, 형식, Description |
owner string 필수The account owner of the repository. The name is not case sensitive. |
repo string 필수The name of the repository. 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 a repository"에 대한 HTTP 응답 상태 코드
| 상태 코드 | Description |
|---|---|
200 | Responds with effective values inherited from owner and/or global level. |
"Remove pre-receive hook enforcement for a repository"에 대한 코드 샘플
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_IDResponds with effective values inherited from owner and/or global level.
Status: 200{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}