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 Extractors API

Extractors are tools used to move data from various source systems to CDF. The extractors API is used to manage extractor releases, give access to downloads, and contextualize which source systems each extractor is used to access.Each extractor has a list of releases, and each release may have a list of artifacts which are things like documentation PDFs, executables, and installers.Extractors may also be tied to source systems through solutions, representing concrete sources each extractor may connect to.The extractors API is currently read-only. In the future it may be possible to define per-project extractors. Because of this, cognite-maintained extractors and source systems currently have their external ID prefixed by `cognite-`.

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

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

This API exposes 9 operations across 9 paths, and defines 21 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}.

9 operations 9 paths 21 schemas 5 GET4 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 Extractors 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 9

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

Extractors 9

Extractors are tools used to move data from various source systems to CDF. The extractors API is used to manage extractor releases, give access to downloads, and contextualize whi…

GET
/extractors
List Extractors
list_extractors → 200400
POST
/extractors/byids
Retrieve Extractors
retrieve_extractors body → 200400422
GET
/extractors/releases
List releases
list_releases 1 param → 200400
POST
/extractors/releases/byids
Retrieve Releases
retrieve_releases body → 200400422
GET
/extractors/sources
List Source Systems
list_source_systems → 200400
POST
/extractors/sources/byids
Retrieve Source Systems
retrieve_source_systems body → 200400422
GET
/extractors/solutions
List Solutions
list_solutions → 200400
POST
/extractors/solutions/byids
Retrieve Solutions
retrieve_solutions body → 200400422
GET
/extractors/schemas/{extractor}/{version}
Get Config Schema
get_extractor_schema 2 params → 200400

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Extractor (9 properties), SourceSystem (7 properties), Solution (6 properties), Release (6 properties). Each schema is shown below with its type and property counts.

ExtractorsItemsWithIgnoreUnknownIds_ExternalId_
object
List of externalIds with optional ignore unknown ids
2 properties 1 required
Solution
object
A solution represents a connection between an extractor and a source system it can be configured to read from.
6 properties 3 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
Extractor
object
An extractor instance
9 properties 4 required
ItemsResponse_Extractor_
object
List of extractors
1 property 1 required
ItemsResponse_Solution_
object
List of source systems
1 property 1 required
Artifact
object
An artifact for an extractor release.
4 properties 3 required
ItemsResponse_Release_
object
List of releases
1 property 1 required
ReleaseId
object
Identifier for a release
2 properties 2 required
Changelog
object
Extractor changelog, uses the [keep-a-changelog](https://keepachangelog.com/en/1.1.0/) format
6 properties
Link
object
Link to an external resource for an extractor
3 properties 3 required
SourceSystem
object
A source system representing a source extractors may read from.
7 properties 4 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
ExtractorId
object
Identifier for an extractor
1 property 1 required
ValidationErrorContent
object
Cognite API error.
2 properties 2 required
LinkType
Enumeration of link types.
Error
object
Cognite API error.
4 properties 2 required
ItemType
string
Status of this item. "Global" means that it is maintained by Cognite and considered official. "Community" means that it is community made and maintained. "Unre…
ItemsResponse_SourceSystem_
object
List of source systems
1 property 1 required
Release
object
A release of an extractor
6 properties 3 required
ItemsWithIgnoreUnknownIds_ReleaseId_
object
List of release ids with optional ignore unknown ids
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-extractors-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 Extractors 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.