Data Diffs
Update a data diff
Update the configuration of an existing data diff via the Datafold API.
PATCH
/
api
/
v1
/
datadiffs
/
{datadiff_id}
Update a data diff
curl --request PATCH \
--url https://app.datafold.com/api/v1/datadiffs/{datadiff_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"purged": true
}
'import requests
url = "https://app.datafold.com/api/v1/datadiffs/{datadiff_id}"
payload = {
"archived": True,
"purged": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({archived: true, purged: true})
};
fetch('https://app.datafold.com/api/v1/datadiffs/{datadiff_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://app.datafold.com/api/v1/datadiffs/{datadiff_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([
'archived' => true,
'purged' => true
]),
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/datadiffs/{datadiff_id}"
payload := strings.NewReader("{\n \"archived\": true,\n \"purged\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.datafold.com/api/v1/datadiffs/{datadiff_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"archived\": true,\n \"purged\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.datafold.com/api/v1/datadiffs/{datadiff_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"archived\": true,\n \"purged\": true\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Previous
Get a data diff summaryGet the summary results of a specific data diff via the Datafold API.
Next
⌘I
Update a data diff
curl --request PATCH \
--url https://app.datafold.com/api/v1/datadiffs/{datadiff_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"purged": true
}
'import requests
url = "https://app.datafold.com/api/v1/datadiffs/{datadiff_id}"
payload = {
"archived": True,
"purged": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({archived: true, purged: true})
};
fetch('https://app.datafold.com/api/v1/datadiffs/{datadiff_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://app.datafold.com/api/v1/datadiffs/{datadiff_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([
'archived' => true,
'purged' => true
]),
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/datadiffs/{datadiff_id}"
payload := strings.NewReader("{\n \"archived\": true,\n \"purged\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.datafold.com/api/v1/datadiffs/{datadiff_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"archived\": true,\n \"purged\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.datafold.com/api/v1/datadiffs/{datadiff_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"archived\": true,\n \"purged\": true\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}