Create source
curl --request POST \
--url https://api.prequel.co/sources \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"vendor": "<unknown>",
"athena": {
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "arn:aws:iam::123456789012:role/service-role/role-name"
},
"workgroup": "<string>"
},
"name": "<string>",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
}
}
'import requests
url = "https://api.prequel.co/sources"
payload = { "source": {
"vendor": "<unknown>",
"athena": {
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": { "aws_iam_role_arn": "arn:aws:iam::123456789012:role/service-role/role-name" },
"workgroup": "<string>"
},
"name": "<string>",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
} }
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: {
vendor: '<unknown>',
athena: {
connection_database: '<string>',
bucket_s3: {bucket_name: '<string>', bucket_region: '<string>'},
auth_method: '<unknown>',
aws_iam_role: {aws_iam_role_arn: 'arn:aws:iam::123456789012:role/service-role/role-name'},
workgroup: '<string>'
},
name: '<string>',
max_concurrent_transfers: 123,
max_concurrent_queries_per_transfer: 123
}
})
};
fetch('https://api.prequel.co/sources', 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/sources",
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' => [
'vendor' => '<unknown>',
'athena' => [
'connection_database' => '<string>',
'bucket_s3' => [
'bucket_name' => '<string>',
'bucket_region' => '<string>'
],
'auth_method' => '<unknown>',
'aws_iam_role' => [
'aws_iam_role_arn' => 'arn:aws:iam::123456789012:role/service-role/role-name'
],
'workgroup' => '<string>'
],
'name' => '<string>',
'max_concurrent_transfers' => 123,
'max_concurrent_queries_per_transfer' => 123
]
]),
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/sources"
payload := strings.NewReader("{\n \"source\": {\n \"vendor\": \"<unknown>\",\n \"athena\": {\n \"connection_database\": \"<string>\",\n \"bucket_s3\": {\n \"bucket_name\": \"<string>\",\n \"bucket_region\": \"<string>\"\n },\n \"auth_method\": \"<unknown>\",\n \"aws_iam_role\": {\n \"aws_iam_role_arn\": \"arn:aws:iam::123456789012:role/service-role/role-name\"\n },\n \"workgroup\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123\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/sources")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"vendor\": \"<unknown>\",\n \"athena\": {\n \"connection_database\": \"<string>\",\n \"bucket_s3\": {\n \"bucket_name\": \"<string>\",\n \"bucket_region\": \"<string>\"\n },\n \"auth_method\": \"<unknown>\",\n \"aws_iam_role\": {\n \"aws_iam_role_arn\": \"arn:aws:iam::123456789012:role/service-role/role-name\"\n },\n \"workgroup\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prequel.co/sources")
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 \"vendor\": \"<unknown>\",\n \"athena\": {\n \"connection_database\": \"<string>\",\n \"bucket_s3\": {\n \"bucket_name\": \"<string>\",\n \"bucket_region\": \"<string>\"\n },\n \"auth_method\": \"<unknown>\",\n \"aws_iam_role\": {\n \"aws_iam_role_arn\": \"arn:aws:iam::123456789012:role/service-role/role-name\"\n },\n \"workgroup\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"source": {
"athena": {
"workgroup": "<string>",
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "<string>"
}
},
"id": "<string>",
"vendor": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
},
"ssh_public_key": "<string>"
},
"message": "<string>"
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}Sources
Create source
Add a new source.
POST
/
sources
Create source
curl --request POST \
--url https://api.prequel.co/sources \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"source": {
"vendor": "<unknown>",
"athena": {
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "arn:aws:iam::123456789012:role/service-role/role-name"
},
"workgroup": "<string>"
},
"name": "<string>",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
}
}
'import requests
url = "https://api.prequel.co/sources"
payload = { "source": {
"vendor": "<unknown>",
"athena": {
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": { "aws_iam_role_arn": "arn:aws:iam::123456789012:role/service-role/role-name" },
"workgroup": "<string>"
},
"name": "<string>",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
} }
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: {
vendor: '<unknown>',
athena: {
connection_database: '<string>',
bucket_s3: {bucket_name: '<string>', bucket_region: '<string>'},
auth_method: '<unknown>',
aws_iam_role: {aws_iam_role_arn: 'arn:aws:iam::123456789012:role/service-role/role-name'},
workgroup: '<string>'
},
name: '<string>',
max_concurrent_transfers: 123,
max_concurrent_queries_per_transfer: 123
}
})
};
fetch('https://api.prequel.co/sources', 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/sources",
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' => [
'vendor' => '<unknown>',
'athena' => [
'connection_database' => '<string>',
'bucket_s3' => [
'bucket_name' => '<string>',
'bucket_region' => '<string>'
],
'auth_method' => '<unknown>',
'aws_iam_role' => [
'aws_iam_role_arn' => 'arn:aws:iam::123456789012:role/service-role/role-name'
],
'workgroup' => '<string>'
],
'name' => '<string>',
'max_concurrent_transfers' => 123,
'max_concurrent_queries_per_transfer' => 123
]
]),
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/sources"
payload := strings.NewReader("{\n \"source\": {\n \"vendor\": \"<unknown>\",\n \"athena\": {\n \"connection_database\": \"<string>\",\n \"bucket_s3\": {\n \"bucket_name\": \"<string>\",\n \"bucket_region\": \"<string>\"\n },\n \"auth_method\": \"<unknown>\",\n \"aws_iam_role\": {\n \"aws_iam_role_arn\": \"arn:aws:iam::123456789012:role/service-role/role-name\"\n },\n \"workgroup\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123\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/sources")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"vendor\": \"<unknown>\",\n \"athena\": {\n \"connection_database\": \"<string>\",\n \"bucket_s3\": {\n \"bucket_name\": \"<string>\",\n \"bucket_region\": \"<string>\"\n },\n \"auth_method\": \"<unknown>\",\n \"aws_iam_role\": {\n \"aws_iam_role_arn\": \"arn:aws:iam::123456789012:role/service-role/role-name\"\n },\n \"workgroup\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prequel.co/sources")
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 \"vendor\": \"<unknown>\",\n \"athena\": {\n \"connection_database\": \"<string>\",\n \"bucket_s3\": {\n \"bucket_name\": \"<string>\",\n \"bucket_region\": \"<string>\"\n },\n \"auth_method\": \"<unknown>\",\n \"aws_iam_role\": {\n \"aws_iam_role_arn\": \"arn:aws:iam::123456789012:role/service-role/role-name\"\n },\n \"workgroup\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"source": {
"athena": {
"workgroup": "<string>",
"connection_database": "<string>",
"bucket_s3": {
"bucket_name": "<string>",
"bucket_region": "<string>"
},
"auth_method": "<unknown>",
"aws_iam_role": {
"aws_iam_role_arn": "<string>"
}
},
"id": "<string>",
"vendor": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123
},
"ssh_public_key": "<string>"
},
"message": "<string>"
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}Authorizations
Body
application/json
- Amazon Athena
- Amazon Aurora MySQL
- Amazon Aurora PostgreSQL
- Google BigQuery
- ClickHouse
- Databricks
- Mock (for testing in staging only)
- MongoDB
- MotherDuck
- MySQL
- Oracle
- PostgreSQL
- Amazon Redshift
- Amazon Redshift Serverless
- SingleStore
- Snowflake
- SQL Server
Show child attributes
Show child attributes
⌘I