Test provider source
curl --request POST \
--url https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"name": "production-primary",
"postgres": {
"host": "example.ab02cdefgxyz.us-east-1.rds.amazonaws.com",
"port": 5432,
"database": "analytics",
"auth_method": "password_auth",
"password_auth": {
"username": "data_export_user",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": false
},
"redshift": {
"host": "cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com",
"port": 5439,
"database": "dev",
"cluster": "acme-cluster",
"region": "us-east-1",
"workgroup": "default-workgroup",
"username": "data_export_user",
"use_ssh_tunnel": true,
"disable_ssl": false
},
"redshift_serverless": {
"host": "workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com",
"port": 5439,
"database": "dev",
"workgroup": "default-workgroup",
"region": "us-east-1",
"use_ssh_tunnel": true,
"disable_ssl": false
},
"bigquery": {
"project_id": "acme-analytics-1234",
"region": "us-central1",
"gcp_service_account_role": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com"
},
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3": {
"bucket_name": "acme-data-export-staging",
"region": "us-east-1",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"bucket_host": "s3.us-east-1.amazonaws.com",
"use_ssh_tunnel": true
},
"abs": {
"bucket_name": "acme-data-export-staging",
"storage_account_name": "acmestorage",
"auth_method": "azure_service_shared_access_signature",
"azure_service_shared_access_signature": {
"shared_access_signature_token": "<string>"
}
},
"sftp": {
"username": "data_export_user",
"host": "sftp.acme.com",
"port": 22,
"auth_method": "public_key_auth",
"public_key_auth": {
"public_key": "<string>"
}
},
"gcs": {
"bucket_name": "acme-data-export-staging",
"region": "us-central1",
"gcp_service_account_role": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com"
},
"gcs_hmac_keys": {
"access_key": "GOOG1EXAMPLEACCESSID",
"secret": "<string>"
},
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3_compatible": {
"host": "s3.us-east-1.amazonaws.com",
"port": 443,
"bucket_name": "acme-data-export-staging",
"auth_method": "access_keys",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"disable_ssl": false,
"use_ssh_tunnel": true
},
"snowflake": {
"host": "db54321.us-central1.gcp.snowflakecomputing.com",
"port": 443,
"database": "ANALYTICS",
"username": "DATA_EXPORT_USER",
"auth_method": "public_key_auth",
"public_key_auth": {
"public_key": "<string>"
}
},
"delta_sharing": {
"host": "sharing.delta.io",
"port": 443
}
}
}
'import requests
url = "https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source"
payload = { "source": {
"name": "production-primary",
"postgres": {
"host": "example.ab02cdefgxyz.us-east-1.rds.amazonaws.com",
"port": 5432,
"database": "analytics",
"auth_method": "password_auth",
"password_auth": {
"username": "data_export_user",
"password": "<string>"
},
"use_ssh_tunnel": True,
"disable_ssl": False
},
"redshift": {
"host": "cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com",
"port": 5439,
"database": "dev",
"cluster": "acme-cluster",
"region": "us-east-1",
"workgroup": "default-workgroup",
"username": "data_export_user",
"use_ssh_tunnel": True,
"disable_ssl": False
},
"redshift_serverless": {
"host": "workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com",
"port": 5439,
"database": "dev",
"workgroup": "default-workgroup",
"region": "us-east-1",
"use_ssh_tunnel": True,
"disable_ssl": False
},
"bigquery": {
"project_id": "acme-analytics-1234",
"region": "us-central1",
"gcp_service_account_role": { "service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com" },
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3": {
"bucket_name": "acme-data-export-staging",
"region": "us-east-1",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"bucket_host": "s3.us-east-1.amazonaws.com",
"use_ssh_tunnel": True
},
"abs": {
"bucket_name": "acme-data-export-staging",
"storage_account_name": "acmestorage",
"auth_method": "azure_service_shared_access_signature",
"azure_service_shared_access_signature": { "shared_access_signature_token": "<string>" }
},
"sftp": {
"username": "data_export_user",
"host": "sftp.acme.com",
"port": 22,
"auth_method": "public_key_auth",
"public_key_auth": { "public_key": "<string>" }
},
"gcs": {
"bucket_name": "acme-data-export-staging",
"region": "us-central1",
"gcp_service_account_role": { "service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com" },
"gcs_hmac_keys": {
"access_key": "GOOG1EXAMPLEACCESSID",
"secret": "<string>"
},
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3_compatible": {
"host": "s3.us-east-1.amazonaws.com",
"port": 443,
"bucket_name": "acme-data-export-staging",
"auth_method": "access_keys",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"disable_ssl": False,
"use_ssh_tunnel": True
},
"snowflake": {
"host": "db54321.us-central1.gcp.snowflakecomputing.com",
"port": 443,
"database": "ANALYTICS",
"username": "DATA_EXPORT_USER",
"auth_method": "public_key_auth",
"public_key_auth": { "public_key": "<string>" }
},
"delta_sharing": {
"host": "sharing.delta.io",
"port": 443
}
} }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: {
name: 'production-primary',
postgres: {
host: 'example.ab02cdefgxyz.us-east-1.rds.amazonaws.com',
port: 5432,
database: 'analytics',
auth_method: 'password_auth',
password_auth: {username: 'data_export_user', password: '<string>'},
use_ssh_tunnel: true,
disable_ssl: false
},
redshift: {
host: 'cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com',
port: 5439,
database: 'dev',
cluster: 'acme-cluster',
region: 'us-east-1',
workgroup: 'default-workgroup',
username: 'data_export_user',
use_ssh_tunnel: true,
disable_ssl: false
},
redshift_serverless: {
host: 'workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com',
port: 5439,
database: 'dev',
workgroup: 'default-workgroup',
region: 'us-east-1',
use_ssh_tunnel: true,
disable_ssl: false
},
bigquery: {
project_id: 'acme-analytics-1234',
region: 'us-central1',
gcp_service_account_role: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
},
gcp_service_account_key: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
service_account_key: '<unknown>'
}
},
s3: {
bucket_name: 'acme-data-export-staging',
region: 'us-east-1',
aws_access_keys: {access_id: 'AKIAIOSFODNN7EXAMPLE', secret_key: '<string>'},
bucket_host: 's3.us-east-1.amazonaws.com',
use_ssh_tunnel: true
},
abs: {
bucket_name: 'acme-data-export-staging',
storage_account_name: 'acmestorage',
auth_method: 'azure_service_shared_access_signature',
azure_service_shared_access_signature: {shared_access_signature_token: '<string>'}
},
sftp: {
username: 'data_export_user',
host: 'sftp.acme.com',
port: 22,
auth_method: 'public_key_auth',
public_key_auth: {public_key: '<string>'}
},
gcs: {
bucket_name: 'acme-data-export-staging',
region: 'us-central1',
gcp_service_account_role: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
},
gcs_hmac_keys: {access_key: 'GOOG1EXAMPLEACCESSID', secret: '<string>'},
gcp_service_account_key: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
service_account_key: '<unknown>'
}
},
s3_compatible: {
host: 's3.us-east-1.amazonaws.com',
port: 443,
bucket_name: 'acme-data-export-staging',
auth_method: 'access_keys',
aws_access_keys: {access_id: 'AKIAIOSFODNN7EXAMPLE', secret_key: '<string>'},
disable_ssl: false,
use_ssh_tunnel: true
},
snowflake: {
host: 'db54321.us-central1.gcp.snowflakecomputing.com',
port: 443,
database: 'ANALYTICS',
username: 'DATA_EXPORT_USER',
auth_method: 'public_key_auth',
public_key_auth: {public_key: '<string>'}
},
delta_sharing: {host: 'sharing.delta.io', port: 443}
}
})
};
fetch('https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source', 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.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source",
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([
'source' => [
'name' => 'production-primary',
'postgres' => [
'host' => 'example.ab02cdefgxyz.us-east-1.rds.amazonaws.com',
'port' => 5432,
'database' => 'analytics',
'auth_method' => 'password_auth',
'password_auth' => [
'username' => 'data_export_user',
'password' => '<string>'
],
'use_ssh_tunnel' => true,
'disable_ssl' => false
],
'redshift' => [
'host' => 'cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com',
'port' => 5439,
'database' => 'dev',
'cluster' => 'acme-cluster',
'region' => 'us-east-1',
'workgroup' => 'default-workgroup',
'username' => 'data_export_user',
'use_ssh_tunnel' => true,
'disable_ssl' => false
],
'redshift_serverless' => [
'host' => 'workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com',
'port' => 5439,
'database' => 'dev',
'workgroup' => 'default-workgroup',
'region' => 'us-east-1',
'use_ssh_tunnel' => true,
'disable_ssl' => false
],
'bigquery' => [
'project_id' => 'acme-analytics-1234',
'region' => 'us-central1',
'gcp_service_account_role' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
],
'gcp_service_account_key' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
'service_account_key' => '<unknown>'
]
],
's3' => [
'bucket_name' => 'acme-data-export-staging',
'region' => 'us-east-1',
'aws_access_keys' => [
'access_id' => 'AKIAIOSFODNN7EXAMPLE',
'secret_key' => '<string>'
],
'bucket_host' => 's3.us-east-1.amazonaws.com',
'use_ssh_tunnel' => true
],
'abs' => [
'bucket_name' => 'acme-data-export-staging',
'storage_account_name' => 'acmestorage',
'auth_method' => 'azure_service_shared_access_signature',
'azure_service_shared_access_signature' => [
'shared_access_signature_token' => '<string>'
]
],
'sftp' => [
'username' => 'data_export_user',
'host' => 'sftp.acme.com',
'port' => 22,
'auth_method' => 'public_key_auth',
'public_key_auth' => [
'public_key' => '<string>'
]
],
'gcs' => [
'bucket_name' => 'acme-data-export-staging',
'region' => 'us-central1',
'gcp_service_account_role' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
],
'gcs_hmac_keys' => [
'access_key' => 'GOOG1EXAMPLEACCESSID',
'secret' => '<string>'
],
'gcp_service_account_key' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
'service_account_key' => '<unknown>'
]
],
's3_compatible' => [
'host' => 's3.us-east-1.amazonaws.com',
'port' => 443,
'bucket_name' => 'acme-data-export-staging',
'auth_method' => 'access_keys',
'aws_access_keys' => [
'access_id' => 'AKIAIOSFODNN7EXAMPLE',
'secret_key' => '<string>'
],
'disable_ssl' => false,
'use_ssh_tunnel' => true
],
'snowflake' => [
'host' => 'db54321.us-central1.gcp.snowflakecomputing.com',
'port' => 443,
'database' => 'ANALYTICS',
'username' => 'DATA_EXPORT_USER',
'auth_method' => 'public_key_auth',
'public_key_auth' => [
'public_key' => '<string>'
]
],
'delta_sharing' => [
'host' => 'sharing.delta.io',
'port' => 443
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source"
payload := strings.NewReader("{\n \"source\": {\n \"name\": \"production-primary\",\n \"postgres\": {\n \"host\": \"example.ab02cdefgxyz.us-east-1.rds.amazonaws.com\",\n \"port\": 5432,\n \"database\": \"analytics\",\n \"auth_method\": \"password_auth\",\n \"password_auth\": {\n \"username\": \"data_export_user\",\n \"password\": \"<string>\"\n },\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift\": {\n \"host\": \"cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"cluster\": \"acme-cluster\",\n \"region\": \"us-east-1\",\n \"workgroup\": \"default-workgroup\",\n \"username\": \"data_export_user\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift_serverless\": {\n \"host\": \"workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"workgroup\": \"default-workgroup\",\n \"region\": \"us-east-1\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"bigquery\": {\n \"project_id\": \"acme-analytics-1234\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-east-1\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"bucket_host\": \"s3.us-east-1.amazonaws.com\",\n \"use_ssh_tunnel\": true\n },\n \"abs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"storage_account_name\": \"acmestorage\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"azure_service_shared_access_signature\": {\n \"shared_access_signature_token\": \"<string>\"\n }\n },\n \"sftp\": {\n \"username\": \"data_export_user\",\n \"host\": \"sftp.acme.com\",\n \"port\": 22,\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"gcs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcs_hmac_keys\": {\n \"access_key\": \"GOOG1EXAMPLEACCESSID\",\n \"secret\": \"<string>\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3_compatible\": {\n \"host\": \"s3.us-east-1.amazonaws.com\",\n \"port\": 443,\n \"bucket_name\": \"acme-data-export-staging\",\n \"auth_method\": \"access_keys\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"disable_ssl\": false,\n \"use_ssh_tunnel\": true\n },\n \"snowflake\": {\n \"host\": \"db54321.us-central1.gcp.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"ANALYTICS\",\n \"username\": \"DATA_EXPORT_USER\",\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"delta_sharing\": {\n \"host\": \"sharing.delta.io\",\n \"port\": 443\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"name\": \"production-primary\",\n \"postgres\": {\n \"host\": \"example.ab02cdefgxyz.us-east-1.rds.amazonaws.com\",\n \"port\": 5432,\n \"database\": \"analytics\",\n \"auth_method\": \"password_auth\",\n \"password_auth\": {\n \"username\": \"data_export_user\",\n \"password\": \"<string>\"\n },\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift\": {\n \"host\": \"cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"cluster\": \"acme-cluster\",\n \"region\": \"us-east-1\",\n \"workgroup\": \"default-workgroup\",\n \"username\": \"data_export_user\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift_serverless\": {\n \"host\": \"workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"workgroup\": \"default-workgroup\",\n \"region\": \"us-east-1\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"bigquery\": {\n \"project_id\": \"acme-analytics-1234\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-east-1\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"bucket_host\": \"s3.us-east-1.amazonaws.com\",\n \"use_ssh_tunnel\": true\n },\n \"abs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"storage_account_name\": \"acmestorage\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"azure_service_shared_access_signature\": {\n \"shared_access_signature_token\": \"<string>\"\n }\n },\n \"sftp\": {\n \"username\": \"data_export_user\",\n \"host\": \"sftp.acme.com\",\n \"port\": 22,\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"gcs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcs_hmac_keys\": {\n \"access_key\": \"GOOG1EXAMPLEACCESSID\",\n \"secret\": \"<string>\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3_compatible\": {\n \"host\": \"s3.us-east-1.amazonaws.com\",\n \"port\": 443,\n \"bucket_name\": \"acme-data-export-staging\",\n \"auth_method\": \"access_keys\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"disable_ssl\": false,\n \"use_ssh_tunnel\": true\n },\n \"snowflake\": {\n \"host\": \"db54321.us-central1.gcp.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"ANALYTICS\",\n \"username\": \"DATA_EXPORT_USER\",\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"delta_sharing\": {\n \"host\": \"sharing.delta.io\",\n \"port\": 443\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": {\n \"name\": \"production-primary\",\n \"postgres\": {\n \"host\": \"example.ab02cdefgxyz.us-east-1.rds.amazonaws.com\",\n \"port\": 5432,\n \"database\": \"analytics\",\n \"auth_method\": \"password_auth\",\n \"password_auth\": {\n \"username\": \"data_export_user\",\n \"password\": \"<string>\"\n },\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift\": {\n \"host\": \"cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"cluster\": \"acme-cluster\",\n \"region\": \"us-east-1\",\n \"workgroup\": \"default-workgroup\",\n \"username\": \"data_export_user\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift_serverless\": {\n \"host\": \"workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"workgroup\": \"default-workgroup\",\n \"region\": \"us-east-1\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"bigquery\": {\n \"project_id\": \"acme-analytics-1234\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-east-1\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"bucket_host\": \"s3.us-east-1.amazonaws.com\",\n \"use_ssh_tunnel\": true\n },\n \"abs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"storage_account_name\": \"acmestorage\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"azure_service_shared_access_signature\": {\n \"shared_access_signature_token\": \"<string>\"\n }\n },\n \"sftp\": {\n \"username\": \"data_export_user\",\n \"host\": \"sftp.acme.com\",\n \"port\": 22,\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"gcs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcs_hmac_keys\": {\n \"access_key\": \"GOOG1EXAMPLEACCESSID\",\n \"secret\": \"<string>\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3_compatible\": {\n \"host\": \"s3.us-east-1.amazonaws.com\",\n \"port\": 443,\n \"bucket_name\": \"acme-data-export-staging\",\n \"auth_method\": \"access_keys\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"disable_ssl\": false,\n \"use_ssh_tunnel\": true\n },\n \"snowflake\": {\n \"host\": \"db54321.us-central1.gcp.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"ANALYTICS\",\n \"username\": \"DATA_EXPORT_USER\",\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"delta_sharing\": {\n \"host\": \"sharing.delta.io\",\n \"port\": 443\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>"
}{
"status": "error",
"message": "<string>",
"data": null
}{
"status": "error",
"message": "<string>",
"data": null
}{
"status": "error",
"message": "<string>",
"data": null
}{
"status": "error",
"message": "<string>",
"data": null
}Sources
Test provider source
Probe an import source visible to the selected provider.
POST
/
import
/
providers
/
{provider_id}
/
sources
/
{source_id}
/
test-source
Test provider source
curl --request POST \
--url https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"name": "production-primary",
"postgres": {
"host": "example.ab02cdefgxyz.us-east-1.rds.amazonaws.com",
"port": 5432,
"database": "analytics",
"auth_method": "password_auth",
"password_auth": {
"username": "data_export_user",
"password": "<string>"
},
"use_ssh_tunnel": true,
"disable_ssl": false
},
"redshift": {
"host": "cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com",
"port": 5439,
"database": "dev",
"cluster": "acme-cluster",
"region": "us-east-1",
"workgroup": "default-workgroup",
"username": "data_export_user",
"use_ssh_tunnel": true,
"disable_ssl": false
},
"redshift_serverless": {
"host": "workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com",
"port": 5439,
"database": "dev",
"workgroup": "default-workgroup",
"region": "us-east-1",
"use_ssh_tunnel": true,
"disable_ssl": false
},
"bigquery": {
"project_id": "acme-analytics-1234",
"region": "us-central1",
"gcp_service_account_role": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com"
},
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3": {
"bucket_name": "acme-data-export-staging",
"region": "us-east-1",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"bucket_host": "s3.us-east-1.amazonaws.com",
"use_ssh_tunnel": true
},
"abs": {
"bucket_name": "acme-data-export-staging",
"storage_account_name": "acmestorage",
"auth_method": "azure_service_shared_access_signature",
"azure_service_shared_access_signature": {
"shared_access_signature_token": "<string>"
}
},
"sftp": {
"username": "data_export_user",
"host": "sftp.acme.com",
"port": 22,
"auth_method": "public_key_auth",
"public_key_auth": {
"public_key": "<string>"
}
},
"gcs": {
"bucket_name": "acme-data-export-staging",
"region": "us-central1",
"gcp_service_account_role": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com"
},
"gcs_hmac_keys": {
"access_key": "GOOG1EXAMPLEACCESSID",
"secret": "<string>"
},
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3_compatible": {
"host": "s3.us-east-1.amazonaws.com",
"port": 443,
"bucket_name": "acme-data-export-staging",
"auth_method": "access_keys",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"disable_ssl": false,
"use_ssh_tunnel": true
},
"snowflake": {
"host": "db54321.us-central1.gcp.snowflakecomputing.com",
"port": 443,
"database": "ANALYTICS",
"username": "DATA_EXPORT_USER",
"auth_method": "public_key_auth",
"public_key_auth": {
"public_key": "<string>"
}
},
"delta_sharing": {
"host": "sharing.delta.io",
"port": 443
}
}
}
'import requests
url = "https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source"
payload = { "source": {
"name": "production-primary",
"postgres": {
"host": "example.ab02cdefgxyz.us-east-1.rds.amazonaws.com",
"port": 5432,
"database": "analytics",
"auth_method": "password_auth",
"password_auth": {
"username": "data_export_user",
"password": "<string>"
},
"use_ssh_tunnel": True,
"disable_ssl": False
},
"redshift": {
"host": "cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com",
"port": 5439,
"database": "dev",
"cluster": "acme-cluster",
"region": "us-east-1",
"workgroup": "default-workgroup",
"username": "data_export_user",
"use_ssh_tunnel": True,
"disable_ssl": False
},
"redshift_serverless": {
"host": "workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com",
"port": 5439,
"database": "dev",
"workgroup": "default-workgroup",
"region": "us-east-1",
"use_ssh_tunnel": True,
"disable_ssl": False
},
"bigquery": {
"project_id": "acme-analytics-1234",
"region": "us-central1",
"gcp_service_account_role": { "service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com" },
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3": {
"bucket_name": "acme-data-export-staging",
"region": "us-east-1",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"bucket_host": "s3.us-east-1.amazonaws.com",
"use_ssh_tunnel": True
},
"abs": {
"bucket_name": "acme-data-export-staging",
"storage_account_name": "acmestorage",
"auth_method": "azure_service_shared_access_signature",
"azure_service_shared_access_signature": { "shared_access_signature_token": "<string>" }
},
"sftp": {
"username": "data_export_user",
"host": "sftp.acme.com",
"port": 22,
"auth_method": "public_key_auth",
"public_key_auth": { "public_key": "<string>" }
},
"gcs": {
"bucket_name": "acme-data-export-staging",
"region": "us-central1",
"gcp_service_account_role": { "service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com" },
"gcs_hmac_keys": {
"access_key": "GOOG1EXAMPLEACCESSID",
"secret": "<string>"
},
"gcp_service_account_key": {
"service_account_email": "data-export@acme-analytics-1234.iam.gserviceaccount.com",
"service_account_key": "<unknown>"
}
},
"s3_compatible": {
"host": "s3.us-east-1.amazonaws.com",
"port": 443,
"bucket_name": "acme-data-export-staging",
"auth_method": "access_keys",
"aws_access_keys": {
"access_id": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "<string>"
},
"disable_ssl": False,
"use_ssh_tunnel": True
},
"snowflake": {
"host": "db54321.us-central1.gcp.snowflakecomputing.com",
"port": 443,
"database": "ANALYTICS",
"username": "DATA_EXPORT_USER",
"auth_method": "public_key_auth",
"public_key_auth": { "public_key": "<string>" }
},
"delta_sharing": {
"host": "sharing.delta.io",
"port": 443
}
} }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: {
name: 'production-primary',
postgres: {
host: 'example.ab02cdefgxyz.us-east-1.rds.amazonaws.com',
port: 5432,
database: 'analytics',
auth_method: 'password_auth',
password_auth: {username: 'data_export_user', password: '<string>'},
use_ssh_tunnel: true,
disable_ssl: false
},
redshift: {
host: 'cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com',
port: 5439,
database: 'dev',
cluster: 'acme-cluster',
region: 'us-east-1',
workgroup: 'default-workgroup',
username: 'data_export_user',
use_ssh_tunnel: true,
disable_ssl: false
},
redshift_serverless: {
host: 'workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com',
port: 5439,
database: 'dev',
workgroup: 'default-workgroup',
region: 'us-east-1',
use_ssh_tunnel: true,
disable_ssl: false
},
bigquery: {
project_id: 'acme-analytics-1234',
region: 'us-central1',
gcp_service_account_role: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
},
gcp_service_account_key: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
service_account_key: '<unknown>'
}
},
s3: {
bucket_name: 'acme-data-export-staging',
region: 'us-east-1',
aws_access_keys: {access_id: 'AKIAIOSFODNN7EXAMPLE', secret_key: '<string>'},
bucket_host: 's3.us-east-1.amazonaws.com',
use_ssh_tunnel: true
},
abs: {
bucket_name: 'acme-data-export-staging',
storage_account_name: 'acmestorage',
auth_method: 'azure_service_shared_access_signature',
azure_service_shared_access_signature: {shared_access_signature_token: '<string>'}
},
sftp: {
username: 'data_export_user',
host: 'sftp.acme.com',
port: 22,
auth_method: 'public_key_auth',
public_key_auth: {public_key: '<string>'}
},
gcs: {
bucket_name: 'acme-data-export-staging',
region: 'us-central1',
gcp_service_account_role: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
},
gcs_hmac_keys: {access_key: 'GOOG1EXAMPLEACCESSID', secret: '<string>'},
gcp_service_account_key: {
service_account_email: 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
service_account_key: '<unknown>'
}
},
s3_compatible: {
host: 's3.us-east-1.amazonaws.com',
port: 443,
bucket_name: 'acme-data-export-staging',
auth_method: 'access_keys',
aws_access_keys: {access_id: 'AKIAIOSFODNN7EXAMPLE', secret_key: '<string>'},
disable_ssl: false,
use_ssh_tunnel: true
},
snowflake: {
host: 'db54321.us-central1.gcp.snowflakecomputing.com',
port: 443,
database: 'ANALYTICS',
username: 'DATA_EXPORT_USER',
auth_method: 'public_key_auth',
public_key_auth: {public_key: '<string>'}
},
delta_sharing: {host: 'sharing.delta.io', port: 443}
}
})
};
fetch('https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source', 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.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source",
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([
'source' => [
'name' => 'production-primary',
'postgres' => [
'host' => 'example.ab02cdefgxyz.us-east-1.rds.amazonaws.com',
'port' => 5432,
'database' => 'analytics',
'auth_method' => 'password_auth',
'password_auth' => [
'username' => 'data_export_user',
'password' => '<string>'
],
'use_ssh_tunnel' => true,
'disable_ssl' => false
],
'redshift' => [
'host' => 'cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com',
'port' => 5439,
'database' => 'dev',
'cluster' => 'acme-cluster',
'region' => 'us-east-1',
'workgroup' => 'default-workgroup',
'username' => 'data_export_user',
'use_ssh_tunnel' => true,
'disable_ssl' => false
],
'redshift_serverless' => [
'host' => 'workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com',
'port' => 5439,
'database' => 'dev',
'workgroup' => 'default-workgroup',
'region' => 'us-east-1',
'use_ssh_tunnel' => true,
'disable_ssl' => false
],
'bigquery' => [
'project_id' => 'acme-analytics-1234',
'region' => 'us-central1',
'gcp_service_account_role' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
],
'gcp_service_account_key' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
'service_account_key' => '<unknown>'
]
],
's3' => [
'bucket_name' => 'acme-data-export-staging',
'region' => 'us-east-1',
'aws_access_keys' => [
'access_id' => 'AKIAIOSFODNN7EXAMPLE',
'secret_key' => '<string>'
],
'bucket_host' => 's3.us-east-1.amazonaws.com',
'use_ssh_tunnel' => true
],
'abs' => [
'bucket_name' => 'acme-data-export-staging',
'storage_account_name' => 'acmestorage',
'auth_method' => 'azure_service_shared_access_signature',
'azure_service_shared_access_signature' => [
'shared_access_signature_token' => '<string>'
]
],
'sftp' => [
'username' => 'data_export_user',
'host' => 'sftp.acme.com',
'port' => 22,
'auth_method' => 'public_key_auth',
'public_key_auth' => [
'public_key' => '<string>'
]
],
'gcs' => [
'bucket_name' => 'acme-data-export-staging',
'region' => 'us-central1',
'gcp_service_account_role' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com'
],
'gcs_hmac_keys' => [
'access_key' => 'GOOG1EXAMPLEACCESSID',
'secret' => '<string>'
],
'gcp_service_account_key' => [
'service_account_email' => 'data-export@acme-analytics-1234.iam.gserviceaccount.com',
'service_account_key' => '<unknown>'
]
],
's3_compatible' => [
'host' => 's3.us-east-1.amazonaws.com',
'port' => 443,
'bucket_name' => 'acme-data-export-staging',
'auth_method' => 'access_keys',
'aws_access_keys' => [
'access_id' => 'AKIAIOSFODNN7EXAMPLE',
'secret_key' => '<string>'
],
'disable_ssl' => false,
'use_ssh_tunnel' => true
],
'snowflake' => [
'host' => 'db54321.us-central1.gcp.snowflakecomputing.com',
'port' => 443,
'database' => 'ANALYTICS',
'username' => 'DATA_EXPORT_USER',
'auth_method' => 'public_key_auth',
'public_key_auth' => [
'public_key' => '<string>'
]
],
'delta_sharing' => [
'host' => 'sharing.delta.io',
'port' => 443
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source"
payload := strings.NewReader("{\n \"source\": {\n \"name\": \"production-primary\",\n \"postgres\": {\n \"host\": \"example.ab02cdefgxyz.us-east-1.rds.amazonaws.com\",\n \"port\": 5432,\n \"database\": \"analytics\",\n \"auth_method\": \"password_auth\",\n \"password_auth\": {\n \"username\": \"data_export_user\",\n \"password\": \"<string>\"\n },\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift\": {\n \"host\": \"cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"cluster\": \"acme-cluster\",\n \"region\": \"us-east-1\",\n \"workgroup\": \"default-workgroup\",\n \"username\": \"data_export_user\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift_serverless\": {\n \"host\": \"workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"workgroup\": \"default-workgroup\",\n \"region\": \"us-east-1\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"bigquery\": {\n \"project_id\": \"acme-analytics-1234\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-east-1\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"bucket_host\": \"s3.us-east-1.amazonaws.com\",\n \"use_ssh_tunnel\": true\n },\n \"abs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"storage_account_name\": \"acmestorage\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"azure_service_shared_access_signature\": {\n \"shared_access_signature_token\": \"<string>\"\n }\n },\n \"sftp\": {\n \"username\": \"data_export_user\",\n \"host\": \"sftp.acme.com\",\n \"port\": 22,\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"gcs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcs_hmac_keys\": {\n \"access_key\": \"GOOG1EXAMPLEACCESSID\",\n \"secret\": \"<string>\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3_compatible\": {\n \"host\": \"s3.us-east-1.amazonaws.com\",\n \"port\": 443,\n \"bucket_name\": \"acme-data-export-staging\",\n \"auth_method\": \"access_keys\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"disable_ssl\": false,\n \"use_ssh_tunnel\": true\n },\n \"snowflake\": {\n \"host\": \"db54321.us-central1.gcp.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"ANALYTICS\",\n \"username\": \"DATA_EXPORT_USER\",\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"delta_sharing\": {\n \"host\": \"sharing.delta.io\",\n \"port\": 443\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"name\": \"production-primary\",\n \"postgres\": {\n \"host\": \"example.ab02cdefgxyz.us-east-1.rds.amazonaws.com\",\n \"port\": 5432,\n \"database\": \"analytics\",\n \"auth_method\": \"password_auth\",\n \"password_auth\": {\n \"username\": \"data_export_user\",\n \"password\": \"<string>\"\n },\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift\": {\n \"host\": \"cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"cluster\": \"acme-cluster\",\n \"region\": \"us-east-1\",\n \"workgroup\": \"default-workgroup\",\n \"username\": \"data_export_user\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift_serverless\": {\n \"host\": \"workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"workgroup\": \"default-workgroup\",\n \"region\": \"us-east-1\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"bigquery\": {\n \"project_id\": \"acme-analytics-1234\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-east-1\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"bucket_host\": \"s3.us-east-1.amazonaws.com\",\n \"use_ssh_tunnel\": true\n },\n \"abs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"storage_account_name\": \"acmestorage\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"azure_service_shared_access_signature\": {\n \"shared_access_signature_token\": \"<string>\"\n }\n },\n \"sftp\": {\n \"username\": \"data_export_user\",\n \"host\": \"sftp.acme.com\",\n \"port\": 22,\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"gcs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcs_hmac_keys\": {\n \"access_key\": \"GOOG1EXAMPLEACCESSID\",\n \"secret\": \"<string>\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3_compatible\": {\n \"host\": \"s3.us-east-1.amazonaws.com\",\n \"port\": 443,\n \"bucket_name\": \"acme-data-export-staging\",\n \"auth_method\": \"access_keys\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"disable_ssl\": false,\n \"use_ssh_tunnel\": true\n },\n \"snowflake\": {\n \"host\": \"db54321.us-central1.gcp.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"ANALYTICS\",\n \"username\": \"DATA_EXPORT_USER\",\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"delta_sharing\": {\n \"host\": \"sharing.delta.io\",\n \"port\": 443\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prequel.co/import/providers/{provider_id}/sources/{source_id}/test-source")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": {\n \"name\": \"production-primary\",\n \"postgres\": {\n \"host\": \"example.ab02cdefgxyz.us-east-1.rds.amazonaws.com\",\n \"port\": 5432,\n \"database\": \"analytics\",\n \"auth_method\": \"password_auth\",\n \"password_auth\": {\n \"username\": \"data_export_user\",\n \"password\": \"<string>\"\n },\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift\": {\n \"host\": \"cluster-name.ab1cdefgh.us-east-1.redshift.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"cluster\": \"acme-cluster\",\n \"region\": \"us-east-1\",\n \"workgroup\": \"default-workgroup\",\n \"username\": \"data_export_user\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"redshift_serverless\": {\n \"host\": \"workgroup.123456789.us-east-1.redshift-serverless.amazonaws.com\",\n \"port\": 5439,\n \"database\": \"dev\",\n \"workgroup\": \"default-workgroup\",\n \"region\": \"us-east-1\",\n \"use_ssh_tunnel\": true,\n \"disable_ssl\": false\n },\n \"bigquery\": {\n \"project_id\": \"acme-analytics-1234\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-east-1\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"bucket_host\": \"s3.us-east-1.amazonaws.com\",\n \"use_ssh_tunnel\": true\n },\n \"abs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"storage_account_name\": \"acmestorage\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"azure_service_shared_access_signature\": {\n \"shared_access_signature_token\": \"<string>\"\n }\n },\n \"sftp\": {\n \"username\": \"data_export_user\",\n \"host\": \"sftp.acme.com\",\n \"port\": 22,\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"gcs\": {\n \"bucket_name\": \"acme-data-export-staging\",\n \"region\": \"us-central1\",\n \"gcp_service_account_role\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\"\n },\n \"gcs_hmac_keys\": {\n \"access_key\": \"GOOG1EXAMPLEACCESSID\",\n \"secret\": \"<string>\"\n },\n \"gcp_service_account_key\": {\n \"service_account_email\": \"data-export@acme-analytics-1234.iam.gserviceaccount.com\",\n \"service_account_key\": \"<unknown>\"\n }\n },\n \"s3_compatible\": {\n \"host\": \"s3.us-east-1.amazonaws.com\",\n \"port\": 443,\n \"bucket_name\": \"acme-data-export-staging\",\n \"auth_method\": \"access_keys\",\n \"aws_access_keys\": {\n \"access_id\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secret_key\": \"<string>\"\n },\n \"disable_ssl\": false,\n \"use_ssh_tunnel\": true\n },\n \"snowflake\": {\n \"host\": \"db54321.us-central1.gcp.snowflakecomputing.com\",\n \"port\": 443,\n \"database\": \"ANALYTICS\",\n \"username\": \"DATA_EXPORT_USER\",\n \"auth_method\": \"public_key_auth\",\n \"public_key_auth\": {\n \"public_key\": \"<string>\"\n }\n },\n \"delta_sharing\": {\n \"host\": \"sharing.delta.io\",\n \"port\": 443\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>"
}{
"status": "error",
"message": "<string>",
"data": null
}{
"status": "error",
"message": "<string>",
"data": null
}{
"status": "error",
"message": "<string>",
"data": null
}{
"status": "error",
"message": "<string>",
"data": null
}Authorizations
ApiKeyAuthAppId & ScopedAuthToken
Path Parameters
Import Provider ID.
Import Source ID.
Body
application/json
Optional partial source patch merged onto the saved source to test connection without persisting.
Show child attributes
Show child attributes