CreateIntegration
curl --request POST \
--url https://developer.synq.io/api/integrations/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"config": {
"athena": {
"accessKey": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
},
"region": "<string>",
"workgroup": "<string>",
"useShowCreateTable": true,
"useShowCreateView": true,
"fetchQueryLogs": true,
"useIcebergMetricsScan": true,
"scope": {
"include": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
],
"exclude": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
]
}
}
}
}
'import requests
url = "https://developer.synq.io/api/integrations/v1"
payload = {
"title": "<string>",
"config": { "athena": {
"accessKey": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
},
"region": "<string>",
"workgroup": "<string>",
"useShowCreateTable": True,
"useShowCreateView": True,
"fetchQueryLogs": True,
"useIcebergMetricsScan": True,
"scope": {
"include": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
],
"exclude": [
{
"database": "<string>",
"schema": "<string>",
"table": "<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({
title: '<string>',
config: {
athena: {
accessKey: {accessKeyId: '<string>', secretAccessKey: '<string>'},
region: '<string>',
workgroup: '<string>',
useShowCreateTable: true,
useShowCreateView: true,
fetchQueryLogs: true,
useIcebergMetricsScan: true,
scope: {
include: [{database: '<string>', schema: '<string>', table: '<string>'}],
exclude: [{database: '<string>', schema: '<string>', table: '<string>'}]
}
}
}
})
};
fetch('https://developer.synq.io/api/integrations/v1', 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://developer.synq.io/api/integrations/v1",
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([
'title' => '<string>',
'config' => [
'athena' => [
'accessKey' => [
'accessKeyId' => '<string>',
'secretAccessKey' => '<string>'
],
'region' => '<string>',
'workgroup' => '<string>',
'useShowCreateTable' => true,
'useShowCreateView' => true,
'fetchQueryLogs' => true,
'useIcebergMetricsScan' => true,
'scope' => [
'include' => [
[
'database' => '<string>',
'schema' => '<string>',
'table' => '<string>'
]
],
'exclude' => [
[
'database' => '<string>',
'schema' => '<string>',
'table' => '<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://developer.synq.io/api/integrations/v1"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"config\": {\n \"athena\": {\n \"accessKey\": {\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n },\n \"region\": \"<string>\",\n \"workgroup\": \"<string>\",\n \"useShowCreateTable\": true,\n \"useShowCreateView\": true,\n \"fetchQueryLogs\": true,\n \"useIcebergMetricsScan\": true,\n \"scope\": {\n \"include\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ]\n }\n }\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://developer.synq.io/api/integrations/v1")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"config\": {\n \"athena\": {\n \"accessKey\": {\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n },\n \"region\": \"<string>\",\n \"workgroup\": \"<string>\",\n \"useShowCreateTable\": true,\n \"useShowCreateView\": true,\n \"fetchQueryLogs\": true,\n \"useIcebergMetricsScan\": true,\n \"scope\": {\n \"include\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ]\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/integrations/v1")
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 \"title\": \"<string>\",\n \"config\": {\n \"athena\": {\n \"accessKey\": {\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n },\n \"region\": \"<string>\",\n \"workgroup\": \"<string>\",\n \"useShowCreateTable\": true,\n \"useShowCreateView\": true,\n \"fetchQueryLogs\": true,\n \"useIcebergMetricsScan\": true,\n \"scope\": {\n \"include\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ]\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"integration": {
"id": "<string>",
"title": "<string>",
"disabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"etag": "<string>",
"config": {
"athena": {
"accessKey": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
},
"region": "<string>",
"workgroup": "<string>",
"useShowCreateTable": true,
"useShowCreateView": true,
"fetchQueryLogs": true,
"useIcebergMetricsScan": true,
"scope": {
"include": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
],
"exclude": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
]
}
}
},
"outputs": {
"athena": {
"accountId": "<string>",
"principalArn": "<string>"
}
},
"capabilities": {
"canPatch": true,
"canRefresh": true,
"canDisable": true,
"canEnable": true,
"canDelete": true,
"isDwh": true,
"canReconcileDeploy": true
}
}
}synq.integrations.v1.IntegrationsService
CreateIntegration
Create a new integration. The server assigns the id and returns the created integration including any generated outputs.
The integration type is fixed by the populated config variant and cannot
be changed later. Counts against the per-workspace quota.
Not safe to blindly retry: the server mints a new id on each call, so a retried create produces a second integration. On a transport error, list / look up before retrying.
POST
/
api
/
integrations
/
v1
CreateIntegration
curl --request POST \
--url https://developer.synq.io/api/integrations/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"config": {
"athena": {
"accessKey": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
},
"region": "<string>",
"workgroup": "<string>",
"useShowCreateTable": true,
"useShowCreateView": true,
"fetchQueryLogs": true,
"useIcebergMetricsScan": true,
"scope": {
"include": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
],
"exclude": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
]
}
}
}
}
'import requests
url = "https://developer.synq.io/api/integrations/v1"
payload = {
"title": "<string>",
"config": { "athena": {
"accessKey": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
},
"region": "<string>",
"workgroup": "<string>",
"useShowCreateTable": True,
"useShowCreateView": True,
"fetchQueryLogs": True,
"useIcebergMetricsScan": True,
"scope": {
"include": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
],
"exclude": [
{
"database": "<string>",
"schema": "<string>",
"table": "<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({
title: '<string>',
config: {
athena: {
accessKey: {accessKeyId: '<string>', secretAccessKey: '<string>'},
region: '<string>',
workgroup: '<string>',
useShowCreateTable: true,
useShowCreateView: true,
fetchQueryLogs: true,
useIcebergMetricsScan: true,
scope: {
include: [{database: '<string>', schema: '<string>', table: '<string>'}],
exclude: [{database: '<string>', schema: '<string>', table: '<string>'}]
}
}
}
})
};
fetch('https://developer.synq.io/api/integrations/v1', 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://developer.synq.io/api/integrations/v1",
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([
'title' => '<string>',
'config' => [
'athena' => [
'accessKey' => [
'accessKeyId' => '<string>',
'secretAccessKey' => '<string>'
],
'region' => '<string>',
'workgroup' => '<string>',
'useShowCreateTable' => true,
'useShowCreateView' => true,
'fetchQueryLogs' => true,
'useIcebergMetricsScan' => true,
'scope' => [
'include' => [
[
'database' => '<string>',
'schema' => '<string>',
'table' => '<string>'
]
],
'exclude' => [
[
'database' => '<string>',
'schema' => '<string>',
'table' => '<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://developer.synq.io/api/integrations/v1"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"config\": {\n \"athena\": {\n \"accessKey\": {\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n },\n \"region\": \"<string>\",\n \"workgroup\": \"<string>\",\n \"useShowCreateTable\": true,\n \"useShowCreateView\": true,\n \"fetchQueryLogs\": true,\n \"useIcebergMetricsScan\": true,\n \"scope\": {\n \"include\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ]\n }\n }\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://developer.synq.io/api/integrations/v1")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"config\": {\n \"athena\": {\n \"accessKey\": {\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n },\n \"region\": \"<string>\",\n \"workgroup\": \"<string>\",\n \"useShowCreateTable\": true,\n \"useShowCreateView\": true,\n \"fetchQueryLogs\": true,\n \"useIcebergMetricsScan\": true,\n \"scope\": {\n \"include\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ]\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/integrations/v1")
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 \"title\": \"<string>\",\n \"config\": {\n \"athena\": {\n \"accessKey\": {\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n },\n \"region\": \"<string>\",\n \"workgroup\": \"<string>\",\n \"useShowCreateTable\": true,\n \"useShowCreateView\": true,\n \"fetchQueryLogs\": true,\n \"useIcebergMetricsScan\": true,\n \"scope\": {\n \"include\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"table\": \"<string>\"\n }\n ]\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"integration": {
"id": "<string>",
"title": "<string>",
"disabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"etag": "<string>",
"config": {
"athena": {
"accessKey": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
},
"region": "<string>",
"workgroup": "<string>",
"useShowCreateTable": true,
"useShowCreateView": true,
"fetchQueryLogs": true,
"useIcebergMetricsScan": true,
"scope": {
"include": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
],
"exclude": [
{
"database": "<string>",
"schema": "<string>",
"table": "<string>"
}
]
}
}
},
"outputs": {
"athena": {
"accountId": "<string>",
"principalArn": "<string>"
}
},
"capabilities": {
"canPatch": true,
"canRefresh": true,
"canDisable": true,
"canEnable": true,
"canDelete": true,
"isDwh": true,
"canReconcileDeploy": true
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Request to create an integration.
Human-friendly name for the integration.
Required string length:
1 - 255Connection configuration. Exactly one config variant must be set; it fixes
the integration's type.
- athena
- bigquery
- clickhouse
- databricks
- dbt_cloud
- duckdb
- fabric
- mssql
- mysql
- oracle
- postgres
- redshift
- snowflake
- trino
Show child attributes
Show child attributes
Response
200 - application/json
Success
Response from creating an integration.
The created integration, including its assigned id, etag, and any generated outputs.
Show child attributes
Show child attributes
⌘I