Skip to main content
POST
Report Extractor Info

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

Update to extractor information.

Request sent on extractor startup containing information about the extractor.

externalId
string
required

The external ID provided by the client. Must be unique for the resource type.

Required string length: 1 - 255
Example:

"my.integrations.id"

extractor
Extractor · object
required

Identifier for an extractor. Note that if the extractor externalId starts with cognite, it must correspond to a cognite extractor.

tasks
Task · object[]

A list of tasks configured for this extractor.

activeConfigRevision

The currently active config revision, or "local" if a local config file is in use.

timestamp
integer

Timestamp of the startup event in milliseconds since 01/01/1970.

availableActions
AvailableAction · object[]

List of actions the extractor supports. CDF uses this to know what remote operations can be requested for this integration.

Maximum array length: 100

Response

Response with updates for the extractor.

Response sent on extractor check-in.

externalId
string
required

The external ID provided by the client. Must be unique for the resource type.

Required string length: 1 - 255
Example:

"my.integrations.id"

lastConfigRevision
integer

Last stored extractor configuration revision.

pendingActions
Action · object[]

Actions the extractor should pick up and perform, reporting their outcome back via actionUpdates on a subsequent checkin.

Last modified on September 25, 2026