Connection Syncs
Sync connection
Runs the object-store connection’s configured direction: imports every new object, or exports every redacted output not yet exported. File services use the picker import and per-file export instead. Returns the created sync; poll it for completion.
POST
/
workspaces
/
{workspaceId}
/
connections
/
{connectionId}
/
sync
Sync connection
curl --request POST \
--url https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/syncimport requests
url = "https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/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.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"attempt": 123,
"connectionId": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recordsSynced": 123,
"startedAt": "2023-11-07T05:31:56Z",
"status": "pending",
"triggerType": "on_demand",
"triggeredBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}Path Parameters
Response
A connection sync (import or export).
A connection sync (import or export).
Sync connection
curl --request POST \
--url https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/syncimport requests
url = "https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/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.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"attempt": 123,
"connectionId": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recordsSynced": 123,
"startedAt": "2023-11-07T05:31:56Z",
"status": "pending",
"triggerType": "on_demand",
"triggeredBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}