Skip to main content
GET
Get connection

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Response

Connection

An SFTP / Email / API endpoint with its credentials. Canonical name as of API version 2026-05-25 (formerly Client). Credentials (sftpPassword / sftpPrivateKey / sftpPassphrase / awsPassword) are write-only and never returned in responses.

id
string
required
name
string
required
type
enum<string>
required

Connection kind. Always present as of API version 2026-05-25.

Available options:
SFTP,
EMAIL
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
sftpUsername
string
useHostedSFTP
boolean
awsUserName
string

Server-generated SFTP username slug for a FileFeed-hosted connection. (Outbound uploads reference a connection by its human-readable name, not this slug.)

awsPublicKey
string
ipWhitelist
string[]
sftpServerDataId
string
sftpServer
object

The SFTP server a connection is bound to. For a self-hosted connection, host/port/rootDirectory describe the customer endpoint FileFeed dials out to; for a hosted connection, the FileFeed-managed AWS Transfer server.

emailInbox
object

Resolved inbox config for an EMAIL connection. Returned on Connection.emailInbox, present only when type = EMAIL.