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_

POST/admin/pre-receive-environments/{pre_receive_environment_id}/downloads

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

pre_receive_environment_id integer required

Responses

application/json pre-receive-environment-download-status object

Response

downloaded_at string

optionalnullable

message string

optionalnullable

state string

optional

url string

optional

Response Example: 202 application/json

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

application/json object

Client Errors

errors array[object]

optional

items object

code string

optional

message string

optional

resource string

optional

message string

optional

Response Example: 422 application/json

{
  "errors": [
    {
      "code": "custom",
      "message": "Can not start a new download when a download is in progress",
      "resource": "PreReceiveEnvironment"
    }
  ],
  "message": "Validation Failed"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

pre_receive_environment_id *

Request Sample: Shell / cURL

curl --request POST \
  --url {protocol}://{hostname}/api/v3/admin/pre-receive-environments/{pre_receive_environment_id}/downloads