DynamicFilePath

An object containing a fileName and/or folderPath field.

The folderPath may be relative or absolute; paths are relative to the API key's default folder (configured per API key in the Bytescale Dashboard).

If a field is omitted, the API key's default values will be used for that field. These are configured per API key via the Bytescale 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 Optional

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

fileNameFallback Optional

Fallback file name if the fileName is already taken.

Example: "image.jpg"

Type: String

Min Length: 0

Max Length: 512

fileNameVariablesEnabled Optional

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

folderPath Optional

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

Relative paths are relative to the API key's default folder (configured per API key in the Bytescale 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

folderPathVariablesEnabled Optional

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

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:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

DynamicFilePath

Structure

Example

Properties

fileName Optional

fileNameFallback Optional

fileNameVariablesEnabled Optional

folderPath Optional

folderPathVariablesEnabled Optional

Used by

You are using an outdated browser.