# File Store


--------------------------------------------------------------------------------
title: "Introduction"
description: "Catalys File Store is file management system that enables you to store your application files in a secure cloud and provide access to the shared file system as needed."
last_updated: "2026-03-18T07:41:08.535Z"
source: "https://docs.catalyst.zoho.com/en/cloud-scale/help/file-store/introduction/"
service: "Cloud Scale"
--------------------------------------------------------------------------------

 
# File Store

### Introduction

File Store is a Catalyst Cloud Scale component that provides cloud storage to securely store, manage, and organize both application files and user data. It supports a wide range of file types, including images, videos, documents, spreadsheets, and text files, which can be organized into folders for easy management. Whether you’re storing assets like app icons, user profile pictures, or user documents, the robust storage system powered by Catalyst ensures durability, scalability, and seamless file access, including downloading files to your local machine whenever needed.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can create multiple folders and store each of the related files in a folder. You can also set permissions for folders and define the access level granted for each of the user roles to each folder. Catalyst does not allow you to create sub-folders within your folders.

{{%note%}}{{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} Catalyst provides 1 GB of File Store space for each project in the {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34; %}}development environment{{%/link%}}. There are no upper limits for storage in the production environment.{{%/note%}}

#### SDK and API documentation

You can create, update, and delete folders, upload and delete files directly from the console, or by using the SDKs. Catalyst also provides APIs to perform File Store operations. For more information and code samples on working in these programming environments, refer to these help pages:

* {{%link href=&#34;/en/sdk/java/v1/cloud-scale/file-store/create-folder-instance/&#34; %}}File Store - Java SDK{{%/link%}}
* {{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/get-component-instance/&#34; %}}File Store - Node.js SDK{{%/link%}}
* {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-component-instance/&#34; %}}File Store - Python SDK{{%/link%}}
* {{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-component-instance/&#34; %}}File Store - Web SDK{{%/link%}}
* {{%link href=&#34;/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder&#34; %}}File Store - API Documentation{{%/link%}}
&lt;br /&gt;


--------------------------------------------------------------------------------
title: "Key Features"
description: "Catalys File Store is file management system that enables you to store your application files in a secure cloud and provide access to the shared file system as needed."
last_updated: "2026-03-18T07:41:08.535Z"
source: "https://docs.catalyst.zoho.com/en/cloud-scale/help/file-store/key-features/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


### Key Features

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

* Enables you to organize and store all the files related to the application in one repository in the cloud
* Can store files of all types and formats, and of any size that is within the storage limits
* Allows you to create, update, delete folders and their contents automatically using API calls
* Other components can read and write files and folders into File Store using functions
* Can automatically modify the file contents based on the execution results of the other components
* Access to the files is defined by the {{%link href=&#34;/en/cloud-scale/help/authentication/user-management/roles/introduction/&#34; %}}user roles{{%/link%}} of the end users
* {{%link href=&#34;/en/devops/help/metrics/files/&#34; %}}Metrics{{%/link%}} displays the following usage information of File Store: Total Space Utilization, Number of Files in each Folder, and File Size in each Folder
&lt;br /&gt;


--------------------------------------------------------------------------------
title: "Implementation"
description: "Catalys File Store is file management system that enables you to store your application files in a secure cloud and provide access to the shared file system as needed."
last_updated: "2026-03-18T07:41:08.536Z"
source: "https://docs.catalyst.zoho.com/en/cloud-scale/help/file-store/implementation/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


# Implementation

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can create folders, set access permissions for folders, upload files, rename folders, delete files and folders, and download files from the console. When a folder is created, a unique {{%bold class=&#34;bold-primary&#34;%}}Folder ID{{%/bold%}} is created for it. Similarly, whenever a file is uploaded to a folder, a unique {{%bold class=&#34;bold-primary&#34;%}}File ID{{%/bold%}} is created automatically for it. A file or a folder can be referred to by its ID number when working with the SDKs.

### Create a Folder

To create a folder in Catalyst:

1. Navigate to {{%bold class=&#34;bold-primary&#34;%}}Storage{{%/bold%}} in the Catalyst Cloud Scale console, then {{%bold class=&#34;bold-primary&#34;%}}File Store{{%/bold%}}.
2. In the _Folders_ page, click {{%bold class=&#34;bold-primary&#34;%}}Create Folder{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;

3. Enter the folder name in the {{%bold class=&#34;bold-primary&#34;%}}Create Folder{{%/bold%}} pop-up window.&lt;br /&gt; &lt;br /&gt;

{{%note%}}{{%bold%}}Note{{%/bold%}}: The Personal Identifiable Information (PII)/Electronic Protected Health Validator (ePHI) indicates sensitive user data that needs to be stored and managed in compliance with all relevant data and privacy protection laws, such as {{%link href=&#34;https://www.hhs.gov/hipaa/for-professionals/special-topics/health-information-technology/cloud-computing/index.html&#34; %}}HIPAA{{%/link%}} and {{%link href=&#34;https://gdpr-info.eu/issues/personal-data/&#34; %}}GDPR{{%/link%}}  guidelines. Examples of such sensitive data include Identifiable Health Information (IIHI), personal and contact information such as name, address, and telephone numbers, medical history and information including Medical Record Number (MRN) and Medicare Beneficiary Identifier (MBI), identity information such as Social Security Number and vehicle identifiers and any other user data that falls under this scope. You must enable the {{%bold%}}PII/ePHI validator{{%/bold%}} for folders that contain sensitive user data.&lt;br /&gt;&lt;br /&gt;If this validator is enabled for a folder, Catalyst account admins and project members with the necessary permissions will be able to view all activities performed in these folders, in the {{%link href=&#34;/en/devops/help/logs/application-logs&#34; %}}{{%italics%}}Application Logs{{%/italics%}}{{%/link%}} section of {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/audit-logs&#34; %}}{{%italics%}}Audit Logs{{%/italics%}}{{%/link%}} in the console. The activities include creation or deletion of files in a folder where the {{%bold%}}PII/ePHI validator{{%/bold%}} has been enabled in the File Store.{{%/note%}}

4. Click {{%bold class=&#34;bold-primary&#34;%}}Create{{%/bold%}}.


The folder is now created and a unique Folder ID is assigned to the folder. You can view the folder in the _Folders_ page, which lists all the folders in the File Store, along with their properties like Folder Name, ID, PII/ePHI validator status, Created By, and Created Date. You can now upload files to this folder.

&lt;br /&gt;

### Upload a File into a Folder

To upload a file to a folder in Catalyst:

1. In the _Folder_ page in _File Store_, click the name of the folder you need to upload the file to.
2. In the folder&#39;s page, click {{%bold class=&#34;bold-primary&#34;%}}Upload Files{{%/bold%}}.&lt;br /&gt; 
&lt;br /&gt;
3. In the pop-up window, select the files to upload from your system.&lt;br /&gt; 
&lt;br /&gt;
4. Click {{%bold class=&#34;bold-primary&#34;%}}Open{{%/bold%}}.&lt;br /&gt;&lt;br /&gt;The file will now be uploaded to the folder. You will be able to view the upload status at the bottom of the page.
&lt;br /&gt;

The file will now be uploaded to the folder. The File ID is created automatically for the file once it is uploaded. You can view the file in the folder page, which lists all the files in the folder and some of their properties including File Name, ID, Created By, Created Date, and Size.

You can search for a file in the folder using the _Search Files_ search bar.

&lt;br /&gt; &lt;br /&gt;

### Set Permissions for a Folder

As discussed in the introduction, you can set permissions for a folder and define the access level granted to each {{%link href=&#34;/en/cloud-scale/help/authentication/user-management/roles/introduction/&#34; %}}user role{{%/link%}} for each folder. The three access permissions are:

* {{%bold class=&#34;bold-primary&#34;%}}Download:{{%/bold%}} The user roles with the Download permission enabled for a folder can download the entire folder or the folder&#39;s contents to their computers.
* {{%bold class=&#34;bold-primary&#34;%}}Upload{{%/bold%}}: The user roles with the Upload permission enabled for a folder can upload files into the folder from their computers.
* {{%bold class=&#34;bold-primary&#34;%}}Delete{{%/bold%}}: The user roles with the Delete permission enabled for a folder can delete the entire folder or folder&#39;s contents.

To set permissions for a folder in Catalyst:

1. In the _Folder_ page in _File Store_, click on the ellipsis icon for the folder you wish to set permissions for, and click {{%bold class=&#34;bold-primary&#34;%}}Permissions{{%/bold%}}.&lt;br /&gt; 
&lt;br /&gt;
2. Click the check boxes in the pop-up window to enable or disable *Download*, *Upload*, and *Delete* permissions for each user role.&lt;br /&gt; 
&lt;br /&gt;
3. Click {{%bold class=&#34;bold-primary&#34;%}}Save{{%/bold%}} to save the changes.

The users can now access the folder based on the permissions that are set for their user role.

&lt;br /&gt;

### Edit a Folder

To edit a folder in Catalyst:

1. In the _Folder_ page in _File Store_, click the ellipsis icon corresponding to the folder that you wish to edit and click **Edit**.&lt;br /&gt;
&lt;br /&gt;
2. Enter the new name for the folder, then press {{%bold class=&#34;bold-primary&#34;%}}Update{{%/bold%}}.&lt;br /&gt; 
&lt;br /&gt;

The folder has now been edited.

&lt;br /&gt;

### Delete Files and Folders

You can delete a file or a folder from the File Store permanently.

To delete a folder from the File Store:

2. In the _Folder_ page in _File Store_, click the ellipsis icon for the folder you wish to delete and click {{%bold class=&#34;bold-primary&#34;%}}Delete{{%/bold%}}.&lt;br /&gt; 
&lt;br /&gt;
3. Click {{%bold class=&#34;bold-primary&#34;%}}Yes, Proceed{{%/bold%}} in the confirmation pop-up.&lt;br /&gt; 
&lt;br /&gt;

The folder is now deleted permanently from the File Store.
&lt;br /&gt;&lt;br /&gt;

To delete a file from a folder in the File Store:

1. Open the folder that contains the file to be deleted.
2. Click the ellipsis icon for the file you wish to delete, then click {{%bold class=&#34;bold-primary&#34;%}}Delete{{%/bold%}}.&lt;br /&gt; 
&lt;br /&gt;
3. Click {{%bold class=&#34;bold-primary&#34;%}}Yes, Proceed{{%/bold%}} in the confirmation pop-up.&lt;br /&gt; 
&lt;br /&gt;

The file is now deleted permanently from the File Store.

&lt;br /&gt;

### Download a File from a Folder

To download a file from the File Store to your computer:

1. Open the folder that contains the file to download.
2. Click the ellipsis icon for the file you wish to download, then click {{%bold class=&#34;bold-primary&#34;%}}Download{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;&lt;br /&gt;Choose where you want the file to be saved on your computer and click **Save**.&lt;br /&gt;


The file will now be downloaded to your local machine.

---

## API Reference — File Store

--------------------------------------------------------------------------------
title: "Get Specific Folder"
description: "This API enables you to retrieve the details of a specific folder in the File Store along with the details of all the files in it"
last_updated: "2026-03-18T07:41:08.540Z"
source: "https://docs.catalyst.zoho.com/en/api/code-reference/cloud-scale/file-store/get-specific-folder/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


{{% section path=&#34;/en/api/code-reference/cloud-scale/file-store/get-specific-folder/&#34; id=&#34;GetSpecificFolder&#34; %}}

{{%divtag class=&#34;LeftContent&#34;%}}

# File Store

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

{{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}Catalyst File Store{{%/link%}} provides cloud storage solutions to store, manage, and organize your application files and user data files such as images, videos, CSV files, spreadsheets, and more in folders.

# Get the Details of a Specific Folder

### Description

This API enables you to retrieve the details of a specific folder in the File Store, along with the details of all the files in the folder. The folder is referred by its unique Folder ID.


### Request Details

#### Request URL
{{%request class=&#34;apigreen&#34; req=&#34;GET&#34; %}}&lt;p&gt;{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}&lt;/p&gt;{{%/request%}}

{{%request_id id=&#34;api-domain&#34; data=&#34;URL&#34; %}}The DC-specific domain to access Catalyst API{{%/request_id%}}

{{%request_id id=&#34;project_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34;%}}unique ID{{%/link%}} of the project{{%/request_id%}}

{{%request_id id=&#34;folder_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the folder {{%/request_id%}}


#### Request Headers
{{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token} &lt;br&gt;
{{%/scope%}}

**Optional Headers** &lt;br&gt;
{{%scope%}} **CATALYST-ORG:** {org_id}
{{%/scope%}}
{{%scope%}} **Environment:** Development
{{%/scope%}}

#### Scope
{{%scope%}}
ZohoCatalyst.folders.READ
{{%/scope%}}


### Response Details

The JSON response returns the metadata of the particular folder such as the {{%badge%}}folder_name{{%/badge%}}, the details of the user who created and last modified it, along with the metadata of all the files in the folder, such as the {{%badge%}}file_id{{%/badge%}}, {{%badge%}}file_name{{%/badge%}}, {{%badge%}}file_size{{%/badge%}} of each file.


{{%/divtag%}}

{{%divtag class=&#34;RightContent&#34;%}}

{{% panel_without_adjustment header=&#34;Sample Request&#34; class=&#34;language-bash&#34; %}}curl -X GET \
  https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/3376000000427654 \
  -H &#34;Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57&#34;

{{% /panel_without_adjustment %}}

{{% panel_with_adjustment header=&#34;Sample Response&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;status&#34;:&#34;success&#34;,
    &#34;data&#34;:{
      &#34;folder_name&#34;:&#34;PricingInfo&#34;,
      &#34;created_time&#34;:&#34;Apr 01, 2020 11:11 AM&#34;,
      &#34;created_by&#34;:{
        &#34;zuid&#34;:1019540152,
        &#34;is_confirmed&#34;:true,
        &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
        &#34;first_name&#34;:&#34;Amelia&#34;,
        &#34;last_name&#34;:&#34;Burrows&#34;,
        &#34;user_id&#34;:671930455
      },
      &#34;modified_time&#34;:&#34;Apr 11, 2020 10:41 PM&#34;,
      &#34;modified_by&#34;:{
        &#34;zuid&#34;:1019540876,
        &#34;is_confirmed&#34;:true,
        &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
        &#34;first_name&#34;:&#34;Patricia&#34;,
        &#34;last_name&#34;:&#34;Boyle&#34;,
        &#34;user_id&#34;:671930321
      },
      &#34;project_details&#34;:{
        &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
        &#34;id&#34;:4000000006007
      },
      &#34;file_details&#34;:[
        {
          &#34;id&#34;:337600000030123,
          &#34;file_location&#34;:null,
          &#34;file_name&#34;:&#34;PO1898908GT.pdf&#34;,
          &#34;file_size&#34;:10,
          &#34;created_by&#34;:{
            &#34;zuid&#34;:1019540199,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;jane.simmons@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Jane&#34;,
            &#34;last_name&#34;:&#34;Simmons&#34;,
            &#34;user_id&#34;:671930000
          },
          &#34;created_time&#34;:&#34;Feb 21, 2020 01:11 PM&#34;,
          &#34;modified_by&#34;:{
            &#34;zuid&#34;:1019540152,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Patricia&#34;,
            &#34;last_name&#34;:&#34;Boyle&#34;,
            &#34;user_id&#34;:671930321
          },
          &#34;modified_time&#34;:&#34;Jan 13, 2020 08:00 PM&#34;,
          &#34;project_details&#34;:{
            &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
            &#34;id&#34;:4000000006007
          },
          &#34;folder_details&#34;: 3376000000427654
        },
        {
          &#34;id&#34;:337600000030121,
          &#34;file_location&#34;:null,
          &#34;file_name&#34;:&#34;ST1898190CR.pdf&#34;,
          &#34;file_size&#34;:9,
          &#34;created_by&#34;:{
            &#34;zuid&#34;:1019540152,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Patricia&#34;,
            &#34;last_name&#34;:&#34;Boyle&#34;,
            &#34;user_id&#34;:671930321
          },
          &#34;created_time&#34;:&#34;Jan 01, 2020 09:09 PM&#34;,
          &#34;modified_by&#34;:{
            &#34;zuid&#34;:1019540152,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Patricia&#34;,
            &#34;last_name&#34;:&#34;Boyle&#34;,
            &#34;user_id&#34;:671930321
          },
          &#34;modified_time&#34;:&#34;Mar 11, 2020 07:09 AM&#34;,
          &#34;project_details&#34;:{
            &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
            &#34;id&#34;:4000000006007
          },
          &#34;folder_details&#34;:3376000000427654
        }
      ],
      &#34;audit_consent&#34;: false,
      &#34;id&#34;:829000000038455
    }
  }
  {{% /panel_with_adjustment %}}


{{% expand-container %}}   
{{% expand id=&#34;sdk_docs&#34; header=&#34;SDK Documentation&#34;%}}
{{%link href=&#34;/en/sdk/java/v1/cloud-scale/file-store/create-folder-instance/&#34;%}}Retrieve Folder Details- Java SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/retrieve-folder-details&#34;%}}Retrieve Folder Details- Node.js SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/retrieve-folder-details&#34;%}}Retrieve Folder Details- Python SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/retrieve-folder-details&#34;%}}Retrieve Folder Details- Web SDK{{%/link%}}
{{%/expand%}}
{{%/expand-container%}}

{{%/divtag%}}
{{%/section%}}


--------------------------------------------------------------------------------
title: "Get All Folders"
description: "This API enables you to retrieve the details of all the folders in your project from the File Store"
last_updated: "2026-03-18T07:41:08.540Z"
source: "https://docs.catalyst.zoho.com/en/api/code-reference/cloud-scale/file-store/get-all-folders/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


{{% section path=&#34;/en/api/code-reference/cloud-scale/file-store/get-all-folders/&#34; id=&#34;GetAllFolders&#34; %}}

{{%divtag class=&#34;LeftContent&#34;%}}

# Get the Details of All Folders

### Description

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

This API enables you to retrieve the details of all the folders in your project from the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}}.


### Request Details

#### Request URL
{{%request class=&#34;apigreen&#34; req=&#34;GET&#34; %}}&lt;p&gt;{api-domain}/baas/v1/project/{project_id}/folder&lt;/p&gt;{{%/request%}}

{{%request_id id=&#34;api-domain&#34; data=&#34;URL&#34; %}}The DC-specific domain to access Catalyst API{{%/request_id%}}

{{%request_id id=&#34;project_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34;%}}unique ID{{%/link%}} of the project{{%/request_id%}}


#### Request Headers
{{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token} &lt;br&gt;
{{%/scope%}}

**Optional Headers** &lt;br&gt;
{{%scope%}} **CATALYST-ORG:** {org_id}
{{%/scope%}}
{{%scope%}} **Environment:** Development
{{%/scope%}}

#### Scope
{{%scope%}}
ZohoCatalyst.folders.READ
{{%/scope%}}


### Response Details

The JSON response returns the metadata of all the folders such as the {{%badge%}}folder_name{{%/badge%}}, the details of the user who created and last modified it, and the project details.


{{%/divtag%}}

{{%divtag class=&#34;RightContent&#34;%}}

{{% panel_without_adjustment header=&#34;Sample Request&#34; class=&#34;language-bash&#34; %}}curl -X GET \
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder \
-H &#34;Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57&#34;

{{% /panel_without_adjustment %}}

{{% panel_with_adjustment header=&#34;Sample Response&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;status&#34;:&#34;success&#34;,
    &#34;data&#34;:[
        {
            &#34;folder_name&#34;:&#34;ShipmentOrderForms&#34;,
            &#34;created_time&#34;:&#34;Oct 22, 2019 11:01 AM&#34;,
            &#34;created_by&#34;:{
                &#34;zuid&#34;:1019540152,
                &#34;is_confirmed&#34;:true,
                &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
                &#34;first_name&#34;:&#34;Amelia&#34;,
                &#34;last_name&#34;:&#34;Burrows&#34;,
                &#34;user_type&#34;: &#34;Admin&#34;,
                &#34;user_id&#34;:671930455
            },
            &#34;modified_time&#34;: &#34;Jun 05, 2023 12:26 AM&#34;,
            &#34;modified_by&#34;: {
                &#34;zuid&#34;: 671930455,
                &#34;is_confirmed&#34;: false,
                &#34;email_id&#34;: &#34;emma@zylker.com&#34;,
                &#34;first_name&#34;: &#34;Amelia&#34;,
                &#34;last_name&#34;: &#34;Burrows&#34;,
                &#34;user_type&#34;: &#34;Admin&#34;,
                &#34;user_id&#34;: 671930455
            },
            &#34;project_details&#34;:{
                &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
                &#34;id&#34;:4000000006007
            },
            &#34;audit_consent&#34;: false,
            &#34;id&#34;:105000000121098
        }
       {
            &#34;folder_name&#34;:&#34;PricingInfo&#34;,
            &#34;created_time&#34;:&#34;Sep 01, 2019 03:33 PM&#34;,
            &#34;created_by&#34;:{
                &#34;zuid&#34;:1019540152,
                &#34;is_confirmed&#34;:true,
                &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
                &#34;first_name&#34;:&#34;Patricia&#34;,
                &#34;last_name&#34;:&#34;Boyle&#34;,
                &#34;user_type&#34;: &#34;Admin&#34;,
                &#34;user_id&#34;:671930765
            },
            &#34;modified_time&#34;: &#34;Jun 05, 2023 12:26 AM&#34;,
            &#34;modified_by&#34;: {
                &#34;zuid&#34;: 671930455,
                &#34;is_confirmed&#34;: false,
                &#34;email_id&#34;: &#34;p.boyle@zylker.com&#34;,
                &#34;first_name&#34;: &#34;Patricia&#34;,
                &#34;last_name&#34;: &#34;Boyle&#34;,
                &#34;user_type&#34;: &#34;Admin&#34;,
                &#34;user_id&#34;: 671930765
            },
            &#34;project_details&#34;:{
                &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
                &#34;id&#34;:4000000006007
            },
            &#34;audit_consent&#34;: false,
            &#34;id&#34;:105000000145678
        }
    ]
}
{{% /panel_with_adjustment %}}

{{% expand-container %}}   
{{% expand id=&#34;sdk_docs&#34; header=&#34;SDK Documentation&#34;%}}
{{%link href=&#34;/en/sdk/java/v1/cloud-scale/file-store/create-folder-instance/&#34;%}}Retrieve Folder Details- Java SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/retrieve-folder-details&#34;%}}Retrieve Folder Details- Node.js SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/retrieve-folder-details&#34;%}}Retrieve Folder Details- Python SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/retrieve-folder-details&#34;%}}Retrieve Folder Details- Web SDK{{%/link%}}
{{%/expand%}}
{{%/expand-container%}}


{{%/divtag%}}
{{%/section%}}


--------------------------------------------------------------------------------
title: "Upload File In a Folder"
description: "This API enables you to upload a file from your local system to an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.540Z"
source: "https://docs.catalyst.zoho.com/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


{{% section path=&#34;/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/&#34; id=&#34;UploadFileInaFolder&#34; %}}

{{%divtag class=&#34;LeftContent&#34;%}}

# Upload a File In a Folder

### Description

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

This API enables you to upload a file from your local system to an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}}, by referring to the folder&#39;s unique ID. You can upload an image, text document, CSV, or any type of file you need. The maximum size of a file that you can upload is 100 MB.

You must specify the file path and the file name in the API request, as shown in the sample request.

{{%note%}}{{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} Catalyst provides 1 GB of File Store space for each project in the {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34;%}}development environment{{%/link%}}. There are no upper limits for storage in the production environment.{{%/note%}}

### Request Details

#### Request URL
{{%request class=&#34;apiyellow&#34; req=&#34;POST&#34; %}}&lt;p&gt;{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file&lt;/p&gt;{{%/request%}}

{{%request_id id=&#34;api-domain&#34; data=&#34;URL&#34; %}}The DC-specific domain to access Catalyst API{{%/request_id%}}

{{%request_id id=&#34;project_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34;%}}unique ID{{%/link%}} of the project{{%/request_id%}}

{{%request_id id=&#34;folder_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the folder {{%/request_id%}}


#### Request Headers
{{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token} &lt;br&gt;
**Content-Type:** multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
{{%/scope%}}

**Optional Headers** &lt;br&gt;
{{%scope%}} **CATALYST-ORG:** {org_id}
{{%/scope%}}
{{%scope%}} **Environment:** Development
{{%/scope%}}

#### Scope
{{%scope%}}
ZohoCatalyst.files.CREATE
{{%/scope%}}


{{%note%}} {{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} This operation can also be executed with Catalyst user authentication permissions using Catalyst SDKs. Refer to the [Catalyst API Prerequisites section](/en/api/introduction/overview-and-prerequisites/#prerequisites) for details.{{%/note%}}


#### Request JSON Properties

{{% nested_fields children=&#34;open&#34; border=&#34;yes&#34; expandable=&#34;no&#34; title=&#34;code&#34; textformat=&#34;file&#34; condition=&#34;mandatory&#34; maxlength=&#34; &#34; %}} Path of the file to be uploaded in your computer

Maximum file size allowed: 100 MB {{% /nested_fields %}} 

{{% nested_fields children=&#34;open&#34; border=&#34;yes&#34; expandable=&#34;no&#34; title=&#34;file_name&#34; textformat=&#34;string&#34; condition=&#34;mandatory&#34; maxlength=&#34; &#34; %}} Name of the file to be uploaded {{% /nested_fields %}} 


### Response Details

The JSON response returns the metadata of the file that was uploaded, such as the {{%badge%}}file_name{{%/badge%}}, {{%badge%}}file_size{{%/badge%}}, and the details of the user who uploaded the file.


{{%/divtag%}}

{{%divtag class=&#34;RightContent&#34;%}}

{{% panel_without_adjustment header=&#34;Sample Request&#34; class=&#34;language-bash&#34; %}}curl -X POST \
  https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file \
  -H &#34;Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57&#34; \
  -H &#34;content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW&#34; \
  -F code=@/Desktop/EmployeeInfo.csv \
  -F file_name=EmployeeInfo

{{% /panel_without_adjustment %}}

{{% panel_without_adjustment header=&#34;Sample Response&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;status&#34;: &#34;success&#34;,
    &#34;data&#34;: {
        &#34;id&#34;: 56000000368030,
        &#34;file_location&#34;: null,
        &#34;file_name&#34;: &#34;EmployeeInfo&#34;,
        &#34;file_size&#34;: 264328,
        &#34;created_by&#34;: {
            &#34;zuid&#34;: 1019540152,
            &#34;is_confirmed&#34;: false,
            &#34;email_id&#34;: &#34;emma@zylker.com&#34;,
            &#34;first_name&#34;: &#34;Amelia&#34;,
            &#34;last_name&#34;: &#34;Burrows&#34;,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;: 64635102
        },
        &#34;created_time&#34;: &#34;Jun 05, 2023 12:40 AM&#34;,
        &#34;modified_by&#34;: {
            &#34;zuid&#34;: 1019540152,
            &#34;is_confirmed&#34;: false,
            &#34;email_id&#34;: &#34;emma@zylker.com&#34;,
            &#34;first_name&#34;: &#34;Amelia&#34;,
            &#34;last_name&#34;: &#34;Burrows&#34;,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;: 64635102
        },
        &#34;modified_time&#34;: &#34;Jun 05, 2023 12:40 AM&#34;,
        &#34;project_details&#34;: {
            &#34;project_name&#34;: &#34;EmployeePortal&#34;,
            &#34;id&#34;: 3376000001796044,
            &#34;project_type&#34;: &#34;Live&#34;
        },
        &#34;folder_details&#34;: 3376000001925212
    }
}
{{% /panel_without_adjustment %}}


{{% expand-container %}}   
{{% expand id=&#34;sdk_docs&#34; header=&#34;SDK Documentation&#34;%}}
{{%link href=&#34;/en/sdk/java/v1/cloud-scale/file-store/upload-file&#34;%}}Upload a File- Java SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/upload-file&#34;%}}Upload a File- Node.js SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/upload-file&#34;%}}Upload a File- Python SDK{{%/link%}}&lt;br/&gt;&lt;br/&gt;
{{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/upload-file&#34;%}}Upload a File- Web SDK{{%/link%}}
{{%/expand%}}
{{%/expand-container%}}


{{%/divtag%}}
{{%/section%}}


--------------------------------------------------------------------------------
title: "Download a File From a Folder"
description: "This API enables you to download a file from an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.540Z"
source: "https://docs.catalyst.zoho.com/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


{{% section path=&#34;/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/&#34; id=&#34;DownloadaFileFromaFolder&#34; %}}

{{%divtag class=&#34;LeftContent&#34;%}}

# Download a File From a Folder

### Description

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

This API enables you to download a file from an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}}, by referring to the unique IDs of the folder and file.

The file will be automatically downloaded to the configured directory in your system after you execute this API. Catalyst will not send any response back for this request.


### Request Details

#### Request URL
{{%request class=&#34;apigreen&#34; req=&#34;GET&#34; %}}&lt;p&gt;{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}/download&lt;/p&gt;{{%/request%}}

{{%request_id id=&#34;api-domain&#34; data=&#34;URL&#34; %}}The DC-specific domain to access Catalyst API{{%/request_id%}}

{{%request_id id=&#34;project_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34;%}}unique ID{{%/link%}} of the project{{%/request_id%}}

{{%request_id id=&#34;folder_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the folder {{%/request_id%}}

{{%request_id id=&#34;file_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the file {{%/request_id%}}


#### Request Headers
{{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token} &lt;br&gt;
**Content-Type:** application/json
{{%/scope%}}

**Optional Headers** &lt;br&gt;
{{%scope%}} **CATALYST-ORG:** {org_id}
{{%/scope%}}
{{%scope%}} **Environment:** Development
{{%/scope%}}

#### Scope
{{%scope%}}
ZohoCatalyst.files.READ
{{%/scope%}}


{{%note%}} {{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} This operation can also be executed with Catalyst user authentication permissions using Catalyst SDKs. Refer to the [Catalyst API Prerequisites section](/en/api/introduction/overview-and-prerequisites/#prerequisites) for details.{{%/note%}}

{{%/divtag%}}

{{%divtag class=&#34;RightContent&#34;%}}

{{% panel_without_adjustment header=&#34;Sample Request&#34; class=&#34;language-bash&#34; %}}curl -X GET \
  https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/332000000044009/download \
  -H &#34;Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57&#34; \
  -H &#34;Content-Type: application/json&#34;

{{% /panel_without_adjustment %}}


{{% expand-container %}}   
{{% expand id=&#34;sdk_docs&#34; header=&#34;SDK Documentation&#34;%}}
{{%link href=&#34;/en/sdk/java/v1/cloud-scale/file-store/download-file-from-folder&#34;%}}Download a File- Java SDK{{%/link%}}&lt;/br&gt;&lt;/br&gt;
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/download-file-from-folder/&#34;%}}Download a File- Node.js SDK{{%/link%}}&lt;/br&gt;&lt;/br&gt;
{{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/download-a-file-from-the-folder/&#34;%}}Download a File- Python SDK{{%/link%}}&lt;/br&gt;&lt;/br&gt;
{{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/download-file-from-folder&#34;%}}Download a File- Web SDK{{%/link%}}
{{%/expand%}}
{{%/expand-container%}}

{{%/divtag%}}
{{%/section%}}


--------------------------------------------------------------------------------
title: "Get Specific File"
description: "This API enables you to retrieve the details of a specific file in a folder in the File Store."
last_updated: "2026-03-18T07:41:08.540Z"
source: "https://docs.catalyst.zoho.com/en/api/code-reference/cloud-scale/file-store/get-specific-file/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


{{% section path=&#34;/en/api/code-reference/cloud-scale/file-store/get-specific-file/&#34; id=&#34;GetSpecificFile&#34; %}}

{{%divtag class=&#34;LeftContent&#34;%}}

# Get the Details of a Specific File

### Description

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

This API enables you to retrieve the details of a specific file in a folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}}. The folder and the file are referred by their unique IDs.


### Request Details

#### Request URL
{{%request class=&#34;apigreen&#34; req=&#34;GET&#34; %}}&lt;p&gt;{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}&lt;/p&gt;{{%/request%}}

{{%request_id id=&#34;api-domain&#34; data=&#34;URL&#34; %}}The DC-specific domain to access Catalyst API{{%/request_id%}}

{{%request_id id=&#34;project_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34;%}}unique ID{{%/link%}} of the project{{%/request_id%}}

{{%request_id id=&#34;folder_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the folder {{%/request_id%}}

{{%request_id id=&#34;file_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the file {{%/request_id%}}


#### Request Headers
{{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token}
{{%/scope%}}

**Optional Headers** &lt;br&gt;
{{%scope%}} **CATALYST-ORG:** {org_id}
{{%/scope%}}
{{%scope%}} **Environment:** Development
{{%/scope%}}

#### Scope
{{%scope%}}
ZohoCatalyst.files.READ
{{%/scope%}}


{{%note%}} {{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} This operation can also be executed with Catalyst user authentication permissions using Catalyst SDKs. Refer to the [Catalyst API Prerequisites section](/en/api/introduction/overview-and-prerequisites/#prerequisites) for details.{{%/note%}}


### Response Details

The response will return the metadata and details of the particular file including its {{%badge%}}file_name{{%/badge%}}, {{%badge%}}file_size{{%/badge%}}, and the details of the user who created and last modified the file.


{{%/divtag%}}

{{%divtag class=&#34;RightContent&#34;%}}

{{% panel_without_adjustment header=&#34;Sample Request&#34; class=&#34;language-bash&#34; %}}curl -X GET \
  https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/332000000044009\
  -H &#34;Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57&#34;

{{% /panel_without_adjustment %}}

{{% panel_without_adjustment header=&#34;Sample Response&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;status&#34;:&#34;success&#34;,
    &#34;data&#34;:{
      &#34;id&#34;: 332000000044009,
      &#34;file_location&#34;:null,
      &#34;file_name&#34;:&#34;Sales2019.csv&#34;,
      &#34;file_size&#34;:264328,
      &#34;created_by&#34;:{
        &#34;zuid&#34;:1019540152,
        &#34;is_confirmed&#34;:true,
        &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
        &#34;first_name&#34;:&#34;Amelia&#34;,
        &#34;last_name&#34;:&#34;Burrows&#34;,
        &#34;user_type&#34;: &#34;Admin&#34;,
        &#34;user_id&#34;:671930111
      },
      &#34;created_time&#34;:&#34;Apr 09, 2020 01:10 AM&#34;,
      &#34;modified_by&#34;:{
        &#34;zuid&#34;:1019540009,
        &#34;is_confirmed&#34;:true,
        &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
        &#34;first_name&#34;:&#34;Patricia&#34;,
        &#34;last_name&#34;:&#34;Boyle&#34;,
        &#34;user_type&#34;: &#34;Admin&#34;,
        &#34;user_id&#34;:671930989
      },
      &#34;modified_time&#34;:&#34;Mar 01, 2020 06:18 PM&#34;,
      &#34;project_details&#34;:{
        &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
        &#34;id&#34;:4000000006007,
        &#34;project_type&#34;: &#34;Live&#34;
      },
      &#34;folder_details&#34;:105000000121098
      }
    }{{% /panel_without_adjustment %}}


{{%/divtag%}}
{{%/section%}}


--------------------------------------------------------------------------------
title: "Get Details of Multiple Files"
description: "This API enables you to retrieve the details of multiple files in a particular folder in the File Store."
last_updated: "2026-03-18T07:41:08.540Z"
source: "https://docs.catalyst.zoho.com/en/api/code-reference/cloud-scale/file-store/get-details-of-multiple-files/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


{{% section path=&#34;/en/api/code-reference/cloud-scale/file-store/get-details-of-multiple-files/&#34; id=&#34;GetDetailsofMultipleFiles&#34; %}}

{{%divtag class=&#34;LeftContent&#34;%}}

# Get the Details of Multiple Files

### Description

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

This API enables you to retrieve the details of multiple files in a particular folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}}. The folder is referred by its unique Folder ID.

This API request can retrieve the details of a maximum number of 200 files in the folder in one call. Therefore, if a folder has 300 files, you can execute a second API call to retrieve the details of files 201 to 300. This can be done by specifying the {{%badge%}}start{{%/badge%}} and {{%badge%}}end{{%/badge%}} values in the query params in the request as depicted below. The first 200 files are retrieved by default, if the query params are not specified.


### Request Details

#### Request URL
{{%request class=&#34;apigreen&#34; req=&#34;GET&#34; %}}&lt;p&gt;{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file?start={start_index}&amp;end={number_of_files}&lt;/p&gt;{{%/request%}}

{{%request_id id=&#34;api-domain&#34; data=&#34;URL&#34; %}}The DC-specific domain to access Catalyst API{{%/request_id%}}

{{%request_id id=&#34;project_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34;%}}unique ID{{%/link%}} of the project{{%/request_id%}}

{{%request_id id=&#34;folder_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the folder {{%/request_id%}}

{{%request_id id=&#34;start&#34; data=&#34;Numerical&#34; %}}&lt;p&gt;Start value of the current bundle &lt;/p&gt;{{%/request_id%}}

{{%request_id id=&#34;end&#34; data=&#34;Numerical&#34; %}}&lt;p&gt;Number of files to be retrieved. The maximum value allowed is 200. &lt;/p&gt;{{%/request_id%}}

For example, to retrieve the details of files 201 to 300, specify the {{%badge%}}start{{%/badge%}} as &#39;201&#39; and the {{%badge%}}end{{%/badge%}} as &#39;100&#39;.

{{%note%}} {{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} The {{%badge%}}start{{%/badge%}} value must always be greater than 0.{{%/note%}}


#### Request Headers
{{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token}
{{%/scope%}}

**Optional Headers** &lt;br&gt;
{{%scope%}} **CATALYST-ORG:** {org_id}
{{%/scope%}}
{{%scope%}} **Environment:** Development
{{%/scope%}}

#### Scope
{{%scope%}}
ZohoCatalyst.files.READ
{{%/scope%}}


{{%note%}} {{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} This operation can also be executed with Catalyst user authentication permissions using Catalyst SDKs. Refer to the [Catalyst API Prerequisites section](/en/api/introduction/overview-and-prerequisites/#prerequisites) for details.{{%/note%}}


### Response Details

The response will return the metadata and details of all the files that are returned, including their {{%badge%}}file_name{{%/badge%}}, {{%badge%}}file_size{{%/badge%}}, and the details of the user who created and last modified the file.


{{%/divtag%}}

{{%divtag class=&#34;RightContent&#34;%}}

{{% panel_without_adjustment header=&#34;Sample Request&#34; class=&#34;language-bash&#34; %}}curl -X GET \
  https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/3376000000301993/file?start=201&amp;end=2 \
  -H &#34;Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57&#34;

{{% /panel_without_adjustment %}}

{{% panel_with_adjustment header=&#34;Sample Response&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;status&#34;:&#34;success&#34;,
    &#34;data&#34;: [
        {
          &#34;id&#34;:3376000000301234,
          &#34;file_location&#34;:null,
          &#34;file_name&#34;:&#34;AuditLog.csv&#34;,
          &#34;file_size&#34;:1621,
          &#34;created_by&#34;: {
            &#34;zuid&#34;:10016873924,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Amelia&#34;,
            &#34;last_name&#34;:&#34;Burrows&#34;,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;:671930400
          },
          &#34;created_time&#34;:&#34;Apr 27, 2020 07:37 PM&#34;,
          &#34;modified_by&#34;: {
            &#34;zuid&#34;:10016873924,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Patricia&#34;,
            &#34;last_name&#34;:&#34;Boyle&#34;,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;:671938657
          },
          &#34;modified_time&#34;:&#34;Apr 27, 2020 07:37 PM&#34;,
          &#34;project_details&#34;: {
            &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
            &#34;id&#34;: 4000000006007,
            &#34;project_type&#34;: &#34;Live&#34;
          },
        &#34;folder_details&#34;:3376000000301993
        },
        {
          &#34;id&#34;:3376000000300987,
          &#34;file_location&#34;:null,
          &#34;file_name&#34;:&#34;ZohoCatalyst-Pricing.pdf&#34;,
          &#34;file_size&#34;:346466,
          &#34;created_by&#34;: {
            &#34;zuid&#34;:10016873924,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Ameila&#34;,
            &#34;last_name&#34;:&#34;Burrows&#34;,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;:671930400
          },
          &#34;created_time&#34;:&#34;Apr 27, 2020 07:36 PM&#34;,
          &#34;modified_by&#34;: {
            &#34;zuid&#34;:10016873924,
            &#34;is_confirmed&#34;:true,
            &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Patricia&#34;,
            &#34;last_name&#34;:&#34;Boyle&#34;,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;:671938657
          },
          &#34;modified_time&#34;:&#34;Apr 27, 2020 07:36 PM&#34;,
          &#34;project_details&#34;: {
            &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
            &#34;id&#34;:3376000000168765,
            &#34;project_type&#34;: &#34;Live&#34;
          },
          &#34;folder_details&#34;:3376000000301993
        }
      ]
    }{{% /panel_with_adjustment %}}


{{%/divtag%}}
{{%/section%}}


--------------------------------------------------------------------------------
title: "Delete File"
description: "This API enables you to delete an existing file from a folder."
last_updated: "2026-03-18T07:41:08.541Z"
source: "https://docs.catalyst.zoho.com/en/api/code-reference/cloud-scale/file-store/delete-file/"
service: "Cloud Scale"
--------------------------------------------------------------------------------


{{% section path=&#34;/en/api/code-reference/cloud-scale/file-store/delete-file/&#34; id=&#34;DeleteFile&#34; %}}

{{%divtag class=&#34;LeftContent&#34;%}}

# Delete a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

### Description

This API is used to delete an existing file from a folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}}, by referring to the Folder ID and File ID.


### Request Details

#### Request URL
{{%request class=&#34;apired&#34; req=&#34;DELETE&#34; %}}&lt;p&gt;{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}&lt;/p&gt;{{%/request%}}

{{%request_id id=&#34;api-domain&#34; data=&#34;URL&#34; %}}The DC-specific domain to access Catalyst API{{%/request_id%}}

{{%request_id id=&#34;project_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34;%}}unique ID{{%/link%}} of the project{{%/request_id%}}

{{%request_id id=&#34;folder_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the folder {{%/request_id%}}

{{%request_id id=&#34;file_id&#34; data=&#34;Numerical&#34; %}}The {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}unique ID{{%/link%}} of the file {{%/request_id%}}


#### Request Headers
{{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token} &lt;br&gt;
**Content-Type:** application/json
{{%/scope%}}

**Optional Headers** &lt;br&gt;
{{%scope%}} **CATALYST-ORG:** {org_id}
{{%/scope%}}
{{%scope%}} **Environment:** Development
{{%/scope%}}

#### Scope
{{%scope%}}
ZohoCatalyst.files.DELETE
{{%/scope%}}


{{%note%}} {{%bold class=&#34;bold-primary&#34;%}}Note:{{%/bold%}} This operation can also be executed with Catalyst user authentication permissions using Catalyst SDKs. Refer to the [Catalyst API Prerequisites section](/en/api/introduction/overview-and-prerequisites/#prerequisites) for details.{{%/note%}}


### Response Details

The response will return the metadata and details of the file that was deleted including its {{%badge%}}file_name{{%/badge%}}, {{%badge%}}file_size{{%/badge%}}, and the details of the user who created and last modified the file.


{{%/divtag%}}

{{%divtag class=&#34;RightContent&#34;%}}

{{% panel_without_adjustment header=&#34;Sample Request&#34; class=&#34;language-bash&#34; %}}curl -X DELETE \
  https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/4000000044001 \
  -H &#34;Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57&#34; \
  -H &#34;Content-Type: application/json&#34;

{{% /panel_without_adjustment %}}

{{% panel_without_adjustment header=&#34;Sample Response&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;status&#34;: &#34;success&#34;,
    &#34;data&#34;: {
        &#34;id&#34;: 4000000044001,
        &#34;file_location&#34;: null,
        &#34;file_name&#34;: &#34;bookingsSept2019.pdf&#34;,
        &#34;file_size&#34;: 458186,
        &#34;created_by&#34;: {
            &#34;zuid&#34;: 671787990,
            &#34;is_confirmed&#34;:true,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;: 671930400,
            &#34;email_id&#34;: &#34;emma@zylker.com&#34;,
            &#34;first_name&#34;: &#34;Amelia&#34;,
            &#34;last_name&#34;: &#34;Burrows&#34;
        },
        &#34;created_time&#34;: &#34;2019-03-14T12:35:18&#43;05:30&#34;,
        &#34;modified_by&#34;: {
            &#34;zuid&#34;: 671787990,
            &#34;is_confirmed&#34;:true,
            &#34;user_type&#34;: &#34;Admin&#34;,
            &#34;user_id&#34;: 671930400,
            &#34;email_id&#34;: &#34;emma@zylker.com&#34;,
            &#34;first_name&#34;: &#34;Amelia&#34;,
            &#34;last_name&#34;: &#34;Burrows&#34;
        },
        &#34;modified_time&#34;: &#34;2019-03-14T12:35:18&#43;05:30&#34;,
        &#34;project_details&#34;: {
            &#34;id&#34;: 4000000006007,
            &#34;project_name&#34;: &#34;ShipmentTracking&#34;,
            &#34;project_type&#34;: &#34;Live&#34;
        },
        &#34;folder_details&#34;: 105000000121098
    }
    }{{% /panel_without_adjustment %}}


{{% expand-container %}}   
{{% expand id=&#34;sdk_docs&#34; header=&#34;SDK Documentation&#34;%}}
{{%link href=&#34;/en/sdk/java/v1/cloud-scale/file-store/delete-file&#34;%}}Delete a File- Java SDK{{%/link%}}&lt;/br&gt;&lt;/br&gt;
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/delete-file&#34;%}}Delete a File- Node.js SDK{{%/link%}}&lt;/br&gt;&lt;/br&gt;
{{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/delete-a-file&#34;%}}Delete a File- Python SDK{{%/link%}}&lt;/br&gt;&lt;/br&gt;
{{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/delete-file&#34;%}}Delete a File- Web SDK{{%/link%}}
{{%/expand%}}
{{%/expand-container%}}


{{%/divtag%}}
{{%/section%}}


---

## SDK — Android — File Store

--------------------------------------------------------------------------------
title: "Create a File Store Instance"
description: "Catalyst File Store provides storage solutions for the app data files and user data files of your Catalyst application, and enables access to shared data."
last_updated: "2026-03-18T07:41:08.547Z"
source: "https://docs.catalyst.zoho.com/en/sdk/android/v2/cloud-scale/file-store/create-file-store-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- File Store - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)

--------------------------------------------------------------------------------


# File Store

{{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}} provides cloud storage solutions for the application files and user data files of your Catalyst application, and enables access to shared data. You can store, manage, and organize images, videos, text files, document files, spreadsheets, or files of other formats.

### Create a File Store Instance

You can create an instance of your Catalyst project&#39;s File Store using the {{%badge%}}**getFileStoreInstance()**{{%/badge%}} method, and enable the methods defined in this class to access the instance object. This prevents unnecessary server calls.

A File Store instance can be created as shown below:

{{%code class=&#34;language-bash&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance(): ZCatalystFileStore{{%/code%}}


--------------------------------------------------------------------------------
title: "Get Folders"
description: "You can obtain the details of a specific folder in the File Store."
last_updated: "2026-03-18T07:41:08.547Z"
source: "https://docs.catalyst.zoho.com/en/sdk/android/v2/cloud-scale/file-store/get-folders/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Get Folder - API (/en/api/code-reference/cloud-scale/file-store/get-all-folders/#GetAllFolders)

--------------------------------------------------------------------------------


# Get Folders

### Get the Metadata of a Specific Folder

You can obtain the details of a specific folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by passing its unique Folder ID as an argument to the {{%badge%}}**getFolder()**{{%/badge%}} method, as shown in the code syntax below. This fetches the folder object using which you can retrieve the folder&#39;s metadata such as the details of its creation, last modification, and the meta details of the files in it.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/android/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolder(
    id: Long,
    success: (ZCatalystFolder) → Unit,
    failure: ((ZCatalystException) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ZCatalystFolder&amp;gt;&amp;gt;?
{{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}Folder ID{{%/link%}} of the folder to be retrieved

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolder(2823000000006561,//Replace this with your Folder ID
    {
        folder -&gt; println(&#34;Get Folder Success&#34;)
        println(&#34;Folder name: ${folder.name} &#34;)
    },
    {
        exception -&gt; println(&#34;Get Folder Failed! $exception&#34;)
    })
{{%/code%}}

### Get the Metadata of all Folders

You can retrieve the details of all the folders available in your project&#39;s File Store using the {{%badge%}}**getFolders()**{{%/badge%}} method, as shown in the code syntax below. This can fetch the meta data of all the folders, and the files in them.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/android/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolders(
    success: (List&amp;lt;ZCatalystFolder&amp;gt;) → Unit,
    failure: ((ZCatalystException) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ArrayList&amp;lt;ZCatalystFolder&amp;gt;&amp;gt;&amp;gt;?
{{%/code%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolders(
    {
        folders -&gt;
        for (folder in folders){
                println(&#34;Folder names: ${folder.name}&#34;)
        }
    },
    {
        exception -&gt;
        println(&#34;Get Folders Failed! $exception&#34;)
    }
)
{{%/code%}}

--------------------------------------------------------------------------------
title: "Create a Folder Instance"
description: "You can create an instance for a specific folder in the File Store and enable the methods defined in this class to access the instance object."
last_updated: "2026-03-18T07:41:08.547Z"
source: "https://docs.catalyst.zoho.com/en/sdk/android/v2/cloud-scale/file-store/create-folder-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- File Store - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)

--------------------------------------------------------------------------------


# Create a Folder Instance

You can create an instance for a specific folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}} using the {{%badge%}}**getFolderInstance()**{{%/badge%}} method, and enable the methods defined in this class to access the instance object. You must pass the Folder ID of that folder to the {{%badge%}}getFolderInstance(){{%/badge%}} method, as shown in the code syntax below.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/android/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolderInstance(
    id: Long
): ZCatalystFolder
{{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}Folder ID{{%/link%}} of the folder that the instance object must be returned for

A sample code snippet is shown below:

{{%code class=&#34;language-bash&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561) //Replace this with your Folder ID{{%/code%}}


--------------------------------------------------------------------------------
title: "Get Files"
description: "You can retrieve the details of a specific file or of all the files in the File Store."
last_updated: "2026-03-18T07:41:08.547Z"
source: "https://docs.catalyst.zoho.com/en/sdk/android/v2/cloud-scale/file-store/get-files/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Get File - API (/en/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile)

--------------------------------------------------------------------------------


# Get Files

### Get the Metadata of a Specific File

You can retrieve the details of a specific file in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by passing its unique File ID as an argument to the {{%badge%}}**getFile()**{{%/badge%}} method, as shown in the code syntax below. This fetches the file object using which you can retrieve the file&#39;s metadata such as the details of its creation, last modification, file size, etc.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/android/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.getFile(
    id: Long,
    success: (ZCatalystFile) → Unit,
    failure: ((ZCatalystException) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ZCatalystFile&amp;gt;&amp;gt;?
{{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#upload-a-file-into-a-folder&#34;%}}File ID{{%/link%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}val folder = ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561) //Replace this with your Folder ID
    folder.getFile(2823000000044005, //Replace this with your File ID
        {
            file -&gt; println(&#34;Get File Success&#34;)
            println(&#34;The name of the file is: ${file.name}&#34;)
            println(&#34;The size of the file is: ${file.size}&#34;)
        },
        {
            exception -&gt; println(&#34;Get File Failed! $exception&#34;)
        })
{{%/code%}}

### Get the Metadata of all Files

You can retrieve the details of all the files available in a specific folder using the {{%badge%}}**getFiles()**{{%/badge%}} method, as shown in the code syntax below.

The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/android/v2/cloud-scale/file-store/create-folder-instance&#34;%}}Folder Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.getFiles(
    success: (List&amp;lt;ZCatalystFile&amp;gt;) → Unit,
    failure: ((ZCatalystException) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ArrayList&amp;lt;ZCatalystFile&amp;gt;&amp;gt;&amp;gt;?
{{%/code%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).getFiles( //Replace this with your Folder ID
    {
        files -&gt; println(&#34;Get Files Success&#34;)
        for (file in files){
            println(&#34;File names: ${file.name}&#34;)
        }
    },
    {
        exception -&gt; println(&#34;Get Files Failed $exception&#34;)
    }
)
{{%/code%}}

--------------------------------------------------------------------------------
title: "Upload a File"
description: "You can upload a file to an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.548Z"
source: "https://docs.catalyst.zoho.com/en/sdk/android/v2/cloud-scale/file-store/upload-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Upload File - API (/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder)

--------------------------------------------------------------------------------


# Upload a File

You can upload a file to an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by calling the {{%badge%}}**uploadFile()**{{%/badge%}} method. After the file is uploaded in the folder, a unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}File ID{{%/link%}} will be generated for it. You can upload an image, text document, CSV, or any type of file you need upto 100MB of file size.

You can upload the file in one of the following five ways, as discussed below. The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code sections of all the methods below is the instance defined in the {{%link href=&#34;/en/sdk/android/v2/cloud-scale/file-store/create-folder-instance&#34;%}}Folder Instance page{{%/link%}}. This will refer to the folder that the file must be uploaded in.

### By passing the File URI Scheme

You can upload the file to the folder of the given folder instance by passing the file&#39;s URI scheme as an argument to the {{%badge%}}uploadFile(){{%/badge%}} method:

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.uploadFile(
    uri: Uri,
    success: (ZCatalystFile) → Unit,
    failure: ((ZCatalystException) → Unit)?,
    progress: ((Long, Long, Double) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ZCatalystFile&amp;gt;&amp;gt;?
{{%/code%}}

**Parameters**:

* {{%badge%}}**uri**{{%/badge%}}: The File URI scheme of the file to be uploaded

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile(&#34;/src.example.com/files/productImage.png&#34;,
    {
        println(&#34; &gt;&gt; File Upload Success -$it&#34;)
    },
    {
        println(&#34; &gt;&gt; File Upload Failed -$it&#34;)
    })
{{%/code%}}

### By passing the File Path

You can upload the file to the folder of the given folder instance by passing its file path in the local system an argument to the {{%badge%}}uploadFile(){{%/badge%}} method:

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.uploadFile(
    filePath: String,
    success: (ZCatalystFile) → Unit,
    failure: ((ZCatalystException) → Unit)?,
    progress: ((Long, Long, Double) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ZCatalystFile&amp;gt;&amp;gt;?
{{%/code%}}

**Parameters**:

* {{%badge%}}**filepath**{{%/badge%}}: The file path of the file to be uploaded

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile(&#34;/Desktop/HelplineCard.jpg&#34;,
    {
        println(&#34; &amp;gt;&amp;gt; File Upload Success -$it&#34;)
    },
    {
        println(&#34; &amp;gt;&amp;gt; File Upload Failed -$it&#34;)
    })
{{%/code%}}

### By passing the File URI Scheme and File Name

You can upload the file to the folder of the given folder instance by passing both File URI scheme and the file name as individual arguments to the {{%badge%}}uploadFile(){{%/badge%}} method:

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.uploadFile(
    uri: Uri,
    fileName: String,
    success: (ZCatalystFile) → Unit,
    failure: ((ZCatalystException) → Unit)?,
    progress: ((Long, Long, Double) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ZCatalystFile&amp;gt;&amp;gt;?
{{%/code%}}

**Parameters**:

* {{%badge%}}**uri**{{%/badge%}}: The File URI scheme of the file to be uploaded
* {{%badge%}}**fileName**{{%/badge%}}: The name of the file to be uploaded

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile(&#34;/src.example.com/files&#34;, &#34;productImage.png&#34;,
    {
        println(&#34; &amp;gt;&amp;gt; File Upload Success -$it&#34;)
    },
    {
        println(&#34; &amp;gt;&amp;gt; File Upload Failed -$it&#34;)
    })
{{%/code%}}

### By passing the File Path and File Name

You can upload the file to the folder of the given folder instance by passing both the file path in the local system and the file name as the arguments to the {{%badge%}}uploadFile(){{%/badge%}} method:

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.uploadFile(
    filePath: String,
    fileName: String,
    success: (ZCatalystFile) → Unit,
    failure: ((ZCatalystException) → Unit)?,
    progress: ((Long, Long, Double) → Unit)?
): ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ZCatalystFile&amp;gt;&amp;gt;?
{{%/code%}}

**Parameters**:

* {{%badge%}}**filepath**{{%/badge%}}: The file path of the file to be uploaded
* {{%badge%}}**fileName**{{%/badge%}}: The name of the file to be uploaded

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile(&#34;/Desktop&#34;, &#34;HelplineCard.jpg&#34;,
    {
        println(&#34; &amp;gt;&amp;gt; File Upload Success -$it&#34;)
    },
    {
        println(&#34; &amp;gt;&amp;gt; File Upload Failed -$it&#34;)
    })
{{%/code%}}


### By passing the File as inputStream and the File Name

You can upload the file to the folder of the given folder instance by passing both the file as inputStream and the file name as the arguments to the {{%badge%}}uploadFile(){{%/badge%}} method:

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.uploadFile(stream: InputStream,
                   fileName: String,
                   success: (ZCatalystFile) -&gt; Unit,
                   failure: ((ZCatalystException) -&gt; Unit)? = null,
                   progress: ((bytesWritten: Long, contentLength: Long, percentage: Double) -&gt; Unit)? = null)
            : ZCatalystRequest&amp;lt;ZCatalystResponse&amp;lt;ZCatalystFile&amp;gt;&amp;gt;?
{{%/code%}}

**Parameters**:

* {{%badge%}}**stream**{{%/badge%}}: The inputStream of the file
* {{%badge%}}**fileName**{{%/badge%}}: The name of the file to be uploaded

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}val file = File(&#34;/Desktop/HelplineCard.jpg&#34;)
val inputStream: InputStream = FileInputStream(file)
ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile(inputStream,
    {
        println(&#34; &gt;&gt; File Upload Success -$it&#34;)
    },
    {
        println(&#34; &gt;&gt; File Upload Failed -$it&#34;)
    })
{{%/code%}}

--------------------------------------------------------------------------------
title: "Download a File"
description: "You can download a file from an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.548Z"
source: "https://docs.catalyst.zoho.com/en/sdk/android/v2/cloud-scale/file-store/download-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Download File - API (/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder)

--------------------------------------------------------------------------------


# Download a File

You can download a file from an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}} by calling the {{%badge%}}**download()**{{%/badge%}} method. The operation will return a temporary URL where the file is stored.

The {{%badge%}}&amp;lt;FILE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is an instance created for the specific file, as shown in the sample code snippet. This will refer to the file from the specific folder that must be downloaded by its unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}File ID{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FILE_INSTANCE&amp;gt;.download(
    success: (InputStream) → Unit,
    failure: ((ZCatalystException) → Unit)?,
    progress: ((Long, Long, Double) → Unit)?
): ZCatalystRequest&amp;lt;ResponseBody&amp;gt;?
{{%/code%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).getFile(2823000000044005, //Replace this with your Folder ID and File ID
    {
        file -&gt; file.download(
        {
            println(&#34;File download success ${it.available()}&#34;)
        },
        {
            println(&#34;File download failed $it&#34;)
        },
        {   bytesWritten, contentLength, percentage -&gt;
            println(&#34;&amp;gt;&amp;gt; Percentage - $percentage&#34;)
            println(&#34;&amp;gt;&amp;gt; Bytes Written - $bytesWritten&#34;)
            println(&#34;&amp;gt;&amp;gt; Content Length - $contentLength&#34;)
        }
    )
})
{{%/code%}}

--------------------------------------------------------------------------------
title: "Delete a File"
description: "You can delete an existing file from a folder in the File Store."
last_updated: "2026-03-18T07:41:08.548Z"
source: "https://docs.catalyst.zoho.com/en/sdk/android/v2/cloud-scale/file-store/delete-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Delete File - API (/en/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile)

--------------------------------------------------------------------------------


# Delete a File

You can delete an existing file from a folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}} by calling the {{%badge%}}**delete()**{{%/badge%}} method and referring to the file with the file instance. This will delete the file permanently.

The {{%badge%}}&amp;lt;FILE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is an instance created for the specific file, as shown in the sample code snippet. This will refer to the file from the specific folder that must be deleted by its unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}File ID{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FILE_INSTANCE&amp;gt;.delete(
    success: () → Unit,
    failure: ((ZCatalystException) → Unit)?
): ZCatalystRequest&amp;lt;Unit&amp;gt;?
{{%/code%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006544).getFile(2823000000006589, //Replace this with your Folder ID and File ID
    {
        file -&gt; file.delete(
        {
            println(&#34;File Deleted successfully&#34;)
        })
    },
    {
                exception -&gt; println(&#34;Delete File Failed $exception&#34;)
    })
{{%/code%}}

---

## SDK — Flutter — File Store

--------------------------------------------------------------------------------
title: "Create a File Store Instance"
description: "Catalyst File Store provides storage solutions for the app data files and user data files of your Catalyst application, and enables access to shared data."
last_updated: "2026-03-18T07:41:08.549Z"
source: "https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/file-store/create-file-store-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- File Store - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)

--------------------------------------------------------------------------------


# File Store

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

{{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}} provides cloud storage solutions for the application files and user data files of your Catalyst application, and enables access to shared data. You can store, manage, and organize images, videos, text files, document files, spreadsheets, or files of other formats.

### Create a File Store Instance

You can create an instance of your Catalyst project&#39;s File Store using the {{%badge%}}**getFileStoreInstance()**{{%/badge%}} method, and enable the methods defined in this class to access the instance object. This prevents unnecessary server calls.

A File Store instance can be created as shown below:

{{%code class=&#34;language-bash&#34;%}}var fileStore = ZCatalystApp.getInstance().getFileStoreInstance();{{%/code%}}


--------------------------------------------------------------------------------
title: "Get Folders"
description: "You can obtain the details of a specific folder in the File Store."
last_updated: "2026-03-18T07:41:08.549Z"
source: "https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/file-store/get-folders/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Get Folder - API (/en/api/code-reference/cloud-scale/file-store/get-all-folders/#GetAllFolders)

--------------------------------------------------------------------------------


# Get Folders

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

### Get the Metadata of a Specific Folder

You can obtain the details of a specific folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by passing its unique Folder ID as an argument to the {{%badge%}}**getFolder()**{{%/badge%}} method, as shown in the code syntax below. This fetches the folder object using which you can retrieve the folder&#39;s metadata such as the details of its creation, last modification, and the meta details of the files in it.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/flutter/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}Future&lt;(APIResponse, ZCatalystFolder)&gt; &amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolder(int id){{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}Folder ID{{%/link%}} of the folder to be retrieved

A sample code snippet with the File Store instance is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}try{
  var (response, folder) = await   ZCatalystApp.getInstance().getFileStoreInstance().getFolder(2823000000006561);
 print(&#39;Get Folder Success.&#39;);
 print(&#39;Folder name : ${folder.name}&#39;);

} on ZCatalystException catch (ex) {
  print(&#34;Failed to fetch folder: $ex&#34;)
}{{%/code%}}

&lt;br&gt;

### Get the Metadata of all Folders

You can retrieve the details of all the folders available in your project&#39;s File Store using the {{%badge%}}**getFolders()**{{%/badge%}} method, as shown in the code syntax below. This can fetch the meta data of all the folders, and the files in them.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/flutter/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}Future&lt;(APIResponse, List&amp;lt;ZCatalystFolder&amp;gt;)&gt; &amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolders(){{%/code%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}try{
  var (response, folders) =  await ZCatalystApp.getInstance().getFileStoreInstance().getFolders();
  print(&#39;Get all Folders Success.&#39;);
 for (var folder in folders) {
   print(folder.name);
 }
} on ZCatalystException catch (ex) {
  print(&#34;Failed to fetch all folders $ex&#34;);
}{{%/code%}}

--------------------------------------------------------------------------------
title: "Create a Folder Instance"
description: "You can create an instance for a specific folder in the File Store and enable the methods defined in this class to access the instance object."
last_updated: "2026-03-18T07:41:08.549Z"
source: "https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/file-store/create-folder-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- File Store - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)

--------------------------------------------------------------------------------


# Create a Folder Instance

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can create an instance for a specific folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}} using the {{%badge%}}**getFolderInstance()**{{%/badge%}} method, and enable the methods defined in this class to access the instance object. You must pass the Folder ID of that folder to the {{%badge%}}getFolderInstance(){{%/badge%}} method, as shown in the code syntax below.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/flutter/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolderInstance(
    int id
){{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}Folder ID{{%/link%}} of the folder that the instance object must be returned for

A sample code snippet is shown below:

{{%code class=&#34;language-bash&#34;%}}ZCatalystFolder folder = ZCatalystApp.getInstance()
      .getFileStoreInstance()
      .getFolderInstance(2823000000006561);{{%/code%}}


--------------------------------------------------------------------------------
title: "Get Files"
description: "You can retrieve the details of a specific file or of all the files in the File Store."
last_updated: "2026-03-18T07:41:08.549Z"
source: "https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/file-store/get-files/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Get File - API (/en/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile)

--------------------------------------------------------------------------------


# Get Files

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

### Get the Metadata of a Specific File

You can retrieve the details of a specific file in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by passing its unique File ID as an argument to the {{%badge%}}**getFile()**{{%/badge%}} method, as shown in the code syntax below. This fetches the file object using which you can retrieve the file&#39;s metadata such as the details of its creation, last modification, file size, etc.

The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/flutter/v2/cloud-scale/file-store/create-file-store-instance/&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}Future&lt;(APIResponse, ZCatalystFile)&gt; &amp;lt;FOLDER_INSTANCE&amp;gt;.getFile(int id){{%/code%}}


**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#upload-a-file-into-a-folder&#34;%}}File ID{{%/link%}} of the file to be retrieved

A sample code snippet with the folder instance is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystFolder folder = ZCatalystApp.getInstance()
      .getFileStoreInstance()
      .getFolderInstance(2823000000006561);
try{
  var (response, file) = await folder.getFile(2823000000006561);
  print(&#39;Get File Success&#39;);
  print(&#39;The name of the file is : ${file.name}&#39;);
  print(&#39;The size of the file is : ${file.size}&#39;);
} on ZCatalystException catch (ex) {
  print(ex.toString);
}{{%/code%}}

&lt;br&gt;

### Get the Metadata of all Files

You can retrieve the details of all the files available in a specific folder using the {{%badge%}}**getFiles()**{{%/badge%}} method, as shown in the code syntax below.

The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/flutter/v2/cloud-scale/file-store/create-folder-instance&#34;%}}Folder Instance page{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}Future&lt;(APIResponse, List&amp;lt;ZCatalystFile&amp;gt;)&gt; &amp;lt;FOLDER_INSTANCE&amp;gt;.getFiles(){{%/code%}}

A sample code snippet with the folder instance is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystFolder folder = ZCatalystApp.getInstance()
      .getFileStoreInstance()
      .getFolderInstance(2823000000006561); //Define the folder instance
try{
  var (response, files) = await folder.getFiles();
  for (var file in files) {
   print(file.name); //Actions to be executed upon success
  }
} on ZCatalystException catch (ex) {
  print(ex.toString());
}{{%/code%}}

--------------------------------------------------------------------------------
title: "Upload a File"
description: "You can upload a file to an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.550Z"
source: "https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/file-store/upload-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Upload File - API (/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder)

--------------------------------------------------------------------------------


# Upload a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can upload a file to an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by calling the {{%badge%}}**uploadFile()**{{%/badge%}} method. After the file is uploaded in the folder, a unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}File ID{{%/link%}} will be generated for it.  You can upload an image, text document, CSV, or any other type of file you need. 

The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code sections of all the methods below is the instance defined in the {{%link href=&#34;/en/sdk/flutter/v2/cloud-scale/file-store/create-folder-instance&#34;%}}Folder Instance page{{%/link%}}. This will refer to the folder that the file must be uploaded in.

{{%code class=&#34;language-bash line-numbers&#34;%}}Future&lt;(APIResponse, ZCatalystFile)&gt; &amp;lt;FOLDER_INSTANCE&amp;gt;.uploadFile(String filePath, String fileName){{%/code%}}

**Parameters**:

* {{%badge%}}**filepath**{{%/badge%}}: The file path of the file to be uploaded
* {{%badge%}}**fileName**{{%/badge%}}: The name of the file to be uploaded

A sample code snippet with the folder instance is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystFolder folder = ZCatalystApp.getInstance()
      .getFileStoreInstance()
      .getFolderInstance(2823000000006561); //Define the folder instance and specify the ID of the folder to upload the file in
try{
  var (response, file) = await folder.uploadFile(
    &#39;assets/images/product_image.webp&#39;,
    &#39;sample_product&#39;);
  print(&#39;File Upload Success: ${file.name}&#39;); 

} on ZCatalystException catch (ex) {
  print(ex.toString());
}{{%/code%}}

--------------------------------------------------------------------------------
title: "Download a File"
description: "You can download a file from an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.550Z"
source: "https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/file-store/download-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Download File - API (/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder)

--------------------------------------------------------------------------------


# Download a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can download a file from an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34;%}}File Store{{%/link%}} by calling the {{%badge%}}**download()**{{%/badge%}} method. The file will be automatically downloaded to file path that you set and will be assigned the file name that you configure. You can pass these values as arguments to the {{%badge%}}download(){{%/badge%}} method as shown in the example.

The {{%badge%}}&amp;lt;FILE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is an instance created for the specific file, as shown in the sample code snippet. This will refer to the file from the specific folder that must be downloaded by its unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}File ID{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}Future&lt;(APIResponse, String)&gt; &amp;lt;FILE_INSTANCE&amp;gt;.download(
void Function(int, int, double) inProgress){{%/code%}}

A sample code snippet with the file instance is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystFolder folder = ZCatalystApp.getInstance()
      .getFileStoreInstance()
      .getFolderInstance(2823000000006561);
try{
  var (_, file) = folder.getFile(2823000000006561);
  var (_, downloadedFilePath) = await file.download(
          filePath: &#39;/desktop/files/&#39;,
          fileName: &#39;red.webp&#39;,
          onProgress: (bytesWritten, contentLength, percentage) {
            print(&#39;${percentage}%&#39;);
          });
   print(downloadedFilePath);
} on ZCatalystException catch (ex) {
  print(ex.toString());
}{{%/code%}}

--------------------------------------------------------------------------------
title: "Delete a File"
description: "You can delete an existing file from a folder in the File Store."
last_updated: "2026-03-18T07:41:08.550Z"
source: "https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/file-store/delete-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Delete File - API (/en/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile)

--------------------------------------------------------------------------------


# Delete a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can delete an existing file from a folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}} by calling the {{%badge%}}**delete()**{{%/badge%}} method and referring to the file with the file instance. This will delete the file permanently.

The {{%badge%}}&amp;lt;FILE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is an instance created for the specific file, as shown in the sample code snippet. This will refer to the file that must be deleted by its unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/&#34;%}}File ID{{%/link%}}.

{{%code class=&#34;language-bash line-numbers&#34;%}}Future&amp;lt;APIResponse&amp;gt; &amp;lt;FILE_INSTANCE&amp;gt;.delete(){{%/code%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystFolder folder = ZCatalystApp.getInstance()
      .getFileStoreInstance()
      .getFolderInstance(2823000000006561);
try{
  var (_ file) = await folder.getFile(2823000000006561);
  await file.delete();
  print(&#39;File deleted successfully.&#39;);
} on ZCatalystException catch (ex) {
  print(ex.toString());
}{{%/code%}}

---

## SDK — iOS — File Store

--------------------------------------------------------------------------------
title: "Create a File Store Instance"
description: "Catalyst File Store provides storage solutions for the app data files and user data files of your Catalyst application, and enables access to shared data."
last_updated: "2026-03-18T07:41:08.551Z"
source: "https://docs.catalyst.zoho.com/en/sdk/ios/v2/cloud-scale/file-store/create-file-store-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- File Store - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)

--------------------------------------------------------------------------------


# File Store

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

{{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}} provides cloud storage solutions for the application files and user data files of your Catalyst application, and enables access to shared data. You can store, manage, and organize images, videos, text files, document files, spreadsheets, or files of other formats.

### Create a File Store Instance

You can create an instance of your Catalyst project&#39;s File Store using the {{%badge%}}**getFileStoreInstance()**{{%/badge%}} method, and enable the methods defined in this class to access the instance object. This prevents unnecessary server calls.

A File Store instance can be created as shown below:

{{%code class=&#34;language-bash&#34;%}}ZCatalystApp.shared.getFileStoreInstance() -&gt; ZCatalystFileStore{{%/code%}}


--------------------------------------------------------------------------------
title: "Get Folders"
description: "Catalyst File Store provides storage solutions for the app data files and user data files of your Catalyst application, and enables access to shared data."
last_updated: "2026-03-18T07:41:08.551Z"
source: "https://docs.catalyst.zoho.com/en/sdk/ios/v2/cloud-scale/file-store/get-folders/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Get Folder - API (/en/api/code-reference/cloud-scale/file-store/get-all-folders/#GetAllFolders)

--------------------------------------------------------------------------------


# Get Folders

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

### Get the Metadata of a Specific Folder

You can obtain the details of a specific folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by passing its unique Folder ID as an argument to the {{%badge%}}**getFolder()**{{%/badge%}} method, as shown in the code syntax below. This fetches the folder object using which you can retrieve the folder&#39;s metadata such as the details of its creation, last modification, and the meta details of the files in it.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/ios/v2/cloud-scale/file-store/create-file-store-instance&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolder( id : Int64, completion : @escaping ( Result&amp;lt; ZCatalystFolder, ZCatalystError &amp;gt; ) -&gt; Void ){{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}Folder ID{{%/link%}} of the folder to be retrieved
* {{%badge%}}**completion**{{%/badge%}}: If the operation is successful, the completion block will return the folder details. Else, it will return an error.

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.shared.getFileStoreInstance().getFolder(id : 3376000000427654) {(result) in //Replace this with your Folder ID
	switch result	{
  	case .success ( let folder) :
		   print(&#34;The names of the folder are &#34; &#43; folder.name)
	  case .error( let error ) :
	   print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
  	}
	}
{{%/code%}}

### Get the Metadata of all Folders

You can retrieve the details of all the folders available in your project&#39;s File Store using the {{%badge%}}**getFolders()**{{%/badge%}} method, as shown in the code syntax below. This can fetch the meta data of all the folders, and the files in them.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/ios/v2/cloud-scale/file-store/create-file-store-instance&#34;%}}File Store Instance page{{%/link%}}.

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolders( completion : @escaping ( Result&amp;lt; [ ZCatalystFolder ], ZCatalystError &amp;gt; ) -&gt; Void ){{%/code%}}

**Parameters**:

* {{%badge%}}**completion**{{%/badge%}}: If the operation is successful, the completion block will return the details of all the folders. Else, it will return an error.

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.shared.getFileStoreInstance().getFolders() {(result) in
	switch result{
	  case .success ( let folders) :
	   for folder in folders {
    			print(&#34;The names of the folder are &#34; &#43; folder.name)
   			}	
  case .error( let error ) :
   	print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
		  }
	}
{{%/code%}}

--------------------------------------------------------------------------------
title: "Create a Folder Instance"
description: "You can create an instance for a specific folder in the File Store and enable the methods defined in this class to access the instance object."
last_updated: "2026-03-18T07:41:08.551Z"
source: "https://docs.catalyst.zoho.com/en/sdk/ios/v2/cloud-scale/file-store/create-folder-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- File Store - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)

--------------------------------------------------------------------------------


# Create a Folder Instance

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can create an instance for a specific folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}} using the {{%badge%}}**getFolderInstance()**{{%/badge%}} method, and enable the methods defined in this class to access the instance object. You must pass the Folder ID of that folder to the {{%badge%}}getFolderInstance(){{%/badge%}} method, as shown in the code syntax below.

The {{%badge%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/ios/v2/cloud-scale/file-store/create-file-store-instance&#34;%}}File Store Instance page{{%/link%}}

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FILE_STORE_INSTANCE&amp;gt;.getFolderInstance( id : Int64 ) -&gt; ZCatalystFolder{{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}Folder ID{{%/link%}} of the folder that the instance object must be returned for

A sample code snippet is shown below:

{{%code class=&#34;language-bash&#34;%}}let folderInstance = ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 3376000000427654) //Replace this with your Folder ID{{%/code%}}


--------------------------------------------------------------------------------
title: "Get Files"
description: "You can retrieve the details of a specific file or of all the files in the File Store."
last_updated: "2026-03-18T07:41:08.551Z"
source: "https://docs.catalyst.zoho.com/en/sdk/ios/v2/cloud-scale/file-store/get-files/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Get File - API (/en/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile)

--------------------------------------------------------------------------------


# Get Files

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

### Get the Metadata of a Specific File

You can retrieve the details of a specific file in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}, by passing its unique File ID as an argument to the {{%badge%}}**getFile()**{{%/badge%}} method, as shown in the code syntax below. This fetches the file object using which you can retrieve the file&#39;s metadata such as the details of its creation, last modification, file size, etc.

The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/ios/v2/cloud-scale/file-store/create-folder-instance&#34;%}}Folder Instance page{{%/link%}}.

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.getFile( fileId : Int64, completion : @escaping ( Result&amp;lt; ZCatalystFile, ZCatalystError &amp;gt; ) -&gt; Void ){{%/code%}}

**Parameters**:

* {{%badge%}}**id**{{%/badge%}}: The unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#upload-a-file-into-a-folder&#34;%}}File ID{{%/link%}} of the file to be retrieved

* {{%badge%}}**completion**{{%/badge%}}: If the operation is successful, the completion block will return with the file details. Else, it will return an error.

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 105000000121098) .getFile(fileId : 332000000044009){(result) in
	//Replace this with your Folder ID and File ID
switch result	{
	  case .success ( let file) :
   	print(&#34;The name of the file is &#34; &#43; file.name)
	  case .error( let error ) :
   	print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
  	}
	}
{{%/code%}}

### Get the Metadata of all Files

You can retrieve the details of all the files available in a specific folder using the {{%badge%}}**getFiles()**{{%/badge%}} method, as shown in the code syntax below.

The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code below is the instance defined in the {{%link href=&#34;/en/sdk/ios/v2/cloud-scale/file-store/create-folder-instance&#34;%}}Folder Instance page{{%/link%}}.

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.getFiles( completion : @escaping ( Result&amp;lt; [ ZCatalystFile ], ZCatalystError &amp;gt; ) -&gt; Void ){{%/code%}}

**Parameters**:

* {{%badge%}}**completion**{{%/badge%}}: If the operation is successful, the completion block will return the details of all the files. Else, it will return an error.

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 105000000121098) .getFiles {(result) in 
//Replace this with your Folder ID
	switch result	{
	  case .success ( let files) :
   	for file in files{
	    print(&#34;The names of the folder are \(file.name)&#34;)
	   }
	  case .error( let error ) :
	   print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
	  }
	}
{{%/code%}}

--------------------------------------------------------------------------------
title: "Upload a File"
description: "You can upload a file to an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.551Z"
source: "https://docs.catalyst.zoho.com/en/sdk/ios/v2/cloud-scale/file-store/upload-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Upload File - API (/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder)

--------------------------------------------------------------------------------


# Upload a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can upload a file to an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}}. After the file is uploaded in the folder, a unique {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34;%}}File ID{{%/link%}} will be generated for it. You can upload an image, text document, CSV, or any type of file you need upto 100MB of file size.

You can upload the file in one of the following ways, as discussed below. The {{%badge%}}&amp;lt;FOLDER_INSTANCE&amp;gt;{{%/badge%}} used in the code sections of all the methods below is the instance defined in the {{%link href=&#34;/en/sdk/ios/v2/cloud-scale/file-store/create-folder-instance&#34;%}}Folder Instance page{{%/link%}}. This will refer to the folder that the file must be uploaded in.

### Through Delegate

You can upload the file to the folder of the given folder instance through a delegate. This can be done in two ways:

#### i. By passing the file path

You can pass the File Reference ID and file path along with the delegate method object as the arguments to the {{%badge%}}upload(){{%/badge%}} method:

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.upload( fileRefId : String, filePath : URL, fileUploadDelegate : ZCatalystFileUploadDelegate ){{%/code%}}

**Parameters**:

* {{%badge%}}**fileRefId**{{%/badge%}}: A unique reference ID to identify a specific upload task. This is returned in the Delegate method after the task is successfully completed.

* {{%badge%}}**filePath**{{%/badge%}}: The file path of the file to be uploaded in the local system.

* {{%badge%}}**fileUploadDelegate**{{%/badge%}}: An instance of the type {{%badge%}}ZCatalystFileUploadDelegate{{%/badge%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}func progress(fileRefId: String, session: URLSession, sessionTask: URLSessionTask, progressPercentage: Double, totalBytesSent: Int64, totalBytesExpectedToSend: Int64) {
	print(&#34;The percentage of file upload is \(progressPercentage)&#34;)
	}
	func didFinish(fileRefId: String, fileDetails: ZCatalystFile) {
	print(&#34;The file with reference id &#34; &#43; fileRefId &#43; &#34; is successfully uploaded.&#34;)
	}
	func didFail(fileRefId: String, with error: ZCatalystError?) {
	print(&#34;The file with reference id &#34; &#43; fileRefId &#43; &#34; upload has been failed due to \(ZCatalystError.self)&#34;)
	}
	}
let filePath = self.testBundle?.path( forResource : &#34;companylogo&#34;, ofType : &#34;jpeg&#34; ) //Replace this with your file name
let url = URL( fileURLWithPath : filePath! )
ZCatalystApp.shared.getFileStoreInstance().getFolderInstance( id : 2823000000006544 ).upload( fileRefId : fileRefId, filePath : url, fileUploadDelegate : self ) //Replace this with your Folder ID
{{%/code%}}

#### ii. By passing the file data

You can pass the file data along with the delegate method object as the arguments to the {{%badge%}}upload(){{%/badge%}} method:

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.upload( fileRefId : String, fileName : String, fileData : Data, fileUploadDelegate : ZCatalystFileUploadDelegate ){{%/code%}}

**Parameters**:

* {{%badge%}}**fileRefId**{{%/badge%}}: A unique reference ID to identify a specific upload task. This is returned in the Delegate method after the task is successfully completed.

* {{%badge%}}**fileName**{{%/badge%}}: The name of the file to be uploaded.

* {{%badge%}}**fileData**{{%/badge%}}: The contents of the file of the type {{%badge%}}Data{{%/badge%}}

* {{%badge%}}**fileUploadDelegate**{{%/badge%}}: An instance of the type {{%badge%}}ZCatalystFileUploadDelegate{{%/badge%}}

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}func progress(fileRefId: String, session: URLSession, sessionTask: URLSessionTask, progressPercentage: Double, totalBytesSent: Int64, totalBytesExpectedToSend: Int64)
{
	print(&#34;The percentage of file upload is \(progressPercentage)&#34;)
	}
	func didFinish(fileRefId: String, fileDetails: ZCatalystFile)
	{
	print(&#34;The file with reference id &#34; &#43; fileRefId &#43; &#34; is successfully uploaded.&#34;)
	}
	func didFail(fileRefId: String, with error: ZCatalystError?)
	{
	print(&#34;The file with reference id &#34; &#43; fileRefId &#43; &#34; upload has been failed due to \(ZCatalystError.self)&#34;)
	}
}
if let data = image?.pngData()
ZCatalystApp.shared.getFileStoreInstance().getFolderInstance( id : 105000000121098 ).upload( fileRefId : &#34;1234567&#34;, fileName : url.lastPathComponent, fileData: data, fileUploadDelegate : self ) //Replace this with your File Reference ID
{{%/code%}}

### Through Completion Handler

You can upload the file to the folder of the given folder instance through a completion handler. This can be done in two ways:

#### i. By passing the file path

You can pass the file path along with the completion handler as the arguments to the {{%badge%}}upload(){{%/badge%}} method:

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.upload( filePath : URL, completion : @escaping ( Result&amp;lt; ZCatalystFile, ZCatalystError &amp;gt; ) -&gt; Void ){{%/code%}}

**Parameters**:

* {{%badge%}}**filePath**{{%/badge%}}: The file path of the file to be uploaded in the local system.

* {{%badge%}}**completion**{{%/badge%}}: If the operation is successful, the completion block will return the details of the uploaded file. Else, it will return an error.

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}let filePath = self.testBundle?.path( forResource : &#34;document&#34;, ofType : &#34;jpeg&#34; ) //Replace this with your file name
	let url = URL( fileURLWithPath : filePath! )
ZCatalystApp.shared.getFileStoreInstance().getFolderInstance( id : 105000000121098 ).upload( filePath : url) { ( fileResult ) in
//Replace this with your Folder ID
	switch fileResult{
	  case .success (let file) :    
	   print (&#34;Image has been successfully uploaded and it&#39;s id is &#34; &#43; file.id)
	  case .error(let error) :
   	print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
  } 
}
{{%/code%}}

#### ii. By passing the file data

You can pass the file data along with the completion handler as the arguments to the {{%badge%}}upload(){{%/badge%}} method:

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FOLDER_INSTANCE&amp;gt;.upload( fileName : String, fileData : Data, completion: @escaping (Result&amp;lt;ZCatalystFile, ZCatalystError&amp;gt;) -&gt; Void ){{%/code%}}

**Parameters**:

* {{%badge%}}**fileName**{{%/badge%}}: The name of the file to be uploaded.

* {{%badge%}}**fileData**{{%/badge%}}: The contents of the file of the type {{%badge%}}Data{{%/badge%}}.

* {{%badge%}}**completion**{{%/badge%}}: If the operation is successful, the completion block will return the details of the uploaded file. Else, it will return an error.

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}let image = UIImage ( named : &#34;document&#34; ) 
//replace your file name here
	if let data = image?.pngData(){
ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id: 105000000121098).upload(fileName: &#34;document&#34;, fileData: data, fileRefId : &#34;123456789983&#34;) { (result) in
//replace your file name and fire reference id here
	switch result{
	  case .success (let file) :    
	   print (&#34;Image has been successfully uploaded and it&#39;s id is \(file.id)&#34;)
	  case .error(let error) :
   	print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
  	}
 	}
	}
{{%/code%}}

--------------------------------------------------------------------------------
title: "Download a File"
description: "You can download a file from an existing folder in the File Store."
last_updated: "2026-03-18T07:41:08.552Z"
source: "https://docs.catalyst.zoho.com/en/sdk/ios/v2/cloud-scale/file-store/download-file/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)
- File Store Implementation (/en/cloud-scale/help/file-store/implementation)
- Download File - API (/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder)

--------------------------------------------------------------------------------


# Download a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can download a file from an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}File Store{{%/link%}} by calling the {{%badge%}}**download()**{{%/badge%}} method. The operation will return a temporary URL where the file is stored.

You can download a file in one of the two ways shown below.

The {{%badge%}}&amp;lt;FILE_INSTANCE&amp;gt;{{%/badge%}} used in both the code sections is an instance created for the specific file, as shown in the sample code snippet. This will refer to the file from the specific folder that must be downloaded.

### Through Delegate

The file is downloaded through a delegate in this method, as shown in the code syntax below:

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FILE_INSTANCE&amp;gt;.download( fileDownloadDelegate : ZCatalystFileDownloadDelegate ){{%/code%}}

**Parameters**:

* {{%badge%}}**FileDownloadDelegate**{{%/badge%}}: An instance of the type {{%badge%}}ZCatalystFileDownloadDelegate{{%/badge%}}.

A sample code snippet is shown below:

{{%code class=&#34;language-bash&#34;%}}func progress(fileRefId: String, session: URLSession, downloadTask: URLSessionDownloadTask, progressPercentage: Double, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)
{
print(&#34;The percentage of file download is \(progressPercentage)&#34;)
}

func didFinish( fileRefId : String, fileResult : ( Data, URL ) )
{
print(&#34;The file with reference id &#34; &#43; fileRefId &#43; &#34; is successfully downloaded.&#34;)
}
    
func didFail( fileRefId : String, with error : ZCatalystError? )
{
print(&#34;The file with reference id &#34; &#43; fileRefId &#43; &#34; download has been failed due to \(ZCatalystError.self)&#34;)
}

ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 105000000121098) .getFile(id : 332000000044009){(result) in
//replace your folder id and file id here
	switch result{
  	case .success ( let file) :
   file.download( fileDownloadDelegate : self )
	  case .error( let error ) :
   	print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
	  }
	}
{{%/code%}}

### Through a Completion Handler

The file is downloaded through a completion handler in this method, as shown in the code syntax below:

{{%code class=&#34;language-bash&#34;%}}&amp;lt;FILE_INSTANCE&amp;gt;.download( completion : @escaping ( Result&amp;lt; ( Data, URL ), ZCatalystError &amp;gt; ) -&gt; Void ){{%/code%}}

**Parameters**:

* {{%badge%}}**completion**{{%/badge%}}: If the operation is successful, the completion block will return the file data and a temporary URL where the file data is stored. Else, it will return an error.

A sample code snippet is shown below:

{{%code class=&#34;language-bash line-numbers&#34;%}}ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id: 105000000121098).getFile(fileId: 332000000044009) {(result) in
	//Replace this with your Folder ID and File ID
switch result{
  	case .success(let file) :
    file.download(){(result) in
    switch result{
     case .success(let downloaded_file) :
        	print(&#34;The file is successfully downloaded.&#34;)
       	case .error(let error) :
	        print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
     	}
    	}
  	case .error(let error) :
    	print( &#34;Error occurred &amp;gt;&amp;gt;&amp;gt; \( error )&#34; )
	  }
	}
{{%/code%}}

---

## SDK — Java — File Store

--------------------------------------------------------------------------------
title: "Create a Folder Instance"
description: "This page describes the method to fetch a folder instance from the File Store in your Java application with sample code snippets."
last_updated: "2026-03-18T07:41:08.553Z"
source: "https://docs.catalyst.zoho.com/en/sdk/java/v1/cloud-scale/file-store/create-folder-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# File Store

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

{{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}} provides cloud storage solutions for the application files and user data files of your Catalyst application, and enables access to shared data. You can store, manage, and organize images, videos, text files, document files, spreadsheets, or files of other formats.

## Create a Folder Instance

You can create an empty folder instance and use it to refer to a specific folder in the File Store and perform file operations on it. This is done by fetching the File Store instance with the {{%badge%}}getInstance(){{%/badge%}} method, and using it to fetch the folder instance with the {{%badge%}}getFolderInstance(){{%/badge%}} method. 

You can refer to the specific folder you need to create the folder instance for, by either its unique ID or by its name, as shown below.

#### Sample Code Snippet 
&lt;br&gt;
{{% panel_without_adjustment header=&#34;Package Imports&#34; class=&#34;language-java line-numbers&#34; %}}import com.zc.component.files.ZCFile; 
import com.zc.component.files.ZCFolder;{{% /panel_without_adjustment %}}

### Fetch the Folder Instance using the Folder ID 

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}} //Fetch an instance of the file store 
ZCFile fileStore = ZCFile.getInstance(); 
//Use the File Store instance to fetch the Folder Instance of a specific folder by referring to its ID
ZCFolder folderDetails = fileStore.getFolderInstance(1510000000109393L);
{{%/code%}} 

### Fetch the Folder Instance using the Folder Name 

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}} //Fetch an instance of the file store 
ZCFile fileStore = ZCFile.getInstance(); 
//Use the File Store instance to fetch the Folder Instance of a specific folder by referring to its name
ZCFolder folderDetails = fileStore.getFolderInstance(&#34;EmpDetails&#34;);
{{% /code%}} 


--------------------------------------------------------------------------------
title: "Get Folder Details"
description: "This page describes the method to retrieve the folder details from the File Store in your Java application with sample code snippets."
last_updated: "2026-03-18T07:41:08.553Z"
source: "https://docs.catalyst.zoho.com/en/sdk/java/v1/cloud-scale/file-store/get-folder-details/"
service: "Cloud Scale"
related:
- Retrieve the Folder Details - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)
- File Store (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# Get Folder Details

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can retrieve the metadata of the folders created in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}}. You can get the details of a specific folder in the File Store of your project, or the details of all the folders in your project.

### Get Details of a Specific Folder

You can obtain the details of a specific folder by creating a folder instance as mentioned here. You will need to fetch the File Store instance first, and use it to fetch the folder instance. 

#### Sample Code Snippet 
&lt;br&gt;
{{% panel_without_adjustment header=&#34;Package Imports&#34; class=&#34;language-java line-numbers&#34; %}}import com.zc.component.files.ZCFile; 
import com.zc.component.files.ZCFolder; {{% /panel_without_adjustment %}}

You can refer to the specific folder whose metadata you require to be fetched in two ways:

#### Refer to the Folder by its ID

You can specify the unique Folder ID of the folder to be fetched to the {{%badge%}}getFolder(){{%/badge%}} method, as shown below.

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}}//Get an instance of the File Store 
ZCFile fileStore = ZCFile.getInstance(); 
//Get Folder Details by passing the Folder ID 
ZCFolder folderDetails = fileStore.getFolder(1510000000109393L);
{{% /code%}}

#### Refer to the Folder by its Name

You can specify the name of the folder to be fetched to the {{%badge%}}getFolder(){{%/badge%}} method, as shown below.

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}}//Get an instance of the File Store 
ZCFile fileStore = ZCFile.getInstance(); 
//Get Folder Details by passing the folder name 
ZCFolder folderDetails = fileStore.getFolder(&#34;EmpDetails&#34;);
{{% /code%}}

&lt;br&gt;

### Get Details of All Folders

If you want to fetch the details of all the folders in your Catalyst project, use the following variant of the
{{%badge%}}getFolder(){{%/badge%}} method:

#### Sample Code Snippet 
&lt;br&gt;
{{% panel_without_adjustment header=&#34;Package Imports&#34; class=&#34;language-java line-numbers&#34; %}}import com.zc.component.files.ZCFile; 
import com.zc.component.files.ZCFolder;{{% /panel_without_adjustment %}}

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}}//Get an instance for the file store 
ZCFile fileStore = ZCFile.getInstance(); 
//Get All the folders in the project 
List&amp;lt;ZCFolder&amp;gt;folderDetails = fileStore.getFolder();
{{% /code%}} 

--------------------------------------------------------------------------------
title: "Upload a File"
description: "This page describes the method to upload a file to a folder in the File Store in your Java application with sample code snippets."
last_updated: "2026-03-18T07:41:08.554Z"
source: "https://docs.catalyst.zoho.com/en/sdk/java/v1/cloud-scale/file-store/upload-file/"
service: "Cloud Scale"
related:
- Upload a File - API (/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder)
- File Store (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# Upload a File in a Folder

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can upload a file from your local system to an existing folder in the
{{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34; %}}File Store{{%/link%}}, by referring to the folder&#39;s
unique ID. You can upload an image, text document, CSV, or any type of file you need. The maximum size of a file that
you can upload is 100 MB.

You must create a file object for the file to be uploaded and create a File Store instance, as shown below. You must
then fetch the folder details by passing its Folder ID in {{%badge%}}getFolderInstance(){{%/badge%}}, and upload the
file object to the folder instance using the {{%badge%}}uploadFile(){{%/badge%}} method.

A unique File ID is created for the file after it is uploaded.

{{%note%}}{{%bold%}}Note :{{%/bold%}} Catalyst provides 1 GB of File Store space for each project in the
{{%link href=&#34;/en/deployment-and-billing/environments/development-environment&#34; %}}development environment{{%/link%}}. There are no upper limits for storage in the production environment.{{%/note%}}

#### Sample Code Snippet 
&lt;br&gt;
{{% panel_without_adjustment header=&#34;Package Imports&#34; class=&#34;language-java line-numbers&#34; %}}import com.zc.component.files.ZCFile; 
import com.zc.component.files.ZCFolder;
import java.io.File; {{% /panel_without_adjustment %}}

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}}// Create a file object 
File f = new File(&#34;empdetails.csv&#34;); 
//Create an instance for the File Store 
ZCFile fileStore = ZCFile.getInstance(); 
//Get a folder instance using the Folder ID 
ZCFolder folder = fileStore.getFolderInstance(1510000000109393); 
//Upload the file using the folder instance 
folder.uploadFile(f);
{{% /code%}} 

--------------------------------------------------------------------------------
title: "Download a File from the folder"
description: "This page describes the method to download a file from folders in the File Store in your Java application with sample code snippets."
last_updated: "2026-03-18T07:41:08.554Z"
source: "https://docs.catalyst.zoho.com/en/sdk/java/v1/cloud-scale/file-store/download-file-from-folder/"
service: "Cloud Scale"
related:
- Download a File from the folder - API (/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder)
- File Store (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# Download a file from the folder

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can download a file from the folder by referring to its unique File ID. The input stream of the file is obtained by
calling the {{%badge%}}downloadFile(){{%/badge%}} method.

#### Sample Code Snippet 
&lt;br&gt;
{{% panel_without_adjustment header=&#34;Package Imports&#34; class=&#34;language-java line-numbers&#34; %}}import com.zc.component.files.ZCFile; 
import com.zc.component.files.ZCFolder; {{% /panel_without_adjustment %}}

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}}//Get an instance for the file store
ZCFile fileStore = ZCFile.getInstance(); 
//Get Folder details using folder ID 
ZCFolder folder = fileStore.getFolderInstance(1510000000109393L); 
//Download the File as an Input Stream using the file id 
InputStream is = folder.downloadFile(1510000000108418L);
{{% /code%}} 

--------------------------------------------------------------------------------
title: "Delete a File"
description: "This page describes the method to delete a folder from the File Store in your Java application with sample code snippets."
last_updated: "2026-03-18T07:41:08.554Z"
source: "https://docs.catalyst.zoho.com/en/sdk/java/v1/cloud-scale/file-store/delete-file/"
service: "Cloud Scale"
related:
- Delete a File - API (/en/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile)
- File Store (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# Delete a file

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

A file can be deleted from a folder using the following code snippet.

{{%note%}}{{%bold%}}Note :{{%/bold%}} File once deleted will not be restored.{{%/note%}}

#### Sample Code Snippet 
&lt;br&gt;
{{% panel_without_adjustment header=&#34;Package Imports&#34; class=&#34;language-java line-numbers&#34; %}}import com.zc.component.files.ZCFile;
import com.zc.component.files.ZCFolder; {{% /panel_without_adjustment %}}

{{%code class=&#34;language-java&#34; scroll=&#34;set-scroll&#34; %}}//Get a file store instance 
ZCFile fileStore = ZCFile.getInstance(); 
//Get a folder Instance 
ZCFolder folder = fileStore.getFolderInstance(704000000116007l); 
//Deletes the file by referring to its ID
folder.deleteFile(704000000122001l);
{{% /code%}} 

---

## SDK — Node JS — File Store

--------------------------------------------------------------------------------
title: "Get File Store Instance"
description: "This page describes the method to delete a folder from the File Store in your NodeJS application with sample code snippets."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/file-store/get-component-instance/"
service: "Cloud Scale"
related:
- Get Component Instance - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# File Store

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

### Get Component Instance

The file store reference can be created by the following method which would not fire a server-side call.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get a file store instance 
let filestore = app.filestore();{{% /code%}} 

--------------------------------------------------------------------------------
title: "Get Folder Instance"
description: "This page describes the method to fetch a folder instance from the File Store in your NodeJS application with sample code snippets."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/file-store/get-folder-instance/"
service: "Cloud Scale"
related:
- Get Folder Instance - API (/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder)
- File Store (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# Get a Folder Instance

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

A folder reference can be created by the following method which would not fire a server-side call. The filestore
reference used in the below code snippet is the {{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/get-component-instance&#34; %}}component instance.{{%/link%}}

There is no promise involved in the above method and the instance of the folder alone is returned.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}// Get a folder instance let filestore = app.filestore(); 
let folder = filestore.folder(1510000000109545);{{% /code%}} 


--------------------------------------------------------------------------------
title: "Retrieve Folder Details"
description: "This page describes the method to retrieve the folder details from the File Store in your NodeJS application with sample code snippets."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/file-store/retrieve-folder-details/"
service: "Cloud Scale"
related:
- Retrieve Folder Details - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Get Folder Details

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can retrieve the details of the folders created in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34; %}}Catalyst File Store{{%/link%}}. It can be a single folder or all the folders located in the file store. The {{%badge%}}filestore{{%/badge%}} reference used in the below code snippets is the {{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/get-component-instance&#34; %}}component instance{{%/link%}} created earlier.

### Get Details of a Single Folder

This particular method retrieves the details of a specific folder referred through its unique {{%bold%}}Folder
ID{{%/bold%}} by calling {{%badge%}}getFolderDetails(){{%/badge%}} method.

The promise is returned here which in turn resolves to the folder meta details. The resultant meta can be converted to a
String or a JSON output by accessing the {{%badge%}}.toString(){{%/badge%}} or {{%badge%}}.toJSON(){{%/badge%}} method.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get a single folder with details by passing the folder id which in turn returns a promise 
let filestore = app.filestore(); 
let folderPromise = filestore.getFolderDetails(1510000000109545); 
folderPromise.then((folder) =&gt; {
console.log(folder); });{{% /code%}} 

A sample response that you will receive for each version is shown below:

{{% panel_with_select header=&#34;Node JS&#34; %}}
{{% divtag id=&#34;V2&#34; class=&#34;language-json line-numbers&#34;%}} 
    {
    &#34;folder_name&#34;:&#34;Store_Data&#34;,
    &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:&#34;2136000000007733&#34;,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;file_details&#34;:[
    {
        &#34;id&#34;:&#34;2136000000020111&#34;,
        &#34;file_location&#34;:null,
        &#34;file_name&#34;:&#34;Img.jpeg&#34;,
        &#34;file_size&#34;:&#34;84881&#34;,
        &#34;created_by&#34;:{
          &#34;zuid&#34;:&#34;66466723&#34;,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:&#34;2136000000006767&#34;
        },
        &#34;created_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
        &#34;modified_by&#34;:{
          &#34;zuid&#34;:&#34;66466723&#34;,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:&#34;2136000000006767&#34;
        },
        &#34;modified_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
        &#34;project_details&#34;:{
          &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
          &#34;id&#34;:&#34;2136000000007733&#34;,
          &#34;project_type&#34;:&#34;Live&#34;
        },
        &#34;folder_details&#34;:&#34;2136000000008551&#34;
    }
    ],
    &#34;id&#34;:&#34;2136000000008551&#34;
    }
    }
{{% /divtag %}}

{{% divtag id=&#34;V1&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;folder_name&#34;:&#34;Store_Data&#34;,
    &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:2136000000007733,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;file_details&#34;:[
    {
      &#34;id&#34;:2136000000020111,
      &#34;file_location&#34;:null,
      &#34;file_name&#34;:&#34;invoice1349.jpeg&#34;,
      &#34;file_size&#34;:84881,
      &#34;created_by&#34;:{
          &#34;zuid&#34;:66466723,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:2136000000006767
      },
      &#34;created_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
      &#34;modified_by&#34;:{
          &#34;zuid&#34;:66466723,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:2136000000006767
      },
      &#34;modified_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
      &#34;project_details&#34;:{
          &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
          &#34;id&#34;:2136000000007733,
          &#34;project_type&#34;:&#34;Live&#34;
      },
      &#34;folder_details&#34;:2136000000008551
    }
    ],
    &#34;id&#34;:2136000000008551
    }
{{% /divtag %}} 
{{% /panel_with_select %}}

### Get Details of All Folders

You can fetch the details of all folders in your Catalyst application using the {{%badge%}}getAllFolders(){{%/badge%}}
method.

The promise returned here will be resolved to an array of folder meta details.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get details of all the folders in the project 
let filestore = app.filestore(); 
let allFolderPromise = filestore.getAllFolders(); 
allFolderPromise.then((folders) =&gt; 
{ 
console.log(folders); 
});{{% /code%}} 

A sample response that you will receive for each version is shown below:

{{% panel_with_select header=&#34;Node JS&#34; %}}
{{% divtag id=&#34;V2&#34; class=&#34;language-json line-numbers&#34;%}} 
    [
    {
    &#34;folder_name&#34;:&#34;Invoices&#34;,
    &#34;created_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;modified_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:&#34;2136000000007733&#34;,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;id&#34;:&#34;2136000000037021&#34;
    },
    {
    &#34;folder_name&#34;:&#34;Store_Data&#34;,
    &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:&#34;2136000000007733&#34;,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;id&#34;:&#34;2136000000008551&#34;
    }
    ]
{{% /divtag %}}

{{% divtag id=&#34;V1&#34; class=&#34;language-json line-numbers&#34;%}}   
    [
    {
    &#34;folder_name&#34;:&#34;Invoices&#34;,
    &#34;created_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;modified_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:2136000000007733,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;id&#34;:2136000000037021
    },
    {
    &#34;folder_name&#34;:&#34;Store_Data&#34;,
    &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:2136000000007733,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;id&#34;:2136000000008551
    }
    ]
{{% /divtag %}} 
{{% /panel_with_select %}}


--------------------------------------------------------------------------------
title: "Upload File"
description: "This page describes the method to upload a file to a folder in the File Store in your NodeJS application with sample code snippets."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/file-store/upload-file/"
service: "Cloud Scale"
related:
- Upload File - API (/en/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Upload a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can upload a file from your local system to an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34; %}}File Store{{%/link%}}, by referring to the folder&#39;s unique ID. You can upload an image, text document, CSV, or any type of file you need. The maximum size of a file that you can upload is 100 MB. A unique File ID is created for the file after it is uploaded.

{{%note%}}{{%bold class=&#34;bold-primary&#34; %}}{{%/bold%}}
Catalyst provides 1 GB of File Store space for each project in the {{%link href=&#34;/en/deployment-and-billing/environments/development-environment&#34; %}}development environment{{%/link%}}. There are no upper limits for storage in the production environment.{{%/note%}}

#### Create a JSON Configuration

You must initially create a JSON configuration object for the file to be uploaded, as shown below. This JSON object
creates a {{%badge%}}ReadStream(){{%/badge%}} for the file. You can include the file name in it optionally.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Create a JSON object with the file and its name, using the keys &#39;name&#39; and &#39;code&#39; 
let config = 
{ 
code:fs.createReadStream(&#39;empdata.csv&#39;), name: &#39;testFile.txt&#39; 
};{{% /code%}} 

### Upload the File

You must now upload the file by passing the JSON object to the {{%badge%}}uploadFile(){{%/badge%}} method, as shown
below.

You can either use the {{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/get-folder-instance&#34; %}}folder reference{{%/link%}} or the {{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/retrieve-folder-details&#34; %}}folder meta{{%/link%}} created earlier, to refer the folder where the file needs to be uploaded in. You must pass the unique Folder ID of the folder. The promise returned here will be resolved to a JSON object with the uploaded file information.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Upload the file by passing the JSON config to the method, which in turn returns a promise 
let filestore = app.filestore(); 
let folder = filestore.folder(1510000000109545); 
//Provide the Folder ID 
let uploadPromise = folder.uploadFile(config); 
//Pass the JSON object created for the file 
uploadPromise.then((fileObject) =&gt; {
console.log(fileObject); 
});{{% /code%}} 

A sample response that you will receive for each version is shown below:

{{% panel_with_select header=&#34;Node JS&#34; %}}
{{% divtag id=&#34;V2&#34; class=&#34;language-javascript line-numbers&#34;%}} 
    {
    id: &#34;2136000000020122&#34;,
    file_location: null,
    file_name: &#34;empdata.csv&#34;,
    file_size: &#34;84881&#34;,
    created_by: {
      zuid: &#34;66466723&#34;,
      is_confirmed: false,
      email_id: &#34;emma@zylker.com&#34;,
      first_name: &#34;Amelia&#34;,
      last_name: &#34;Burrows&#34;,
      user_type: &#34;Admin&#34;,
      user_id: &#34;2136000000006003&#34;
    },
    created_time: &#34;Aug 17, 2021 09:33 PM&#34;,
    modified_by: {
      zuid: &#34;66466723&#34;,
      is_confirmed: false,
      email_id: &#34;emma@zylker.com&#34;,
      first_name: &#34;Amelia&#34;,
      last_name: &#34;Burrows&#34;,
      user_type: &#34;Admin&#34;,
      user_id: &#34;2136000000006003&#34;
    },
    modified_time: &#34;Aug 17, 2021 09:33 PM&#34;,
    project_details: { project_name: &#34;ShipmentTracking&#34;, id: &#34;2136000000007733&#34; },
    folder_details: &#34;2136000000008551&#34;
    }
{{% /divtag %}}

{{% divtag id=&#34;V1&#34; class=&#34;language-javascript line-numbers&#34;%}}
    {
    id: 2136000000020117,
    file_location: null,
    file_name: &#34;empdata.csv&#34;,
    file_size: 84881,
    created_by: {
      zuid: 66466723,
      is_confirmed: false,
      email_id: &#34;emma@zylker.com&#34;,
      first_name: &#34;Amelia&#34;,
      last_name: &#34;Burrows&#34;,
      user_type: &#34;Admin&#34;,
      user_id: 2136000000006003
    },
    created_time: &#34;Aug 17, 2021 09:33 PM&#34;,
    modified_by: {
      zuid: 66466723,
      is_confirmed: false,
      email_id: &#34;emma@zylker.com&#34;,
      first_name: &#34;Amelia&#34;,
      last_name: &#34;Burrows&#34;,
      user_type: &#34;Admin&#34;,
      user_id: 2136000000006003
    },
    modified_time: &#34;Aug 17, 2021 09:33 PM&#34;,
    project_details: { project_name: &#34;ShipmentTracking&#34;, id: 2136000000007733 },
    folder_details: 2136000000008551
    }
{{% /divtag %}} 
{{% /panel_with_select %}}


--------------------------------------------------------------------------------
title: "Download File from Folder"
description: "This page describes the method to download a file from folders in the File Store in your NodeJS application with sample code snippets."
last_updated: "2026-03-18T07:41:08.557Z"
source: "https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/file-store/download-file-from-folder/"
service: "Cloud Scale"
related:
- Download File from Folder - API (/en/api/code-reference/cloud-scale/file-store/delete-file/#description)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Download a File from the Folder

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

A file can be downloaded from the folder by referring to its unique {{%bold%}}FileID.{{%/bold%}} A
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/get-folder-instance&#34; %}}folder reference {{%/link%}}or a
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/retrieve-folder-details&#34; %}}folder meta{{%/link%}} is used in the below code snippet. {{%bold%}}FileID{{%/bold%}} is passed as an argument to the {{%badge%}}downloadFile(){{%/badge%}} method.

The promise returned here will be resolved to a buffer containing the content of the file.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Download the file by passing the file ID to the method which in turn returns a promise 
let filestore = app.filestore(); 
let folder = filestore.folder(1510000000109545); 
let downloadPromise = folder.downloadFile(1510000000107568); 
downloadPromise.then((fileObject) =&gt; 
{ 
console.log(fileObject); 
});{{% /code%}} 


--------------------------------------------------------------------------------
title: "Delete a File"
description: "This page describes the method to delete a folder from the File Store in your Java application with sample code snippets."
last_updated: "2026-03-18T07:41:08.557Z"
source: "https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/file-store/delete-file/"
service: "Cloud Scale"
related:
- Delete a File - API (/en/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Delete a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

A file from a folder can be deleted by referring its {{%bold%}}File ID{{%/bold%}}. The
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/get-folder-instance&#34; %}}folder reference{{%/link%}} or a
{{%link href=&#34;/en/sdk/nodejs/v2/cloud-scale/file-store/retrieve-folder-details&#34; %}}folder meta{{%/link%}} is used in the
below code snippet. A {{%bold%}}fileID{{%/bold%}} is passed as a parameter to the {{%badge%}}deleteFile(){{%/badge%}} method.

The promise returned here will be resolved to an deleted file object which is a JSON.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}// Delete the file by passing the file ID to the method which in turn returns a promise 
let filestore = app.filestore(); 
let folder = filestore.folder(1510000000109545); 
let deletePromise = folder.deleteFile(1510000000107568);
deletePromise.then((fileObject) =&gt; 
{ 
console.log(fileObject); 
});{{% /code%}} 


---

## SDK — Python — File Store

--------------------------------------------------------------------------------
title: "Get File Store Instance"
description: "This page describes the method to delete a folder from the File Store in your Python application with sample code snippets."
last_updated: "2026-03-18T07:41:08.558Z"
source: "https://docs.catalyst.zoho.com/en/sdk/python/v1/cloud-scale/file-store/get-component-instance/"
service: "Cloud Scale"
related:
- File Store Help (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# File Store

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

{{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}} provides cloud storage solutions for the application files and user data files of your Catalyst application, and enables access to shared data. You can store, manage, and organize images, videos, text files, document files, spreadsheets, or files of other formats.

### Get a Component Instance

A component instance is an object that can be used to access the pre-defined configurations specific to a particular component. This process will not fire a server-side call. Also note that this component instance will be used in multiple scenarios while using the File Store component in your Catalyst application.

The {{%badge%}}app{{%/badge%}} reference used in the code below is the {{%link href=&#34;/en/sdk/python/v1/setup/#initializing-the-sdk&#34; %}}Python object{{%/link%}} returned as a response during SDK initialization. You can create a new {{%badge%}}filestore_service{{%/badge%}}instance as shown below :

{{%code class=&#34;language-python&#34; scroll=&#34;set-scroll&#34; %}}#Get filestore component instance
filestore_service = app.filestore()
{{% /code%}} 

--------------------------------------------------------------------------------
title: "Get Folder Instance"
description: "This page describes the method to fetch a folder instance from the File Store in your Python application with sample code snippets."
last_updated: "2026-03-18T07:41:08.558Z"
source: "https://docs.catalyst.zoho.com/en/sdk/python/v1/cloud-scale/file-store/get-folder-instance/"
service: "Cloud Scale"
related:
- File Store Help (/en/cloud-scale/help/file-store/introduction)

--------------------------------------------------------------------------------


# Get a folder instance

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

To know more about the component instance {{%badge%}}filestore_service{{%/badge%}} used below, please refer to {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-component-instance/&#34; %}}this help section{{%/link%}}.

{{%code class=&#34;language-python&#34; scroll=&#34;set-scroll&#34; %}}#Get folder instance
filestore_service = app.filestore()
folder_service = filestore_service.folder(5249000000016011)	
{{% /code%}} 


--------------------------------------------------------------------------------
title: "Retrieve Folder Details"
description: "This page describes the method to retrieve the folder details from the File Store in your Python application with sample code snippets."
last_updated: "2026-03-18T07:41:08.558Z"
source: "https://docs.catalyst.zoho.com/en/sdk/python/v1/cloud-scale/file-store/retrieve-folder-details/"
service: "Cloud Scale"
related:
- Retrieve Folder Details - API (/en/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile)
- File Store Help (/en/cloud-scale/help/file-store/introduction/)
- SDK Scopes (/en/sdk/python/v1/sdk-scopes)

--------------------------------------------------------------------------------


# Get Folder Details

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can retrieve the details of the folders created in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34; %}}Catalyst File Store{{%/link%}}. It can be a single folder or all the folders located in the File store. 

To know more about the component instance {{%badge%}}filestore_service{{%/badge%}} used below, please refer to {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-component-instance/&#34; %}}this help section{{%/link%}}.

### Get Details of a Single Folder

This particular method retrieves the details of a specific folder referred through its unique folder ID by calling the {{%badge%}}get_folder_details(){{%/badge%}} method. You can obtain the folder ID from the Data Store or from the URL when the folder is opened in the console.

The folder meta details are returned as response to this method.

**Parameters Used**

&lt;table class=&#34;content-table&#34;&gt;
	&lt;thead&gt;
		&lt;tr&gt;
			&lt;th class=&#34;w20p&#34;&gt;Parameter Name&lt;/th&gt;
         &lt;th class=&#34;w20p&#34;&gt;Data Type&lt;/th&gt;
      &lt;th class=&#34;w60p&#34;&gt;Definition&lt;/th&gt;
		&lt;/tr&gt;
	&lt;/thead&gt;
	&lt;tbody&gt;
		&lt;tr&gt;
			&lt;td&gt;{{%badge%}}file_ID{{%/badge%}}&lt;/td&gt;
         &lt;td&gt;String&lt;/td&gt;
			&lt;td&gt;A {{%bold%}}Mandatory{{%/bold%}} parameter. Will hold the ID of the folder for which details has to be fetched.&lt;/td&gt;
		&lt;/tr&gt;
	&lt;/tbody&gt;
&lt;/table&gt;

{{%code class=&#34;language-python&#34; scroll=&#34;set-scroll&#34; %}}#Get details of a single folder
filestore_service = app.filestore()
data = filestore_service.get_folder_details(5249000000016011)
{{% /code%}} 

A sample response is shown below :

{{%code class=&#34;language-json line-numbers&#34;%}}{
   &#34;folder_name&#34;:&#34;Store_Data&#34;,
   &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
   &#34;created_by&#34;:{
      &#34;zuid&#34;:&#34;66466723&#34;,
      &#34;is_confirmed&#34;:false,
      &#34;email_id&#34;:&#34;amelia.burrows@zylker.com&#34;,
      &#34;first_name&#34;:&#34;Amelia&#34;,
      &#34;last_name&#34;:&#34;Burrows&#34;,
      &#34;user_type&#34;:&#34;Admin&#34;,
      &#34;user_id&#34;:&#34;2136000000006003&#34;
   },
   &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
   &#34;modified_by&#34;:{
      &#34;zuid&#34;:&#34;66466723&#34;,
      &#34;is_confirmed&#34;:false,
      &#34;email_id&#34;:&#34;amelia.burrows@zylker.com&#34;,
      &#34;first_name&#34;:&#34;Amelia&#34;,
      &#34;last_name&#34;:&#34;Burrows&#34;,
      &#34;user_type&#34;:&#34;Admin&#34;,
      &#34;user_id&#34;:&#34;2136000000006003&#34;
   },
   &#34;project_details&#34;:{
      &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
      &#34;id&#34;:&#34;2136000000007733&#34;,
      &#34;project_type&#34;:&#34;Live&#34;
   },
   &#34;file_details&#34;:[
      {
         &#34;id&#34;:&#34;2136000000020111&#34;,
         &#34;file_location&#34;:null,
         &#34;file_name&#34;:&#34;Img.jpeg&#34;,
         &#34;file_size&#34;:&#34;84881&#34;,
         &#34;created_by&#34;:{
            &#34;zuid&#34;:&#34;66466723&#34;,
            &#34;is_confirmed&#34;:false,
            &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Patricia&#34;,
            &#34;last_name&#34;:&#34;Boyle&#34;,
            &#34;user_type&#34;:&#34;Admin&#34;,
            &#34;user_id&#34;:&#34;2136000000006767&#34;
         },
         &#34;created_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
         &#34;modified_by&#34;:{
            &#34;zuid&#34;:&#34;66466723&#34;,
            &#34;is_confirmed&#34;:false,
            &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
            &#34;first_name&#34;:&#34;Patricia&#34;,
            &#34;last_name&#34;:&#34;Boyle&#34;,
            &#34;user_type&#34;:&#34;Admin&#34;,
            &#34;user_id&#34;:&#34;2136000000006767&#34;
         },
         &#34;modified_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
         &#34;project_details&#34;:{
            &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
            &#34;id&#34;:&#34;2136000000007733&#34;,
            &#34;project_type&#34;:&#34;Live&#34;
         },
         &#34;folder_details&#34;:&#34;5249000000016011&#34;
      }
   ],
   &#34;id&#34;:&#34;2136000000008551&#34;
}
{{% /code%}} 

### Get Details of All Folders

You can fetch the details of all folders in your Catalyst application using the {{%badge%}}get_all_folders(){{%/badge%}}
method.

An array of folder meta details is returned as response to this method.

{{%code class=&#34;language-python&#34; scroll=&#34;set-scroll&#34; %}}#Get details of all folders
filestore_service = app.filestore()
data = filestore_service.get_all_folders()
{{% /code%}} 

A sample response is shown below :

{{%code class=&#34;language-json line-numbers&#34;%}}[
   {
      &#34;folder_name&#34;:&#34;Invoices&#34;,
      &#34;created_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
      &#34;created_by&#34;:{
         &#34;zuid&#34;:&#34;66466723&#34;,
         &#34;is_confirmed&#34;:false,
         &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
         &#34;first_name&#34;:&#34;Amelia&#34;,
         &#34;last_name&#34;:&#34;Burrows&#34;,
         &#34;user_type&#34;:&#34;Admin&#34;,
         &#34;user_id&#34;:&#34;2136000000006003&#34;
      },
      &#34;modified_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
      &#34;modified_by&#34;:{
         &#34;zuid&#34;:&#34;66466723&#34;,
         &#34;is_confirmed&#34;:false,
         &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
         &#34;first_name&#34;:&#34;Amelia&#34;,
         &#34;last_name&#34;:&#34;Burrows&#34;,
         &#34;user_type&#34;:&#34;Admin&#34;,
         &#34;user_id&#34;:&#34;2136000000006003&#34;
      },
      &#34;project_details&#34;:{
         &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
         &#34;id&#34;:&#34;2136000000007733&#34;,
         &#34;project_type&#34;:&#34;Live&#34;
      },
      &#34;id&#34;:&#34;2136000000037021&#34;
   },
   {
      &#34;folder_name&#34;:&#34;Store_Data&#34;,
      &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
      &#34;created_by&#34;:{
         &#34;zuid&#34;:&#34;66466723&#34;,
         &#34;is_confirmed&#34;:false,
         &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
         &#34;first_name&#34;:&#34;Amelia&#34;,
         &#34;last_name&#34;:&#34;Burrows&#34;,
         &#34;user_type&#34;:&#34;Admin&#34;,
         &#34;user_id&#34;:&#34;2136000000006003&#34;
      },
      &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
      &#34;modified_by&#34;:{
         &#34;zuid&#34;:&#34;66466723&#34;,
         &#34;is_confirmed&#34;:false,
         &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
         &#34;first_name&#34;:&#34;Amelia&#34;,
         &#34;last_name&#34;:&#34;Burrows&#34;,
         &#34;user_type&#34;:&#34;Admin&#34;,
         &#34;user_id&#34;:&#34;2136000000006003&#34;
      },
      &#34;project_details&#34;:{
         &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
         &#34;id&#34;:&#34;2136000000007733&#34;,
         &#34;project_type&#34;:&#34;Live&#34;
      },
      &#34;id&#34;:&#34;2136000000008551&#34;
   }
]
{{%/code%}} 

{{%note%}}{{%bold%}}Info :{{%/bold%}} Refer to the {{%link href=&#34;/en/sdk/python/v1/sdk-scopes&#34; %}}SDK Scopes table{{%/link%}} to determine the required permission level for performing the above operation.{{%/note%}} 


--------------------------------------------------------------------------------
title: "Upload File"
description: "This page describes the method to upload a file to a folder in the File Store in your Python application with sample code snippets."
last_updated: "2026-03-18T07:41:08.559Z"
source: "https://docs.catalyst.zoho.com/en/sdk/python/v1/cloud-scale/file-store/upload-file/"
service: "Cloud Scale"
related:
- Upload File - API (/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder)
- File Store Help (/en/cloud-scale/help/file-store/introduction/)
- SDK Scopes (/en/sdk/python/v1/sdk-scopes)

--------------------------------------------------------------------------------


# Upload a File

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

You can upload a file from your local system to an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction/&#34; %}}Catalyst File Store{{%/link%}}, by referring to its unique folder ID. You can upload an image, text document, CSV, or any type of file you need. 

The maximum size of a file that you can upload is 100 MB. A unique file ID is created for the file after it is uploaded.

{{%note%}}{{%bold class=&#34;bold-primary&#34; %}}Note :{{%/bold%}}
Catalyst provides 1 GB of File Store space for each project in the {{%link href=&#34;/en/deployment-and-billing/environments/development-environment&#34; %}}development environment{{%/link%}}. There are no upper limits for storage in the production environment.{{%/note%}}

You can either use the component reference or the folder reference created earlier, to refer the folder where the file needs to be uploaded in. You must pass the unique folder ID of the folder. The response returned here will be the information of the uploaded file.

To know more about the component instance {{%badge%}}filestore_service{{%/badge%}} used below, please refer to {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-component-instance/&#34; %}}this help section{{%/link%}}.

**Parameters Used**

&lt;table class=&#34;content-table&#34;&gt;
	&lt;thead&gt;
		&lt;tr&gt;
			&lt;th class=&#34;w20p&#34;&gt;Parameter Name&lt;/th&gt;
      &lt;th class=&#34;w20p&#34;&gt;Data Type&lt;/th&gt;
      &lt;th class=&#34;w60p&#34;&gt;Definition&lt;/th&gt;
		&lt;/tr&gt;
	&lt;/thead&gt;
	&lt;tbody&gt;
		&lt;tr&gt;
			&lt;td&gt;{{%badge%}}file_name{{%/badge%}}&lt;/td&gt;
      &lt;td&gt;String&lt;/td&gt;
			&lt;td&gt;A {{%bold%}}Mandatory{{%/bold%}} parameter. Will hold the name of the file to be uploaded in FileStore.&lt;/td&gt;
		&lt;/tr&gt;
    &lt;tr&gt;
			&lt;td&gt;{{%badge%}}content_type{{%/badge%}}&lt;/td&gt;
      &lt;td&gt;File&lt;/td&gt;
			&lt;td&gt;A {{%bold%}}Mandatory{{%/bold%}} parameter. Will hold the the default value as &#34;file&#34;.&lt;/td&gt;
		&lt;/tr&gt;
	&lt;/tbody&gt;
&lt;/table&gt;


{{%code class=&#34;language-python&#34; scroll=&#34;set-scroll&#34; %}}#Upload a file
file = open(&#39;file.txt&#39;, &#34;rb&#34;)
filestore_service = app.filestore()
folder = filestore_service.folder(6759000000166049)
folder.upload_file(&#39;testFile.txt&#39;,file)	
{{% /code%}} 

A sample response is shown below :

{{%code class=&#34;language-json line-numbers&#34;%}}{
  id: &#34;5249000000016011&#34;,
  file_location: null,
  file_name: &#34;testFile.txt&#34;,
  file_size: &#34;84881&#34;,
  created_by: {
    zuid: &#34;66466723&#34;,
    is_confirmed: false,
    email_id: &#34;amelia.burrows@zylker.com&#34;,
    first_name: &#34;Amelia&#34;,
    last_name: &#34;Burrows&#34;,
    user_type: &#34;Admin&#34;,
    user_id: &#34;2136000000006003&#34;
  },
  created_time: &#34;Aug 17, 2021 09:33 PM&#34;,
  modified_by: {
    zuid: &#34;66466723&#34;,
    is_confirmed: false,
    email_id: &#34;amelia.burrows@zylker.com&#34;,
    first_name: &#34;Amelia&#34;,
    last_name: &#34;Burrows&#34;,
    user_type: &#34;Admin&#34;,
    user_id: &#34;2136000000006003&#34;
  },
  modified_time: &#34;Aug 17, 2021 09:33 PM&#34;,
  project_details: { project_name: &#34;ShipmentTracking&#34;, id: &#34;2136000000007733&#34; },
  folder_details: &#34;5249000000016011&#34;
}
{{%/code%}} 

{{%note%}}{{%bold%}}Info :{{%/bold%}} Refer to the {{%link href=&#34;/en/sdk/python/v1/sdk-scopes&#34; %}}SDK Scopes table{{%/link%}} to determine the required permission level for performing the above operation.{{%/note%}} 


--------------------------------------------------------------------------------
title: "Download File from Folder"
description: "This page describes the method to download a file from folders in the File Store in your Python application with sample code snippets."
last_updated: "2026-03-18T07:41:08.559Z"
source: "https://docs.catalyst.zoho.com/en/sdk/python/v1/cloud-scale/file-store/download-a-file-from-the-folder/"
service: "Cloud Scale"
related:
- Download File from Folder - API (/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder)
- File Store Help (/en/cloud-scale/help/file-store/introduction)
- SDK Scopes (/en/sdk/python/v1/sdk-scopes)

--------------------------------------------------------------------------------


# Download a File from the Folder

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

A file can be downloaded from the folder by referring to its unique file ID. To know more about the {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-component-instance/&#34; %}}component instance{{%/link%}}{{%badge%}}filestore_service{{%/badge%}} and the {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-folder-instance/&#34; %}}folder instance{{%/link%}}{{%badge%}}folder_service{{%/badge%}} used below, please refer to their respective help sections.

The file ID is passed as an argument to the {{%badge%}}download_file(){{%/badge%}} method. This method returns the text file in the Bytes format as a response.

**Parameters Used**

&lt;table class=&#34;content-table&#34;&gt;
	&lt;thead&gt;
		&lt;tr&gt;
			&lt;th class=&#34;w20p&#34;&gt;Parameter Name&lt;/th&gt;
			&lt;th class=&#34;w20p&#34;&gt;Data Type&lt;/th&gt;
      &lt;th class=&#34;w60p&#34;&gt;Definition&lt;/th&gt;
		&lt;/tr&gt;
	&lt;/thead&gt;
	&lt;tbody&gt;
		&lt;tr&gt;
			&lt;td&gt;{{%badge%}}file_ID{{%/badge%}}&lt;/td&gt;
			&lt;td&gt;String&lt;/td&gt;
			&lt;td&gt;A {{%bold%}}Mandatory{{%/bold%}} parameter. Will hold the ID of the file to be downloaded.&lt;/td&gt;
		&lt;/tr&gt;
	&lt;/tbody&gt;
&lt;/table&gt;

{{%code class=&#34;language-python&#34; scroll=&#34;set-scroll&#34; %}}#Download a File
filestore_service = app.filestore()
folder_service = filestore_service.folder(5249000000016011)
data = folder_service.download_file(5249000000032063)
{{% /code%}} 

{{%note%}}{{%bold%}}Info :{{%/bold%}} Refer to the {{%link href=&#34;/en/sdk/python/v1/sdk-scopes&#34; %}}SDK Scopes table{{%/link%}} to determine the required permission level for performing the above operation.{{%/note%}} 


--------------------------------------------------------------------------------
title: "Delete a File"
description: "This page describes the method to delete a folder from the File Store in your Python application with sample code snippets."
last_updated: "2026-03-18T07:41:08.559Z"
source: "https://docs.catalyst.zoho.com/en/sdk/python/v1/cloud-scale/file-store/delete-a-file/"
service: "Cloud Scale"
related:
- Delete a File - API (/en/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile)
- File Store Help (/en/cloud-scale/help/file-store/introduction)
- SDK Scopes (/en/sdk/python/v1/sdk-scopes)

--------------------------------------------------------------------------------


# Delete a file

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst now offers you a brand new object storage component called {{%bold%}}Stratus{{%/bold%}} in {{%bold%}}Early Access{{%/bold%}} mode. This component is a significant upgrade to the current {{%italics%}}Cloud Scale File Store{{%/italics%}} component. You can find out more about the Stratus component {{%link href=&#34;/en/cloud-scale/help/stratus/introduction/&#34; %}}here{{%/link%}}.&lt;br /&gt;&lt;br /&gt;To use the Stratus component in the Early Access mode, email us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}.{{%/note%}}

A file from a folder can be deleted by referring its file ID. The component reference or folder reference is used in the below code snippet. A file ID is passed as a parameter to the {{%badge%}}delete_file(){{%/badge%}} method. The response returns a boolean value ( true or false) based on the status of deletion. 

To know more about the {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-component-instance/&#34; %}}component instance{{%/link%}}{{%badge%}}filestore_service{{%/badge%}} and the {{%link href=&#34;/en/sdk/python/v1/cloud-scale/file-store/get-folder-instance/&#34; %}}folder instance{{%/link%}}{{%badge%}}folder_service{{%/badge%}} used below, please refer to their respective help sections.

**Parameters Used**

&lt;table class=&#34;content-table&#34;&gt;
	&lt;thead&gt;
		&lt;tr&gt;
			&lt;th class=&#34;w20p&#34;&gt;Parameter Name&lt;/th&gt;
			&lt;th class=&#34;w20p&#34;&gt;Data Type&lt;/th&gt;
      &lt;th class=&#34;w60p&#34;&gt;Definition&lt;/th&gt;
		&lt;/tr&gt;
	&lt;/thead&gt;
	&lt;tbody&gt;
		&lt;tr&gt;
			&lt;td&gt;{{%badge%}}file_ID{{%/badge%}}&lt;/td&gt;
			&lt;td&gt;String&lt;/td&gt;
			&lt;td&gt;A {{%bold%}}Mandatory{{%/bold%}} parameter. Will hold the ID of the file to be deleted.&lt;/td&gt;
		&lt;/tr&gt;
	&lt;/tbody&gt;
&lt;/table&gt;

{{%code class=&#34;language-python&#34; scroll=&#34;set-scroll&#34; %}}#Delete a file
filestore_service = app.filestore()
folder_service = filestore_service.folder(5249000000016011)
folder_service.delete_file(5249000000032063)
{{% /code%}} 

{{%note%}}{{%bold%}}Info :{{%/bold%}} Refer to the {{%link href=&#34;/en/sdk/python/v1/sdk-scopes&#34; %}}SDK Scopes table{{%/link%}} to determine the required permission level for performing the above operation.{{%/note%}} 


---

## SDK — Web — File Store

--------------------------------------------------------------------------------
title: "Get Component Instance"
description: "This page describes the method to delete a folder from the File Store in your Web application with sample code snippets."
last_updated: "2026-03-18T07:41:08.560Z"
source: "https://docs.catalyst.zoho.com/en/sdk/web/v4/cloud-scale/file-store/get-component-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# File Store

{{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34;%}}Catalyst File Store{{%/link%}} provides cloud storage solutions for the application files and user data files of your Catalyst application, and enables access to shared data. You can store, manage, and organize images, videos, text files, document files, spreadsheets, or files of other formats.

### Get a Component Instance

The {{%badge%}}file store{{%/badge%}} component instance can be created as shown below. This does not fire a server-side call.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get a file store instance 
var filestore = catalyst.file;
{{% /code%}} 

--------------------------------------------------------------------------------
title: "Get Folder Instance"
description: "This page describes the method to fetch a folder instance from the File Store in your Web application with sample code snippets."
last_updated: "2026-03-18T07:41:08.560Z"
source: "https://docs.catalyst.zoho.com/en/sdk/web/v4/cloud-scale/file-store/get-folder-instance/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Get a Folder Object

A {{%badge%}}folder{{%/badge%}} object can be created using the following code snippet, which does not fire a server-side call. The {{%badge%}}filestore{{%/badge%}} used in the code snippet below is the {{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-component-instance&#34; %}}component instance.{{%/link%}}

{{%note%}}{{%bold%}}Note : {{%/bold%}}There is no promise involved in the method above and the folder object is returned.{{%/note%}}

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}// Get a folder instance 
var filestore = catalyst.file; 
var folder = filestore.folderId(FOLDER_ID);
{{% /code%}} 


--------------------------------------------------------------------------------
title: "Retrieve Folder Details"
description: "This page describes the method to retrieve the folder details from the File Store in your NodeJS application with sample code snippets."
last_updated: "2026-03-18T07:41:08.560Z"
source: "https://docs.catalyst.zoho.com/en/sdk/web/v4/cloud-scale/file-store/retrieve-folder-details/"
service: "Cloud Scale"
related:
- Retrieve Folder Details - API (/en/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Get Folder Details

### Get the Details of a Single Folder

The method that retrieves the details of a specific folder referred through its unique {{%bold%}}folder ID{{%/bold%}} is
the {{%badge%}}get(){{%/badge%}} method. The {{%badge%}}folder{{%/badge%}} used in the code snippet below is the
{{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-folder-instance/&#34; %}}folder object.{{%/link%}}

{{%note%}}{{%bold%}}Note : {{%/bold%}} The promise returned here will be resolved to an object in which the {{%bold%}}content{{%/bold%}} key contains details of a single folder.{{%/note%}}

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get the folder details using the folder Object
var filestore = catalyst.file;
var folder = filestore.folderId(2136000000008551);
var folderPromise = folder.get();
folderPromise
.then((response) =&gt; {
    console.log(response.content);
})
.catch((err) =&gt; {
    console.log(err);
});
{{% /code%}} 


A sample response that you will receive for each version is shown below:

{{% panel_with_select header=&#34;Web SDK&#34; %}}
{{% divtag id=&#34;V3&#34; class=&#34;language-json line-numbers&#34;%}} 
    {
    &#34;folder_name&#34;:&#34;Store_Data&#34;,
    &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:&#34;66466723&#34;,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:&#34;2136000000006003&#34;
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:&#34;2136000000007733&#34;,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;file_details&#34;:[
    {
      &#34;id&#34;:&#34;2136000000020111&#34;,
      &#34;file_location&#34;:null,
      &#34;file_name&#34;:&#34;Img.jpeg&#34;,
      &#34;file_size&#34;:&#34;84881&#34;,
      &#34;created_by&#34;:{
          &#34;zuid&#34;:&#34;66466723&#34;,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:&#34;2136000000006767&#34;
      },
      &#34;created_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
      &#34;modified_by&#34;:{
          &#34;zuid&#34;:&#34;66466723&#34;,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:&#34;2136000000006767&#34;
      },
      &#34;modified_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
      &#34;project_details&#34;:{
          &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
          &#34;id&#34;:&#34;2136000000007733&#34;,
          &#34;project_type&#34;:&#34;Live&#34;
      },
      &#34;folder_details&#34;:&#34;2136000000008551&#34;
    }
    ],
    &#34;id&#34;:&#34;2136000000008551&#34;
    }
{{% /divtag %}}

{{% divtag id=&#34;V2&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    &#34;folder_name&#34;:&#34;Store_Data&#34;,
    &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:2136000000007733,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;file_details&#34;:[
    {
      &#34;id&#34;:2136000000020111,
      &#34;file_location&#34;:null,
      &#34;file_name&#34;:&#34;invoice1349.jpeg&#34;,
      &#34;file_size&#34;:84881,
      &#34;created_by&#34;:{
          &#34;zuid&#34;:66466723,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:2136000000006767
      },
      &#34;created_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
      &#34;modified_by&#34;:{
          &#34;zuid&#34;:66466723,
          &#34;is_confirmed&#34;:false,
          &#34;email_id&#34;:&#34;p.boyle@zylker.com&#34;,
          &#34;first_name&#34;:&#34;Patricia&#34;,
          &#34;last_name&#34;:&#34;Boyle&#34;,
          &#34;user_type&#34;:&#34;Admin&#34;,
          &#34;user_id&#34;:2136000000006767
      },
      &#34;modified_time&#34;:&#34;Aug 17, 2021 09:32 PM&#34;,
      &#34;project_details&#34;:{
          &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
          &#34;id&#34;:2136000000007733,
          &#34;project_type&#34;:&#34;Live&#34;
      },
      &#34;folder_details&#34;:2136000000008551
    }
    ],
    &#34;id&#34;:2136000000008551
    }
{{% /divtag %}} 
{{% /panel_with_select %}}


You can retrieve the details of the folders created in the file store. This can be a single folder or all the folders
located in the file store. The _filestore_ used in the code snippets below is the
{{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-component-instance&#34; %}}component instance.{{%/link%}}

### Get all the Folder Details

If you want to fetch the details of all the folders in your Catalyst project, the {{%badge%}}getAllFolder(){{%/badge%}} method is used.

{{%note%}}{{%bold%}}Note : {{%/bold%}} The promise returned here will be resolved to an object in which the {{%bold%}}content{{%/bold%}} key contains an array of all the folder details.{{%/note%}}

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get all the folders by calling the method which in turn return a promise 
var filestore = catalyst.file; 
var allFolderPromise = filestore.getAllFolder(); 
allFolderPromise .then((response) =&gt; { console.log(response.content); 
})
.catch((err) =&gt; { console.log(err); });
{{% /code%}} 


A sample response that you will receive for each version is shown below:

{{% panel_with_select header=&#34;Web SDK&#34; %}}
{{% divtag id=&#34;V3&#34; class=&#34;language-json line-numbers&#34;%}} 
        [
        {
        folder_name: &#34;Store_Data&#34;,
        created_time: &#34;Jul 05, 2023 12:42 PM&#34;,
        created_by: {
        zuid: 788778872,
        is_confirmed: false,
        email_id: &#34;amelia.burrows@zylker.com&#34;,
        first_name: &#34;Amelia&#34;,
        last_name: &#34;Burrows&#34;,
        user_type: &#34;Admin&#34;,
        user_id: 10103000000003004
        },
        modified_time: &#34;Jul 05, 2023 12:42 PM&#34;,
        modified_by: {
        zuid: 788778872,
        is_confirmed: false,
        email_id: &#34;amelia.burrows@zylker.com&#34;,
        first_name: &#34;Amelia&#34;,
        last_name: &#34;Burrows&#34;,
        user_type: &#34;Admin&#34;,
        user_id: 10103000000003004
        },
        project_details: {
        project_name: &#34;Shipment_Tracking&#34;,
        id: 10103000000115000,
        project_type: &#34;Live&#34;
        },
        audit_consent: false,
        id: 10103000000114006
        },
        {
        folder_name: &#34;Git_Details&#34;,
        created_time: &#34;Jul 05, 2023 12:36 PM&#34;,
        created_by: {
        zuid: 788778872,
        is_confirmed: false,
        email_id: &#34;amelia.burrows@zylker.com&#34;,
        first_name: &#34;Amelia&#34;,
        last_name: &#34;Burrows&#34;,
        user_type: &#34;Admin&#34;,
        user_id: 10103000000003004
        },
        modified_time: &#34;Jul 05, 2023 12:36 PM&#34;,
        modified_by: {
        zuid: 788778872,
        is_confirmed: false,
        email_id: &#34;amelia.burrows@zylker.com&#34;,
        first_name: &#34;Amelia&#34;,
        last_name: &#34;Burrows&#34;,
        user_type: &#34;Admin&#34;,
        user_id: 10103000000003004
        },
        project_details: {
        project_name: &#34;GitHubBot&#34;,
        id: 10103000000115000,
        project_type: &#34;Live&#34;
        },
        audit_consent: false,
        id: 10103000000115076
        }
        ]
{{% /divtag %}}

{{% divtag id=&#34;V2&#34; class=&#34;language-json line-numbers&#34;%}}
    [
    {
    &#34;folder_name&#34;:&#34;Invoices&#34;,
    &#34;created_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;modified_time&#34;:&#34;Aug 25, 2021 11:38 AM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:2136000000007733,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;id&#34;:2136000000037021
    },
    {
    &#34;folder_name&#34;:&#34;Store_Data&#34;,
    &#34;created_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;created_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;modified_time&#34;:&#34;Aug 13, 2021 05:32 PM&#34;,
    &#34;modified_by&#34;:{
    &#34;zuid&#34;:66466723,
    &#34;is_confirmed&#34;:false,
    &#34;email_id&#34;:&#34;emma@zylker.com&#34;,
    &#34;first_name&#34;:&#34;Amelia&#34;,
    &#34;last_name&#34;:&#34;Burrows&#34;,
    &#34;user_type&#34;:&#34;Admin&#34;,
    &#34;user_id&#34;:2136000000006003
    },
    &#34;project_details&#34;:{
    &#34;project_name&#34;:&#34;ShipmentTracking&#34;,
    &#34;id&#34;:2136000000007733,
    &#34;project_type&#34;:&#34;Live&#34;
    },
    &#34;id&#34;:2136000000008551
    }
    ]
{{% /divtag %}} 
{{% /panel_with_select %}}


--------------------------------------------------------------------------------
title: "Upload a File"
description: "This page describes the method to upload a file to a folder in the File Store in your Web application with sample code snippets."
last_updated: "2026-03-18T07:41:08.561Z"
source: "https://docs.catalyst.zoho.com/en/sdk/web/v4/cloud-scale/file-store/upload-file/"
service: "Cloud Scale"
related:
- Upload File - API (/en/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Upload a File

You can upload a file from your local system to an existing folder in the {{%link href=&#34;/en/cloud-scale/help/file-store/introduction&#34; %}}File Store{{%/link%}}, by referring to the folder&#39;s unique ID. You can upload an image, text document, CSV, or any type of file you need. The maximum size of a file that you can upload is 100 MB.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst provides 1 GB of File Store space for each project in the {{%link href=&#34;/en/deployment-and-billing/environments/development-environment&#34; %}}development environment{{%/link%}}. There are no
upper limits for storage in the production environment.{{%/note%}}

You must create a file object for the file to be uploaded, as shown below. The {{%badge%}}fileobject{{%/badge%}} is
passed as an argument to the {{%badge%}}uploadFile(){{%/badge%}} method. The upload starts only when the
{{%badge%}}start(){{%/badge%}} method is called. You must specify Folder ID of the folder while referring to it.

The {{%badge%}}folder{{%/badge%}} reference used in the code below is the {{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-folder-instance/&#34; %}}folder object{{%/link%}} created earlier.

The promise returned here will be resolved to an object in which the {{%badge%}}content{{%/badge%}} key contains the
details of the uploaded file. A unique File ID is created for the file after it is uploaded.

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}var filestore = catalyst.file;
var folder = filestore.folderId(7189310908031); //Specify the Folder ID
var uploadPromise = folder.uploadFile(fileobject).start(); //Pass the file object and upload the file
uploadPromise
.then((response) =&gt; {
console.log(response.content);
})
.catch((err) =&gt; {
console.log(err);
});
{{% /code%}} 


A sample response that you will receive for each version is shown below:

{{% panel_with_select header=&#34;Web SDK&#34; %}}
{{% divtag id=&#34;V3&#34; class=&#34;language-json line-numbers&#34;%}} 
    {
    id: &#34;2136000000020122&#34;,
    file_location: null,
    file_name: &#34;shipmentdetails.csv&#34;,
    file_size: &#34;84881&#34;,
    created_by: {
    zuid: &#34;66466723&#34;,
    is_confirmed: false,
    email_id: &#34;amelia.burrows@zylker.com&#34;,
    first_name: &#34;Amelia&#34;,
    last_name: &#34;Burrows&#34;,
    user_type: &#34;Admin&#34;,
    user_id: &#34;2136000000006003&#34;
    },
    created_time: &#34;Aug 17, 2021 09:33 PM&#34;,
    modified_by: {
    zuid: &#34;66466723&#34;,
    is_confirmed: false,
    email_id: &#34;amelia.burrows@zylker.com&#34;,
    first_name: &#34;Amelia&#34;,
    last_name: &#34;Burrows&#34;,
    user_type: &#34;Admin&#34;,
    user_id: &#34;2136000000006003&#34;
    },
    modified_time: &#34;Jul 06, 2023 11:38 AM&#34;,
    project_details: {
    project_name: &#34;ShipmentTracking&#34;,
    id: 10103000000115000,
    project_type: &#34;Live&#34;
    },
    folder_details: 10103000000114006
    }
{{% /divtag %}}

{{% divtag id=&#34;V2&#34; class=&#34;language-json line-numbers&#34;%}}
    {
    id: 2136000000020117,
    file_location: null,
    file_name: &#34;empdata.csv&#34;,
    file_size: 84881,
    created_by: {
    zuid: 66466723,
    is_confirmed: false,
    email_id: &#34;emma@zylker.com&#34;,
    first_name: &#34;Amelia&#34;,
    last_name: &#34;Burrows&#34;,
    user_type: &#34;Admin&#34;,
    user_id: 2136000000006003
    },
    created_time: &#34;Aug 17, 2021 09:33 PM&#34;,
    modified_by: {
    zuid: 66466723,
    is_confirmed: false,
    email_id: &#34;emma@zylker.com&#34;,
    first_name: &#34;Amelia&#34;,
    last_name: &#34;Burrows&#34;,
    user_type: &#34;Admin&#34;,
    user_id: 2136000000006003
    },
    modified_time: &#34;Aug 17, 2021 09:33 PM&#34;,
    project_details: { project_name: &#34;ShipmentTracking&#34;, id: 2136000000007733 },
    folder_details: 2136000000008551
    }
{{% /divtag %}} 
{{% /panel_with_select %}}


--------------------------------------------------------------------------------
title: "Get File Object"
description: "This page describes the method to fetch a file object from the File Store in your Web application with sample code snippets."
last_updated: "2026-03-18T07:41:08.561Z"
source: "https://docs.catalyst.zoho.com/en/sdk/web/v4/cloud-scale/file-store/get-file-object/"
service: "Cloud Scale"
related:
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Get File Object

A {{%badge%}}file{{%/badge%}} object can be created using the following code snippet, which does not fire a server-side call. The unique {{%bold%}}File ID{{%/bold%}} is passed as an argument here.The {{%badge%}}folder{{%/badge%}} used in the code snippet below is the {{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-folder-instance&#34; %}}folder object.{{%/link%}}

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get a file object by passing the file ID 
var filestore = catalyst.file; 
var folder = filestore.folderId(FOLDER_ID);
var file = folder.fileId(FILE_ID);
{{% /code%}} 


--------------------------------------------------------------------------------
title: "Download a File from the Folder"
description: "This page describes the method to download a file from folders in the File Store in your Web application with sample code snippets."
last_updated: "2026-03-18T07:41:08.561Z"
source: "https://docs.catalyst.zoho.com/en/sdk/web/v4/cloud-scale/file-store/download-file-from-folder/"
service: "Cloud Scale"
related:
- Download a File from the Folder - API (/en/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Download a File from the Folder

Unlike other SDKs, Catalyst Web SDK allows you to get the download URL of a file where the actual file can be
downloaded. It requires the {{%bold%}}{{%badge%}}folder ID{{%/badge%}}{{%/bold%}} and {{%bold%}}{{%badge%}}
file ID{{%/badge%}}{{%/bold%}} to identify which file is to be downloaded from the URL. The {{%badge%}}file{{%/badge%}} used in the code snippet below is the {{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-file-object/&#34; %}}file object.{{%/link%}} The {{%badge%}}getDownloadLink(){{%/badge%}} method is used to return the promise.

{{%note%}}{{%bold%}}Note : {{%/bold%}} The promise returned here will be resolved to an object in which the content key contains a {{%bold%}}{{%badge%}}download_url{{%/badge%}}{{%/bold%}} key where the download URL will be available.{{%/note%}}

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Get the download Link by calling the method which returns a promise. 
var filestore = catalyst.file; 
var folder = filestore.folderId(FOLDER_ID); 
var file = folder.fileId(FILE_ID); 
var downloadPromise = file.getDownloadLink();
downloadPromise .then((response) =&gt; { console.log(response.content); }) .catch((err) =&gt; { console.log(err); });
{{% /code%}} 


--------------------------------------------------------------------------------
title: "Delete File"
description: "This page describes the method to delete a file from the File Store in your Web application with sample code snippets."
last_updated: "2026-03-18T07:41:08.561Z"
source: "https://docs.catalyst.zoho.com/en/sdk/web/v4/cloud-scale/file-store/delete-file/"
service: "Cloud Scale"
related:
- Delete File - API (/en/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile)
- File Store (/en/cloud-scale/help/file-store/introduction/)

--------------------------------------------------------------------------------


# Delete a File

The {{%badge%}}delete(){{%/badge%}} method is used to delete a file from the folder. The {{%badge%}}file{{%/badge%}} used in the code snippet below is the {{%link href=&#34;/en/sdk/web/v4/cloud-scale/file-store/get-file-object&#34; %}}file object.{{%/link%}}

{{%note%}}{{%bold%}}Note : {{%/bold%}} The promise returned here will be resolved to an object in which the {{%bold%}}{{%badge%}}content{{%/badge%}}{{%/bold%}} key contains the deleted file details.{{%/note%}}

{{%code class=&#34;language-javascript&#34; scroll=&#34;set-scroll&#34; %}}//Delete the file by calling the method which returns a promise. 
var filestore = catalyst.file; 
var folder = filestore.folderId(FOLDER_ID); 
var file = folder.fileId(FILE_ID); 
var deletePromise = file.delete(); deletePromise
.then((response) =&gt; { console.log(response.content); }) .catch((err) =&gt; { console.log(err); });
{{% /code%}}