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

이 버전의 GitHub Enterprise는 다음 날짜에 중단됩니다. 2023-03-15. 중요한 보안 문제에 대해서도 패치 릴리스가 이루어지지 않습니다. 성능 향상, 향상된 보안, 새로운 기능을 위해 최신 버전의 GitHub Enterprise로 업그레이드합니다. 업그레이드에 대한 도움말은 GitHub Enterprise 지원에 문의하세요.

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를 사용하여 사전 수신 후크에 대한 환경을 만들고, 나열하고, 업데이트하고, 삭제합니다.

사전 수신 환경 정보

이러한 엔드포인트는 인증된 사이트 관리자만 사용할 수 있습니다. 일반 사용자는 응답을 받게 됩니다 404 .

개체 특성

사전 수신 환경

NameType설명
namestringUI에 표시되는 환경 이름입니다.
image_urlstring다운로드하고 추출할 tarball의 URL입니다.
default_environmentbooleanGitHub Enterprise Server와 함께 제공되는 기본 환경인지 여부입니다.
downloadobject이 환경의 다운로드 상태입니다.
hooks_countinteger이 환경을 사용하는 사전 수신 후크 수입니다.

사전 수신 환경 다운로드

NameType설명
statestring가장 최근 다운로드의 상태입니다.
downloaded_atstring가장 최근 다운로드가 시작된 시간입니다.
messagestring오류 발생 시 생성된 오류 메시지입니다.

state의 가능한 값은 not_started, in_progress, success, failed입니다.

List pre-receive environments

매개 변수

헤더
acceptstring

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

쿼리 매개 변수
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

기본값: created

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

HTTP 응답 상태 코드

상태 코드Description
200

OK

코드 샘플

get/admin/pre-receive-environments
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/admin/pre-receive-environments

Response

Status: 200
[ { "id": 1, "name": "Default", "image_url": "githubenterprise://internal", "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1", "html_url": "https://github.example.com/admin/pre-receive-environments/1", "default_environment": true, "created_at": "2016-05-20T11:35:45-05:00", "hooks_count": 14, "download": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest", "state": "not_started", "downloaded_at": "2016-05-26T07:42:53-05:00", "message": null } }, { "id": 2, "name": "DevTools Hook Env", "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", "html_url": "https://github.example.com/admin/pre-receive-environments/2", "default_environment": false, "created_at": "2016-05-20T11:35:45-05:00", "hooks_count": 1, "download": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", "state": "success", "downloaded_at": "2016-05-26T07:42:53-05:00", "message": null } } ]

Create a pre-receive environment

매개 변수

헤더
acceptstring

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

본문 매개 변수
namestring필수

The new pre-receive environment's name.

image_urlstring필수

URL from which to download a tarball of this environment.

HTTP 응답 상태 코드

상태 코드Description
201

Created

코드 샘플

post/admin/pre-receive-environments
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/admin/pre-receive-environments \ -d '{"name":"DevTools Hook Env","image_url":"https://my_file_server/path/to/devtools_env.tar.gz"}'

Response

Status: 201
{ "id": 2, "name": "DevTools Hook Env", "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", "html_url": "https://github.example.com/admin/pre-receive-environments/2", "default_environment": false, "created_at": "2016-05-20T11:35:45-05:00", "hooks_count": 1, "download": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", "state": "not_started", "downloaded_at": null, "message": null } }

Get a pre-receive environment

매개 변수

헤더
acceptstring

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

경로 매개 변수
pre_receive_environment_idinteger필수

The unique identifier of the pre-receive environment.

HTTP 응답 상태 코드

상태 코드Description
200

OK

코드 샘플

get/admin/pre-receive-environments/{pre_receive_environment_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/admin/pre-receive-environments/PRE_RECEIVE_ENVIRONMENT_ID

Response

Status: 200
{ "id": 2, "name": "DevTools Hook Env", "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", "html_url": "https://github.example.com/admin/pre-receive-environments/2", "default_environment": false, "created_at": "2016-05-20T11:35:45-05:00", "hooks_count": 1, "download": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", "state": "not_started", "downloaded_at": null, "message": null } }

Update a pre-receive environment

You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.

매개 변수

헤더
acceptstring

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

경로 매개 변수
pre_receive_environment_idinteger필수

The unique identifier of the pre-receive environment.

본문 매개 변수
namestring

This pre-receive environment's new name.

image_urlstring

URL from which to download a tarball of this environment.

HTTP 응답 상태 코드

상태 코드Description
200

OK

422

Client Errors

코드 샘플

patch/admin/pre-receive-environments/{pre_receive_environment_id}
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/admin/pre-receive-environments/PRE_RECEIVE_ENVIRONMENT_ID \ -d '{"name":"DevTools Hook Env","image_url":"https://my_file_server/path/to/devtools_env.tar.gz"}'

Response

Status: 200
{ "id": 2, "name": "DevTools Hook Env", "image_url": "https://my_file_server/path/to/devtools_env.tar.gz", "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2", "html_url": "https://github.example.com/admin/pre-receive-environments/2", "default_environment": false, "created_at": "2016-05-20T11:35:45-05:00", "hooks_count": 1, "download": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest", "state": "success", "downloaded_at": "2016-05-26T07:42:53-05:00", "message": null } }

Delete a pre-receive environment

If you attempt to delete an environment that cannot be deleted, you will receive a 422 Unprocessable Entity response.

The possible error messages are:

  • Cannot modify or delete the default environment
  • Cannot delete environment that has hooks
  • Cannot delete environment when download is in progress

매개 변수

헤더
acceptstring

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

경로 매개 변수
pre_receive_environment_idinteger필수

The unique identifier of the pre-receive environment.

HTTP 응답 상태 코드

상태 코드Description
204

No Content

422

Client Errors

코드 샘플

delete/admin/pre-receive-environments/{pre_receive_environment_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/admin/pre-receive-environments/PRE_RECEIVE_ENVIRONMENT_ID

Response

Status: 204

Start a pre-receive environment download

Triggers a new download of the environment tarball from the environment's image_url. When the download is finished, the newly downloaded tarball will overwrite the existing environment.

If a download cannot be triggered, you will receive a 422 Unprocessable Entity response.

The possible error messages are:

  • Cannot modify or delete the default environment
  • Can not start a new download when a download is in progress

매개 변수

헤더
acceptstring

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

경로 매개 변수
pre_receive_environment_idinteger필수

The unique identifier of the pre-receive environment.

HTTP 응답 상태 코드

상태 코드Description
202

Accepted

422

Client Errors

코드 샘플

post/admin/pre-receive-environments/{pre_receive_environment_id}/downloads
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/admin/pre-receive-environments/PRE_RECEIVE_ENVIRONMENT_ID/downloads

Response

Status: 202
{ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "not_started", "downloaded_at": null, "message": null }

Get the download status for a pre-receive environment

In addition to seeing the download status at the "Get a pre-receive environment" endpoint, there is also this separate endpoint for just the download status.

매개 변수

헤더
acceptstring

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

경로 매개 변수
pre_receive_environment_idinteger필수

The unique identifier of the pre-receive environment.

HTTP 응답 상태 코드

상태 코드Description
200

OK

코드 샘플

get/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/admin/pre-receive-environments/PRE_RECEIVE_ENVIRONMENT_ID/downloads/latest

Response

Status: 200
{ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "success", "downloaded_at": "2016-05-26T07:42:53-05:00", "message": null }