Update a data source
curl --request PATCH \
--url https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"snowflakeAccountId": "<string>",
"snowflakeWarehouse": "<string>",
"snowflakeRole": "<string>",
"snowflakePrivateKey": "<string>",
"snowflakePrivateKeyPassphrase": "<string>",
"databaseName": null,
"username": "<string>",
"host": "<string>",
"port": 32767,
"bigQueryProjectId": "<string>",
"spannerInstanceId": "<string>",
"athenaWorkgroup": "<string>",
"athenaOutputLocation": "<string>",
"athenaCatalog": "<string>",
"sslEnabled": false,
"sslVerifyServerCertificate": true,
"sslCaCertificate": "<string>",
"sshEnabled": false,
"sshHost": "<string>",
"sshPort": 32767,
"sshUsername": "<string>",
"sshPassword": "<string>",
"sshPrivateKey": "<string>",
"sshPrivateKeyPassphrase": "<string>",
"maxPoolSize": 50,
"unsetPassword": true,
"password": "<string>",
"unsetSshPassword": true,
"unsetSshPrivateKey": true,
"unsetSshPrivateKeyPassphrase": true,
"bigQueryJsonKey": "<string>"
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}"
payload = {
"snowflakeAccountId": "<string>",
"snowflakeWarehouse": "<string>",
"snowflakeRole": "<string>",
"snowflakePrivateKey": "<string>",
"snowflakePrivateKeyPassphrase": "<string>",
"databaseName": None,
"username": "<string>",
"host": "<string>",
"port": 32767,
"bigQueryProjectId": "<string>",
"spannerInstanceId": "<string>",
"athenaWorkgroup": "<string>",
"athenaOutputLocation": "<string>",
"athenaCatalog": "<string>",
"sslEnabled": False,
"sslVerifyServerCertificate": True,
"sslCaCertificate": "<string>",
"sshEnabled": False,
"sshHost": "<string>",
"sshPort": 32767,
"sshUsername": "<string>",
"sshPassword": "<string>",
"sshPrivateKey": "<string>",
"sshPrivateKeyPassphrase": "<string>",
"maxPoolSize": 50,
"unsetPassword": True,
"password": "<string>",
"unsetSshPassword": True,
"unsetSshPrivateKey": True,
"unsetSshPrivateKeyPassphrase": True,
"bigQueryJsonKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
snowflakeAccountId: '<string>',
snowflakeWarehouse: '<string>',
snowflakeRole: '<string>',
snowflakePrivateKey: '<string>',
snowflakePrivateKeyPassphrase: '<string>',
databaseName: null,
username: '<string>',
host: '<string>',
port: 32767,
bigQueryProjectId: '<string>',
spannerInstanceId: '<string>',
athenaWorkgroup: '<string>',
athenaOutputLocation: '<string>',
athenaCatalog: '<string>',
sslEnabled: false,
sslVerifyServerCertificate: true,
sslCaCertificate: '<string>',
sshEnabled: false,
sshHost: '<string>',
sshPort: 32767,
sshUsername: '<string>',
sshPassword: '<string>',
sshPrivateKey: '<string>',
sshPrivateKeyPassphrase: '<string>',
maxPoolSize: 50,
unsetPassword: true,
password: '<string>',
unsetSshPassword: true,
unsetSshPrivateKey: true,
unsetSshPrivateKeyPassphrase: true,
bigQueryJsonKey: '<string>'
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}', 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://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}",
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([
'snowflakeAccountId' => '<string>',
'snowflakeWarehouse' => '<string>',
'snowflakeRole' => '<string>',
'snowflakePrivateKey' => '<string>',
'snowflakePrivateKeyPassphrase' => '<string>',
'databaseName' => null,
'username' => '<string>',
'host' => '<string>',
'port' => 32767,
'bigQueryProjectId' => '<string>',
'spannerInstanceId' => '<string>',
'athenaWorkgroup' => '<string>',
'athenaOutputLocation' => '<string>',
'athenaCatalog' => '<string>',
'sslEnabled' => false,
'sslVerifyServerCertificate' => true,
'sslCaCertificate' => '<string>',
'sshEnabled' => false,
'sshHost' => '<string>',
'sshPort' => 32767,
'sshUsername' => '<string>',
'sshPassword' => '<string>',
'sshPrivateKey' => '<string>',
'sshPrivateKeyPassphrase' => '<string>',
'maxPoolSize' => 50,
'unsetPassword' => true,
'password' => '<string>',
'unsetSshPassword' => true,
'unsetSshPrivateKey' => true,
'unsetSshPrivateKeyPassphrase' => true,
'bigQueryJsonKey' => '<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://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}"
payload := strings.NewReader("{\n \"snowflakeAccountId\": \"<string>\",\n \"snowflakeWarehouse\": \"<string>\",\n \"snowflakeRole\": \"<string>\",\n \"snowflakePrivateKey\": \"<string>\",\n \"snowflakePrivateKeyPassphrase\": \"<string>\",\n \"databaseName\": null,\n \"username\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 32767,\n \"bigQueryProjectId\": \"<string>\",\n \"spannerInstanceId\": \"<string>\",\n \"athenaWorkgroup\": \"<string>\",\n \"athenaOutputLocation\": \"<string>\",\n \"athenaCatalog\": \"<string>\",\n \"sslEnabled\": false,\n \"sslVerifyServerCertificate\": true,\n \"sslCaCertificate\": \"<string>\",\n \"sshEnabled\": false,\n \"sshHost\": \"<string>\",\n \"sshPort\": 32767,\n \"sshUsername\": \"<string>\",\n \"sshPassword\": \"<string>\",\n \"sshPrivateKey\": \"<string>\",\n \"sshPrivateKeyPassphrase\": \"<string>\",\n \"maxPoolSize\": 50,\n \"unsetPassword\": true,\n \"password\": \"<string>\",\n \"unsetSshPassword\": true,\n \"unsetSshPrivateKey\": true,\n \"unsetSshPrivateKeyPassphrase\": true,\n \"bigQueryJsonKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"snowflakeAccountId\": \"<string>\",\n \"snowflakeWarehouse\": \"<string>\",\n \"snowflakeRole\": \"<string>\",\n \"snowflakePrivateKey\": \"<string>\",\n \"snowflakePrivateKeyPassphrase\": \"<string>\",\n \"databaseName\": null,\n \"username\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 32767,\n \"bigQueryProjectId\": \"<string>\",\n \"spannerInstanceId\": \"<string>\",\n \"athenaWorkgroup\": \"<string>\",\n \"athenaOutputLocation\": \"<string>\",\n \"athenaCatalog\": \"<string>\",\n \"sslEnabled\": false,\n \"sslVerifyServerCertificate\": true,\n \"sslCaCertificate\": \"<string>\",\n \"sshEnabled\": false,\n \"sshHost\": \"<string>\",\n \"sshPort\": 32767,\n \"sshUsername\": \"<string>\",\n \"sshPassword\": \"<string>\",\n \"sshPrivateKey\": \"<string>\",\n \"sshPrivateKeyPassphrase\": \"<string>\",\n \"maxPoolSize\": 50,\n \"unsetPassword\": true,\n \"password\": \"<string>\",\n \"unsetSshPassword\": true,\n \"unsetSshPrivateKey\": true,\n \"unsetSshPrivateKeyPassphrase\": true,\n \"bigQueryJsonKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"snowflakeAccountId\": \"<string>\",\n \"snowflakeWarehouse\": \"<string>\",\n \"snowflakeRole\": \"<string>\",\n \"snowflakePrivateKey\": \"<string>\",\n \"snowflakePrivateKeyPassphrase\": \"<string>\",\n \"databaseName\": null,\n \"username\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 32767,\n \"bigQueryProjectId\": \"<string>\",\n \"spannerInstanceId\": \"<string>\",\n \"athenaWorkgroup\": \"<string>\",\n \"athenaOutputLocation\": \"<string>\",\n \"athenaCatalog\": \"<string>\",\n \"sslEnabled\": false,\n \"sslVerifyServerCertificate\": true,\n \"sslCaCertificate\": \"<string>\",\n \"sshEnabled\": false,\n \"sshHost\": \"<string>\",\n \"sshPort\": 32767,\n \"sshUsername\": \"<string>\",\n \"sshPassword\": \"<string>\",\n \"sshPrivateKey\": \"<string>\",\n \"sshPrivateKeyPassphrase\": \"<string>\",\n \"maxPoolSize\": 50,\n \"unsetPassword\": true,\n \"password\": \"<string>\",\n \"unsetSshPassword\": true,\n \"unsetSshPrivateKey\": true,\n \"unsetSshPrivateKeyPassphrase\": true,\n \"bigQueryJsonKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"displayName": "<string>",
"description": "<string>",
"dialect": "ELASTICSEARCH",
"databaseName": "<string>",
"username": "<string>",
"host": "<string>",
"port": 123,
"sslEnabled": true,
"sslCustomCertificatesEnabled": true,
"sslVerifyServerCertificate": true,
"sshEnabled": true,
"sshHost": "<string>",
"sshPort": 123,
"sshUsername": "<string>",
"bigQueryProjectId": "<string>",
"spannerInstanceId": "<string>",
"athenaWorkgroup": "<string>",
"athenaOutputLocation": "<string>",
"athenaCatalog": "<string>",
"snowflakeAccountId": "<string>",
"snowflakeWarehouse": "<string>",
"snowflakeRole": "<string>",
"lastSuccessfulSyncAt": "2023-11-07T05:31:56Z",
"lastSyncStatus": "PENDING",
"lastSyncAttemptAt": "2023-11-07T05:31:56Z",
"hasCompletedFirstSync": true,
"syncErrorMessage": "<string>",
"lastHealthyAt": "2023-11-07T05:31:56Z",
"lastHealthStatus": "HEALTHY",
"lastHealthCheckAttemptAt": "2023-11-07T05:31:56Z",
"isDemo": true,
"isBasedashWarehouse": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "RateLimitExceeded",
"detail": "<string>",
"retryAfterMs": 123
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}Data Sources
Update a data source
Updates an existing data source connection settings. Requires admin access to the organization.
PATCH
/
api
/
public
/
organizations
/
{orgId}
/
data-sources
/
{id}
Update a data source
curl --request PATCH \
--url https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"snowflakeAccountId": "<string>",
"snowflakeWarehouse": "<string>",
"snowflakeRole": "<string>",
"snowflakePrivateKey": "<string>",
"snowflakePrivateKeyPassphrase": "<string>",
"databaseName": null,
"username": "<string>",
"host": "<string>",
"port": 32767,
"bigQueryProjectId": "<string>",
"spannerInstanceId": "<string>",
"athenaWorkgroup": "<string>",
"athenaOutputLocation": "<string>",
"athenaCatalog": "<string>",
"sslEnabled": false,
"sslVerifyServerCertificate": true,
"sslCaCertificate": "<string>",
"sshEnabled": false,
"sshHost": "<string>",
"sshPort": 32767,
"sshUsername": "<string>",
"sshPassword": "<string>",
"sshPrivateKey": "<string>",
"sshPrivateKeyPassphrase": "<string>",
"maxPoolSize": 50,
"unsetPassword": true,
"password": "<string>",
"unsetSshPassword": true,
"unsetSshPrivateKey": true,
"unsetSshPrivateKeyPassphrase": true,
"bigQueryJsonKey": "<string>"
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}"
payload = {
"snowflakeAccountId": "<string>",
"snowflakeWarehouse": "<string>",
"snowflakeRole": "<string>",
"snowflakePrivateKey": "<string>",
"snowflakePrivateKeyPassphrase": "<string>",
"databaseName": None,
"username": "<string>",
"host": "<string>",
"port": 32767,
"bigQueryProjectId": "<string>",
"spannerInstanceId": "<string>",
"athenaWorkgroup": "<string>",
"athenaOutputLocation": "<string>",
"athenaCatalog": "<string>",
"sslEnabled": False,
"sslVerifyServerCertificate": True,
"sslCaCertificate": "<string>",
"sshEnabled": False,
"sshHost": "<string>",
"sshPort": 32767,
"sshUsername": "<string>",
"sshPassword": "<string>",
"sshPrivateKey": "<string>",
"sshPrivateKeyPassphrase": "<string>",
"maxPoolSize": 50,
"unsetPassword": True,
"password": "<string>",
"unsetSshPassword": True,
"unsetSshPrivateKey": True,
"unsetSshPrivateKeyPassphrase": True,
"bigQueryJsonKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
snowflakeAccountId: '<string>',
snowflakeWarehouse: '<string>',
snowflakeRole: '<string>',
snowflakePrivateKey: '<string>',
snowflakePrivateKeyPassphrase: '<string>',
databaseName: null,
username: '<string>',
host: '<string>',
port: 32767,
bigQueryProjectId: '<string>',
spannerInstanceId: '<string>',
athenaWorkgroup: '<string>',
athenaOutputLocation: '<string>',
athenaCatalog: '<string>',
sslEnabled: false,
sslVerifyServerCertificate: true,
sslCaCertificate: '<string>',
sshEnabled: false,
sshHost: '<string>',
sshPort: 32767,
sshUsername: '<string>',
sshPassword: '<string>',
sshPrivateKey: '<string>',
sshPrivateKeyPassphrase: '<string>',
maxPoolSize: 50,
unsetPassword: true,
password: '<string>',
unsetSshPassword: true,
unsetSshPrivateKey: true,
unsetSshPrivateKeyPassphrase: true,
bigQueryJsonKey: '<string>'
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}', 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://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}",
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([
'snowflakeAccountId' => '<string>',
'snowflakeWarehouse' => '<string>',
'snowflakeRole' => '<string>',
'snowflakePrivateKey' => '<string>',
'snowflakePrivateKeyPassphrase' => '<string>',
'databaseName' => null,
'username' => '<string>',
'host' => '<string>',
'port' => 32767,
'bigQueryProjectId' => '<string>',
'spannerInstanceId' => '<string>',
'athenaWorkgroup' => '<string>',
'athenaOutputLocation' => '<string>',
'athenaCatalog' => '<string>',
'sslEnabled' => false,
'sslVerifyServerCertificate' => true,
'sslCaCertificate' => '<string>',
'sshEnabled' => false,
'sshHost' => '<string>',
'sshPort' => 32767,
'sshUsername' => '<string>',
'sshPassword' => '<string>',
'sshPrivateKey' => '<string>',
'sshPrivateKeyPassphrase' => '<string>',
'maxPoolSize' => 50,
'unsetPassword' => true,
'password' => '<string>',
'unsetSshPassword' => true,
'unsetSshPrivateKey' => true,
'unsetSshPrivateKeyPassphrase' => true,
'bigQueryJsonKey' => '<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://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}"
payload := strings.NewReader("{\n \"snowflakeAccountId\": \"<string>\",\n \"snowflakeWarehouse\": \"<string>\",\n \"snowflakeRole\": \"<string>\",\n \"snowflakePrivateKey\": \"<string>\",\n \"snowflakePrivateKeyPassphrase\": \"<string>\",\n \"databaseName\": null,\n \"username\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 32767,\n \"bigQueryProjectId\": \"<string>\",\n \"spannerInstanceId\": \"<string>\",\n \"athenaWorkgroup\": \"<string>\",\n \"athenaOutputLocation\": \"<string>\",\n \"athenaCatalog\": \"<string>\",\n \"sslEnabled\": false,\n \"sslVerifyServerCertificate\": true,\n \"sslCaCertificate\": \"<string>\",\n \"sshEnabled\": false,\n \"sshHost\": \"<string>\",\n \"sshPort\": 32767,\n \"sshUsername\": \"<string>\",\n \"sshPassword\": \"<string>\",\n \"sshPrivateKey\": \"<string>\",\n \"sshPrivateKeyPassphrase\": \"<string>\",\n \"maxPoolSize\": 50,\n \"unsetPassword\": true,\n \"password\": \"<string>\",\n \"unsetSshPassword\": true,\n \"unsetSshPrivateKey\": true,\n \"unsetSshPrivateKeyPassphrase\": true,\n \"bigQueryJsonKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"snowflakeAccountId\": \"<string>\",\n \"snowflakeWarehouse\": \"<string>\",\n \"snowflakeRole\": \"<string>\",\n \"snowflakePrivateKey\": \"<string>\",\n \"snowflakePrivateKeyPassphrase\": \"<string>\",\n \"databaseName\": null,\n \"username\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 32767,\n \"bigQueryProjectId\": \"<string>\",\n \"spannerInstanceId\": \"<string>\",\n \"athenaWorkgroup\": \"<string>\",\n \"athenaOutputLocation\": \"<string>\",\n \"athenaCatalog\": \"<string>\",\n \"sslEnabled\": false,\n \"sslVerifyServerCertificate\": true,\n \"sslCaCertificate\": \"<string>\",\n \"sshEnabled\": false,\n \"sshHost\": \"<string>\",\n \"sshPort\": 32767,\n \"sshUsername\": \"<string>\",\n \"sshPassword\": \"<string>\",\n \"sshPrivateKey\": \"<string>\",\n \"sshPrivateKeyPassphrase\": \"<string>\",\n \"maxPoolSize\": 50,\n \"unsetPassword\": true,\n \"password\": \"<string>\",\n \"unsetSshPassword\": true,\n \"unsetSshPrivateKey\": true,\n \"unsetSshPrivateKeyPassphrase\": true,\n \"bigQueryJsonKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"snowflakeAccountId\": \"<string>\",\n \"snowflakeWarehouse\": \"<string>\",\n \"snowflakeRole\": \"<string>\",\n \"snowflakePrivateKey\": \"<string>\",\n \"snowflakePrivateKeyPassphrase\": \"<string>\",\n \"databaseName\": null,\n \"username\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 32767,\n \"bigQueryProjectId\": \"<string>\",\n \"spannerInstanceId\": \"<string>\",\n \"athenaWorkgroup\": \"<string>\",\n \"athenaOutputLocation\": \"<string>\",\n \"athenaCatalog\": \"<string>\",\n \"sslEnabled\": false,\n \"sslVerifyServerCertificate\": true,\n \"sslCaCertificate\": \"<string>\",\n \"sshEnabled\": false,\n \"sshHost\": \"<string>\",\n \"sshPort\": 32767,\n \"sshUsername\": \"<string>\",\n \"sshPassword\": \"<string>\",\n \"sshPrivateKey\": \"<string>\",\n \"sshPrivateKeyPassphrase\": \"<string>\",\n \"maxPoolSize\": 50,\n \"unsetPassword\": true,\n \"password\": \"<string>\",\n \"unsetSshPassword\": true,\n \"unsetSshPrivateKey\": true,\n \"unsetSshPrivateKeyPassphrase\": true,\n \"bigQueryJsonKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"displayName": "<string>",
"description": "<string>",
"dialect": "ELASTICSEARCH",
"databaseName": "<string>",
"username": "<string>",
"host": "<string>",
"port": 123,
"sslEnabled": true,
"sslCustomCertificatesEnabled": true,
"sslVerifyServerCertificate": true,
"sshEnabled": true,
"sshHost": "<string>",
"sshPort": 123,
"sshUsername": "<string>",
"bigQueryProjectId": "<string>",
"spannerInstanceId": "<string>",
"athenaWorkgroup": "<string>",
"athenaOutputLocation": "<string>",
"athenaCatalog": "<string>",
"snowflakeAccountId": "<string>",
"snowflakeWarehouse": "<string>",
"snowflakeRole": "<string>",
"lastSuccessfulSyncAt": "2023-11-07T05:31:56Z",
"lastSyncStatus": "PENDING",
"lastSyncAttemptAt": "2023-11-07T05:31:56Z",
"hasCompletedFirstSync": true,
"syncErrorMessage": "<string>",
"lastHealthyAt": "2023-11-07T05:31:56Z",
"lastHealthStatus": "HEALTHY",
"lastHealthCheckAttemptAt": "2023-11-07T05:31:56Z",
"isDemo": true,
"isBasedashWarehouse": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "RateLimitExceeded",
"detail": "<string>",
"retryAfterMs": 123
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}Authorizations
API key authentication using Bearer token format: Bearer <basedash_api_key>
Body
application/json
Snowflake account ID
Snowflake warehouse
Snowflake role
Snowflake private key
Snowflake private key passphrase
Database name
Database username
Database host
Database port
Required range:
0 <= x <= 65535BigQuery project ID
Spanner instance ID
Athena workgroup
Athena output location (s3://...)
Athena catalog
Enable SSL connection
Verify the server's TLS certificate when SSL is on
PEM CA certificate to trust for the server certificate
Maximum string length:
65536Enable SSH tunnel
SSH tunnel host
SSH tunnel port
Required range:
0 <= x <= 65535SSH tunnel username
SSH tunnel password
SSH private key
SSH private key passphrase
Maximum number of connections in the pool per container
Required range:
1 <= x <= 100Database password
BigQuery JSON key
Response
Data source updated successfully
Show child attributes
Show child attributes