---
sourceDocument: Yokohama Build workflows
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/build-workflows

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama Build workflows

ft:clusterId :

    - crworkflow

bundleId :

    - crworkflow

workflow :

    - Creator


---

# SFTP step

# SFTP step {#ariaid-title1}

Release version: Yokohama  
Updated January 30, 2025  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read  
Create a reusable action to manage files and directories on an SFTP server and to move
files from one SFTP server to another.
Note:  
* This step requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf). For more information about the ServiceNow® Integration Hub subscription packages, see [Integration Hub usage and subscription](https://www.servicenow.com/docs/access?context=subscription-usage&version=yokohama&pubname=yokohama-integrate-applications&ft:locale=en-US). After the required plugin is activated, the step is visible under Integrations.
* The SFTP step runs only on a ServiceNow® MID Server with SSH capabilities. Activate the plugin, Integration Hub in Workflow Data Fabric Professional (com.glide.hub.integrations.professional) to use the JDBC capability for the MID Server. For more information, see [Request an Integration Hub plugin](https://www.servicenow.com/docs/access?context=request-integrationhub&version=yokohama&pubname=yokohama-integrate-applications&ft:locale=en-US).
* The SFTP step requires a credential record that supports either SSH private key credentials or SSH credentials. This step does not support Windows credentials where the Use MID Server service account option is selected.
{#sftp-step__ul_y4l_lmj_kjb}

## Roles and availability {#sftp-step__section_b3v_vmj_kjb}

The SFTP step is available as an Workflow Studio action step. Users with the
action_designer role can create a custom action with one or more action steps.

## Prerequisite {#sftp-step__section_tqv_4vk_kjb}

Activate the Managed File Transfer Extensions for the SFTP Step
(com.glide.hub.action_step.sftp_mft) plugin.

## SFTP commands {#sftp-step__section_npq_14j_kjb}

* [Copy File](https://servicenow-prod.fluidtopics.net/1qnwk4FwfaYw6rOnU1eylQ "Copies a file from the source SFTP server to target SFTP server.")
* [Copy Directory](https://servicenow-prod.fluidtopics.net/g02i1CPqDSrZf4d2LBr3yw "Copies a directory from the source SFTP server to the target SFTP server.")
* [Create Directory](https://servicenow-prod.fluidtopics.net/u1XClFAx5dFgPIJtd8l9AA "Creates a new directory on an SFTP server.")
* [Get File List](https://servicenow-prod.fluidtopics.net/gOd8ekIzUR7Pg4oM4QOEOQ "Returns a list of files from a given directory and its subfolders on an SFTP server.")
* [Remove File](https://servicenow-prod.fluidtopics.net/r05eIuu5AkJ6l8ZBTgY6NA "Removes a file on an SFTP server, including subfolders, when configured.")
* [Remove Files](https://servicenow-prod.fluidtopics.net/uNx0UtRlfglCEmuK3ngtcQ "Remove files on an SFTP server, including subfolders, when configured.")
* [Delete Directory](https://servicenow-prod.fluidtopics.net/aqvqhRTpe3hueQ9VXoYqww "Deletes directory on an SFTP server, including subfolders, when configured.")
* [Rename File or Directory](https://servicenow-prod.fluidtopics.net/ji_7Z0bqoXn7zSTv5rLLBw "Renames a file or directory on an SFTP server.")
* [Set File Attributes](https://servicenow-prod.fluidtopics.net/OEdYFMjwz8FVHDWPtr7e4A "Sets common file attributes, such as timestamps, size, permissions, and UID/GID, for a file or directory on an SFTP server.")
* [Copy Attachments To SFTP Server](https://servicenow-prod.fluidtopics.net/hQxhTV3t9GTsKzRsQoVVQA "Copies the specified attachments from ServiceNow instance to an SFTP server.")
* [Copy Files To This Instance](https://servicenow-prod.fluidtopics.net/hxueUrWXQOHzAsYkFkyUnA "Attaches the specified files in the SFTP server to the specified record in ServiceNow instance.")

{#sftp-step__ul_z41_24j_kjb}  
Note:  
The SFTP commands can be performed on a maximum of 10,000 files at a time.
* **[Copy File](https://servicenow-prod.fluidtopics.net/1qnwk4FwfaYw6rOnU1eylQ)**   
  Copies a file from the source SFTP server to target SFTP server.
* **[Copy Directory](https://servicenow-prod.fluidtopics.net/g02i1CPqDSrZf4d2LBr3yw)**   
  Copies a directory from the source SFTP server to the target SFTP server.
* **[Create Directory](https://servicenow-prod.fluidtopics.net/u1XClFAx5dFgPIJtd8l9AA)**   
  Creates a new directory on an SFTP server.
* **[Get File List](https://servicenow-prod.fluidtopics.net/gOd8ekIzUR7Pg4oM4QOEOQ)**   
  Returns a list of files from a given directory and its subfolders on an SFTP server.
* **[Remove File](https://servicenow-prod.fluidtopics.net/r05eIuu5AkJ6l8ZBTgY6NA)**   
  Removes a file on an SFTP server, including subfolders, when configured.
* **[Remove Files](https://servicenow-prod.fluidtopics.net/uNx0UtRlfglCEmuK3ngtcQ)**   
  Remove files on an SFTP server, including subfolders, when configured.
* **[Delete Directory](https://servicenow-prod.fluidtopics.net/aqvqhRTpe3hueQ9VXoYqww)**   
  Deletes directory on an SFTP server, including subfolders, when configured.
* **[Rename File or Directory](https://servicenow-prod.fluidtopics.net/ji_7Z0bqoXn7zSTv5rLLBw)**   
  Renames a file or directory on an SFTP server.
* **[Set File Attributes](https://servicenow-prod.fluidtopics.net/OEdYFMjwz8FVHDWPtr7e4A)**   
  Sets common file attributes, such as timestamps, size, permissions, and UID/GID, for a file or directory on an SFTP server.
* **[Copy Attachments To SFTP Server](https://servicenow-prod.fluidtopics.net/hQxhTV3t9GTsKzRsQoVVQA)**   
  Copies the specified attachments from ServiceNow instance to an SFTP server.
* **[Copy Files To This Instance](https://servicenow-prod.fluidtopics.net/hxueUrWXQOHzAsYkFkyUnA)**   
  Attaches the specified files in the SFTP server to the specified record in ServiceNow instance.

