🔌Connections

Connections contain the details for communicating with an SFTP host. All connection details are encrypted.

Connection fields

• Name - A name to be displayed with the connection to identify it. The slug used when calling the API for the connection is derived from the name.

• Host - The address at which the target SFTP server is hosted.

• Port - The port at which the the SFTP is served.

• Username - The username of the user connecting to the SFTP server

• Credentials - either Password Based or Key Based

  • Password Based

    • Password - The password of the user connecting to the SFTP server

  • Key Based

    • Private Key - A file with key used to authenticate to the SFTP server

    • Pass Phrase - The pass phrase associated with the Private Key file

Connection management

Connections are managed in the connections section, accessible from the top navigation.

When a connection is created a slug is generated from it's name which is used as a component of the API endpoint path when making http requests to interact with the SFTP server.

An account may create many Connections. Connections may be removed. Upon removal any clients to SFTP over HTTP attempting to use that connection will fail.