Python SDK
from cognite.client.data_classes.data_modeling import NodeId, EdgeId
res = client.data_modeling.instances.inspect(
nodes=NodeId("my-space", "foo1"),
edges=EdgeId("my-space", "bar2"),
)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inspectionOperations": {
"involvedViews": {
"allVersions": false
},
"involvedContainers": {
"allVersions": false
}
},
"items": [
{
"instanceType": "node",
"externalId": "<string>",
"space": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inspectionOperations: {involvedViews: {allVersions: false}, involvedContainers: {allVersions: false}},
items: [{instanceType: 'node', externalId: '<string>', space: '<string>'}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inspectionOperations' => [
'involvedViews' => [
'allVersions' => false
],
'involvedContainers' => [
'allVersions' => false
]
],
'items' => [
[
'instanceType' => 'node',
'externalId' => '<string>',
'space' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect"
payload := strings.NewReader("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"involvedContainers\": {\n \"allVersions\": false\n }\n },\n \"items\": [\n {\n \"instanceType\": \"node\",\n \"externalId\": \"<string>\",\n \"space\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"involvedContainers\": {\n \"allVersions\": false\n }\n },\n \"items\": [\n {\n \"instanceType\": \"node\",\n \"externalId\": \"<string>\",\n \"space\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"involvedContainers\": {\n \"allVersions\": false\n }\n },\n \"items\": [\n {\n \"instanceType\": \"node\",\n \"externalId\": \"<string>\",\n \"space\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"instanceType": "node",
"externalId": "<string>",
"space": "<string>",
"inspectionResults": {
"involvedViews": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"involvedContainers": [
{
"type": "container",
"space": "<string>",
"externalId": "<string>"
}
]
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Inspect instances
Required capabilities:
dataModelsAcl:READ
POST
/
models
/
instances
/
inspect
Python SDK
from cognite.client.data_classes.data_modeling import NodeId, EdgeId
res = client.data_modeling.instances.inspect(
nodes=NodeId("my-space", "foo1"),
edges=EdgeId("my-space", "bar2"),
)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inspectionOperations": {
"involvedViews": {
"allVersions": false
},
"involvedContainers": {
"allVersions": false
}
},
"items": [
{
"instanceType": "node",
"externalId": "<string>",
"space": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inspectionOperations: {involvedViews: {allVersions: false}, involvedContainers: {allVersions: false}},
items: [{instanceType: 'node', externalId: '<string>', space: '<string>'}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inspectionOperations' => [
'involvedViews' => [
'allVersions' => false
],
'involvedContainers' => [
'allVersions' => false
]
],
'items' => [
[
'instanceType' => 'node',
'externalId' => '<string>',
'space' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect"
payload := strings.NewReader("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"involvedContainers\": {\n \"allVersions\": false\n }\n },\n \"items\": [\n {\n \"instanceType\": \"node\",\n \"externalId\": \"<string>\",\n \"space\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"involvedContainers\": {\n \"allVersions\": false\n }\n },\n \"items\": [\n {\n \"instanceType\": \"node\",\n \"externalId\": \"<string>\",\n \"space\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/instances/inspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inspectionOperations\": {\n \"involvedViews\": {\n \"allVersions\": false\n },\n \"involvedContainers\": {\n \"allVersions\": false\n }\n },\n \"items\": [\n {\n \"instanceType\": \"node\",\n \"externalId\": \"<string>\",\n \"space\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"instanceType": "node",
"externalId": "<string>",
"space": "<string>",
"inspectionResults": {
"involvedViews": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
],
"involvedContainers": [
{
"type": "container",
"space": "<string>",
"externalId": "<string>"
}
]
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-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 accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
application/json
Change filter specification
Response
Instances along with which containers/views they are associated with
List of instance inspection results
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I