# Couchdrop Developer Docs ## couchdrop-api - [Couchdrop API Overview](https://developers.couchdrop.io/couchdrop-api-overview.md) - [Available Endpoints](https://developers.couchdrop.io/available-endpoints.md): Couchdrop has two separate endpoints for public API access - [Errors and Response Codes](https://developers.couchdrop.io/errors-and-response-codes.md): All API methods return a HTTP status code which indicates success or failure. - [Manage domain/account](https://developers.couchdrop.io/domains-and-accounts/master.md): General settings allow you to manage your account with Couchdrop. Its also the perfect place to start with API access. - [Authentication](https://developers.couchdrop.io/domains-and-accounts/authentication.md): To authenticate with Couchdrop see the routes below - [Users](https://developers.couchdrop.io/administration/managing-users.md): With Couchdrop you can configure additional users. Additional users cannot manage your Couchdrop service, but are able to upload/download and view files. - [Groups](https://developers.couchdrop.io/administration/groups.md): Managing groups can be done via the API. The following routes are available. - [Folder Permissions](https://developers.couchdrop.io/administration/advanced-folder-permissions.md): After enabling Advanced Permissions, you can configure a folder with granular access to individual users. - [Folder Properties](https://developers.couchdrop.io/administration/managing-folders.md): With Couchdrop you can configure folders with advanced user permissions, webhook and email notifications, as well as web portal uploads. - [Shared Links](https://developers.couchdrop.io/administration/managing-shared-links.md): Shared Links can be created to provide external users with access to files. Links can be set up securely with a password requirement as well as a time for access via the link to expire. - [Storage Connections](https://developers.couchdrop.io/administration/storage-connections.md): Couchdrop connects to external storage engines. Managing storage engines and mappings can be done using the API. - [SFTP Connections](https://developers.couchdrop.io/administration/storage-connections/sftp-connections.md): Configuring a connection to an external SFTP can be done with basic connectivity details as outlined below. - [S3 Connections](https://developers.couchdrop.io/administration/storage-connections/s3-connections.md): Configuring a connection to S3 or a compatible S3 provider can be done with basic connectivity details as outlined below. - [FTP Connections](https://developers.couchdrop.io/administration/storage-connections/ftp-connections.md): Configuring a connection to an external FTP can be done with basic connectivity details as outlined below. - [Azure Connections](https://developers.couchdrop.io/administration/storage-connections/azure-connections.md) - [GCS Connections](https://developers.couchdrop.io/administration/storage-connections/gcs-connections.md) - [Other](https://developers.couchdrop.io/administration/storage-connections/other.md) - [Automations](https://developers.couchdrop.io/administration/automations.md): With Couchdrop you can configure Automations which can be created to perform actions on files and folders automatically. These workflows can be action or schedule based. - [Scheduled Automations](https://developers.couchdrop.io/administration/automations/scheduled-automations.md) - [Create/Update](https://developers.couchdrop.io/administration/automations/scheduled-automations/create-update.md): Create or update a schedule workflow - [Get all schedule workflows](https://developers.couchdrop.io/administration/automations/scheduled-automations/get-all-schedule-workflows.md): Get all configured schedule workflow configurations - [Get schedule workflow](https://developers.couchdrop.io/administration/automations/scheduled-automations/get-schedule-workflow.md): Get a specific schedule workflow configuration. - [Trigger schedule workflow](https://developers.couchdrop.io/administration/automations/scheduled-automations/trigger-schedule-workflow.md): Trigger specific schedule workflow for testing purposes. - [Delete Scheduled Workflow](https://developers.couchdrop.io/administration/automations/scheduled-automations/delete-scheduled-workflow.md): Delete a schedule workflow - [Event Automations](https://developers.couchdrop.io/administration/automations/event-automations.md) - [Create/Update](https://developers.couchdrop.io/administration/automations/event-automations/create-update.md): Create or update an action workflow - [Get action workflow](https://developers.couchdrop.io/administration/automations/event-automations/get-action-workflow.md): Get a specific action workflow configuration. - [Get all action workflows](https://developers.couchdrop.io/administration/automations/event-automations/get-all-action-workflows.md): Get all configured action workflow configurations - [Trigger action workflow](https://developers.couchdrop.io/administration/automations/event-automations/trigger-action-workflow.md): Trigger specific action workflow. - [Delete Action Workflow](https://developers.couchdrop.io/administration/automations/event-automations/delete-action-workflow.md): Delete an action workflow - [Actions](https://developers.couchdrop.io/administration/automations/actions.md): When configuring an automation, you are required to configure a set of actions. These actions apply to the files matching the conditions of the automation. - [Webhook](https://developers.couchdrop.io/administration/automations/actions/webhook.md): The webhook action sends a HTTP/HTTPS webhook to the destination specified. - [Rename](https://developers.couchdrop.io/administration/automations/actions/rename.md): The rename action renames a file. - [Copy](https://developers.couchdrop.io/administration/automations/actions/copy.md): The copy action duplicates a file, copying it to a new destination - [Move](https://developers.couchdrop.io/administration/automations/actions/move.md): The move action copies a file then removes the original object. Effectively moving the file. - [PGP Encrypt](https://developers.couchdrop.io/administration/automations/actions/pgp-encrypt.md): The PGP encrypt action can be used to encrypt files as part of a workflow. - [Paths](https://developers.couchdrop.io/administration/automations/actions/paths.md): Certain operations work on paths. Couchdrop has a bunch of path variables available that can be used to craft relevant paths. - [Conditions](https://developers.couchdrop.io/administration/automations/conditions.md): When configuring an automation, you can set additional conditions on it which are required to match before the automation will fire. - [Symlinks/Shortcuts](https://developers.couchdrop.io/administration/symlinks-shortcuts.md): Symbolic links or Shortcuts provide a versatile and easy way to work with directories in multiple locations. A symlink/shortcut can point to any folder in the Couchdrop virtual file system. - [Auditing and Reporting](https://developers.couchdrop.io/administration/auditing-and-reporting.md): Couchdrop has comprehensive auditing across all operations. Audit events can be pulled from the API - [Using webhooks](https://developers.couchdrop.io/webhooks/using-webhooks.md): Couchdrop provides configurable webhooks on all file events. Webhooks can be sent to a HTTPS endpoint and always contain a JSON body with the event details. - [Listing files/folders](https://developers.couchdrop.io/filesystem-operations/managing-files.md) - [Downloading a file](https://developers.couchdrop.io/filesystem-operations/downloading-a-file.md): How to stream a file with Couchdrop - [Uploading a File](https://developers.couchdrop.io/filesystem-operations/uploading-a-file.md): Uploading a file is the most common use case for our API. Files are uploaded in binary form as the post body. - [Rename files/folders](https://developers.couchdrop.io/filesystem-operations/managing-files-1.md) - [Deleting files/folders](https://developers.couchdrop.io/filesystem-operations/managing-files-2.md) - [Create a folder](https://developers.couchdrop.io/filesystem-operations/managing-folders.md)