Download Droplet

Download Droplet
Download droplet bits

Download a gzip compressed tarball file containing a Cloud Foundry compatible droplet. When using a remote blobstore, such as AWS, the response is a redirect to the actual location of the bits. If the client is automatically following redirects, then the OAuth token that was used to communicate with Cloud Controller will be relayed on the new redirect request. Some blobstores may reject the request in that case. Clients may need to follow the redirect without including the OAuth token. Only droplets that are in the STAGED state and have lifecycle type buildpack can be downloaded.

Request
URI
GET
https://api.example.local/v3/droplets/{guid}/download
COPY
Path Parameters
string
guid
Required

The unique identifier for the resource

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns file of type(s) application/octet-stream
Operation doesn't return any data structure

302

Redirect to download location

Operation doesn't return any data structure

401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


404

Not Found

Returns NotFound of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


422

Unprocessable Entity

Returns UnprocessableEntity of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


502

Bad Gateway

Returns BadGateway of type(s) application/json 
{
    "code": 0,
    "detail": "string",
    "title": "string"
}
integer
code
Optional

A numeric code for this error

string
detail
Optional

Detailed description of the error

string
title
Optional

Name of the error


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v3/droplets/{guid}/download
On This Page
Droplets Operations
GET
List Droplets
POST
Create Droplet
GET
Get Droplet
PATCH
Update Droplet
DELETE
Delete Droplet
GET
Download Droplet
POST
Upload Droplet