---
title: "File Storage Component"
slug: "file-storage-component"
updated: 2026-09-15T17:57:26Z
published: 2026-09-15T17:57:26Z
canonical: "docs.unqork.io/file-storage-component"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# File Storage Component

The File Storage component handles file operations against an external SFTP or FTP service—getting, listing, uploading, or deleting files. Configure it with a service, select the operation method, and define the file and any additional inputs.

**SFTP** (SSH File Transfer Protocol) uses SSH encryption to secure data during transfer and is the recommended protocol for most use cases. **FTP** (File Transfer Protocol) transfers data without encryption and is less secure. Use it only when connecting to services that do not support SFTP.

> **How to read settings tables**
> 
> The tables below describe each configurable option as it displays in the UnqorkAI platform. Values are formatted as follows: `inline code` — a value to type exactly as shown | **Bold** — a value selected from a drop-down, radio button, tab, or choice chip | **ON**/**OFF** — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

## General Settings

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Property ID | `key` | Text input | `fs` | The unique identifier for this component instance. |
| Canvas Label Text | `label` | Text input | — | Identifies the component on the Module Builder canvas. Does not display to end-users. |

## Data Settings

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| File Storage Type | `fileStorageType` | Radio button | **SFTP** | Sets the protocol for the file storage service. Options include: **SFTP** or **FTP**. |
| Method | `method` | Segmented control | **Get** | Sets the file operation to perform. |
| Service | `service` | Service selector | — | The configured SFTP or FTP service to use, as set up in Services Administration. |

> - **Get** (default): Retrieves a file from the service.
> - **List**: Lists files available at the specified path.
> - **Put**: Uploads a file to the service.
> - **Delete**: Removes a file from the service.

### Path

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Property ID | — | Drop-down | — | The module field that provides the file path for the operation. |
| Watch | — | Toggle | OFF | When set to **ON**, this setting watches the selected field for changes to re-execute the operation. |

## Advanced Settings

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Disable Execution | `disabled` | Toggle | OFF | When set to **ON**, this setting prevents the component from executing when triggered. |

---

**Changelog**

| Date | Change |
| --- | --- |
| — | Initial publication. |

SFTP (Secure File Transfer Protocol) supports the transfer of files between an SFTP client and your server. Unlike FTP, it uses tunneling and performs transfers using a crytographic protocol to keep files secure.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the .

End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.