REST API endpoints for pre-receive environments

Use the REST API to create, list, update and delete environments for pre-receive hooks.

About pre-receive environments

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

Note

These endpoints only support authentication using a personal access token (classic). For more information, see Managing your personal access tokens.

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.
`download`	`object`	This environment's download status.
`hooks_count`	`integer`	The number of pre-receive hooks that use this environment.

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.

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Query parameters
Name, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 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: