Cognite Instances API
The Instances API from Cognite — 9 operation(s) for instances.
Cognite Instances API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Instances. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 9 operations across 9 paths, and defines 158 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}.
9 operations
9 paths
158 schemas
9 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 5
Cognite Instances 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 9
Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.
Instances 9
POST
/models/instances
Create or update nodes/edges
POST
/models/instances/list
Filter nodes/edges
POST
/models/instances/byids
Retrieve nodes/edges by their external ids
POST
/models/instances/search
Search for nodes/edges
POST
/models/instances/aggregate
Aggregate data across nodes/edges
POST
/models/instances/delete
Delete nodes/edges
POST
/models/instances/query
Query nodes/edges
POST
/models/instances/sync
Sync nodes/edges
POST
/models/instances/inspect
Inspect instances
Schemas 158
The contract defines 158 schemas that model the data the API accepts and returns. The most detailed are EdgeDefinition (11 properties), NodeDefinition (9 properties), FilterMatchesBrokenCursorableIndexNotice (8 properties), SignificantPostFilteringNotice (8 properties). Each schema is shown below with its type and property counts.
AggregatedResultItem
object
3 properties
2 required
EdgeOrNodeData
object
Property values for the identified/specified view or container
2 properties
1 required
QuerySelectV3
object
Define which view to return properties for, and the properties to return. Up to 10 views can be specified per query.
3 properties
InstanceInspectRequest
object
2 properties
2 required
AggregatedResultItemCollection
object
1 property
2 required
EqualsFilterV3
object
1 property
1 required
NodeOrEdgeListRequestV3
PropertyIdentifierV3
string
TypeInformation
object
Type information for the returned properties (if requested)
DataModelsNestedFilter
object
1 property
1 required
SyncNodeTableExpressionV3
object
The synchronization query to use when we listen for changes to nodes. The nodes must also match the specified filter.
5 properties
1 required
FilterMatchesBrokenCursorableIndexNotice
object
8 properties
6 required
DeletedInstances
array
List of deleted instances
TableExpressionPrefixFilterV3
object
1 property
1 required
NodeOrEdgeCreate
DirectRelationReference
object
Reference to the node pointed to by the direct relation. The reference consists of a space and an external-id.
2 properties
2 required
TableExpressionRangeFilterV3
object
1 property
1 required
NextCursorV3
string
The cursor value used to return (paginate to) the next page of results, when more data is available.
SourceSelectorV3
array
ViewPropertyReference
object
2 properties
2 required
TypingViewOrContainer
object
View or container holding properties
ThroughReference
object
Traverse from another table expression using a direct relation. Only applicable when from is specified. The view or container property to use when we traverse…
2 properties
2 required
ContainsAllFilterV3
object
1 property
1 required
UnitReference
object
Target unit reference.
1 property
1 required
QueryUnionTableExpressionV3
object
Return the union of the specified result sets. We will remove the results that match the optional exception result sets. But this operation does not result in…
3 properties
1 required
InFilterV3
object
1 property
1 required
SyncEdgeTableExpressionV3
object
The synchronization query to use when we listen for changes to edges. The edges must also match the specified filter.
5 properties
1 required
SyncMode
string
Specify whether to sync all instances in a single phase (onePhase - default) or two phases (twoPhase), or to skip the backfill phase noBackfill. With onePhase,…
PrefixFilterV3
object
1 property
1 required
TableExpressionOverlapsFilterV3
object
1 property
1 required
SortV3
object
1 property
InstanceDelete
object
Instance to delete
4 properties
3 required
InstanceInspectResultItem
object
4 properties
4 required
TableExpressionFilterValueRange
SlimNodeDefinition
object
Node
7 properties
7 required
SyncSelectV3
object
Define which view to return properties for, and the properties to return. Up to 10 views can be specified per query.
1 property
OverlapsFilterV3
object
1 property
1 required
LimitWithDefault1000
object
1 property
SourceReference
Reference to a view, or a container
TableExpressionSyncLimit
integer
Limits the number of instances in the result set generated by this table expression. We recommend to to not use a value lower than 100, as this will result in…
NodeOrEdgeSearchRequest
object
Searching nodes or edges using properties from a view
SlimEdgeDefinition
object
Edge
7 properties
7 required
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
SumAggregateFunctionV3
object
Calculates the sum from the values of the specified property.
1 property
1 required
NodeOrEdge
TableExpressionEqualsFilterV3
object
1 property
1 required
MinAggregateFunctionV3
object
The function will calculate, and return, the lowest - min - value for a property.
1 property
1 required
SourceSelectorWithoutPropertiesV3
array
Retrieve properties from the listed - by reference - views. The node/edge must have data in all the sources defined in the list.
TableExpressionChainToDefinition
string
Default: "destination". Applicable when from is an edge result expression. Control which side of the edges in from to chain to. The behavior depends on the dir…
TableExpressionLeafFilter
object
Leaf filter
TableExpressionFilterValue
NodeTableExpressionThrough
CommonAggregationRequest
object
Defines an aggregation request. This will let you group, and aggregate supported data types. The request supports filters, and allows optional search matching.
7 properties
DMSFilterProperty
array
A reference to either a DMS base property or a container property. For nodes the DMS base properties are instanceType, version, space, externalId, type, create…
NodeOrEdgeExternalId
string
ContainsAnyFilterV3
object
1 property
1 required
PropertySortV3
object
3 properties
1 required
InstanceBulk
object
7 properties
1 required
TypeInformationOuter
object
Spaces for the requested view and containers
DMSVersion
string
DirectNodeRelation
object
Direct node relation
4 properties
1 required
SlimNodeOrEdge
IntractableCursorWithNestedFilterNotice
object
Emitted when a query supplies both a cursor and a nested filter on the same result set expression. Nested filters require a join that invalidates cursor positi…
6 properties
6 required
SignificantHasDataFiltersNotice
object
7 properties
7 required
NoTimeoutWithResultsNotice
object
4 properties
4 required
IntractableDirectRelationsCursorNotice
object
6 properties
6 required
QueryIntersectionTableExpressionV3
object
Find the common elements in the returned result set. Excludes the elements from the optional except result set.
3 properties
1 required
TableExpressionInFilterV3
object
1 property
1 required
FilterDefinition
object
A filter Domain Specific Language (DSL) used to create advanced filter queries.
DebugParameters
object
Return query debug notices.
3 properties
ContainersWithoutIndexesInvolvedNotice
object
7 properties
7 required
SortNotBackedByIndexNotice
object
7 properties
7 required
InvalidDebugOptionsNotice
object
CursoringNotice
object
ExcessiveTimeoutNotice
object
5 properties
5 required
FilterValue
DataModelsLeafFilter
object
Leaf filter
ContainerSubObjectIdentifier
object
3 properties
3 required
SearchRequestV3
AggregatedNumberValue
object
3 properties
1 required
TextProperty
object
Text type
5 properties
1 required
HistogramAggregateFunctionV3
object
A histogram aggregator function. This function will generate a histogram from the values of the specified property. It uses the specified interval as defined i…
1 property
1 required
NodeOrEdgeDeleteRequest
object
1 property
1 required
CorePropertyCreateDefinition
object
6 properties
InstanceType
string
The type of instance
CountAggregateFunctionV3
object
Counts the number of items. When you specify a property, it returns the number of non-null values for that property.
1 property
1 required
DebugResponse
object
Contains debug notices if debug flag is set in the query.
1 property
Cursor
object
Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that…
1 property
NodeDefinition
object
Node
9 properties
6 required
RawPropertyValueV3
A value matching the data type of the defined property
DebugNotice
AggregatedHistogramValue
object
4 properties
4 required
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
EdgeWrite
object
Edge to create or update
8 properties
6 required
SearchSort
object
2 properties
1 required
TableExpressionQueryLimit
integer
Limits the number of instances in the result set generated by this result expression.
UnitSystemReference
object
Target system to convert data to. Can be used instead of targetUnit to identify the unit to convert to.
1 property
1 required
QueryUnionAllTableExpressionV3
object
Return the union of the specified result sets. We will remove the results that match the optional exception result sets. Note: The operation may return duplica…
3 properties
1 required
TableExpressionContainsAnyFilterV3
object
1 property
1 required
TableExpressionDataModelsBoolFilter
object
Build a new query by combining other queries, using boolean operators. We support the and, or, and not boolean operators.
QueryTableExpressionV3
object
HasExistingDataFilterV3
object
1 property
1 required
MatchAllFilter
object
1 property
1 required
FilteringNotice
object
SignificantPostFilteringNotice
object
8 properties
8 required
SyncTableExpressionV3
TableExpressionFilterDefinition
object
A filter Domain Specific Language (DSL) used to create advanced filter queries.
AggregationDefinition
object
An aggregate. It consists of a name, an aggregator function, and the field to use for the function.
IndexingNotice
object
DataModelsBoolFilter
object
Build a new query by combining other queries, using boolean operators. We support the and, or, and not boolean operators.
ConstraintOrIndexState
string
CorePropertyDefinition
UnindexedThroughNotice
object
7 properties
7 required
BackfillSort
array
Optionally sort synced instances during the backfill phase of a two-phase sync. The properties sorted on must have a cursorable index on them. Can only be spec…
EdgeDefinition
object
Edge
11 properties
9 required
ViewReference
object
Reference to a view
4 properties
4 required
TypePropertyDefinition
Describes the type and configuration of a property included in the result.
SortingNotice
object
SearchOperator
string
Controls how multiple search terms are combined when matching documents. - OR (default): A document matches if it contains any of the query terms in the search…
ViewDirectNodeRelation
Direct node relation. Can include a hint to specify the view that this direct relation points to. This hint is optional.
FilterValueRange
RangeFilterV3
object
1 property
1 required
PropertyValueGroupV3
object
Group of property values indexed by a local unique identifier. The identifier has to have a length of between 1 and 255 characters. It must also match the patt…
ContainerReference
object
Reference to an existing container
3 properties
3 required
InstanceReferenceFilterV3
object
1 property
1 required
ListOfSpaceExternalIdsRequestWithTyping
object
3 properties
1 required
SpaceSpecification
string
QueryEdgeTableExpressionV3
object
Specifies a result set of edges.
4 properties
1 required
AvgAggregateFunctionV3
object
Calculates the average from the data stored by the specified property. This aggregation uses an average mean calculation, and not an integral mean.
1 property
1 required
TableExpressionFilterValueList
DMSExternalId
string
TableExpressionContainsAllFilterV3
object
1 property
1 required
SelectiveExternalIDFilterNotice
object
7 properties
6 required
EnumProperty
object
An enum type property. An enum property can only consist of predefined values.
3 properties
2 required
ViewCorePropertyDefinition
RangeValue
Value you wish to find in the provided property using a range clause.
ParameterizedPropertyValueV3
object
A parameterized value
1 property
1 required
AggregationRequest
MaxAggregateFunctionV3
object
The function will calculate, and return, the highest - max - value for the property.
1 property
1 required
IncludeTyping
boolean
Should we return property type information as part of the result?
QueryRequest
object
6 properties
2 required
FilterMatchesCursorableSortNotice
object
7 properties
6 required
TargetUnits
array
Properties to convert to another unit. The API can only convert to another unit, if a unit has been defined as part of the type on the underlying container bei…
RawPropertyValueListV3
array
A list of values
AggregatedValueItem
QueryNodeTableExpressionV3
object
Specifies a result set of nodes.
3 properties
1 required
FilterValueList
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
NodeWrite
object
Node to create or update
6 properties
3 required
ViewOrContainer
object
View or container holding properties
ReferencedPropertyValueV3
object
A property reference value
1 property
1 required
DMSExistsFilter
object
1 property
1 required
QuerySetOperationTableExpressionV3
object
Error
object
Cognite API error.
4 properties
2 required
TargetUnit
object
Describes a target unit for a property.
2 properties
2 required
EnumValueProperties
object
Metadata of the enum value.
2 properties
SyncRequest
object
7 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cognite 12
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
#Instances
Where this information came from
This is an independent, third-party profile of Cognite Instances 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.