Поддержка этой версии GitHub Enterprise была прекращена 2023-01-18. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, укрепления безопасности и новых функций установите последнюю версию 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 для создания, перечисления, обновления и удаления сред для перехватчиков предварительного получения.

About pre-receive environments

These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.

Object attributes

Pre-receive Environment

Name	Type	Description
`name`	`string`	The name of the environment as displayed in the UI.
`image_url`	`string`	URL to the tarball that will be downloaded and extracted.
`default_environment`	`boolean`	Whether this is the default environment that ships with GitHub Enterprise Server.
`download`	`object`	This environment's download status.
`hooks_count`	`integer`	The number of pre-receive hooks that use this environment.

Pre-receive Environment Download

Name	Type	Description
`state`	`string`	The state of the most recent download.
`downloaded_at`	`string`	The time when the most recent download started.
`message`	`string`	On failure, this will have any error messages produced.

Possible values for state are not_started, in_progress, success, failed.

List pre-receive environments

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Query parameters
Имя, Type, Описание
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`
`direction`string The direction to sort the results by. Default: `desc` Can be one of: `asc`, `desc`
`sort`string Default: `created` Can be one of: `created`, `updated`, `name`

HTTP response status codes

Status code	Описание
`200`	OK

Code samples

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

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Body parameters
Имя, Type, Описание
`name`stringRequired The new pre-receive environment's name.
`image_url`stringRequired URL from which to download a tarball of this environment.

HTTP response status codes

Status code	Описание
`201`	Created

Code samples

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

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`pre_receive_environment_id`integerRequired The unique identifier of the pre-receive environment.

HTTP response status codes

Status code	Описание
`200`	OK

Code samples

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.

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`pre_receive_environment_id`integerRequired The unique identifier of the pre-receive environment.
Body parameters
Имя, Type, Описание
`name`string This pre-receive environment's new name.
`image_url`string URL from which to download a tarball of this environment.

HTTP response status codes

Status code	Описание
`200`	OK
`422`	Client Errors

Code samples

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

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`pre_receive_environment_id`integerRequired The unique identifier of the pre-receive environment.

HTTP response status codes

Status code	Описание
`204`	No Content
`422`	Client Errors

Code samples

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

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`pre_receive_environment_id`integerRequired The unique identifier of the pre-receive environment.

HTTP response status codes

Status code	Описание
`202`	Accepted
`422`	Client Errors

Code samples

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.

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`pre_receive_environment_id`integerRequired The unique identifier of the pre-receive environment.

HTTP response status codes

Status code	Описание
`200`	OK

Code samples

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
}

Dec	JAN	Feb
	27
2022	2023	2024