Python SDK
from cognite.client.data_classes.hosted_extractors import MappingUpdate
mapping = MappingUpdate('my_mapping').published.set(False)
res = client.hosted_extractors.mappings.update(mapping)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/mappings/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"update": {
"input": {
"set": {
"type": "protobuf",
"messageName": "<string>",
"files": [
{
"fileName": "<string>",
"content": "<string>"
}
]
}
},
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"metadata": {
"set": {}
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
update: {
input: {
set: {
type: 'protobuf',
messageName: '<string>',
files: [{fileName: '<string>', content: '<string>'}]
}
},
name: {set: '<string>'},
description: {set: '<string>'},
metadata: {set: {}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/mappings/update', 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}/hostedextractors/mappings/update",
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([
'items' => [
[
'externalId' => 'my.known.id',
'update' => [
'input' => [
'set' => [
'type' => 'protobuf',
'messageName' => '<string>',
'files' => [
[
'fileName' => '<string>',
'content' => '<string>'
]
]
]
],
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
]
]
]
]
]
]),
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}/hostedextractors/mappings/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"input\": {\n \"set\": {\n \"type\": \"protobuf\",\n \"messageName\": \"<string>\",\n \"files\": [\n {\n \"fileName\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n }\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {}\n }\n }\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}/hostedextractors/mappings/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"input\": {\n \"set\": {\n \"type\": \"protobuf\",\n \"messageName\": \"<string>\",\n \"files\": [\n {\n \"fileName\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n }\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {}\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/mappings/update")
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 \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"input\": {\n \"set\": {\n \"type\": \"protobuf\",\n \"messageName\": \"<string>\",\n \"files\": [\n {\n \"fileName\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n }\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {}\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"mapping": {
"expression": "<string>"
},
"input": {
"type": "protobuf",
"messageName": "<string>",
"files": [
{
"fileName": "<string>"
}
]
},
"published": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 422,
"message": "Extra inputs are not permitted: type"
}
}Required capabilities:
hostedExtractors:WRITE
Update up to 100 mappings.
POST
/
hostedextractors
/
mappings
/
update
Python SDK
from cognite.client.data_classes.hosted_extractors import MappingUpdate
mapping = MappingUpdate('my_mapping').published.set(False)
res = client.hosted_extractors.mappings.update(mapping)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/mappings/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"update": {
"input": {
"set": {
"type": "protobuf",
"messageName": "<string>",
"files": [
{
"fileName": "<string>",
"content": "<string>"
}
]
}
},
"name": {
"set": "<string>"
},
"description": {
"set": "<string>"
},
"metadata": {
"set": {}
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
update: {
input: {
set: {
type: 'protobuf',
messageName: '<string>',
files: [{fileName: '<string>', content: '<string>'}]
}
},
name: {set: '<string>'},
description: {set: '<string>'},
metadata: {set: {}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/mappings/update', 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}/hostedextractors/mappings/update",
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([
'items' => [
[
'externalId' => 'my.known.id',
'update' => [
'input' => [
'set' => [
'type' => 'protobuf',
'messageName' => '<string>',
'files' => [
[
'fileName' => '<string>',
'content' => '<string>'
]
]
]
],
'name' => [
'set' => '<string>'
],
'description' => [
'set' => '<string>'
],
'metadata' => [
'set' => [
]
]
]
]
]
]),
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}/hostedextractors/mappings/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"input\": {\n \"set\": {\n \"type\": \"protobuf\",\n \"messageName\": \"<string>\",\n \"files\": [\n {\n \"fileName\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n }\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {}\n }\n }\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}/hostedextractors/mappings/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"input\": {\n \"set\": {\n \"type\": \"protobuf\",\n \"messageName\": \"<string>\",\n \"files\": [\n {\n \"fileName\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n }\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {}\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/mappings/update")
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 \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"input\": {\n \"set\": {\n \"type\": \"protobuf\",\n \"messageName\": \"<string>\",\n \"files\": [\n {\n \"fileName\": \"<string>\",\n \"content\": \"<string>\"\n }\n ]\n }\n },\n \"name\": {\n \"set\": \"<string>\"\n },\n \"description\": {\n \"set\": \"<string>\"\n },\n \"metadata\": {\n \"set\": {}\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"mapping": {
"expression": "<string>"
},
"input": {
"type": "protobuf",
"messageName": "<string>",
"files": [
{
"fileName": "<string>"
}
]
},
"published": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 422,
"message": "Extra inputs are not permitted: type"
}
}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
Mappings to update.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Response
List of updated mappings.
Maximum array length:
100Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I