Skip to main content

File

Add Bucket Tags

Adds specified tags to the bucket metadata. It runs when all the input link points are active . If successful, returns the updated bucket metadata and triggers bucketMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node parameters
NameTypeDescription
bucketMetadataobjectMetadata of the updated bucket
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket.
Bucket tag(s)requiredThe tags that will be added to the bucket metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Add File Tags

Adds specified tags to the file metadata. It runs when all the input link points are active . If successful, returns the updated file metadata and triggers fileMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node parameters
NameTypeDescription
fileMetadataobjectMetadata of the updated file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be renamed.
File tag(s)requiredThe tags that will be added to the file metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Copy File to Bucket

Copies the file to another bucket. If there already exists a file with the same name in destination bucket, it ensures the copied file name to be unique in its new destination. It runs when all the inputs are active. If successful, it triggers fileMetadata; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node parameters
NameTypeDescription
fileMetadataobjectMetadata of the copied file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be copied.
Destination bucket id/namerequiredThe id or name of the bucket that the file will be copied to.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Create Bucket

Creates a new bucket. If there already exists a bucket with the specified name, it returns an error. If successful, it triggers bucketMetadata; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node parameters
NameTypeDescription
bucketMetadataobjectMetadata of the created bucket
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket namerequiredThe name of the bucket to create.
Default file access typerequiredThe default privacy setting that will be applied to the files uploaded to this bucket.
Bucket tag(s)optionalThe tags that will be added to the bucket metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Delete Bucket

Deletes the bucket and all objects (e.g., files) inside the bucket. It runs when all the input link points are active. If successful, it triggers success; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
successtriggerSuccessful delete operation trigger
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket to delete
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Delete File Identified by Url

Deletes a file identified by the url string. It runs when all the input link points are active. If successful, it triggers success; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
successtriggerSuccessful delete operation trigger
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
File URLrequiredThe public url of the file to delete
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Delete Files from Storage

Deletes the files with the provided file ids/names. It runs when all the input link points are active. If successful, it triggers success; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
successtriggerSuccessful delete operation trigger
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File ids/namesrequiredThe array of ids/names of the files that will be deleted.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Delete Single File from Storage

Deletes the file with the provided bucket and file id/name. It runs when all the input link points are active. If successful, it triggers success; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
successtriggerSuccessful delete operation trigger
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be deleted.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Download File from Storage

Downloads the file with the provided bucket and file id/name. It runs when all the input link points are active. If successful, it triggers file.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
fileobjectFile object including the metadata and contents of the file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be downloaded.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Duplicate File in Storage

Creates a duplicate of the file with the provided bucket and file id/name. It runs when all the input link points are active. If successful, it triggers fileMetadata; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
fileMetadataobjectMetadata of the duplicated file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be duplicated.
Duplicate file namerequiredThe name of the duplicate file (including the file extension). The new duplicate file name. If not specified, uses the original file name as template and ensures the duplicated file name to be unique in its bucket.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Empty Bucket

Removes all objects (e.g., files) inside the bucket. This method does not delete the bucket itself. It runs when all the input link points are active. If successful, it triggers success; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
successtriggerSuccessful empty operation trigger
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket to delete its files.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Get Bucket Files

Gets the list of files matching the query expression. If select query expression is specified, it runs the specified filter query to narrow down returned results, otherwise, returns all files contained in the bucket. It runs when all the input link points are active. If successful, triggers the result and countInfo (if selected) otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
resultlistList of file metadata matching the filter query
countInfoobjectQuery result count info object, which holds total objects count matching the query condition, total pages, current page, and page size information
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket.
Select queryoptionalThe select query expression to retrieve the list of file metadata from the bucket.
Sort fieldsoptionalThe list of file fields to use for sorting the query results
Page numberoptionalPage number to paginate query results
Page sizeoptionalMaximum number of items to fetch per page
Return count infooptionalFlag to show/hide count info output link point.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Get Bucket Metadata

Gets the metadata of the bucket with the provided bucket id/name. It runs when all the input link points are active . If successful, it triggers bucketMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
bucketMetadataobjectMetadata of the bucket
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket.
Return bucket detailsrequiredIf checked it provides additional information about the total number of files contained, their overall total size in bytes, average, min and max file size in bytes etc.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Get Buckets

Gets the list of buckets matching the query expression. If select query expression is specified, it runs the specified filter query to narrow down returned results, otherwise, returns all buckets contained in app. If successful, triggers the result and countInfo (if selected) otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
resultlistList of bucket metadata matching the filter query
countInfoobjectQuery result count info object, which holds total objects count matching the query condition, total pages, current page, and page size information
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Select queryoptionalThe select query expression to retrieve the list of bucket metadata from the cloud storage.
Sort fieldsoptionalThe list of bucket fields to use for sorting the query results
Page numberoptionalPage number to paginate query results
Page sizeoptionalMaximum number of items to fetch per page
Return count infooptionalFlag to show/hide count info output link point.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Get File Metadata

Gets the metadata of the file with the provided bucket and file id/name. It runs when all the input link points are active . If successful, it triggers fileMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
fileMetadataobjectMetadata of the file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be queried for metadata.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Get Storage Stats

Returns the overall information about your apps cloud storage including total number of buckets and files stored, total storage size in bytes and average, min and max file size in bytes. It runs when all the input link points are active. If successful, it triggers success; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
storageStatsobjectInformation about storage usage of the app
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Make Bucket Private

Sets the default privacy of the bucket to private. It runs when all the input link points are active . If successful, it triggers bucketMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
bucketMetadataobjectMetadata of the bucket
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket.
Include filesrequiredIf checked, it also makes each file in the bucket private.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Make Bucket Public

Sets the default privacy of the bucket to public. It runs when all the input link points are active . If successful, it triggers bucketMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
bucketMetadataobjectMetadata of the bucket
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket.
Include filesrequiredIf checked, it also makes each file in the bucket public.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Move File to Bucket

Moves the file to another bucket. The file will be removed from its current bucket and will be moved to its new bucket. If there already exists a file with the same name in destination bucket, it ensures the moved file name to be unique in its new destination. It runs when all the inputs are active. If successful, it triggers fileMetadata; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
fileMetadataobjectMetadata of the moved file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be moved.
Destination bucket id/namerequiredThe id or name of the bucket that the file will be moved to.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Remove Bucket Tags

Removes specified tags from the bucket metadata. It runs when all the input link points are active . If successful, returns the updated bucket metadata and triggers bucketMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node parameters
NameTypeDescription
bucketMetadataobjectMetadata of the updated bucket
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket.
Bucket tag(s)requiredThe tags that will be removed from the bucket metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Remove File Tags

Removes specified tags from the file metadata. It runs when all the input link points are active . If successful, returns the updated file metadata and triggers fileMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node parameters
NameTypeDescription
fileMetadataobjectMetadata of the updated file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be updated.
File tag(s)requiredThe tags that will be removed from the file metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Rename Bucket

Renames the bucket. It runs when all the input link points are active . If successful, it triggers bucketMetadata.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
bucketMetadataobjectMetadata of the bucket
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/namerequiredThe id or name of the bucket.
Bucket namerequiredThe new name of the bucket.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Rename File

Renames the file with the provided bucket and file id/name. It runs when all the input link points are active. If successful, it triggers fileMetadata; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify file id and/or file name
NameTypeDescription
fileMetadataobjectMetadata of the renamed file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be renamed.
File namerequiredThe new name of the file (including the file extension).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Replace File with New One

Replaces an existing file, identified with the bucket and file id/name, with the new one. It runs when all the input link points are active. If successful, it triggers fileMetadata; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
newFileobjectThe new file that will replace the old one
NameTypeDescription
fileMetadataobjectMetadata of the new file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be replaced.
File tag(s)optionalThe tags that will be added to the file metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Search Files

Gets the list of files matching the search expression across all buckets. If select query expression is specified, it runs the specified filter query to narrow down returned results, otherwise, returns all files contained in app storage. It runs when all the input link points are active. If successful, triggers the result and countInfo (if selected) otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify node properties
NameTypeDescription
resultlistList of file metadata matching the filter query
countInfoobjectQuery result count info object, which holds total objects count matching the query condition, total pages, current page, and page size information
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Select queryoptionalThe select query expression to retrieve the list of file metadata from the cloud storage.
Sort fieldsoptionalThe list of file fields to use for sorting the query results
Page numberoptionalPage number to paginate query results
Page sizeoptionalMaximum number of items to fetch per page
Return count infooptionalFlag to show/hide count info output link point.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Set File Access Type

Updates the access type of the file with the provided bucket and file id/name. It runs when all the input link points are active. If successful, it triggers fileMetadata; otherwise triggers errors.

Multi input✔️
Multi output
NameTypeDescription
inputobjectInput object of the node, mainly used to specify file id
NameTypeDescription
fileMetadataobjectMetadata of the updated file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File id/namerequiredThe id or name of the file that will be updated.
File access typerequiredPublic or private. If marked as public anyone with the public file link can access the object on the public internet.
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Upload Files to Storage

Uploads and stores multiple files in specified bucket and returns list of metadata of uploaded files. It runs when all the input link points are active.

Multi input✔️
Multi output
NameTypeDescription
fileslistList of input files that will be uploaded and saved to storage area
NameTypeDescription
filesMetadataobjectList of metadata of uploaded files
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File access typerequiredPublic or private. If marked as public anyone with the public file link can access the object on the public internet.
File tag(s)optionalThe tags that will be added to the file metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.

Upload Single File to Storage

Uploads and stores a single file in specified bucket and returns the uploaded file metadata. It runs when all the input link points are active.

Multi input✔️
Multi output
NameTypeDescription
fileobjectInput file that will be uploaded and saved to storage area
NameTypeDescription
filesMetadataobjectMetadata of the uploaded file
errorslistErrors occurred during node execution

Parameters

NameTypeDescription
Bucket id/nameoptionalThe id or name of the bucket. If not specified 'root' bucket will be used.
File access typerequiredPublic or private. If marked as public anyone with the public file link can access the object on the public internet.
File tag(s)optionalThe tags that will be added to the file metadata. This expression should either returns a text value (e.g., "tag1") or an array of text values (e.g., ["tag1", "tag2"]).
Apply rulesoptionalEnable/disabled execution of object level security rules that define the conditions to allow or restrict certain operations (create, read, upddate, delete) on your app database, storage and cache.
Error managementrequiredError handler type of processing errors raised by this node, either automatically or manually.