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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cognite

Cognite Integrations API

Each integration represents an application running on-premises.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 14 operations across 12 paths, and defines 46 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}.

14 operations 12 paths 46 schemas 6 GET8 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
Contact
Cognite Support
Resource Areas
1

Authentication & Security 5

Cognite Integrations 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 14

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

Integrations 14

Each integration represents an application running on-premises.

GET
/integrations
List Integrations
list_integrations 2 params → 200400422
POST
/integrations
Create Integrations
create_integrations body → 200400422
POST
/integrations/byids
Retrieve Integrations
retrieve_integrations body → 200400422
POST
/integrations/delete
Delete Integrations
delete_integrations body → 200400422
POST
/integrations/update
Update Integrations
update_integrations body → 200400422
POST
/integrations/config
Create config revision.
new_integration_config body → 200400422
GET
/integrations/config
Fetch config revision
get_integration_config 3 params → 200400422
GET
/integrations/config/revisions
List config revisions
list_integration_configs 3 params → 200400422
GET
/integrations/errors
List Errors
get_integration_errors 6 params → 200400422
GET
/integrations/history
Get Task History
get_integration_task_history 5 params → 200400422
GET
/integrations/sync
Sync Integration History
sync_integration_history 7 params → 200400422
POST
/integrations/startup
Report Extractor Info
integration_startup body → 200400422
POST
/integrations/checkin
Check in
integration_checkin body → 200400422
POST
/integrations/extpipes/runs
Extraction pipeline runs
integrations_extpipe_runs body → 200400422

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are ErrorWithTask (7 properties), IntegrationWritableProperties (7 properties), ErrorWithTaskRead (7 properties), TaskHistoryWithErrors (6 properties). Each schema is shown below with its type and property counts.

CheckinRequest
object
Request sent on extractor check-in.
3 properties 1 required
FullConfigRevision
object
A full config revision with the config object and metadata.
6 properties 5 required
ItemsWithCursor_TaskHistoryWithErrors_
object
2 properties 1 required
Task
object
Object representing a task the extractor performs while executing.
4 properties 2 required
422ErrorContent
object
Cognite API error.
2 properties 2 required
TaskHistoryWithErrors
object
A historical task run.
6 properties 3 required
NewExtpipeRun
object
Request of a run operation.
4 properties 2 required
StartupRequest
object
Request sent on extractor startup containing information about the extractor.
5 properties 2 required
UpdateIntegration
object
Update an integration.
5 properties
ConfigRevisionMetadata
object
Metadata about a specific config revision.
5 properties 4 required
UpdateItem_Name_
object
Set a new integration name.
1 property 1 required
ItemsWithCursor_Integration_
object
2 properties 1 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
UpdateItem_Documentation_
object
Set new integration documentation.
1 property 1 required
TaskUpdateType
string
Type of task update.
ObjectPatchAddRemove
object
2 properties
IntegrationExtractor
object
Identifier for an extractor. Note that if the extractor externalId starts with cognite, it must correspond to a cognite extractor.
2 properties 1 required
integrationTaskType
string
Type of task, either running continuously, or for finite periods of time.
UpdateItem_Description_
object
Set a new integration description.
1 property 1 required
TaskUpdate
object
Update to the status of a task.
4 properties 3 required
ItemsWithIgnoreUnknownIds_ExternalId
object
2 properties 1 required
Items_ExtpipeRun_
object
1 property 1 required
Items_CreateIntegration_
object
1 property 1 required
Items_NewExtpipeRun_
object
1 property 1 required
ActiveConfigRevision
The currently active config revision, or "local" if a local config file is in use.
UpdateItem_AllowedNotSeenMinutes_
object
Set the allowed not seen time in minutes (5-1440).
1 property 1 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
Items_ConfigRevisionMetadata_
object
1 property 1 required
ErrorWithTask
object
An error that occurred as part of an extractor run.
7 properties 3 required
ErrorLevel
string
Error level. warning means that something wrong happened but the extractor was able to continue. error means that something wrong happened and the extractor ma…
CheckinResponse
object
Response sent on extractor check-in.
2 properties 1 required
Items_UpdateIntegrationItem_
object
1 property 1 required
NewConfigRevision
object
Request schema for creating a new config revision. This is also backwards compatible with extraction pipelines API.
3 properties 2 required
IntegrationWritableProperties
object
Common writable properties for integrations.
7 properties 2 required
Items_Integration_
object
1 property 1 required
ObjectPatch
object
Custom, application specific metadata. String key - String value.
ObjectPatchSet
object
1 property 1 required
IntegrationsExternalId
string
The external ID provided by the client. Must be unique for the resource type.
Error
object
Cognite API error.
4 properties 2 required
CreateIntegration
UpdateIntegrationItem
object
Update an integration.
2 properties 2 required
ErrorWithTaskRead
object
A historical error that occurred as part of an extractor run.
7 properties 4 required
UpdateSetNull
object
1 property 1 required
SyncResponse
object
Response for the sync endpoint.
4 properties 2 required
Integration
ItemsWithCursor_ErrorWithTaskRead_
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-integrations-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
AE Profile APIs.io
Cognite 3D Asset Mapping API
AE Profile APIs.io
Cognite 3D Files API
AE Profile APIs.io
Cognite 3D Jobs API
AE Profile APIs.io
Cognite 3D Model Revisions API
AE Profile APIs.io
Cognite 3D Models API
AE Profile APIs.io
Cognite Annotations API
AE Profile APIs.io
Cognite Assets API
AE Profile APIs.io
Cognite Connections API
AE Profile APIs.io
Cognite Containers API
AE Profile APIs.io
Cognite Data models API
AE Profile APIs.io
Cognite Data point subscriptions API
AE Profile APIs.io
#Integration
← Back to C APIs
API Details
ID
cognite:cognite-integrations-api
Base URL
https://api.cognitedata.com
Docs
https://api-docs.cognite.com/
Provider
Cognite
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cognite-integrations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cognite-integrations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Cognite Integrations 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.