Skip to content

Download a bundle as a zip

GET
/drives/{drive}/bundles/{bundle}/download
curl --request GET \
--url https://work.optidata.cloud/api/drives/1/bundles/1/download \
--header 'Authorization: Bearer <token>'

Streams the zip archive of a completed bundle request. Requires permission to download the bundle.

A bundle that is still being assembled, or whose archive has already been cleaned up, answers with an error rather than a partial file.

drive
required
integer format: int64

Numeric id of the drive. Read it from GET /drives/config.json.

bundle
required
integer format: int64

Numeric id of the bundle request.

The zip archive.

Media typeapplication/zip
string format: binary

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
"error": "JWT passport exception: Missing bearer token in request"
}

The caller lacks the permission level the operation requires.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
"message": "This action is unauthorized."
}

The bundle does not exist, is not ready yet, or its archive is gone.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examplegenerated
{
"message": "example"
}

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
"message": "Too Many Attempts."
}