How the API works
The Couchdrop API uses an HTTPS endpoint with token-based authentication. Permanent tokens can be created and managed from the Couchdrop Admin panel and temporary tokens can be created with the Authentication route.
Data is submitted and returned either via form data or JSON. Responses are always in JSON and status codes indicate success or failure. Rate limits apply to protect infrastructure, and you can reach out to us if you have higher requirements for your use case.
The API is versioned and we endeavor to maintain backwards compatibility. Full documentation is available at developers.couchdrop.io.
API Capabilities and examples
The Couchdrop API allows you to manage your domain and account, handle administration actions like user and group management, run filesystem operations, and use configurable webhooks for file events.
Below are some examples of how you can integrate the Couchdrop API into your workflows.
-
User and Group Management. Create, modify, and delete users programmatically. You can assign users to groups via the API and apply folder permissions at the group level as well.
-
Storage and Connection Configuration. Integrate cloud storage or remote servers (SFTP, FTP, AS2) with the API and manage connections. Note that OAuth-based storage connections (Google Drive, Dropbox, SharePoint) require initial authorization through the web interface first.
-
Set Permissions and Properties. Apply granular permissions to folders, including read/write access, user/group assignments, and user access to features.
-
Trigger Automations. Execute workflows on-demand via API webhook trigger and extend triggering capabilities by utilizing custom actions.
- Access audit logs. Query audit logs and export filtered logs to CSV or stream real-time events to your systems via webhook integration.
Example Use Case
One common way that organizations make use of the Couchdrop API is for integrations within their own platforms.
For example, a SaaS platform might need to onboard new enterprise customers through an automated provisioning flow. When a customer contract is signed, the platform's CRM triggers an API call to Couchdrop that creates an SFTP user, sets their home directory to a customer-specific folder in S3, applies the correct permissions, and fires a webhook back to the CRM confirming the account is ready.
The customer receives connection details within seconds, and no one had to manually provision anything.