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
  • List files and folders
  • /file/ls
  • /file/lstat

Was this helpful?

  1. Filesystem Operations

Listing files/folders

List files and folders

Listing files and folder can be done using the LS method. This method returns a list of all objects in a folder.

/file/ls

POST https://fileio.couchdrop.io/file/ls

List files and directories in a given path

Headers

Name
Type
Description

token

string

API Access Token

Request Body

Name
Type
Description

path

string

Target Path

{
    "ls":[
        {
            "filename": "document1.txt",
            "size:": 10234,
            "modtime": 1578531065,
            "is_dir": false
        },
        {
            "filename": "folder1",
            "size:": 0,
            "modtime": 0,
            "is_dir": true
        }
    ]
}
{"error": "you do not have the right permissions"}
{"error": "we encountered an error"}

Get file/folder details

You can use the LSTAT method to get details on an individual file or folder

/file/lstat

POST https://fileio.couchdrop.io/file/lstat

Retrieve properties for a file or folder.

Headers

Name
Type
Description

token

string

API Access Token

Request Body

Name
Type
Description

path

string

Target path of file or folder.

{
    "lstat": {
        "filename": "document1.txt",
        "size:": 10234,
        "modtime": 1578531065,
        "is_dir": false
    }
}

PreviousUsing webhooksNextDownloading a file

Last updated 2 years ago

Was this helpful?