curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"format": "one_lake",
"settings": {
"credentials": {
"clientId": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientSecret": "<string>"
},
"locationDescription": {
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"containerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"name": "<string>",
"dataSetId": 4503599627370496
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata"
payload = { "items": [
{
"externalId": "my.known.id",
"format": "one_lake",
"settings": {
"credentials": {
"clientId": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientSecret": "<string>"
},
"locationDescription": {
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"containerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"name": "<string>",
"dataSetId": 4503599627370496
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
format: 'one_lake',
settings: {
credentials: {
clientId: '<string>',
tenantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clientSecret: '<string>'
},
locationDescription: {
workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
containerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
},
name: '<string>',
dataSetId: 4503599627370496
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata",
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([
'items' => [
[
'externalId' => 'my.known.id',
'format' => 'one_lake',
'settings' => [
'credentials' => [
'clientId' => '<string>',
'tenantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clientSecret' => '<string>'
],
'locationDescription' => [
'workspaceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'containerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => '<string>',
'dataSetId' => 4503599627370496
]
]
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"format\": \"one_lake\",\n \"settings\": {\n \"credentials\": {\n \"clientId\": \"<string>\",\n \"tenantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientSecret\": \"<string>\"\n },\n \"locationDescription\": {\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"name\": \"<string>\",\n \"dataSetId\": 4503599627370496\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"format\": \"one_lake\",\n \"settings\": {\n \"credentials\": {\n \"clientId\": \"<string>\",\n \"tenantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientSecret\": \"<string>\"\n },\n \"locationDescription\": {\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"name\": \"<string>\",\n \"dataSetId\": 4503599627370496\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"format\": \"one_lake\",\n \"settings\": {\n \"credentials\": {\n \"clientId\": \"<string>\",\n \"tenantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientSecret\": \"<string>\"\n },\n \"locationDescription\": {\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"name\": \"<string>\",\n \"dataSetId\": 4503599627370496\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"format": "one_lake",
"settings": {
"credentials": {
"clientId": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"locationDescription": {
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"containerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"dataSetId": 4503599627370496
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 403,
"message": "This endpoint is not enabled for project: my-project"
}
}{
"error": {
"code": 409,
"message": "Conflict"
}
}Upsert external data sources
Required capabilities:
transformationsExternalDataSourcesAcl:WRITE
Create or replace external data sources, matched on externalId.
Each item replaces the stored data source in full, so every request
must contain complete settings including clientSecret.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"format": "one_lake",
"settings": {
"credentials": {
"clientId": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientSecret": "<string>"
},
"locationDescription": {
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"containerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"name": "<string>",
"dataSetId": 4503599627370496
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata"
payload = { "items": [
{
"externalId": "my.known.id",
"format": "one_lake",
"settings": {
"credentials": {
"clientId": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientSecret": "<string>"
},
"locationDescription": {
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"containerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"name": "<string>",
"dataSetId": 4503599627370496
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
format: 'one_lake',
settings: {
credentials: {
clientId: '<string>',
tenantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clientSecret: '<string>'
},
locationDescription: {
workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
containerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
},
name: '<string>',
dataSetId: 4503599627370496
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata",
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([
'items' => [
[
'externalId' => 'my.known.id',
'format' => 'one_lake',
'settings' => [
'credentials' => [
'clientId' => '<string>',
'tenantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clientSecret' => '<string>'
],
'locationDescription' => [
'workspaceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'containerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => '<string>',
'dataSetId' => 4503599627370496
]
]
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"format\": \"one_lake\",\n \"settings\": {\n \"credentials\": {\n \"clientId\": \"<string>\",\n \"tenantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientSecret\": \"<string>\"\n },\n \"locationDescription\": {\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"name\": \"<string>\",\n \"dataSetId\": 4503599627370496\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"format\": \"one_lake\",\n \"settings\": {\n \"credentials\": {\n \"clientId\": \"<string>\",\n \"tenantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientSecret\": \"<string>\"\n },\n \"locationDescription\": {\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"name\": \"<string>\",\n \"dataSetId\": 4503599627370496\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/externaldata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"format\": \"one_lake\",\n \"settings\": {\n \"credentials\": {\n \"clientId\": \"<string>\",\n \"tenantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientSecret\": \"<string>\"\n },\n \"locationDescription\": {\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"containerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"name\": \"<string>\",\n \"dataSetId\": 4503599627370496\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"format": "one_lake",
"settings": {
"credentials": {
"clientId": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"locationDescription": {
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"containerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"dataSetId": 4503599627370496
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 403,
"message": "This endpoint is not enabled for project: my-project"
}
}{
"error": {
"code": 409,
"message": "Conflict"
}
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
External data sources to create or replace. All externalId
values must be unique within the request.
1 - 1000 elementsShow child attributes
Show child attributes
Response
Response with the created or updated external data sources.
Array of objects (External Data Source).
Show child attributes
Show child attributes
Was this page helpful?