How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Extraction Pipelines API

Extraction Pipeline objects represent the applications and software that are deployed to ingest operational data into CDF. An extraction pipeline can consist of a number of different software components between the source system and CDF. The extraction pipeline object represents the software component that actually sends the data to CDF. Two examples are Cognite extractors and third party ETL tools such as Microsoft Azure or Informatica PowerCenter

Cognite Extraction Pipelines API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Extraction Pipelines. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 6 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

7 operations 6 paths 44 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Extraction Pipelines API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — 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 acce…
  • oauth2-client-credentials — 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 acce…
  • oauth2-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 acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Extraction Pipelines 7

Extraction Pipeline objects represent the applications and software that are deployed to ingest operational data into CDF. An extraction pipeline can consist of a number of differ…

GET
/extpipes
List extraction pipelines
listExtPipes 2 params → 200
POST
/extpipes
Create extraction pipelines
createExtPipes body → 200400
POST
/extpipes/delete
Delete extraction pipelines
deleteExtPipes body → 200400
POST
/extpipes/update
Update extraction pipelines
updateExtPipes body → 200400
GET
/extpipes/{id}
Retrieve an extraction pipeline by its ID.
showExtPipe 1 param → 200400
POST
/extpipes/byids
Retrieve extraction pipelines
byidsExtPipes body → 200400
POST
/extpipes/list
Filter extraction pipelines
filterExtPipes body → 200400

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are ExtPipesFilter (13 properties), CreateExtPipe (12 properties), ExtPipeUpdateData (11 properties), Contact (4 properties). Each schema is shown below with its type and property counts.

DataSetIdEither
ExtPipesWithCursor
object
List of extraction pipelines
2 properties
ExtPipeUpdateByExternalId
object
2 properties
NameUpdateField
object
Set a new value for name.
1 property 1 required
ExtPipeExternalId
object
1 property 1 required
ExtPipeUpdateData
object
List of updates for Extraction Pipeline
11 properties
MapUpdateAddRemove
object
2 properties
DataSetIdUpdateField
object
Set a new value for dataSetId.
1 property
SourceUpdateField
object
Set a new value for source.
1 property
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
RawTablesUpdateSet
object
1 property
ExtPipeInternalId
object
1 property 1 required
ExtPipeId
object
RawTablesUpdateAddRemove
object
2 properties
ExtPipesFilterRequest
object
3 properties
DocumentationUpdateField
object
Set a new value for documentation.
1 property
DescriptionUpdateField
object
Set a new value for description.
1 property
ItemsRequest_CreateExtPipe_
object
1 property 1 required
DefaultError
object
Cognite API error
4 properties
ExtPipesFilter
object
13 properties
ContactsUpdate
object
Updates the resource's assigned contacts. Contacts can be added, removed or replaced (set).
CogniteInternalId
integer
A server-generated ID for the object.
Contact
object
4 properties
DataSetInternalId
object
1 property 1 required
ContactsUpdateAddRemove
object
2 properties
ExtPipeUpdate
object
ExtPipeNotificationConfiguration
object
1 property
RawTablesUpdate
object
Updates the resource's assigned rawTables. RawTables can be added, removed or replaced (set).
MapUpdate
object
Custom, application specific metadata. String key - String value. Limits of updated extraction pipeline: Maximum length of key is 128 bytes, value 10240 bytes,…
ExtendedItemsRequest_ExtPipeId_
object
2 properties 1 required
ItemsRequest_ExtPipeUpdate_
object
1 property 1 required
ContactsUpdateSet
object
1 property
ExtPipe
ScheduleUpdateField
object
Set a new value for schedule.
1 property
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
ExtPipes
object
List of extraction pipelines
1 property
MapUpdateSet
object
1 property
ExtPipeUpdateById
object
2 properties
RawTable
object
2 properties 2 required
ConfigurationUpdateSet
object
1 property
EpochTimestampRange
object
Range between two timestamps (inclusive).
2 properties
ExternalIdUpdateField
object
Set a new value for the externalId. Must be unique for the resource type.
1 property 1 required
CreateExtPipe
object
12 properties 3 required
DataSetExternalId
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-extraction-pipelines-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Extraction Pipelines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.