Parameter object passed to the ListFolder method in the Upload SDKs.
{}{ "accountId": "YOUR_ACCOUNT_ID", "cursor": "/uploads/file.jpg", "dryRun": true, "folderPath": "/uploads", "includeExternalItems": true, "includeFiles": true, "includePhysicalFolders": true, "includeVirtualFolders": true, "limit": 50, "recursive": true}Your account ID.
This is visible on the settings page:
https://upload.io/dashboard/settings
Type: String
Length: 7
Example: "A623uY2"
Required: No
Cursor for listing folder items.
Type: String
Min Length: 1
Max Length: 512
Example: "/uploads/file.jpg"
Required: No
If true the operation will behave as a "dry run" for CopyFolder or DeleteFolder.
Specifically, the operation will return the same set of items the CopyFolder and DeleteFolder operations would run against given the same folderPath and include* filters.
Default: false
Type: Boolean
Required: No
Absolute path to a folder. Must begin with a /. Should not end with a /.
Type: String
Min Length: 1
Max Length: 512
Example: "/uploads"
Required: No
If true then includes files and physical sub-folders from folders that have overridden storage settings at this level and below.
If false then skips files and physical sub-folders that have been introduced by overridden storage settings at this level and below.
If the current folder inherits its storage settings from an ancestor that has overridden storage settings — e.g. an ancestor folder that's configured to use S3, and this folder inherits those settings — then the files and physical sub-folders of this folder will be included in this operation, regardless of this flag.
Default: true
Type: Boolean
Example: true
Required: No
If true then files will be included.
Default: true
Type: Boolean
Example: true
Required: No
If true then physical folders will be included. Physical folders are folders that are automatically created as a result of uploading files under their path, rather than being created with the PutFolder endpoint.
Default: true
Type: Boolean
Example: true
Required: No
If true then virtual folders will be included. Virtual folders are folders that have been explicitly created with the PutFolder endpoint.
Default: true
Type: Boolean
Example: true
Required: No
The maximum number of items to return.
The response might contain fewer items but will never contain more.
This limit is applied on the unfiltered result, which means the response may contain fewer items than the limit even when there are more items to return. This will occur only when one or more include* flags are set to false.
Type: Integer
Minimum: 1
Maximum: 1000
Example: 50
Required: No
If true then iterates sub-folders recursively.
Physical folders are only included when this flag is set to false.
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: