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

A hosted extractor **source** represents an external source system on the internet. The **source** resource in CDF contains all the information the extractor needs to connect to the external source system.A source can have many jobs, each streaming different data from the source system.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 5 operations across 4 paths, and defines 66 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}.

5 operations 4 paths 66 schemas 1 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
Contact
Cognite Support
Resource Areas
1

Authentication & Security 5

Cognite Sources 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 5

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

Sources 5

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the exter…

GET
/hostedextractors/sources
List Sources
list_sources 2 params → 200400422
POST
/hostedextractors/sources
Create Sources
create_sources body → 200400422
POST
/hostedextractors/sources/byIds
Retrieve Sources
retrieve_sources body → 200400422
POST
/hostedextractors/sources/delete
Delete Sources
delete_sources body → 200400422
POST
/hostedextractors/sources/update
Update Sources
update_sources body → 200400422

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are MqttV5Source (10 properties), RestSource (10 properties), MqttV3Source (10 properties), KafkaSource (9 properties). Each schema is shown below with its type and property counts.

UpdateEventHubSourceItem
object
3 properties 3 required
UpdateKafkaSource
object
5 properties
UpdateItem_RestScheme_
object
Set a new scheme for this source to use
1 property 1 required
CreateClientCredentialsAuthentication
object
6 properties 5 required
UpdateItem_KafkaAuthentication_
object
Set new credentials for authenticating with the broker.
1 property 1 required
SimpleBasicAuthentication
object
Username and password authentication.
2 properties 2 required
Items_CreateSource_
object
1 property 1 required
UpdateItem_CACertificate_
object
Set a new certificate authority.
1 property 1 required
CreateEventHubSource
object
8 properties 4 required
CreateHeaderValueAuthentication
object
3 properties 3 required
CreateQueryParamAuthentication
object
3 properties 3 required
UpdateMqttV5Source
object
6 properties
CreateScramSha256
object
3 properties 3 required
KafkaBrokerList
array
List of redundant kafka brokers to connect to.
UpdateKafkaSourceItem
object
3 properties 3 required
CreateKafkaSource
object
7 properties 3 required
CreateRestSource
object
8 properties 3 required
MqttV3Source
object
10 properties 5 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
CreateMqttV3Source
object
8 properties 3 required
CertificateType
string
Type of certificate in the certificate field.
UpdateItem_AuthCertificate_
object
Set a new authentication certificate.
1 property 1 required
UpdateEventHubSource
object
6 properties
ClientCredentialsAuthentication
object
5 properties 4 required
EventhubAuthentication
object
Authentication details for eventhub. Basic authentication uses a shared access key, where the username is the key name. The kay value is not returned for secur…
ItemsWithIgnoreUnknownIdsAndForce_ExternalId_
object
3 properties 1 required
UpdateItem_Host_
object
Set a new host or IP address.
1 property 1 required
Items_Source_
object
1 property 1 required
ExternalIdWrapper
object
1 property 1 required
Items_UpdateSource_
object
1 property 1 required
UpdateMqttV5SourceItem
object
3 properties 3 required
KafkaSource
object
9 properties 5 required
CACertificate
object
Custom certificate authority certificate to let the source use a self signed certificate.
2 properties 2 required
SimpleBasicAuthenticationWrite
object
Username and password authentication.
3 properties 2 required
UpdateRestSourceItem
object
3 properties 3 required
EventhubAuthenticationWrite
object
Authentication details for eventhub. Basic authentication uses a shared access key, where the username is the key name, and the password is the key value.
QueryParamAuthentication
object
2 properties 2 required
MqttV5Source
object
10 properties 5 required
BasicAuthentication
object
2 properties 2 required
CreateMqttV5Source
object
8 properties 3 required
ItemsWithCursor_Source_
object
2 properties 1 required
MqttAuthentication
object
Method used for authenticating with the mqtt broker. This may be used together with auth certificate.
CreateScramSha512
object
3 properties 3 required
ScramSha256
object
2 properties 2 required
ItemsWithIgnoreUnknownIds_ExternalId_
object
2 properties 1 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
MqttAuthenticationWrite
object
Method used for authenticating with the mqtt broker. This may be used together with auth certificate.
UpdateMqttV3SourceItem
object
3 properties 3 required
KafkaBroker
object
2 properties 2 required
UpdateMqttV3Source
object
6 properties
RestSource
object
10 properties 6 required
UpdateItem_MqttAuthentication_
object
Set new credentials for authenticating with the broker.
1 property 1 required
ValidationErrorContent
object
Cognite API error.
2 properties 2 required
ScramSha512
object
2 properties 2 required
KafkaAuthentication
object
Method used for authenticating with the kafka brokers. This may be used together with auth certificate.
Error
object
Cognite API error.
4 properties 2 required
HeaderValueAuthentication
object
2 properties 2 required
EventHubSource
object
9 properties 6 required
UpdateItem_Port_
object
Set a new port this source should connect to.
1 property 1 required
UpdateRestSource
object
4 properties
KafkaAuthenticationWrite
object
Method used for authenticating with the kafka brokers. This may be used together with auth certificate.
UpdateItem_KafkaBrokers_
object
Set a new list of redundant kafka brokers.
1 property 1 required
CreateBasicAuthentication
object
3 properties 3 required
CertificateDetails
object
Excerpt of certificate details
2 properties 2 required
AuthCertificate
object
Authentication certificate (if configured) used to authenticate to source.
4 properties 3 required
UpdateSetNull
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-sources-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
#Sources
← Back to C APIs
API Details
ID
cognite:cognite-sources-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-sources-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cognite-sources-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 Sources 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.