sftp-credentials
Create SFTP credentials
Creates an SFTP credential configuration for connecting Dromo to an SFTP server.
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-----"
}
'import requests
url = "https://app.dromo.io/api/v1/headless/sftp/credentials/"
payload = {
"hostname": "sftp.example.com",
"port": 22,
"user": "sftpuser",
"auth_type": "PASSWORD",
"password": "secure-password-123",
"private_key": "-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
...
-----END OPENSSH PRIVATE KEY-----"
}
headers = {
"X-Dromo-License-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Dromo-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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-----'
})
};
fetch('https://app.dromo.io/api/v1/headless/sftp/credentials/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.dromo.io/api/v1/headless/sftp/credentials/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'hostname' => 'sftp.example.com',
'port' => 22,
'user' => 'sftpuser',
'auth_type' => 'PASSWORD',
'password' => 'secure-password-123',
'private_key' => '-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
...
-----END OPENSSH PRIVATE KEY-----'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Dromo-License-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.dromo.io/api/v1/headless/sftp/credentials/"
payload := strings.NewReader("{\n \"hostname\": \"sftp.example.com\",\n \"port\": 22,\n \"user\": \"sftpuser\",\n \"auth_type\": \"PASSWORD\",\n \"password\": \"secure-password-123\",\n \"private_key\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\\n...\\n-----END OPENSSH PRIVATE KEY-----\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dromo-License-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.dromo.io/api/v1/headless/sftp/credentials/")
.header("X-Dromo-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"hostname\": \"sftp.example.com\",\n \"port\": 22,\n \"user\": \"sftpuser\",\n \"auth_type\": \"PASSWORD\",\n \"password\": \"secure-password-123\",\n \"private_key\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\\n...\\n-----END OPENSSH PRIVATE KEY-----\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dromo.io/api/v1/headless/sftp/credentials/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Dromo-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"hostname\": \"sftp.example.com\",\n \"port\": 22,\n \"user\": \"sftpuser\",\n \"auth_type\": \"PASSWORD\",\n \"password\": \"secure-password-123\",\n \"private_key\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\\n...\\n-----END OPENSSH PRIVATE KEY-----\"\n}"
response = http.request(request)
puts response.read_body{
"hostname": "sftp.example.com",
"port": 22,
"user": "sftpuser",
"auth_type": "PASSWORD",
"id": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"key_fingerprint": "SHA256:abc123..."
}{
"detail": "Must supply password for password auth"
}Authorizations
This backend API key is different than your frontend license key. Please use the "Backend" license key from your Dromo Dashboard.
Body
application/json
Example:
"sftp.example.com"
Example:
22
Example:
"sftpuser"
Available options:
PASSWORD, KEY Example:
"PASSWORD"
Required when auth_type is PASSWORD
Example:
"secure-password-123"
Required when auth_type is KEY (OpenSSH format)
Example:
"-----BEGIN OPENSSH PRIVATE KEY-----\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\n...\n-----END OPENSSH PRIVATE KEY-----"
Response
SFTP credentials created
Example:
"sftp.example.com"
Example:
22
Example:
"sftpuser"
Available options:
PASSWORD, KEY Example:
"PASSWORD"
Example:
"ee5d0e45-b098-47bc-8217-e93790243dfa"
Example:
"SHA256:abc123..."
Previous
Retrieve SFTP credentialsReturns one SFTP credential configuration by ID without exposing secret credential values.
Next
⌘I
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-----"
}
'import requests
url = "https://app.dromo.io/api/v1/headless/sftp/credentials/"
payload = {
"hostname": "sftp.example.com",
"port": 22,
"user": "sftpuser",
"auth_type": "PASSWORD",
"password": "secure-password-123",
"private_key": "-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
...
-----END OPENSSH PRIVATE KEY-----"
}
headers = {
"X-Dromo-License-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Dromo-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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-----'
})
};
fetch('https://app.dromo.io/api/v1/headless/sftp/credentials/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.dromo.io/api/v1/headless/sftp/credentials/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'hostname' => 'sftp.example.com',
'port' => 22,
'user' => 'sftpuser',
'auth_type' => 'PASSWORD',
'password' => 'secure-password-123',
'private_key' => '-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
...
-----END OPENSSH PRIVATE KEY-----'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Dromo-License-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.dromo.io/api/v1/headless/sftp/credentials/"
payload := strings.NewReader("{\n \"hostname\": \"sftp.example.com\",\n \"port\": 22,\n \"user\": \"sftpuser\",\n \"auth_type\": \"PASSWORD\",\n \"password\": \"secure-password-123\",\n \"private_key\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\\n...\\n-----END OPENSSH PRIVATE KEY-----\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dromo-License-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.dromo.io/api/v1/headless/sftp/credentials/")
.header("X-Dromo-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"hostname\": \"sftp.example.com\",\n \"port\": 22,\n \"user\": \"sftpuser\",\n \"auth_type\": \"PASSWORD\",\n \"password\": \"secure-password-123\",\n \"private_key\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\\n...\\n-----END OPENSSH PRIVATE KEY-----\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dromo.io/api/v1/headless/sftp/credentials/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Dromo-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"hostname\": \"sftp.example.com\",\n \"port\": 22,\n \"user\": \"sftpuser\",\n \"auth_type\": \"PASSWORD\",\n \"password\": \"secure-password-123\",\n \"private_key\": \"-----BEGIN OPENSSH PRIVATE KEY-----\\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\\n...\\n-----END OPENSSH PRIVATE KEY-----\"\n}"
response = http.request(request)
puts response.read_body{
"hostname": "sftp.example.com",
"port": 22,
"user": "sftpuser",
"auth_type": "PASSWORD",
"id": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"key_fingerprint": "SHA256:abc123..."
}{
"detail": "Must supply password for password auth"
}