Local Filesystem to Remote SFTP Server

The Local Filesystem to Remote SFTP Server is a Pipeline type used for a standard SFTP transfer scenario where UDMG acts as a client, pushing files from the local UDMG filesystem to an external SFTP server.

This Pipeline consists of:

• A Local Filesystem Endpoint that represents the location of the files to be transferred (used as the Source Endpoint).
• A Remote SFTP Server Endpoint that represents your partner's SFTP server (used as the Destination Endpoint).
• Pipeline-specific configuration options.
• An HTTP request to the Transfers Scheduled API.

Before You Begin

Prerequisites

Before configuring this Pipeline, we recommend you first:

• Obtain your partner's SFTP Server connection details from their administrator, including hostname, port, and authentication credentials.
• Identify your local source directory and ensure that UDMG has the necessary permissions to read files from it.
• Test network connectivity to your partner's SFTP Server and manually verify that authentication succeeds.
• Prepare API integration setup and have a UDMG User with domain-level permissions.

Understanding Paths in This Pipeline

When configuring a Local Filesystem to Remote SFTP Server Pipeline, several path fields determine where files are read from locally and where they are written to on the external SFTP server.

Each path has a specific role and is combined during runtime to build the complete source and destination paths used in transfers.

Domain Chroot

This path portion is determined by the security.domain_chroot argument defined in the Configuration File.

Valid security.domain_chroot values are:

• NONE: No path is prepended.
• WORKDIR: The file path is resolved relative to the work_directory_path argument defined in the Configuration File (e.g., /home/udmg/ or C:\UDMG\WorkDir\).
• WORKDIR+DOMAIN: Same as WORKDIR, but UDMG also prepends the Domain name (e.g., /home/udmg/primary/ or C:\UDMG\WorkDir\primary\).

Root File Path

This is the root path defined in the Local Filesystem Endpoint used as the Source Endpoint for this Pipeline. Directories above this path are not accessible to Pipelines associated with this Endpoint.

The interpretation of the Root File Path depends on the value of security.domain_chroot:

• If security.domain_chroot is set to NONE, the Root File Path is treated as an absolute path, and should be specified as such.
• Otherwise, the Root File Path is treated as relative to the directory defined by security.domain_chroot (see Domain Chroot).

Valid formats:

• / (empty path)
• /dir
• /dir/subdir
• C:\dir\subdir
• \\[ServerName]\dir\subdir (Windows UNC path)

Relative Path

An optional base path used to locate files within this Pipeline.

Valid formats:

• /
• /dir
• /dir/subdir/filename.ext (in this case, the Pipeline always pushes the same file).

If the Relative Path includes the filename and extension, the corresponding source value should be empty (see Request Body).

source

Optional filename and extension of the source file.

The source property can only be omitted when the filename and extension are already specified in the Relative Path. Otherwise, it must be provided.

If needed, the value can also include one or more subdirectories relative to the defined Relative Path.

Valid formats:

• "" (only if filename.ext is already specified in the Relative Path)
• "/filename.ext"
• "/dir/filename.ext"
• "/dir/subdir/filename.ext"

For implementation details, see Transfer Scheduling via UDMG REST API.

IP Address and Port

The IP Address and Port of the external SFTP server.

They are defined in the Remote SFTP Server Endpoint used as the Destination Endpoint for this Pipeline.

Virtual Path

An optional path in the external SFTP server virtual filesystem where the file is to be pushed.

Valid formats:

• / (empty path)
• /dir

warning

The path must exist in the virtual filesystem exposed by the external SFTP server, and the Credentials specified in this Pipeline must have permission to write to it.

destination

Optional filename and extension of the destination file.

If included, the file will be renamed to the specified name and extension in the external SFTP server. Otherwise, it will keep its original name and extension.

If needed, the value can also include one or more subdirectories relative to the defined Virtual Path. Those directories will be created in the external SFTP server if they don't already exist.

Valid formats:

• "" (keeps the source filename and extension)
• "/new_filename.ext"
• "/dir/filename.ext"
• "/new_dir/new_filename.ext"
• "/dir/subdir/filename.ext"
• "/new_dir/new_subdir/new_filename.ext"

For implementation details, see Transfer Scheduling via UDMG REST API.

External SFTP Server Authentication

Pipelines where UDMG acts as a client—more specifically, those that contain a Remote SFTP Server Endpoint—require credentials to authenticate with the external SFTP server.

Unlike Pipelines, where UDMG acts as the server and relies on Accounts to supply credentials, these Pipelines define credentials directly within the Pipeline configuration.

This design enables each Pipeline to manage its own client authentication credentials independently. As a result, each Pipeline can only authenticate with one external system and use one distinct Credential Type at a time.

Supported Authentication Methods

UDMG supports three authentication methods when connecting to external SFTP servers. The external SFTP server configuration determines the required authentication method and must be provided by the server administrator.

• Username and Password
• Username and Key
• Username, Password, and Key

info

Each Pipeline can only have one Credential Type associated with it at one time.

Transfer Scheduling via UDMG REST API

In a Local Filesystem to Remote SFTP Server Pipeline, each transfer must be explicitly scheduled through the UDMG REST API.

API Endpoint

POST /api/v1/domains/${UDMG_DOMAIN_NAME}/transfers/schedules

Request Body

The request body includes the following fields:

Key	Description	Format	Required
pipeline	Name of the Pipeline associated with the transfer.	Must match the Pipeline's Name field.	Yes
scheduled	Date and time at which the file transfer is scheduled to be initiated. If a past date is provided, the transfer is initiated during the next poll for pending transfers, based on the transfer.check_interval setting.	Must be in RFC 3339 format (2025-01-01T00:00:00Z).	Yes
source	Optional filename and extension (plus optional path) to the source file. For more information, refer to Understanding Paths.	"" (only if filename.ext is already specified in the Relative Path) "/filename.ext" "/dir/filename.ext" "/dir/subdir/filename.ext"	Yes, unless filename.ext is already specified in the Relative Path
destination	Optional filename and extension (plus optional path) to the destination file. Can be used for renaming files. For more information, refer to Understanding Paths.	"" (keeps the source filename and extension) "/new_filename.ext" "/dir/filename.ext" "/new_dir/new_filename.ext" "/dir/subdir/filename.ext" "/new_dir/new_subdir/new_filename.ext"	No

Request Example

The following curl command schedules a file transfer using the Transfers Schedules Endpoint:

curl http://<UDMG_HOST>/api/v1/domains/${UDMG_DOMAIN_NAME}/transfers/schedules \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline": "Pipeline_Push",
    "scheduled": "2026-07-03T15:43:52.344Z",
    "source": "/Form1000.dat",
    "destination": "/Received/Form1000.dat"
  }'

Response Example

{
    "scheduleId": 33,
    "pipeline": "Pipeline_Push",
    "username": "udmg.sys-admin",
    "source": "C:\\UDMG\\WorkDir\\primary\\rootfilepath\\relativepath\\Form1000.dat",
    "destination": "/Received/Form1000.dat",
    "schedule": "2026-07-03T15:43:52.344Z",
    "status": "Pending"
  }

Check Transfer Status

Note that the response from the API only indicates that the transfer has been successfully scheduled, not that it has been completed. The transfer's status will be "Pending" until it is executed, at which point the status will update to "Completed" or "Failed" based on the outcome of the transfer.

After a transfer is scheduled, you can check its status by doing a GET request to the Transfers Schedules Endpoint, which returns a list of all scheduled transfers along with their current status.

GET /api/v1/domains/${UDMG_DOMAIN_NAME}/transfers/schedules

Adding a Pipeline

To add a Local Filesystem to Remote SFTP Server Pipeline, follow these steps:

1. From the Sidebar, select Configuration > Pipelines.
2. Click Add Pipeline.
3. Complete the Name for the new Pipeline.
4. Select the Source Endpoint with a Local Filesystem Endpoint type.
5. Select the Destination Endpoint with a Remote SFTP Server Endpoint type.
6. Fill out the dynamic fields following the Field Descriptions table.
7. Click Add.

warning

UDMG does not allow for the creation of identical Pipelines (even with unique names). The Pipeline must pass the Source Endpoint + Destination Endpoint + Permissions + Virtual Path uniqueness check. See Pipelines for more information on Pipeline validation checks.

Field Descriptions

Name	Description	Specifications	Required
Name	Name of the Pipeline.	Must be unique. Must follow the Standard Naming Pattern. Cannot be modified after creation.	Yes
Description	Description for the Pipeline.		No
Source Endpoint	The Source Endpoint is where files are retrieved, originated, or come from. Allowable Source Endpoints are based on the available Pipeline combinations.	Must reference an already-created Local Filesystem Endpoint. Cannot be modified after creation.	Yes
Destination Endpoint	The Destination Endpoint is where files are delivered to or sent. Allowable Destination Endpoints are based on the available Pipeline combinations.	Must reference an already-created Remote SFTP Server Endpoint. Cannot be modified after creation.	Yes
Relative Path	The exact path where the file to be transferred exists on UDMG locally. The path is used to create a full path. For more information, refer to Understanding Paths.	Format: / /dir /dir/subdir The subdirectory and file name should not be included here if they are added within the source parameter.	Yes
Virtual Path	The path or 'Remote Server Path' where the file is to be transferred to on the external SFTP server. The Transfers Scheduled API destination parameter is appended to this path to create the full path. The path must exist on the external remote SFTP server. For more information, refer to Understanding Paths.	Format: / /dir /dir/subdir The subdirectory and file name should not be included here if they are added within the destination parameter.	Yes
Credentials Name	The client authentication Credentials used to authenticate to the external SFTP server.	Must reference an already-created Credential of type Username and Password, Username and Key, or Username, Password, and Key.	Yes
Universal Event	While this field is currently in the form, it's not used in the remote transfer configuration.		No

Editing a Pipeline

To edit a Local Filesystem to Remote SFTP Server Pipeline, follow these steps:

1. From the Sidebar, select Configuration > Pipelines.
2. Click the Name of the Pipeline you want to edit.
3. Click the Edit button above the Pipeline details.
4. Edit details for the Pipeline.
   • The Source Endpoint and Destination Endpoint cannot be changed after creation.
5. Click Update.

warning

Upon Pipeline update, UDMG checks for Endpoint Source + Endpoint Destination + Configuration + Virtual Path uniqueness.

Managing a Pipeline

All Pipelines support the ability to view the complete Pipeline and linked Endpoint details.

Viewing Pipeline Details

To view the details of a Local Filesystem to Remote SFTP Server Pipeline, follow these steps:

1. From the Sidebar, select Configuration > Pipelines.
2. Click the Name of the Pipeline you want to view.
3. Click the Overview Tab or Details Tab to see additional Pipeline and Endpoint details.

Pipeline Metadata

Pipeline details include all parameters given in the Field Descriptions table, plus the following read-only metadata:

Name	Description
UUID	Universally Unique Identifier of this Pipeline.
Version	Version number of the configuration. Every change increases the number.
Enabled	Pipeline's Enabled status. If enabled, field is set to True.
Created	Date and time this Pipeline was created.
Updated	Date and time this Pipeline was last updated.

Enabling and Disabling Pipelines

Pipelines can be Enabled or Disabled to control their active status and ability to participate in file transfers. The status is defaulted to Enabled and can be changed after creation. The Configuration Item's Disabled status does not impact whether it can be configured. Also, Disabled Endpoints can be added to a Pipeline.

• Enabled (default): The Pipeline is active and allows file transfers.
• Disabled: The Pipeline is inactive and does not allow file transfers.

To enable or disable a Pipeline, follow these steps:

1. From the Sidebar, select Configuration > Pipelines.
2. Click the Name of the Pipeline you want to enable or disable.
3. Click the Enable or Disable button above the Pipeline details.
4. If the Pipeline is Disabled, then the button displays Enabled. If the Pipeline is Enabled, then the button displays Disabled.
5. Click Update.

info

Changes to a Pipeline's Enabled/Disabled status take effect the next time the Transfers Scheduled API is triggered. Disabling a Pipeline is a safe alternative to deleting it.

Deleting a Pipeline

To delete a Local Filesystem to Remote SFTP Server Pipeline, follow these steps:

1. From the Sidebar, select Configuration > Pipelines.
2. Click the Name of the Pipeline you want to delete.
3. Click the Delete button above the Pipeline details.
4. You will be asked to confirm the deletion. Click Continue.

Monitoring a Pipeline

To monitor and determine the status of a Pipeline, the Transfers page and Endpoints page must be monitored to track incoming Transfers and the Source and Destination Endpoints' individual statuses, respectively.

On the Transfers page, the following fields indicate the type of Remote Transfer.

• Is Schedule: If Yes, then the Transfer was a Remote Transfer.
• Is Send: If Yes, then the Remote Transfer was a push scenario.