DynamicFilePath

An object containing a fileName and/or folderPath.

Both fields are optional: omitted fields will use the API key's default values, which are configured per API key via the Upload Dashboard.

Supports path variables.

Structure

{
  "fileName": String,
  "fileNameFallback": String,
  "fileNameVariablesEnabled": Boolean,
  "folderPath": String,
  "folderPathVariablesEnabled": Boolean
}

Example

{
  "fileName": "image.jpg",
  "fileNameFallback": "image.jpg",
  "fileNameVariablesEnabled": true,
  "folderPath": "/uploads",
  "folderPathVariablesEnabled": true
}

Properties

fileName

The file name to upload the file with.

Must not contain /.

Supports path variables.

Example: "image.jpg"

Type: String

Min Length: 0

Max Length: 512

Required: No

fileNameFallback

Fallback file name if the fileName is already taken.

Example: "image.jpg"

Type: String

Min Length: 0

Max Length: 512

Required: No

fileNameVariablesEnabled

If true then path variables like {UTC_DATE} in the fileName will be replaced. You can escape { characters with a \.

If false then path variables like {UTC_DATE} in the fileName will be taken literally.

Default: true

Type: Boolean

Required: No

folderPath

Absolute or relative path to a folder in your Upload account's storage.

Relative paths are relative to the API key's default folder (configured per API key in the Upload Dashboard).

Should not end with /.

Does not support path traversals (e.g. ..).

Supports path variables.

Example: "/uploads"

Type: String

Min Length: 0

Max Length: 512

Required: No

folderPathVariablesEnabled

If true then path variables like {UTC_DATE} in the folderPath will be replaced. You can escape { characters with a \.

If false then path variables like {UTC_DATE} in the folderPath will be taken literally.

Default: true

Type: Boolean

Required: No

Used by

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

DynamicFilePath

Structure

Example

Properties

fileName

fileNameFallback

fileNameVariablesEnabled

folderPath

folderPathVariablesEnabled

Used by

You are using an outdated browser.