Connections
Update connection
Updates connection name or encrypted data.
PATCH
/
workspaces
/
{workspaceId}
/
connections
/
{connectionId}
Update connection
curl --request PATCH \
--url https://api.example.com/workspaces/{workspaceId}/connections/{connectionId} \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"credentials": {
"bucket": "<string>",
"accessKeyId": "<string>",
"endpoint": "<string>",
"region": "us-east-1",
"secretAccessKey": "<string>",
"sessionToken": "<string>"
},
"provider": "s3",
"rootPath": "<string>"
},
"displayName": "<string>",
"isActive": true
}
'import requests
url = "https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}"
payload = {
"config": {
"credentials": {
"bucket": "<string>",
"accessKeyId": "<string>",
"endpoint": "<string>",
"region": "us-east-1",
"secretAccessKey": "<string>",
"sessionToken": "<string>"
},
"provider": "s3",
"rootPath": "<string>"
},
"displayName": "<string>",
"isActive": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
credentials: {
bucket: '<string>',
accessKeyId: '<string>',
endpoint: '<string>',
region: 'us-east-1',
secretAccessKey: '<string>',
sessionToken: '<string>'
},
provider: 's3',
rootPath: '<string>'
},
displayName: '<string>',
isActive: true
})
};
fetch('https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'config' => [
'credentials' => [
'bucket' => '<string>',
'accessKeyId' => '<string>',
'endpoint' => '<string>',
'region' => 'us-east-1',
'secretAccessKey' => '<string>',
'sessionToken' => '<string>'
],
'provider' => 's3',
'rootPath' => '<string>'
],
'displayName' => '<string>',
'isActive' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://api.example.com/workspaces/{workspaceId}/connections/{connectionId}"
payload := strings.NewReader("{\n \"config\": {\n \"credentials\": {\n \"bucket\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"us-east-1\",\n \"secretAccessKey\": \"<string>\",\n \"sessionToken\": \"<string>\"\n },\n \"provider\": \"s3\",\n \"rootPath\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"isActive\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"credentials\": {\n \"bucket\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"us-east-1\",\n \"secretAccessKey\": \"<string>\",\n \"sessionToken\": \"<string>\"\n },\n \"provider\": \"s3\",\n \"rootPath\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"credentials\": {\n \"bucket\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"us-east-1\",\n \"secretAccessKey\": \"<string>\",\n \"sessionToken\": \"<string>\"\n },\n \"provider\": \"s3\",\n \"rootPath\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_body{
"connectionType": "object_store",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"displayName": "<string>",
"id": "<string>",
"isActive": true,
"provider": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"workspaceHandle": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastSyncedAt": "2023-11-07T05:31:56Z",
"sync": {
"deletionPolicy": "ignore",
"syncMode": "import",
"scheduleCron": "<string>"
}
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}<string><string>Path Parameters
Workspace identifier.
Opaque identifier of the connection.
Pattern:
^conn_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Body
application/json
Request payload for updating an existing workspace connection.
Request payload for updating an existing workspace connection.
Typed provider configuration. If provided, fully replaces the stored config (and, with it, the provider). Omit to leave it unchanged.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Human-readable connection display name.
Required string length:
1 - 255Whether the connection is enabled. false disables it (pausing scheduled
syncs and rejecting manual ones); omit to leave unchanged.
Scheduled-sync configuration. Accepted only for schedulable providers (object stores); rejected for others. Omit to leave unchanged.
Show child attributes
Show child attributes
Response
Response type for a workspace connection.
Note: The encrypted connection data is never exposed in API responses. Only metadata about the connection is returned.
Response type for a workspace connection.
Note: The encrypted connection data is never exposed in API responses. Only metadata about the connection is returned.
Capability category of the connection (object store, file service).
Allowed value:
"object_store"When the connection was created.
Account that created this connection.
Show child attributes
Show child attributes
Human-readable connection display name.
Opaque identifier of the connection.
Pattern:
^conn_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Whether the connection is enabled.
Provider identifier (s3, azure, gcs, google_drive, dropbox, ...).
When the connection was last updated.
URL-safe workspace handle. Display-only.
Required string length:
3 - 32Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Unique identifier of the workspace.
When the connection last synced successfully, if ever. Independent of
sync: a connection with no schedule still records its on-demand syncs.
Scheduled-sync configuration; present only for connections that sync on a timer. Its absence does not mean the connection cannot sync — a file service and an unscheduled object store both transfer on demand.
Show child attributes
Show child attributes
Update connection
curl --request PATCH \
--url https://api.example.com/workspaces/{workspaceId}/connections/{connectionId} \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"credentials": {
"bucket": "<string>",
"accessKeyId": "<string>",
"endpoint": "<string>",
"region": "us-east-1",
"secretAccessKey": "<string>",
"sessionToken": "<string>"
},
"provider": "s3",
"rootPath": "<string>"
},
"displayName": "<string>",
"isActive": true
}
'import requests
url = "https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}"
payload = {
"config": {
"credentials": {
"bucket": "<string>",
"accessKeyId": "<string>",
"endpoint": "<string>",
"region": "us-east-1",
"secretAccessKey": "<string>",
"sessionToken": "<string>"
},
"provider": "s3",
"rootPath": "<string>"
},
"displayName": "<string>",
"isActive": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
credentials: {
bucket: '<string>',
accessKeyId: '<string>',
endpoint: '<string>',
region: 'us-east-1',
secretAccessKey: '<string>',
sessionToken: '<string>'
},
provider: 's3',
rootPath: '<string>'
},
displayName: '<string>',
isActive: true
})
};
fetch('https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'config' => [
'credentials' => [
'bucket' => '<string>',
'accessKeyId' => '<string>',
'endpoint' => '<string>',
'region' => 'us-east-1',
'secretAccessKey' => '<string>',
'sessionToken' => '<string>'
],
'provider' => 's3',
'rootPath' => '<string>'
],
'displayName' => '<string>',
'isActive' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://api.example.com/workspaces/{workspaceId}/connections/{connectionId}"
payload := strings.NewReader("{\n \"config\": {\n \"credentials\": {\n \"bucket\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"us-east-1\",\n \"secretAccessKey\": \"<string>\",\n \"sessionToken\": \"<string>\"\n },\n \"provider\": \"s3\",\n \"rootPath\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"isActive\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"credentials\": {\n \"bucket\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"us-east-1\",\n \"secretAccessKey\": \"<string>\",\n \"sessionToken\": \"<string>\"\n },\n \"provider\": \"s3\",\n \"rootPath\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/connections/{connectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"credentials\": {\n \"bucket\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"us-east-1\",\n \"secretAccessKey\": \"<string>\",\n \"sessionToken\": \"<string>\"\n },\n \"provider\": \"s3\",\n \"rootPath\": \"<string>\"\n },\n \"displayName\": \"<string>\",\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_body{
"connectionType": "object_store",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"displayName": "<string>",
"id": "<string>",
"isActive": true,
"provider": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"workspaceHandle": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastSyncedAt": "2023-11-07T05:31:56Z",
"sync": {
"deletionPolicy": "ignore",
"syncMode": "import",
"scheduleCron": "<string>"
}
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}<string><string>