Trigger 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.

POST /admin/pre-receive-environments/:pre_receive_environment_id/downloads

Response

Status: 202 Accepted

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

Client Errors

If a download cannot be triggered, you will get a reponse like this:

Status: 422 Unprocessable Entity

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

The possible error messages are:

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