Data Types

DynamicFilePath

An object containing a fileName and/or folderPath.

Both fields are optional and support path variables.

If a field is omitted, the API key's default value is used for that field. Default values are configured per API key via the Upload Dashboard.

Structure

Example

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

Properties

fileName

File name. May be empty string "". Cannot contain /.

Type: String

Min Length: 0

Max Length: 512

Example: "image.jpg"

Required: No

fileNameVariablesEnabled

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

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

Default: true

Type: Boolean

Example: true

Required: No

folderPath

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

Type: String

Min Length: 0

Max Length: 512

Example: "/uploads"

Required: No

folderPathVariablesEnabled

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

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

Default: true

Type: Boolean

Example: true

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: