Skip to main content
POST
/
extpipes
/
list
Java SDK
List<ExtractionPipeline> listPipelinesResults = new ArrayList<>(); 
client.extractionPipelines() 
          .list(Request.create() 
               .withFilterParameter("source", "source")) 
          .forEachRemaining(events -> listPipelinesResults.addAll(events)); 


curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "externalIdPrefix": "<string>",
    "name": "<string>",
    "description": "<string>",
    "dataSetIds": [
      {
        "id": 4503599627370496
      }
    ],
    "schedule": "<string>",
    "contacts": [
      {
        "name": "<string>",
        "email": "jsmith@example.com",
        "role": "<string>",
        "sendNotification": true
      }
    ],
    "rawTables": [
      {
        "dbName": "<string>",
        "tableName": "<string>"
      }
    ],
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "source": "<string>",
    "documentation": "<string>",
    "createdBy": "<string>",
    "createdTime": {
      "max": 1,
      "min": 1
    },
    "lastUpdatedTime": {
      "max": 1,
      "min": 1
    }
  },
  "limit": 100,
  "cursor": "<string>"
}
'
import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/list"

payload = {
    "filter": {
        "externalIdPrefix": "<string>",
        "name": "<string>",
        "description": "<string>",
        "dataSetIds": [{ "id": 4503599627370496 }],
        "schedule": "<string>",
        "contacts": [
            {
                "name": "<string>",
                "email": "jsmith@example.com",
                "role": "<string>",
                "sendNotification": True
            }
        ],
        "rawTables": [
            {
                "dbName": "<string>",
                "tableName": "<string>"
            }
        ],
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "source": "<string>",
        "documentation": "<string>",
        "createdBy": "<string>",
        "createdTime": {
            "max": 1,
            "min": 1
        },
        "lastUpdatedTime": {
            "max": 1,
            "min": 1
        }
    },
    "limit": 100,
    "cursor": "<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({
    filter: {
      externalIdPrefix: '<string>',
      name: '<string>',
      description: '<string>',
      dataSetIds: [{id: 4503599627370496}],
      schedule: '<string>',
      contacts: [
        {
          name: '<string>',
          email: 'jsmith@example.com',
          role: '<string>',
          sendNotification: true
        }
      ],
      rawTables: [{dbName: '<string>', tableName: '<string>'}],
      metadata: {property1: 'string', property2: 'string'},
      source: '<string>',
      documentation: '<string>',
      createdBy: '<string>',
      createdTime: {max: 1, min: 1},
      lastUpdatedTime: {max: 1, min: 1}
    },
    limit: 100,
    cursor: '<string>'
  })
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/extpipes/list', 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/list",
  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([
    'filter' => [
        'externalIdPrefix' => '<string>',
        'name' => '<string>',
        'description' => '<string>',
        'dataSetIds' => [
                [
                                'id' => 4503599627370496
                ]
        ],
        'schedule' => '<string>',
        'contacts' => [
                [
                                'name' => '<string>',
                                'email' => 'jsmith@example.com',
                                'role' => '<string>',
                                'sendNotification' => true
                ]
        ],
        'rawTables' => [
                [
                                'dbName' => '<string>',
                                'tableName' => '<string>'
                ]
        ],
        'metadata' => [
                'property1' => 'string',
                'property2' => 'string'
        ],
        'source' => '<string>',
        'documentation' => '<string>',
        'createdBy' => '<string>',
        'createdTime' => [
                'max' => 1,
                'min' => 1
        ],
        'lastUpdatedTime' => [
                'max' => 1,
                'min' => 1
        ]
    ],
    'limit' => 100,
    'cursor' => '<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}/extpipes/list"

	payload := strings.NewReader("{\n  \"filter\": {\n    \"externalIdPrefix\": \"<string>\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"dataSetIds\": [\n      {\n        \"id\": 4503599627370496\n      }\n    ],\n    \"schedule\": \"<string>\",\n    \"contacts\": [\n      {\n        \"name\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"role\": \"<string>\",\n        \"sendNotification\": true\n      }\n    ],\n    \"rawTables\": [\n      {\n        \"dbName\": \"<string>\",\n        \"tableName\": \"<string>\"\n      }\n    ],\n    \"metadata\": {\n      \"property1\": \"string\",\n      \"property2\": \"string\"\n    },\n    \"source\": \"<string>\",\n    \"documentation\": \"<string>\",\n    \"createdBy\": \"<string>\",\n    \"createdTime\": {\n      \"max\": 1,\n      \"min\": 1\n    },\n    \"lastUpdatedTime\": {\n      \"max\": 1,\n      \"min\": 1\n    }\n  },\n  \"limit\": 100,\n  \"cursor\": \"<string>\"\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/list")

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  \"filter\": {\n    \"externalIdPrefix\": \"<string>\",\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"dataSetIds\": [\n      {\n        \"id\": 4503599627370496\n      }\n    ],\n    \"schedule\": \"<string>\",\n    \"contacts\": [\n      {\n        \"name\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"role\": \"<string>\",\n        \"sendNotification\": true\n      }\n    ],\n    \"rawTables\": [\n      {\n        \"dbName\": \"<string>\",\n        \"tableName\": \"<string>\"\n      }\n    ],\n    \"metadata\": {\n      \"property1\": \"string\",\n      \"property2\": \"string\"\n    },\n    \"source\": \"<string>\",\n    \"documentation\": \"<string>\",\n    \"createdBy\": \"<string>\",\n    \"createdTime\": {\n      \"max\": 1,\n      \"min\": 1\n    },\n    \"lastUpdatedTime\": {\n      \"max\": 1,\n      \"min\": 1\n    }\n  },\n  \"limit\": 100,\n  \"cursor\": \"<string>\"\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

​
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
​
filter
object
​
limit
integer<int32>
default:100

Limits the number of results to return.

Required range: 1 <= x <= 1000
​
cursor
string

Response

Response with the list of extraction pipelines

List of extraction pipelines

​
items
object[]
Last modified on July 13, 2026