Skip to content

List Files

List all files in a DTN FTP directory, optionally including subdirectories.

listFiles

file

ParameterTypeRequiredDefaultDescription
PathstringNo/The directory path to list files from
OptionTypeDefaultDescription
RecursivebooleantrueWhether to list files recursively in subdirectories

Returns an array of file information objects:

{
"name": "pricing_2024-01-15.csv",
"path": "/data/pricing_2024-01-15.csv",
"size": 15420,
"type": "file",
"modifiedAt": "2024-01-15T08:00:00Z"
}
{
"success": false,
"error": "Connection refused"
}
FieldTypeDescription
namestringFile name
pathstringFull path to the file
sizenumberFile size in bytes
typestringEntry type (file or directory)
modifiedAtstringLast modification timestamp
  • Missing Host: DTN credential is missing host
  • Connection Failure: Unable to connect to FTP server
  • Invalid Path: Directory path does not exist