Update data product version
Required capabilities:
dataProductsAcl:UPDATE
Update the attributes of a data product version. Fields that aren’t included in the request aren’t changed.
POST
/
dataproducts
/
{externalId}
/
versions
/
update
Update data product version
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"version": "1.2.34",
"update": {
"description": {
"set": "<string>"
},
"terms": {
"modify": {
"usage": {
"set": "<string>"
},
"limitations": {
"set": "<string>"
}
}
}
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/update"
payload = { "items": [
{
"version": "1.2.34",
"update": {
"description": { "set": "<string>" },
"terms": { "modify": {
"usage": { "set": "<string>" },
"limitations": { "set": "<string>" }
} }
}
}
] }
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: [
{
version: '1.2.34',
update: {
description: {set: '<string>'},
terms: {modify: {usage: {set: '<string>'}, limitations: {set: '<string>'}}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/update', 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}/dataproducts/{externalId}/versions/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' => [
[
'version' => '1.2.34',
'update' => [
'description' => [
'set' => '<string>'
],
'terms' => [
'modify' => [
'usage' => [
'set' => '<string>'
],
'limitations' => [
'set' => '<string>'
]
]
]
]
]
]
]),
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}/dataproducts/{externalId}/versions/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"version\": \"1.2.34\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"terms\": {\n \"modify\": {\n \"usage\": {\n \"set\": \"<string>\"\n },\n \"limitations\": {\n \"set\": \"<string>\"\n }\n }\n }\n }\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}/dataproducts/{externalId}/versions/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"version\": \"1.2.34\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"terms\": {\n \"modify\": {\n \"usage\": {\n \"set\": \"<string>\"\n },\n \"limitations\": {\n \"set\": \"<string>\"\n }\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/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 \"version\": \"1.2.34\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"terms\": {\n \"modify\": {\n \"usage\": {\n \"set\": \"<string>\"\n },\n \"limitations\": {\n \"set\": \"<string>\"\n }\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"version": "1.2.34",
"views": [
{
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"status": "draft",
"terms": {
"usage": "<string>",
"limitations": "<string>"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"description": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"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.
Path Parameters
Data product external identifier
Required string length:
1 - 100Pattern:
^[a-z]([a-z0-9_-]{0,98}[a-z0-9])?$Body
application/json
List of data product versions (of this data product) to update.
Required array length:
1 elementShow child attributes
Show child attributes
Response
The updated data product version (as a single-item list).
Show child attributes
Show child attributes
Last modified on September 24, 2026
⌘I
Update data product version
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"version": "1.2.34",
"update": {
"description": {
"set": "<string>"
},
"terms": {
"modify": {
"usage": {
"set": "<string>"
},
"limitations": {
"set": "<string>"
}
}
}
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/update"
payload = { "items": [
{
"version": "1.2.34",
"update": {
"description": { "set": "<string>" },
"terms": { "modify": {
"usage": { "set": "<string>" },
"limitations": { "set": "<string>" }
} }
}
}
] }
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: [
{
version: '1.2.34',
update: {
description: {set: '<string>'},
terms: {modify: {usage: {set: '<string>'}, limitations: {set: '<string>'}}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/update', 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}/dataproducts/{externalId}/versions/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' => [
[
'version' => '1.2.34',
'update' => [
'description' => [
'set' => '<string>'
],
'terms' => [
'modify' => [
'usage' => [
'set' => '<string>'
],
'limitations' => [
'set' => '<string>'
]
]
]
]
]
]
]),
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}/dataproducts/{externalId}/versions/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"version\": \"1.2.34\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"terms\": {\n \"modify\": {\n \"usage\": {\n \"set\": \"<string>\"\n },\n \"limitations\": {\n \"set\": \"<string>\"\n }\n }\n }\n }\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}/dataproducts/{externalId}/versions/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"version\": \"1.2.34\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"terms\": {\n \"modify\": {\n \"usage\": {\n \"set\": \"<string>\"\n },\n \"limitations\": {\n \"set\": \"<string>\"\n }\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/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 \"version\": \"1.2.34\",\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"terms\": {\n \"modify\": {\n \"usage\": {\n \"set\": \"<string>\"\n },\n \"limitations\": {\n \"set\": \"<string>\"\n }\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"version": "1.2.34",
"views": [
{
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"status": "draft",
"terms": {
"usage": "<string>",
"limitations": "<string>"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"description": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}