Storage Connections

Couchdrop connects to external storage engines. Managing storage engines and mappings can be done using the API.

Note about OAuth

Some storage provides require OAuth based authentication. Currently this cannot be done using the API.

Getting existing storage connections

Get all storage connections

GET https://api.couchdrop.io/manage/account/storage

Returns a list of all storage connections configured in Couchdrop

Headers

Name	Type	Description
token*	String	API Token

200: OK

{
    "storage":[
        {...}
    ]
}

Create or Update a storage connection

Create/Update Storage

POST https://api.couchdrop.io/manage/account/storage

This method is used to create and/or update storage settings. For param details, see the sub-artices.

Headers

Name	Type	Description
token*	String	API Token

Request Body

Name	Type	Description
id	String	ID of existing storage connection to update. If not specified, Couchdrop will create a new storage entity.
path*	String	Path to mount storage as in Couchdrop
store_type*	String	Store type. See available store types below.
subpath	String	Map this folder/path to Couchdrop. If not specified, we will map the root directory of the storage connection into the folder specified in path

200: OK

{
    "result":{
        ...
    }
}

The store types and their require auth is below. Api authentication can not be provided with OAuth without the assistance of support.

store_type	Name/Provider	Auth Type
azure	Azure Files - Azure Connections	Static Keys
azureblob	Azure Blob - Azure Connections	Static Keys
googledrive	Individual Google Drive	OAuth
googledrive_domain	Google Workspace	API Domain Delegation
gcloud	Google GCS - GCS Connections	Static Keys
dropboxfull	Personal Dropbox	OAuth
dropboxfullbusiness	Team Dropbox	OAuth
digitalocean	Digital Ocean Spaces	Static Keys
wasabi	Wasabi S3 Storage	Static Keys
seagate_lyve_cloud	Seagate S3 Storage	Static Keys
sftp	SFTP - SFTP Connections	Username/Password
ftp	FTP/s - FTP Connections	Username/Password
s3	AWS S3 - S3 Connections	Static Keys
s3_compatible	Custom S3 - S3 Connections	Static Keys
box	Box	OAuth
backblazeb2	Backblaze B2 Storage	Static Key
onedrive	Microsoft Onedrive	OAuth
sharepoint	Microsoft Sharepoint	OAuth
filebase	Filebase	Keys
egnyte	Egnyte	OAuth
idrive	IDrive S3	Keys
sharefile	Citrix Sharefile	OAuth
huddle	Ideagen Huddle	OAuth
hosted	Couchdrop Hosted Storage	--

Removing a storage connection

Remove a storage connection

DELETE https://api.couchdrop.io/manage/account/storage

Headers

Name	Type	Description
token*	String	API Token

Request Body

Name	Type	Description
id*	String	Storage connection ID