CI
Upload PR/MR changes
POST
/
api
/
v1
/
ci
/
{ci_config_id}
/
{pr_num}
Upload PR/MR changes
curl --request POST \
--url https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
[
{
"pr": "<string>",
"prod": "<string>",
"exclude_columns": [],
"include_columns": [],
"pk": [
"<string>"
]
}
]
'import requests
url = "https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}"
payload = [
{
"pr": "<string>",
"prod": "<string>",
"exclude_columns": [],
"include_columns": [],
"pk": ["<string>"]
}
]
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
pr: '<string>',
prod: '<string>',
exclude_columns: [],
include_columns: [],
pk: ['<string>']
}
])
};
fetch('https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}', 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://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}",
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([
[
'pr' => '<string>',
'prod' => '<string>',
'exclude_columns' => [
],
'include_columns' => [
],
'pk' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}"
payload := strings.NewReader("[\n {\n \"pr\": \"<string>\",\n \"prod\": \"<string>\",\n \"exclude_columns\": [],\n \"include_columns\": [],\n \"pk\": [\n \"<string>\"\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"pr\": \"<string>\",\n \"prod\": \"<string>\",\n \"exclude_columns\": [],\n \"include_columns\": [],\n \"pk\": [\n \"<string>\"\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"pr\": \"<string>\",\n \"prod\": \"<string>\",\n \"exclude_columns\": [],\n \"include_columns\": [],\n \"pk\": [\n \"<string>\"\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"ci_run_id": 123,
"run_id": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Use the 'Authorization' header with the format 'Key '
Body
application/json
Previous
List data sourcesRetrieves all data sources for the organization, annotated with an `accessible` boolean.
Returns active data sources (not deleted, hidden, or draft). Each DS includes `accessible=True`
if the user is admin or the user's groups overlap with the DS's groups.
Next
⌘I
Upload PR/MR changes
curl --request POST \
--url https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
[
{
"pr": "<string>",
"prod": "<string>",
"exclude_columns": [],
"include_columns": [],
"pk": [
"<string>"
]
}
]
'import requests
url = "https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}"
payload = [
{
"pr": "<string>",
"prod": "<string>",
"exclude_columns": [],
"include_columns": [],
"pk": ["<string>"]
}
]
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
pr: '<string>',
prod: '<string>',
exclude_columns: [],
include_columns: [],
pk: ['<string>']
}
])
};
fetch('https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}', 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://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}",
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([
[
'pr' => '<string>',
'prod' => '<string>',
'exclude_columns' => [
],
'include_columns' => [
],
'pk' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}"
payload := strings.NewReader("[\n {\n \"pr\": \"<string>\",\n \"prod\": \"<string>\",\n \"exclude_columns\": [],\n \"include_columns\": [],\n \"pk\": [\n \"<string>\"\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"pr\": \"<string>\",\n \"prod\": \"<string>\",\n \"exclude_columns\": [],\n \"include_columns\": [],\n \"pk\": [\n \"<string>\"\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.datafold.com/api/v1/ci/{ci_config_id}/{pr_num}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"pr\": \"<string>\",\n \"prod\": \"<string>\",\n \"exclude_columns\": [],\n \"include_columns\": [],\n \"pk\": [\n \"<string>\"\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"ci_run_id": 123,
"run_id": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}