Skip to main content

Add SFTP Artifact Servers

You can share files and folders on your network and use them for an SFTP Artifact Server connection.

In this topic:

Before You Begin

Visual Summary

Here's an example configuration of SFTP Artifact Source.

The SFTP dialog has the following fields.

Step 1: Select SFTP Artifact Server

To connect to an artifact server, do the following:

  1. Click Setup.
  2. Click Connectors.
  3. Click Artifact Servers.
  4. Click Add Artifact Server.
  5. In Type, click SFTP.

Step 2: Display Name

Enter a name for the SFTP Server. This is the name you will use to identify this connection when adding an Artifact Source to a Harness Service.

Step 3: SFTP URL

Ensure that the value contains the sftp:\\ scheme followed by the hostname or IP address. For example, sftp:\\

If you want to specify a folder in the URL, you can enter the folder using the \myFolder format, such as sftp:\\\myFolder. Typically, you will specify the folder when you use the SFTP Artifact Server as an Artifact Source for a Service.

Step 4: Domain

Enter the domain where the SFTP server is located.

Step 5: Username and Password

Use a user account that has permissions to access the SFTP server.

For secrets and other sensitive settings, select or create a new Harness Encrypted Text secret.

Usage Scope is determined by the secret you selected.

Click Submit.

Review: Adding SFTP Artifact Source in a Service

When you use the SFTP Artifact Server as an Artifact Source for a Service, you can specify a file or a folder for the artifact. This allows a folder to be copied to the deployment target host by the Harness Delegate. Here is the SFTP Artifact Source dialog:

In Artifact Path, you can specify a file or folder by name or using wildcards. The following are example for different files and folders:

  • todo-*zip - All matching files, such,
  • test/*zip - All zip files under test folder.
  • test/1* - All folders under test folder starting with 1.
  • test/* - All folders under test folder.