Python SDK
from cognite.client.data_classes import ExtractionPipelineUpdate
update = ExtractionPipelineUpdate(id=1)
update.description.set("Another new extpipe")
res = client.extraction_pipelines.update(update)
List<ExtractionPipeline> upsertPipelinesList = //list of ExtractionPipeline
client.extractionPipelines().upsert(upsertPipelinesList);
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370495,
"update": {
"description": {
"set": "<string>"
},
"dataSetId": {
"set": 4503599627370495
},
"schedule": {
"set": "<string>"
},
"rawTables": {
"set": [
{
"dbName": "<string>",
"tableName": "<string>"
}
]
},
"contacts": {
"set": [
{
"name": "<string>",
"email": "jsmith@example.com",
"role": "<string>",
"sendNotification": true
}
]
},
"metadata": {
"set": {
"property1": "string",
"property2": "string"
}
},
"source": {
"set": "<string>"
},
"documentation": {
"set": "<string>"
},
"notificationConfig": {
"set": {
"allowedNotSeenRangeInMinutes": 1
}
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
id: 4503599627370495,
update: {
description: {set: '<string>'},
dataSetId: {set: 4503599627370495},
schedule: {set: '<string>'},
rawTables: {set: [{dbName: '<string>', tableName: '<string>'}]},
contacts: {
set: [
{
name: '<string>',
email: 'jsmith@example.com',
role: '<string>',
sendNotification: true
}
]
},
metadata: {set: {property1: 'string', property2: 'string'}},
source: {set: '<string>'},
documentation: {set: '<string>'},
notificationConfig: {set: {allowedNotSeenRangeInMinutes: 1}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/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}/extpipes/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' => [
[
'id' => 4503599627370495,
'update' => [
'description' => [
'set' => '<string>'
],
'dataSetId' => [
'set' => 4503599627370495
],
'schedule' => [
'set' => '<string>'
],
'rawTables' => [
'set' => [
[
'dbName' => '<string>',
'tableName' => '<string>'
]
]
],
'contacts' => [
'set' => [
[
'name' => '<string>',
'email' => 'jsmith@example.com',
'role' => '<string>',
'sendNotification' => true
]
]
],
'metadata' => [
'set' => [
'property1' => 'string',
'property2' => 'string'
]
],
'source' => [
'set' => '<string>'
],
'documentation' => [
'set' => '<string>'
],
'notificationConfig' => [
'set' => [
'allowedNotSeenRangeInMinutes' => 1
]
]
]
]
]
]),
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}/extpipes/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370495,\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370495\n },\n \"schedule\": {\n \"set\": \"<string>\"\n },\n \"rawTables\": {\n \"set\": [\n {\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\"\n }\n ]\n },\n \"contacts\": {\n \"set\": [\n {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"role\": \"<string>\",\n \"sendNotification\": true\n }\n ]\n },\n \"metadata\": {\n \"set\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n }\n },\n \"source\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"notificationConfig\": {\n \"set\": {\n \"allowedNotSeenRangeInMinutes\": 1\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/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 \"id\": 4503599627370495,\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370495\n },\n \"schedule\": {\n \"set\": \"<string>\"\n },\n \"rawTables\": {\n \"set\": [\n {\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\"\n }\n ]\n },\n \"contacts\": {\n \"set\": [\n {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"role\": \"<string>\",\n \"sendNotification\": true\n }\n ]\n },\n \"metadata\": {\n \"set\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n }\n },\n \"source\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"notificationConfig\": {\n \"set\": {\n \"allowedNotSeenRangeInMinutes\": 1\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"dataSetId": 4503599627370495,
"description": "<string>",
"rawTables": [
{
"dbName": "<string>",
"tableName": "<string>"
}
],
"schedule": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"role": "<string>",
"sendNotification": true
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"source": "<string>",
"documentation": "<string>",
"notificationConfig": {
"allowedNotSeenRangeInMinutes": 1
},
"createdBy": "<string>",
"id": 4503599627370495,
"lastSuccess": 123,
"lastFailure": 123,
"lastMessage": "<string>",
"lastSeen": 123,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}{
"code": 123,
"message": "<string>",
"missing": [
{}
],
"duplicated": [
{}
]
}Update extraction pipelines
Required capabilities:
extractionpipelinesAcl:WRITEdatasetsAcl:READ
Update information for a list of extraction pipelines. Fields that are not included in the request, are not changed.
POST
/
extpipes
/
update
Python SDK
from cognite.client.data_classes import ExtractionPipelineUpdate
update = ExtractionPipelineUpdate(id=1)
update.description.set("Another new extpipe")
res = client.extraction_pipelines.update(update)
List<ExtractionPipeline> upsertPipelinesList = //list of ExtractionPipeline
client.extractionPipelines().upsert(upsertPipelinesList);
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370495,
"update": {
"description": {
"set": "<string>"
},
"dataSetId": {
"set": 4503599627370495
},
"schedule": {
"set": "<string>"
},
"rawTables": {
"set": [
{
"dbName": "<string>",
"tableName": "<string>"
}
]
},
"contacts": {
"set": [
{
"name": "<string>",
"email": "jsmith@example.com",
"role": "<string>",
"sendNotification": true
}
]
},
"metadata": {
"set": {
"property1": "string",
"property2": "string"
}
},
"source": {
"set": "<string>"
},
"documentation": {
"set": "<string>"
},
"notificationConfig": {
"set": {
"allowedNotSeenRangeInMinutes": 1
}
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
id: 4503599627370495,
update: {
description: {set: '<string>'},
dataSetId: {set: 4503599627370495},
schedule: {set: '<string>'},
rawTables: {set: [{dbName: '<string>', tableName: '<string>'}]},
contacts: {
set: [
{
name: '<string>',
email: 'jsmith@example.com',
role: '<string>',
sendNotification: true
}
]
},
metadata: {set: {property1: 'string', property2: 'string'}},
source: {set: '<string>'},
documentation: {set: '<string>'},
notificationConfig: {set: {allowedNotSeenRangeInMinutes: 1}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/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}/extpipes/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' => [
[
'id' => 4503599627370495,
'update' => [
'description' => [
'set' => '<string>'
],
'dataSetId' => [
'set' => 4503599627370495
],
'schedule' => [
'set' => '<string>'
],
'rawTables' => [
'set' => [
[
'dbName' => '<string>',
'tableName' => '<string>'
]
]
],
'contacts' => [
'set' => [
[
'name' => '<string>',
'email' => 'jsmith@example.com',
'role' => '<string>',
'sendNotification' => true
]
]
],
'metadata' => [
'set' => [
'property1' => 'string',
'property2' => 'string'
]
],
'source' => [
'set' => '<string>'
],
'documentation' => [
'set' => '<string>'
],
'notificationConfig' => [
'set' => [
'allowedNotSeenRangeInMinutes' => 1
]
]
]
]
]
]),
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}/extpipes/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370495,\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370495\n },\n \"schedule\": {\n \"set\": \"<string>\"\n },\n \"rawTables\": {\n \"set\": [\n {\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\"\n }\n ]\n },\n \"contacts\": {\n \"set\": [\n {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"role\": \"<string>\",\n \"sendNotification\": true\n }\n ]\n },\n \"metadata\": {\n \"set\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n }\n },\n \"source\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"notificationConfig\": {\n \"set\": {\n \"allowedNotSeenRangeInMinutes\": 1\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/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 \"id\": 4503599627370495,\n \"update\": {\n \"description\": {\n \"set\": \"<string>\"\n },\n \"dataSetId\": {\n \"set\": 4503599627370495\n },\n \"schedule\": {\n \"set\": \"<string>\"\n },\n \"rawTables\": {\n \"set\": [\n {\n \"dbName\": \"<string>\",\n \"tableName\": \"<string>\"\n }\n ]\n },\n \"contacts\": {\n \"set\": [\n {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"role\": \"<string>\",\n \"sendNotification\": true\n }\n ]\n },\n \"metadata\": {\n \"set\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n }\n },\n \"source\": {\n \"set\": \"<string>\"\n },\n \"documentation\": {\n \"set\": \"<string>\"\n },\n \"notificationConfig\": {\n \"set\": {\n \"allowedNotSeenRangeInMinutes\": 1\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"dataSetId": 4503599627370495,
"description": "<string>",
"rawTables": [
{
"dbName": "<string>",
"tableName": "<string>"
}
],
"schedule": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"role": "<string>",
"sendNotification": true
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"source": "<string>",
"documentation": "<string>",
"notificationConfig": {
"allowedNotSeenRangeInMinutes": 1
},
"createdBy": "<string>",
"id": 4503599627370495,
"lastSuccess": 123,
"lastFailure": 123,
"lastMessage": "<string>",
"lastSeen": 123,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}{
"code": 123,
"message": "<string>",
"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
Required array length:
1 - 1000 elements- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Response with the list of updated extraction pipelines
List of extraction pipelines
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I