Python SDK
res = client.extraction_pipelines.retrieve_multiple(ids=[1, 2, 3])
res = client.extraction_pipelines.retrieve_multiple(external_ids=["abc", "def"], ignore_unknown_ids=True)List<Item> itemsByExternalIds = List.of(Item.newBuilder()
.setExternalId("10")
.build());
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve(itemsByExternalIds);//by list of items
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve("10");//by varargs of String
List<Item> itemsByInternalIds = List.of(Item.newBuilder()
.setId(10)
.build());
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve(itemsByInternalIds);
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve(10);//by varargs of Longcurl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370495
}
],
"ignoreUnknownIds": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{id: 4503599627370495}], ignoreUnknownIds: false})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/byids', 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/byids",
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
]
],
'ignoreUnknownIds' => false
]),
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/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370495\n }\n ],\n \"ignoreUnknownIds\": false\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/byids")
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 }\n ],\n \"ignoreUnknownIds\": false\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": [
{}
]
}Retrieve extraction pipelines
Required capabilities:
extractionpipelinesAcl:READ
Retrieves information about multiple extraction pipelines in the same project. All ids and externalIds must be unique.
POST
/
extpipes
/
byids
Python SDK
res = client.extraction_pipelines.retrieve_multiple(ids=[1, 2, 3])
res = client.extraction_pipelines.retrieve_multiple(external_ids=["abc", "def"], ignore_unknown_ids=True)List<Item> itemsByExternalIds = List.of(Item.newBuilder()
.setExternalId("10")
.build());
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve(itemsByExternalIds);//by list of items
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve("10");//by varargs of String
List<Item> itemsByInternalIds = List.of(Item.newBuilder()
.setId(10)
.build());
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve(itemsByInternalIds);
List<ExtractionPipeline> retrievedEvents =
client.extractionPipelines().retrieve(10);//by varargs of Longcurl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"id": 4503599627370495
}
],
"ignoreUnknownIds": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{id: 4503599627370495}], ignoreUnknownIds: false})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/byids', 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/byids",
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
]
],
'ignoreUnknownIds' => false
]),
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/byids"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": 4503599627370495\n }\n ],\n \"ignoreUnknownIds\": false\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/byids")
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 }\n ],\n \"ignoreUnknownIds\": false\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
Response
Response with the list of extraction pipelines
List of extraction pipelines
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I