SFTP

Events

• New or Updated File

  Start a FLO when a file is created or updated

Actions

• Create Directory

  Create a new directory at a given path. Without a beginning forward slash, the directory will be created in the user’s home directory. When using a forward slash at the beginning of a path, the path must be absolute. For example:

  • newFolder -> Create a directory called “newFolder” in your home directory
  • /pathToHomeDirectory/newFolder -> Create a new directory called “newFolder” in your home directory, inputting the absolute path
  • /differentPath/newFolder -> Create a new directory somewhere other than your home directory, using an absolute path
  • existingFolder/newFolder -> Create a new folder inside of an existing folder inside of your home directory. When creating a new folder in nested subfolders, these folders must already exist for the operation to complete successfully.

  Inputs:

  • Directory Path (text) - The path at which to create the new directory

• Delete Directory

  Delete a directory at a given path. Without a beginning forward slash, the path will default to the user’s home directory. When using a forward slash at the beginning of a path, the path must be absolute. The operation will only be successful if the target directory is empty. Examples:

  • emptyFolder -> Delete a directory called “emptyFolder” in your home directory
  • /pathToHomeDirectory/emptyFolder -> Delete a directory called “emptyFolder” in your home directory, inputting the absolute path
  • /differentPath/emptyFolder -> Delete a directory called “emptyFolder” somewhere other than your home directory, using an absolute path
  • someFolder/emptyFolder -> Delete a folder called “emptyFolder” inside of an existing folder in your home directory.

  Inputs:

  • Directory Path - The path to the directory that you want to delete

• Delete File

  Delete a file at a given path. Without a beginning forward slash, the path will default to the user’s home directory. When using a forward slash at the beginning of a path, the path must be absolute. Examples:

  • myFile.jpg -> Delete a file called “myFile.jpg” in your home directory
  • /pathToHomeDirectory/myFile.jpg -> Delete a file called “myFile.jpg” in your home directory, inputting the absolute path
  • /differentPath/myFile.jpg -> Delete a file called “myFile.jpg” somewhere other than your home directory, using an absolute path
  • someFolder/myFile.jpg -> Delete a file called “myFile.jpg” inside of an existing folder in your home directory.

  Inputs:

  • File Path - The path to the file that you want to delete

• Download File

  Download a file from an SFTP destination to the filesystem.  The File path input defines the folder and filename within the SFTP destination, separated by a “/” character, according to normal FTP conventions.  Without a beginning forward slash, the path will reference the user’s home directory. When using a forward slash at the beginning of a path, the path must be absolute. Examples:

  • myfile.jpg -> download the file”myfile.jpg” from the user’s home directory
  • /pathToHomeDirectory/myfile.jpg -> same as above, using an absolute path
  • myfolder/myfile.jpg -> download the file “myfile.jpg” from the folder “myfolder”
  • myfolder/subfolder/adeeperfolder/myfile.jpg -> download a file from nested subfolders

  Inputs:

  • File path - the path, including folder and filename, of the file to download

  Outputs:

  • File Content - the File ID of the downloaded file
  • Filename - the filename of the downloaded file
  • Size - the size, in bytes, of the downloaded file

• Read Directory

  Read a directory at a given path. When using a forward slash at the beginning of a path, the path must be absolute. When left empty, the path defaults to “/”. Examples:

  • myFolder -> Read a directory called “myFolder” in your home directory
  • /pathToHomeDirectory -> Read the contents of your home directory
  • /pathToHomeDirectory/myFolder ->Read a directory called “myFolder” in your home directory, this time using the absolute path
  • someFolder/myFolder -> Read the contents of an existing folder in your home directory that is nested in an existing folder.

  Inputs:

  • Directory Path - The path to the directory that you want to read.

  Outputs:

  • Directory
    • Items
      • Name (text) - The name of the file or directory
      • Path (text) - The absolute path of the file or directory
      • File Size (number) - The file size in bytes
      • Last Modified (number) - The last modified date
      • Owner (number)  - The owner of the file or directory
      • Group (number) - The group of the file or directory
      • Permissions (number) - Permissions for the file or directory

• Read File

  Read the text content of a file

• Upload File

  Upload a file to an SFTP destination. The Destination File Path defines the folder and filename within the SFTP destination, separated by a “/” character, according to normal FTP conventions. Without a beginning forward slash, the path will reference the user’s home directory. When using a forward slash at the beginning of a path, the path must be absolute. Examples:

  • myfile.jpg -> upload the file to the root of the SFTP destination site, storing it as “myfile.jpg”
  • /pathToHomeDirectory/myfile.jpg -> same as above, using an absolute path
  • myfolder/myfile.jpg -> save the file as “myfile.jpg” inside the folder “myfolder”
  • myfolder/subfolder/adeeperfolder/myfile.jpg -> store the file under multiple subfolders

  Inputs:

  • File Content - the File ID of the file to upload
  • Destination File Path - the path, including folder and filename, at which to store the file

  Outputs:

  • Succeeded - a boolean value that indicates success if true

• Upload File from URL

  Download a file from a URL and upload the file to an SFTP server

• Write File

  Write a text file to a given path. This action writes plain text to a file, but cannot be used to create file types that contain anything other than plain text, such as .docx.

  NOTE: The maximum file size that can be written is 10MB. If you attempt to upload data larger than 10MB you will receive a “Payload too large” error.

  Without a beginning forward slash, the file will be created in the user’s home directory. When using a forward slash at the beginning of a path, the path must be absolute. For example:

  • newTextFile.txt -> Create a file called “newTextFile.txt” in your home directory
  • /pathToHomeDirectory/newTextFile.txt -> Create a new file called “newTextFile.txt” in your home directory, inputting the absolute path
  • /differentPath/newTextFile.txt -> Create a new file somewhere other than your home directory, using an absolute path
  • existingFolder/newTextFile.txt -> Create a new file inside of an existing folder inside of your home directory. When creating a new file in nested subfolders, these folders must already exist for the operation to complete successfully.

  Inputs:

  • Text Content (text) - The text content that you want to write to a file
  • Destination File Path _(text)_ - The path at which to create the new file