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.
{}
{ "fileName": "image.jpg", "fileNameFallback": "image.jpg", "fileNameVariablesEnabled": true, "folderPath": "/uploads", "folderPathVariablesEnabled": true}
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
Fallback file name if the fileName is already taken.
Example: "image.jpg"
Type: String
Min Length: 0
Max Length: 512
Required: No
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
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
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
This website uses cookies. By continuing you are consenting to the use of cookies per our cookie policy.
This website requires a modern web browser -- the latest versions of these browsers are supported: