Skip to main content
POST
/
headless
/
sftp
/
credentials
Create SFTP credentials
curl --request POST \
  --url https://app.dromo.io/api/v1/headless/sftp/credentials/ \
  --header 'Content-Type: application/json' \
  --header 'X-Dromo-License-Key: <api-key>' \
  --data '
{
  "hostname": "sftp.example.com",
  "port": 22,
  "user": "sftpuser",
  "auth_type": "PASSWORD",
  "password": "secure-password-123",
  "private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\n...\n-----END OPENSSH PRIVATE KEY-----"
}
'
{
  "hostname": "sftp.example.com",
  "port": 22,
  "user": "sftpuser",
  "auth_type": "PASSWORD",
  "id": "ee5d0e45-b098-47bc-8217-e93790243dfa",
  "key_fingerprint": "SHA256:abc123..."
}

Authorizations

​
X-Dromo-License-Key
string
header
required

This backend API key is different than your frontend license key. Please use the "Backend" license key from your Dromo Dashboard.

Body

application/json
​
hostname
string
required
Example:

"sftp.example.com"

​
port
integer
required
Example:

22

​
user
string
required
Example:

"sftpuser"

​
auth_type
enum<string>
required
Available options:
PASSWORD,
KEY
Example:

"PASSWORD"

​
password
string

Required when auth_type is PASSWORD

Example:

"secure-password-123"

​
private_key
string

Required when auth_type is KEY (OpenSSH format)

Example:

"-----BEGIN OPENSSH PRIVATE KEY-----\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\n...\n-----END OPENSSH PRIVATE KEY-----"

Response

SFTP credentials created

​
hostname
string
required
Example:

"sftp.example.com"

​
port
integer
required
Example:

22

​
user
string
required
Example:

"sftpuser"

​
auth_type
enum<string>
required
Available options:
PASSWORD,
KEY
Example:

"PASSWORD"

​
id
string<uuid>
read-only
Example:

"ee5d0e45-b098-47bc-8217-e93790243dfa"

​
key_fingerprint
string | null
read-only
Example:

"SHA256:abc123..."