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.
{}
{ "fileName": "image.jpg", "fileNameVariablesEnabled": true, "folderPath": "/uploads", "folderPathVariablesEnabled": true}
File name. May be empty string "". Cannot contain /.
Type: String
Min Length: 0
Max Length: 512
Example: "image.jpg"
Required: No
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
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
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
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: