Data Types

DownloadFileParams

Parameter object passed to the DownloadFile method in the Upload SDKs.

Structure

{
"accountId": String,
"cache": Boolean,
"filePath": String,
"version": String
}

Example

{
"accountId": "YOUR_ACCOUNT_ID",
"cache": true,
"filePath": "/uploads/image.jpg",
"version": "1"
}

Properties

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Type: String

Length: 7

Example: "A623uY2"

Required: No

cache

Prevents the raw file from being cached by the Upload CDN.

Type: Boolean

Example: true

Required: No

filePath

Absolute path to a file. Must begin with a /.

Type: String

Min Length: 1

Max Length: 512

Example: "/uploads/image.jpg"

Required: No

version

Downloads the latest version of your file (if you have overwritten it) when added to the URL with a unique value.

The value can be anything, e.g. an incremental number, a timestamp, etc.

You only need to provide and update this value if/when you overwrite your file.

The alias _v is also supported.

Type: String

Example: "1"

Required: No

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: