Update SFTP connector
Updates an existing automated SFTP connector identified by ID.
curl --request PUT \
--url https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-Dromo-License-Key: <api-key>' \
--data '
{
"credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"schedule": {
"type": "every_n_minutes",
"minutes": 15
},
"directory": "/uploads",
"file_regex": ".*\\.csv$"
}
'import requests
url = "https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/"
payload = {
"credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"schedule": {
"type": "every_n_minutes",
"minutes": 15
},
"directory": "/uploads",
"file_regex": ".*\.csv$"
}
headers = {
"X-Dromo-License-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Dromo-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credentials: 'ee5d0e45-b098-47bc-8217-e93790243dfa',
schema: 'f9e8d7c6-b5a4-3210-9876-543210fedcba',
schedule: {type: 'every_n_minutes', minutes: 15},
directory: '/uploads',
file_regex: '.*\.csv$'
})
};
fetch('https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/', 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/connectors/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => 'ee5d0e45-b098-47bc-8217-e93790243dfa',
'schema' => 'f9e8d7c6-b5a4-3210-9876-543210fedcba',
'schedule' => [
'type' => 'every_n_minutes',
'minutes' => 15
],
'directory' => '/uploads',
'file_regex' => '.*\\.csv$'
]),
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/connectors/{id}/"
payload := strings.NewReader("{\n \"credentials\": \"ee5d0e45-b098-47bc-8217-e93790243dfa\",\n \"schema\": \"f9e8d7c6-b5a4-3210-9876-543210fedcba\",\n \"schedule\": {\n \"type\": \"every_n_minutes\",\n \"minutes\": 15\n },\n \"directory\": \"/uploads\",\n \"file_regex\": \".*\\\\.csv$\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/")
.header("X-Dromo-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": \"ee5d0e45-b098-47bc-8217-e93790243dfa\",\n \"schema\": \"f9e8d7c6-b5a4-3210-9876-543210fedcba\",\n \"schedule\": {\n \"type\": \"every_n_minutes\",\n \"minutes\": 15\n },\n \"directory\": \"/uploads\",\n \"file_regex\": \".*\\\\.csv$\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Dromo-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": \"ee5d0e45-b098-47bc-8217-e93790243dfa\",\n \"schema\": \"f9e8d7c6-b5a4-3210-9876-543210fedcba\",\n \"schedule\": {\n \"type\": \"every_n_minutes\",\n \"minutes\": 15\n },\n \"directory\": \"/uploads\",\n \"file_regex\": \".*\\\\.csv$\"\n}"
response = http.request(request)
puts response.read_body{
"credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"schedule": {
"type": "every_n_minutes",
"minutes": 15
},
"directory": "/uploads",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"file_regex": ".*\\.csv$"
}Authorizations
This backend API key is different than your frontend license key. Please use the "Backend" license key from your Dromo Dashboard.
Path Parameters
SFTP connector ID
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Body
ID of SFTP credentials to use
"ee5d0e45-b098-47bc-8217-e93790243dfa"
ID of import schema to use
"f9e8d7c6-b5a4-3210-9876-543210fedcba"
- Option 1
- Option 2
Show child attributes
Show child attributes
SFTP directory to monitor
"/uploads"
Optional regex pattern to filter files (null accepts all files)
".*\\.csv$"
Response
SFTP connector updated
ID of SFTP credentials to use
"ee5d0e45-b098-47bc-8217-e93790243dfa"
ID of import schema to use
"f9e8d7c6-b5a4-3210-9876-543210fedcba"
- Option 1
- Option 2
Show child attributes
Show child attributes
SFTP directory to monitor
"/uploads"
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Optional regex pattern to filter files (null accepts all files)
".*\\.csv$"
curl --request PUT \
--url https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-Dromo-License-Key: <api-key>' \
--data '
{
"credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"schedule": {
"type": "every_n_minutes",
"minutes": 15
},
"directory": "/uploads",
"file_regex": ".*\\.csv$"
}
'import requests
url = "https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/"
payload = {
"credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"schedule": {
"type": "every_n_minutes",
"minutes": 15
},
"directory": "/uploads",
"file_regex": ".*\.csv$"
}
headers = {
"X-Dromo-License-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Dromo-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credentials: 'ee5d0e45-b098-47bc-8217-e93790243dfa',
schema: 'f9e8d7c6-b5a4-3210-9876-543210fedcba',
schedule: {type: 'every_n_minutes', minutes: 15},
directory: '/uploads',
file_regex: '.*\.csv$'
})
};
fetch('https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/', 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/connectors/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => 'ee5d0e45-b098-47bc-8217-e93790243dfa',
'schema' => 'f9e8d7c6-b5a4-3210-9876-543210fedcba',
'schedule' => [
'type' => 'every_n_minutes',
'minutes' => 15
],
'directory' => '/uploads',
'file_regex' => '.*\\.csv$'
]),
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/connectors/{id}/"
payload := strings.NewReader("{\n \"credentials\": \"ee5d0e45-b098-47bc-8217-e93790243dfa\",\n \"schema\": \"f9e8d7c6-b5a4-3210-9876-543210fedcba\",\n \"schedule\": {\n \"type\": \"every_n_minutes\",\n \"minutes\": 15\n },\n \"directory\": \"/uploads\",\n \"file_regex\": \".*\\\\.csv$\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/")
.header("X-Dromo-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": \"ee5d0e45-b098-47bc-8217-e93790243dfa\",\n \"schema\": \"f9e8d7c6-b5a4-3210-9876-543210fedcba\",\n \"schedule\": {\n \"type\": \"every_n_minutes\",\n \"minutes\": 15\n },\n \"directory\": \"/uploads\",\n \"file_regex\": \".*\\\\.csv$\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dromo.io/api/v1/headless/sftp/connectors/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Dromo-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": \"ee5d0e45-b098-47bc-8217-e93790243dfa\",\n \"schema\": \"f9e8d7c6-b5a4-3210-9876-543210fedcba\",\n \"schedule\": {\n \"type\": \"every_n_minutes\",\n \"minutes\": 15\n },\n \"directory\": \"/uploads\",\n \"file_regex\": \".*\\\\.csv$\"\n}"
response = http.request(request)
puts response.read_body{
"credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
"schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
"schedule": {
"type": "every_n_minutes",
"minutes": 15
},
"directory": "/uploads",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"file_regex": ".*\\.csv$"
}