Create a data product
Required capabilities:
dataProductsAcl:CREATE
Creates a new data product. Maximum 100 data products allowed per project. Request body must contain an ‘items’ array with up to 1 data product definition per request.
POST
/
dataproducts
Create a data product
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"schemaSpace": "<string>",
"description": "<string>",
"isGoverned": false,
"tags": [
"<string>"
]
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts"
payload = { "items": [
{
"externalId": "<string>",
"name": "<string>",
"schemaSpace": "<string>",
"description": "<string>",
"isGoverned": False,
"tags": ["<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: [
{
externalId: '<string>',
name: '<string>',
schemaSpace: '<string>',
description: '<string>',
isGoverned: false,
tags: ['<string>']
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts', 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",
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' => '<string>',
'name' => '<string>',
'schemaSpace' => '<string>',
'description' => '<string>',
'isGoverned' => false,
'tags' => [
'<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"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"schemaSpace\": \"<string>\",\n \"description\": \"<string>\",\n \"isGoverned\": false,\n \"tags\": [\n \"<string>\"\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"schemaSpace\": \"<string>\",\n \"description\": \"<string>\",\n \"isGoverned\": false,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts")
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\": \"<string>\",\n \"name\": \"<string>\",\n \"schemaSpace\": \"<string>\",\n \"description\": \"<string>\",\n \"isGoverned\": false,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"schemaSpace": "<string>",
"isGoverned": true,
"tags": [
"<string>"
],
"domains": [
"<string>"
],
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"description": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}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
Array of data products to create.
Required array length:
1 elementShow child attributes
Show child attributes
Response
The created data product (as a single-item list).
Show child attributes
Show child attributes
Last modified on September 24, 2026
⌘I
Create a data product
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"schemaSpace": "<string>",
"description": "<string>",
"isGoverned": false,
"tags": [
"<string>"
]
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts"
payload = { "items": [
{
"externalId": "<string>",
"name": "<string>",
"schemaSpace": "<string>",
"description": "<string>",
"isGoverned": False,
"tags": ["<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: [
{
externalId: '<string>',
name: '<string>',
schemaSpace: '<string>',
description: '<string>',
isGoverned: false,
tags: ['<string>']
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts', 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",
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' => '<string>',
'name' => '<string>',
'schemaSpace' => '<string>',
'description' => '<string>',
'isGoverned' => false,
'tags' => [
'<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"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"schemaSpace\": \"<string>\",\n \"description\": \"<string>\",\n \"isGoverned\": false,\n \"tags\": [\n \"<string>\"\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"schemaSpace\": \"<string>\",\n \"description\": \"<string>\",\n \"isGoverned\": false,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts")
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\": \"<string>\",\n \"name\": \"<string>\",\n \"schemaSpace\": \"<string>\",\n \"description\": \"<string>\",\n \"isGoverned\": false,\n \"tags\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"schemaSpace": "<string>",
"isGoverned": true,
"tags": [
"<string>"
],
"domains": [
"<string>"
],
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"description": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}