Skip to main content
GET
/
extpipes
/
{id}
Python SDK
res = client.extraction_pipelines.retrieve(id=1)

res = client.extraction_pipelines.retrieve(external_id="1")
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
id
integer<int64>
required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991

Response

Single extraction pipeline response

​
externalId
string
required

External Id provided by client. Should be unique within the project.

Required string length: 1 - 255
​
name
string
required

Name of Extraction Pipeline

Required string length: 1 - 140
​
dataSetId
integer<int64>
required

DataSet ID

Required range: 0 <= x <= 9007199254740991
​
description
string | null

Description of Extraction Pipeline

Maximum string length: 500
​
rawTables
object[] | null

Raw tables

​
schedule
string | null

Possible values: “On trigger”, “Continuous” or cron expression. If empty then null

Pattern: ^(On trigger|Continuous)|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)|((((\d+,)+\d+|(\d+([/\-])\d+)|\d+|\*(/\d+)?) ?){5,7})$
​
contacts
object[] | null

Contacts list.

​
metadata
object

Custom, application specific metadata. String key -> String value. Limits: Key are at most 128 bytes. Values are at most 10240 bytes. Up to 256 key-value pairs. Total size is at most 10240.

Example:
{
  "property1": "string",
  "property2": "string"
}
​
source
string | null

Source for Extraction Pipeline

Maximum string length: 255
​
documentation
string | null

Documentation text field, supports Markdown for text formatting.

Maximum string length: 10000
​
notificationConfig
object
​
createdBy
string

Extraction Pipeline creator. Usually user email is expected here

Maximum string length: 255
​
id
integer<int64>

A server-generated ID for the object.

Required range: 0 <= x <= 9007199254740991
​
lastSuccess
integer<int64>

Time of last successful run. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

​
lastFailure
integer<int64>

Time of last failure run. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

​
lastMessage
string

Last failure message.

​
lastSeen
integer<int64>

Last seen time. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

​
createdTime
integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
lastUpdatedTime
integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

Last modified on June 2, 2026