Skip to main content
POST
/
labels
JavaScript SDK
const labels = [
  { externalId: 'PUMP', name: "Pump" },
  { externalId: 'ROTATING_EQUIPMENT', name: 'Rotating equipment', description: 'Asset with rotating parts' }
];
const createdLabels = await client.labels.create(labels);
from cognite.client.data_classes import LabelDefinitionWrite
labels = [LabelDefinitionWrite(external_id="ROTATING_EQUIPMENT", name="Rotating equipment"), LabelDefinitionWrite(external_id="PUMP", name="pump")]
res = client.labels.create(labels)
List<Label> upsertLabelsList =  List.of(Label.newBuilder() 
.setExternalId("10")
.setName("Label name")
.setDescription("Description")
.build());

List<Label> list = client.labels().upsert(upsertLabelsList);
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/labels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"name": "<string>",
"description": "<string>",
"dataSetId": 4503599627370496
}
]
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/labels",
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',
'name' => '<string>',
'description' => '<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}/labels"

payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"name\": \"<string>\",\n \"description\": \"<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))

}
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/labels")

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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "externalId": "my.known.id",
      "name": "<string>",
      "createdTime": 1730204346000,
      "description": "<string>",
      "dataSetId": 4503599627370496
    }
  ]
}
{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}

Authorizations

Authorization
string
header
required

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

List of label definitions to create

items
object[]
required
Required array length: 1 - 1000 elements

Response

A list of label definitions.

items
object[]
required
Required array length: 1 - 1000 elements
Last modified on July 10, 2026