Create S3 Connector
curl --request POST \
--url https://api.example.com/v1/connectors/s3 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"credentials": {
"kind": "task_role"
},
"third_party_bucket_settings": {
"endpoint_url": "<string>",
"region": "<string>"
}
}
'import requests
url = "https://api.example.com/v1/connectors/s3"
payload = {
"name": "<string>",
"url": "<string>",
"credentials": { "kind": "task_role" },
"third_party_bucket_settings": {
"endpoint_url": "<string>",
"region": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
credentials: {kind: 'task_role'},
third_party_bucket_settings: {endpoint_url: '<string>', region: '<string>'}
})
};
fetch('https://api.example.com/v1/connectors/s3', 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/v1/connectors/s3",
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([
'name' => '<string>',
'url' => '<string>',
'credentials' => [
'kind' => 'task_role'
],
'third_party_bucket_settings' => [
'endpoint_url' => '<string>',
'region' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/connectors/s3"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"credentials\": {\n \"kind\": \"task_role\"\n },\n \"third_party_bucket_settings\": {\n \"endpoint_url\": \"<string>\",\n \"region\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.example.com/v1/connectors/s3")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"credentials\": {\n \"kind\": \"task_role\"\n },\n \"third_party_bucket_settings\": {\n \"endpoint_url\": \"<string>\",\n \"region\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/connectors/s3")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"credentials\": {\n \"kind\": \"task_role\"\n },\n \"third_party_bucket_settings\": {\n \"endpoint_url\": \"<string>\",\n \"region\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"short_id": "<string>",
"credential_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}connector
Create S3 Connector
Store an S3 connector (encrypted) for the caller’s org.
AWS S3 connectors use the customer-owned IAM role + ExternalId flow. S3-compatible connectors may still use the non-AWS credential variants. Credentials are never echoed back in the response.
POST
/
v1
/
connectors
/
s3
Create S3 Connector
curl --request POST \
--url https://api.example.com/v1/connectors/s3 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"credentials": {
"kind": "task_role"
},
"third_party_bucket_settings": {
"endpoint_url": "<string>",
"region": "<string>"
}
}
'import requests
url = "https://api.example.com/v1/connectors/s3"
payload = {
"name": "<string>",
"url": "<string>",
"credentials": { "kind": "task_role" },
"third_party_bucket_settings": {
"endpoint_url": "<string>",
"region": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
credentials: {kind: 'task_role'},
third_party_bucket_settings: {endpoint_url: '<string>', region: '<string>'}
})
};
fetch('https://api.example.com/v1/connectors/s3', 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/v1/connectors/s3",
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([
'name' => '<string>',
'url' => '<string>',
'credentials' => [
'kind' => 'task_role'
],
'third_party_bucket_settings' => [
'endpoint_url' => '<string>',
'region' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/connectors/s3"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"credentials\": {\n \"kind\": \"task_role\"\n },\n \"third_party_bucket_settings\": {\n \"endpoint_url\": \"<string>\",\n \"region\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.example.com/v1/connectors/s3")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"credentials\": {\n \"kind\": \"task_role\"\n },\n \"third_party_bucket_settings\": {\n \"endpoint_url\": \"<string>\",\n \"region\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/connectors/s3")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"credentials\": {\n \"kind\": \"task_role\"\n },\n \"third_party_bucket_settings\": {\n \"endpoint_url\": \"<string>\",\n \"region\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"short_id": "<string>",
"credential_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
An API key or OAuth2/OIDC access token sent as Authorization: Bearer <token>.
Body
application/json
Unique-per-org name for this connector entry.
Minimum string length:
1Minimum string length:
1- S3TaskRoleCredentials
- S3AssumeRoleCredentials
- S3ProfileCredentials
- S3StaticAccessKeyCredentials
- S3TemporarySessionAccessKeyCredentials
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I