DownloadFileParams

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

Structure

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

Example

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

Properties

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Example: "A623uY2"

Type: String

Length: 7

Required: No

cache

Specifies whether to cache the raw file in the Upload CDN.

Default: true

Type: Boolean

Required: No

cache_ttl

Specifies the maximum amount of time, in seconds, the file will be cached on the user's device and in the Upload CDN's edge cache.

Default: Please refer to your account's default cache settings in the Upload Dashboard.

Type: Number

Required: No

filePath

Absolute path to a file. Begins with a /.

Example: "/uploads/image.jpg"

Type: String

Min Length: 1

Max Length: 512

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 of the version parameter 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.

Example: "1"

Type: String

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:

File Uploading

File Processing APIs

Data Types

More Resources

DownloadFileParams

Structure

Example

Properties

accountId

cache

cache_ttl

filePath

version

You are using an outdated browser.