---
title: "Add Storage Mount"
method: POST
path: "/storage_mounts/add"
tags: ["Document AI — Storage Mounts"]
---

# Add Storage Mount

`POST /storage_mounts/add`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/storage_mounts/add`
- Auth: HTTP bearer

Add an external storage mount (SFTP example). Required: name, host, username, and credentials (password or ssh_key). BYOS mounts also require encryption_key.

## Request body

- object
  - `name` string, required: Display name for the mount.
  - `host` string, required: Remote host (SFTP/FTP).
  - `connector_type` 'sftp' | 's3' | 'azure_blob' | 'webdav' | 'google_drive' | 'onedrive' | 'dropbox' | 'box' | 'imap': Storage connector type.
  - `mount_purpose` 'byos' | 'connector', required: Mount purpose: 'byos' (Bring Your Own Storage) or 'connector' (data source). Immutable after creation.
  - `description` string: Optional description of the mount.
  - `port` integer: Port (default 22 for SFTP).
  - `username` string, required: Login username.
  - `password` string: Password for SFTP/FTP login (or use `ssh_key` for key-based auth).
  - `ssh_key` string: SSH private key (stored encrypted).
  - `api_token` string: API token (stored encrypted).
  - `base_path` string: Base path on the remote server. Parent-directory segments (..) are not allowed.
  - `encryption_key` string: BYOS encryption key when required by plan.
  - `connection_options` object: Additional connection options as JSON (e.g. S3 region, IMAP folder).
  - `icon_url` string: Optional URL for a custom icon.

## Response `200`

Success

- object: Add storage mount
  - `processing_time` string, required: Processing time (format: 123.45ms)
  - `mount_id` string: Mount id
  - `type` string: Type
  - `status` string: Request status (ok/error)

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)