Couchdrop Developer Docs
Couchdrop HomepageKnowledge BaseLogin
  • Couchdrop API Overview
  • Available Endpoints
  • Errors and Response Codes
  • Domains and Accounts
    • Register a new domain
    • Manage domain/account
    • Authentication
  • Administration
    • Users
    • Groups
    • Folder Permissions
    • Folder Properties
    • Shared Links
    • Storage Connections
      • SFTP Connections
      • S3 Connections
      • FTP Connections
      • Azure Connections
      • GCS Connections
      • Other
    • Automations
      • Scheduled Automations
        • Create/Update
        • Get all schedule workflows
        • Get schedule workflow
        • Trigger schedule workflow
        • Delete Scheduled Workflow
      • Event Automations
        • Create/Update
        • Get action workflow
        • Get all action workflows
        • Delete Action Workflow
      • Actions
        • Webhook
        • Rename
        • Copy
        • Move
        • PGP Encrypt
        • Paths
      • Conditions
    • Symlinks/Shortcuts
    • Auditing and Reporting
  • Webhooks
    • Using webhooks
  • Filesystem Operations
    • Listing files/folders
    • Downloading a file
    • Uploading a File
    • Rename files/folders
    • Deleting files/folders
    • Create a folder
Powered by GitBook

Couchdrop

  • Couchdrop Homepage
  • Register
  • Login

Platform

  • Cloud SFTP Server
  • Cloud FTP Server
  • Automated Transfers
  • Mailboxes and Inboxes

Copyright Couchdrop Limited 2025

On this page

Was this helpful?

  1. Domains and Accounts

Authentication

To authenticate with Couchdrop see the routes below

Authenticating with Couchdrops API requires a username and password and on success returns a new authentication token. This token can then we be used in subsequent API requests. Tokens generated using this route only exist for a short period of time and should not be used for long term API access.

For long term access, create and administrative token in Couchdrop's administration interface.

API tokens inherit the permissions of the authenticating user.

Authenticate with username and password

POST https://api.couchdrop.io/authenticate

Authenticate with a POST request

Request Body

Name
Type
Description

username*

String

Username

password*

String

Password

system

String

An optional field describing the source

{
    "token":"<API auth token>"
}
{
    // Response
}
{
    // Response
}
PreviousManage domain/accountNextUsers

Last updated 2 years ago

Was this helpful?