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 Data products API

Data products are governed, ready-for-consumption data assets derived from data domains, following data mesh principles. **Key characteristics:** - **Clear ownership**: Defined data product owners with explicit access roles and accountability - **Rich metadata**: Comprehensive data modeling views, usage terms, access permissions, and descriptivedocumentation - **Self-service consumption**: Discoverable and well-documented for autonomous data consumer access - **Version management**: Immutable data modeling view versions with governed schemas and updatablemetadata Data products act as a governance layer around data modeling, establishing trust and reliabilityfor business decisions through clear ownership, comprehensive metadata, and standardized access patterns. **Space ownership**: A data product owns a schema space. The data modeling views that the data productgoverns live in that schema space. The schema space is exclusively owned by the data product.

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

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

This API exposes 10 operations across 8 paths, and defines 33 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}.

10 operations 8 paths 33 schemas 4 GET6 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 Data products 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 10

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

Data products 10

Data products are governed, ready-for-consumption data assets derived from data domains, following data mesh principles. Key characteristics: - Clear ownership: Defined data produ…

POST
/dataproducts
Create a data product
createDataProduct body → 201400
GET
/dataproducts
List data products
listDataProducts 2 params → 200400
GET
/dataproducts/{externalId}
Get a data product
getDataProduct 1 param → 200404
POST
/dataproducts/delete
Delete a data product
deleteDataProduct body → 200400404
POST
/dataproducts/update
Update a data product
updateDataProduct body → 200400404
POST
/dataproducts/{externalId}/versions
Create a data product version
createDataProductVersion 1 param body → 201400404
GET
/dataproducts/{externalId}/versions
List data product versions
listDataProductVersions 3 params → 200404
GET
/dataproducts/{externalId}/versions/{version}
Get a data product version
getDataProductVersion 2 params → 200404
POST
/dataproducts/{externalId}/versions/delete
Delete data product versions
deleteDataProductVersions 1 param body → 200400404
POST
/dataproducts/{externalId}/versions/update
Update data product version
updateDataProductVersion 1 param body → 200400404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are DataProduct (9 properties), DataProductVersion (7 properties), DataProductCreate (6 properties), DataProductVersionCreate (5 properties). Each schema is shown below with its type and property counts.

DataProductVersionChange
object
2 properties 2 required
ArrayPatchStringSet
object
1 property 1 required
SinglePatchString
object
Set a new value for the string, or remove the value.
DataProductVersion
object
A version of a data product, with a collection of data modeling view references. Each item of the collection is immutable (it may not be modified or removed la…
7 properties 6 required
DataProductSemanticVersionExtendedDescription
The semantic version of this data product version. Together, the data product external id (in the request path) and the semantic version uniquely identifies th…
DataProductVersionTermsPatch
object
Modify nested terms object fields.
1 property
DataProductVersionUpdateRequest
object
1 property 1 required
DataProductSemanticVersion
string
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
ArrayPatchStringAddOrRemove
object
2 properties
DataProductChange
object
2 properties 2 required
DataProductUpdateRequest
object
1 property 1 required
DataProduct
object
9 properties 8 required
DataProductVersionCreate
object
A new version of a data product, with a collection of data modeling view references. Each item of the collection is immutable (it may not be modified or remove…
5 properties 2 required
DataProductExternalId
string
Data product external identifier
RemoveField
object
1 property 1 required
SinglePatchBoolean
object
1 property 1 required
DataProductDeleteRequest
object
1 property 1 required
SetStringField
object
1 property 1 required
ArrayPatchString
object
Change that will be applied to the array.
DataProductSemanticVersionCompactDescription
A semantic version number. We currently use a simplified version of what is described at [semver.org](https://semver.org/).
DataProductVersionViewsAdd
object
1 property 1 required
Space
string
DataProductPatch
object
Changes to apply to a data product
4 properties
DataProductVersionDeleteRequest
object
1 property 1 required
DataProductVersionCreateRequest
object
1 property 1 required
DataProductVersionPatch
object
Changes to apply to a data product version
4 properties
SinglePatchDataProductVersionStatus
object
Set a new value for the data product version status. Note that this property is currently only informational.
1 property 1 required
Error
object
Cognite API error.
4 properties 2 required
DataProductCreateRequest
object
1 property 1 required
DataProductVersionStatus
string
The status of this data product version.
DataProductCreate
object
6 properties 2 required
ViewExternalId
string
The external ID of the view.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-data-products-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 Data products 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.