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

The Containers API from Cognite — 9 operation(s) for containers.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 10 operations across 9 paths, and defines 53 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 9 paths 53 schemas 1 GET9 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 Containers 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 9 paths, the API surfaces 10 operations — 1 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Containers 10
POST
/models/containers
Create or update containers
ApplyContainers body → 200400409
GET
/models/containers
List containers defined in the project
listContainers 5 params → 200400
POST
/models/containers/byids
Retrieve containers by their external ids
byExternalIdsContainers body → 200400
POST
/models/containers/delete
Delete containers
deleteContainers body → 200400
POST
/models/containers/indexes/delete
Delete indexes from containers
deleteContainerIndexes body → 200400
POST
/models/containers/indexes/retry
Retry failed indexes
retryContainerIndexes body → 200400
POST
/models/containers/constraints/delete
Delete constraints from containers
deleteContainerConstraints body → 200400
POST
/models/containers/constraints/retry
Retry failed container constraints
retryContainerConstraints body → 200400
POST
/models/containers/properties/retry
Retry failed property constraints
retryPropertyConstraints body → 200400
POST
/models/containers/inspect
Inspect containers
containerInspect body → 200400

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are CorePropertyCreateDefinition (6 properties), TextProperty (5 properties), RecordCorePropertyCreateDefinition (4 properties), ContainerCommon (4 properties). Each schema is shown below with its type and property counts.

ContainerReference
object
Reference to an existing container
3 properties 3 required
CorePropertyCreateDefinition
object
6 properties
ListOfContainerSubObjectIdentifierRequest
object
1 property 1 required
ContainerPropertyTypeDefinition
object
1 property 1 required
RecordContainerPropertyTypeDefinition
object
1 property 1 required
RequiresConstraintCreateDefinition
object
2 properties 1 required
SpaceSpecification
string
ContainerCommon
object
Container for properties you can access through views. Container specifications give details about storage related details, such as how to index the data and w…
4 properties 2 required
IndexCreateDefinition
object
You can optimize query performance by defining an index to apply to a container. You can only create an index across properties belonging to the same container…
DMSExternalId
string
CDFExternalIdReference
object
An external-id reference to an existing CDF resource type item, such as a time series. An example could be that for an existing time series stored in the CDF t…
3 properties 1 required
InstanceContainerCreateDefinition
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
UpsertConflict
object
1 property 1 required
InvertedIndexDefinition
ContainerCreateDefinition
EnumProperty
object
An enum type property. An enum property can only consist of predefined values.
3 properties 2 required
UsedFor
string
Should this operation apply to nodes, edges, records, or both nodes and edges. NB! Currently all applies to nodes and edges, but not records.
IndexState
object
1 property 1 required
InvertedIndexCreateDefinition
object
2 properties 1 required
RecordDirectNodeRelation
object
Direct node relation. Only the target space existence is validated for records. Target nodes are not auto-created.
3 properties 1 required
ListOfSpaceExternalIdsRequest
object
1 property 1 required
NodeOrEdgeExternalId
string
RecordTextProperty
object
Text type
4 properties 1 required
NextCursorV3
string
The cursor value used to return (paginate to) the next page of results, when more data is available.
RecordContainerCreateDefinition
ConstraintDefinition
object
Describes a constraint across the properties included. Constraints enforce that; Certain properties must be present, A value must be unique across a single or…
DMSVersion
string
DirectNodeRelation
object
Direct node relation
4 properties 1 required
BtreeIndexCreateDefinition
object
4 properties 1 required
ConstraintCreateDefinition
object
Defines a constraint across the properties you include. You can use constraints to enforce that; Certain properties must be present, A value must be unique acr…
RequiresConstraintDefinition
UniquenessConstraintDefinition
BtreeIndexDefinition
ConstraintOrIndexState
string
CorePropertyDefinition
ContainerCreateCollection
object
1 property 1 required
ContainerInspectResultItem
object
3 properties 3 required
RecordCorePropertyCreateDefinition
object
4 properties
PrimitiveProperty
object
Primitive types for the property. We expect dates to be in the ISO-8601 format, while timestamps are expected to be an epoch value with millisecond precision.…
4 properties 1 required
ConstraintState
object
1 property 1 required
ViewReference
object
Reference to a view
4 properties 4 required
Error
object
Cognite API error.
4 properties 2 required
RecordContainerPropertyCreateDefinition
Defines a property of a record container. You can reference this property in views.
UniquenessConstraintCreateDefinition
object
3 properties 1 required
ContainerPropertyCreateDefinition
Defines a property of a container. You can reference this property in views.
ContainerPropertyDefinition
Defines a property of a container. You can reference this property in views.
ContainerInspectRequest
object
2 properties 2 required
EnumValueProperties
object
Metadata of the enum value.
2 properties
ContainerDefinition
7 required
IndexDefinition
object
Indexes applied to a container. The properties of an index always belong to the same container. Ordering of the properties included in the index definition lis…
ContainerSubObjectIdentifier
object
3 properties 3 required
TextProperty
object
Text type
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-containers-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 Data models API
AE Profile APIs.io
Cognite Data point subscriptions API
AE Profile APIs.io
Cognite Data products API
AE Profile APIs.io
#Containers
← Back to C APIs
API Details
ID
cognite:cognite-containers-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-containers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cognite-containers-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 Containers 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.