JavaScript SDK
const dataSets = await client.datasets.update([{id: 123, update: {description: {set: 'New description'}}}]);data_set = client.data_sets.retrieve(id=1)
data_set.description = "New description"
res = client.data_sets.update(data_set)
from cognite.client.data_classes import DataSetUpdate
my_update = DataSetUpdate(id=1).description.set("New description").metadata.remove(["key"])
res = client.data_sets.update(my_update)List<DataSet> upsertDataSetList = //list of DataSet;
List<DataSet> upsertDataSetsResults =
client.datasets().upsert(upsertDataSetList);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"update": {
"externalId": {
"set": "<string>"
},
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
},
"id": 4503599627370496
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/update",
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' => [
[
'update' => [
'externalId' => [
'set' => '<string>'
],
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
],
'id' => 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}/datasets/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"update\": {\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n },\n \"id\": 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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/update")
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 \"update\": {\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n },\n \"id\": 4503599627370496\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"writeProtected": false,
"id": 4503599627370496,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "my.known.id",
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Update data sets.
Required capabilities:
datasetsAcl:WRITE
POST
/
datasets
/
update
JavaScript SDK
const dataSets = await client.datasets.update([{id: 123, update: {description: {set: 'New description'}}}]);data_set = client.data_sets.retrieve(id=1)
data_set.description = "New description"
res = client.data_sets.update(data_set)
from cognite.client.data_classes import DataSetUpdate
my_update = DataSetUpdate(id=1).description.set("New description").metadata.remove(["key"])
res = client.data_sets.update(my_update)List<DataSet> upsertDataSetList = //list of DataSet;
List<DataSet> upsertDataSetsResults =
client.datasets().upsert(upsertDataSetList);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"update": {
"externalId": {
"set": "<string>"
},
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
},
"id": 4503599627370496
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/update",
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' => [
[
'update' => [
'externalId' => [
'set' => '<string>'
],
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
],
'id' => 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}/datasets/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"update\": {\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n },\n \"id\": 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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/datasets/update")
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 \"update\": {\n \"externalId\": {\n \"set\": \"<string>\"\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n },\n \"id\": 4503599627370496\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"writeProtected": false,
"id": 4503599627370496,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "my.known.id",
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
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
application/json
All provided IDs and external IDs must be unique. Fields that are not included in the request, are not changed.
Update applied to single data set
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
A list of data sets.
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I