Update Integrations
Required capabilities:
integrationsAcl:WRITE
Update up to 20 integrations.
POST
/
integrations
/
update
Update Integrations
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.integrations.id",
"update": {
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"documentation": {
"set": "<string>"
},
"allowedNotSeenMinutes": {
"set": 720
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/update"
payload = { "items": [
{
"externalId": "my.integrations.id",
"update": {
"name": { "set": "<string>" },
"description": { "set": "<string>" },
"documentation": { "set": "<string>" },
"allowedNotSeenMinutes": { "set": 720 },
"metadata": { "set": {
"key1": "value1",
"key2": "value2"
} }
}
}
] }
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.integrations.id',
update: {
name: {set: '<string>'},
description: {set: '<string>'},
documentation: {set: '<string>'},
allowedNotSeenMinutes: {set: 720},
metadata: {set: {key1: 'value1', key2: 'value2'}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/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}/integrations/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' => [
[
'externalId' => 'my.integrations.id',
'update' => [
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'documentation' => [
'set' => '<string>'
],
'allowedNotSeenMinutes' => [
'set' => 720
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
]
]
]
]),
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}/integrations/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.integrations.id\",\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"allowedNotSeenMinutes\": {\n \"set\": 720\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\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}/integrations/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.integrations.id\",\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"allowedNotSeenMinutes\": {\n \"set\": 720\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/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 \"externalId\": \"my.integrations.id\",\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"allowedNotSeenMinutes\": {\n \"set\": 720\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.integrations.id",
"extractor": {
"externalId": "cognite-opcua",
"version": "1.2.3"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"description": "<string>",
"documentation": "<string>",
"metadata": {},
"allowedNotSeenMinutes": 1440,
"lastSeen": 1730204346000,
"lastConfigRevision": 123,
"activeConfigRevision": 123,
"tasks": [
{
"type": "continuous",
"name": "<string>",
"action": false,
"description": "<string>",
"sources": [
"<string>"
],
"targets": [
"<string>"
]
}
]
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 422,
"message": "Extra inputs are not permitted: type"
}
}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
Integration updates.
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Response
List of updated integrations.
Maximum array length:
100Show child attributes
Show child attributes
Last modified on September 25, 2026
⌘I
Update Integrations
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.integrations.id",
"update": {
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"documentation": {
"set": "<string>"
},
"allowedNotSeenMinutes": {
"set": 720
},
"metadata": {
"set": {
"key1": "value1",
"key2": "value2"
}
}
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/update"
payload = { "items": [
{
"externalId": "my.integrations.id",
"update": {
"name": { "set": "<string>" },
"description": { "set": "<string>" },
"documentation": { "set": "<string>" },
"allowedNotSeenMinutes": { "set": 720 },
"metadata": { "set": {
"key1": "value1",
"key2": "value2"
} }
}
}
] }
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.integrations.id',
update: {
name: {set: '<string>'},
description: {set: '<string>'},
documentation: {set: '<string>'},
allowedNotSeenMinutes: {set: 720},
metadata: {set: {key1: 'value1', key2: 'value2'}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/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}/integrations/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' => [
[
'externalId' => 'my.integrations.id',
'update' => [
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'documentation' => [
'set' => '<string>'
],
'allowedNotSeenMinutes' => [
'set' => 720
],
'metadata' => [
'set' => [
'key1' => 'value1',
'key2' => 'value2'
]
]
]
]
]
]),
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}/integrations/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.integrations.id\",\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"allowedNotSeenMinutes\": {\n \"set\": 720\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\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}/integrations/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.integrations.id\",\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"allowedNotSeenMinutes\": {\n \"set\": 720\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/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 \"externalId\": \"my.integrations.id\",\n \"update\": {\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"allowedNotSeenMinutes\": {\n \"set\": 720\n },\n \"metadata\": {\n \"set\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.integrations.id",
"extractor": {
"externalId": "cognite-opcua",
"version": "1.2.3"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"description": "<string>",
"documentation": "<string>",
"metadata": {},
"allowedNotSeenMinutes": 1440,
"lastSeen": 1730204346000,
"lastConfigRevision": 123,
"activeConfigRevision": 123,
"tasks": [
{
"type": "continuous",
"name": "<string>",
"action": false,
"description": "<string>",
"sources": [
"<string>"
],
"targets": [
"<string>"
]
}
]
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 422,
"message": "Extra inputs are not permitted: type"
}
}