Sync an SFTP destination - Extole Documentation

Sync an SFTP destination

curl --request POST \
  --url https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync"

headers = {"Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync', 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://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "dropbox_path": "<string>",
  "extole_key_id": "<string>",
  "host": "<string>",
  "id": "<string>",
  "name": "<string>",
  "partner_key_id": "<string>",
  "port": 123,
  "type": "EXTERNAL",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "username": "<string>",
  "key_id": "<string>"
}

POST

/

v6

/

sftp-destinations

/

{sftpDestinationId}

/

sync

Sync an SFTP destination

curl --request POST \
  --url https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync"

headers = {"Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync', 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://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/sftp-destinations/{sftpDestinationId}/sync")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "dropbox_path": "<string>",
  "extole_key_id": "<string>",
  "host": "<string>",
  "id": "<string>",
  "name": "<string>",
  "partner_key_id": "<string>",
  "port": 123,
  "type": "EXTERNAL",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "username": "<string>",
  "key_id": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

sftpDestinationId

string

required

Response

Successful response

EXTERNAL
LOCAL

External sftp destination response.

created_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

dropbox_path

string

required

extole_key_id

string

required

host

string

required

id

string

required

name

string

required

partner_key_id

string

required

port

integer<int32>

required

type

enum<string>

required

Available options:

EXTERNAL

updated_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

username

string

required

key_id

string

required

Delete an SFTP destination Validate an SFTP destination