Python SDK
from cognite.client.data_classes.hosted_extractors import EventHubSourceUpdate
source = EventHubSourceUpdate('my_event_hub').event_hub_name.set("My Updated EventHub")
res = client.hosted_extractors.sources.update(source)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/sources/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"type": "mqtt3",
"externalId": "my.known.id",
"update": {
"port": {
"set": 32768
},
"authentication": {
"set": {
"type": "basic",
"username": "<string>",
"password": "<string>"
}
},
"caCertificate": {
"set": {
"certificate": "<string>"
}
},
"authCertificate": {
"set": {
"key": "<string>",
"certificate": "<string>",
"keyPassword": "<string>"
}
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
type: 'mqtt3',
externalId: 'my.known.id',
update: {
port: {set: 32768},
authentication: {set: {type: 'basic', username: '<string>', password: '<string>'}},
caCertificate: {set: {certificate: '<string>'}},
authCertificate: {set: {key: '<string>', certificate: '<string>', keyPassword: '<string>'}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/sources/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/sources/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' => [
[
'type' => 'mqtt3',
'externalId' => 'my.known.id',
'update' => [
'port' => [
'set' => 32768
],
'authentication' => [
'set' => [
'type' => 'basic',
'username' => '<string>',
'password' => '<string>'
]
],
'caCertificate' => [
'set' => [
'certificate' => '<string>'
]
],
'authCertificate' => [
'set' => [
'key' => '<string>',
'certificate' => '<string>',
'keyPassword' => '<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}/hostedextractors/sources/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"type\": \"mqtt3\",\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"port\": {\n \"set\": 32768\n },\n \"authentication\": {\n \"set\": {\n \"type\": \"basic\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"caCertificate\": {\n \"set\": {\n \"certificate\": \"<string>\"\n }\n },\n \"authCertificate\": {\n \"set\": {\n \"key\": \"<string>\",\n \"certificate\": \"<string>\",\n \"keyPassword\": \"<string>\"\n }\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/sources/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"type\": \"mqtt3\",\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"port\": {\n \"set\": 32768\n },\n \"authentication\": {\n \"set\": {\n \"type\": \"basic\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"caCertificate\": {\n \"set\": {\n \"certificate\": \"<string>\"\n }\n },\n \"authCertificate\": {\n \"set\": {\n \"key\": \"<string>\",\n \"certificate\": \"<string>\",\n \"keyPassword\": \"<string>\"\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/sources/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 \"type\": \"mqtt3\",\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"port\": {\n \"set\": 32768\n },\n \"authentication\": {\n \"set\": {\n \"type\": \"basic\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"caCertificate\": {\n \"set\": {\n \"certificate\": \"<string>\"\n }\n },\n \"authCertificate\": {\n \"set\": {\n \"key\": \"<string>\",\n \"certificate\": \"<string>\",\n \"keyPassword\": \"<string>\"\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"type": "mqtt3",
"externalId": "my.known.id",
"host": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"port": 1883,
"authentication": {
"type": "basic",
"username": "<string>"
},
"useTls": true,
"caCertificate": {
"thumbprint": "<string>",
"expiresAt": 123
},
"authCertificate": {
"thumbprint": "<string>",
"expiresAt": 123
}
}
]
}{
"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 sources.
POST
/
hostedextractors
/
sources
/
update
Python SDK
from cognite.client.data_classes.hosted_extractors import EventHubSourceUpdate
source = EventHubSourceUpdate('my_event_hub').event_hub_name.set("My Updated EventHub")
res = client.hosted_extractors.sources.update(source)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/sources/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"type": "mqtt3",
"externalId": "my.known.id",
"update": {
"port": {
"set": 32768
},
"authentication": {
"set": {
"type": "basic",
"username": "<string>",
"password": "<string>"
}
},
"caCertificate": {
"set": {
"certificate": "<string>"
}
},
"authCertificate": {
"set": {
"key": "<string>",
"certificate": "<string>",
"keyPassword": "<string>"
}
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
type: 'mqtt3',
externalId: 'my.known.id',
update: {
port: {set: 32768},
authentication: {set: {type: 'basic', username: '<string>', password: '<string>'}},
caCertificate: {set: {certificate: '<string>'}},
authCertificate: {set: {key: '<string>', certificate: '<string>', keyPassword: '<string>'}}
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/sources/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/sources/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' => [
[
'type' => 'mqtt3',
'externalId' => 'my.known.id',
'update' => [
'port' => [
'set' => 32768
],
'authentication' => [
'set' => [
'type' => 'basic',
'username' => '<string>',
'password' => '<string>'
]
],
'caCertificate' => [
'set' => [
'certificate' => '<string>'
]
],
'authCertificate' => [
'set' => [
'key' => '<string>',
'certificate' => '<string>',
'keyPassword' => '<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}/hostedextractors/sources/update"
payload := strings.NewReader("{\n \"items\": [\n {\n \"type\": \"mqtt3\",\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"port\": {\n \"set\": 32768\n },\n \"authentication\": {\n \"set\": {\n \"type\": \"basic\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"caCertificate\": {\n \"set\": {\n \"certificate\": \"<string>\"\n }\n },\n \"authCertificate\": {\n \"set\": {\n \"key\": \"<string>\",\n \"certificate\": \"<string>\",\n \"keyPassword\": \"<string>\"\n }\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/sources/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"type\": \"mqtt3\",\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"port\": {\n \"set\": 32768\n },\n \"authentication\": {\n \"set\": {\n \"type\": \"basic\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"caCertificate\": {\n \"set\": {\n \"certificate\": \"<string>\"\n }\n },\n \"authCertificate\": {\n \"set\": {\n \"key\": \"<string>\",\n \"certificate\": \"<string>\",\n \"keyPassword\": \"<string>\"\n }\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/sources/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 \"type\": \"mqtt3\",\n \"externalId\": \"my.known.id\",\n \"update\": {\n \"port\": {\n \"set\": 32768\n },\n \"authentication\": {\n \"set\": {\n \"type\": \"basic\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n }\n },\n \"caCertificate\": {\n \"set\": {\n \"certificate\": \"<string>\"\n }\n },\n \"authCertificate\": {\n \"set\": {\n \"key\": \"<string>\",\n \"certificate\": \"<string>\",\n \"keyPassword\": \"<string>\"\n }\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"type": "mqtt3",
"externalId": "my.known.id",
"host": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"port": 1883,
"authentication": {
"type": "basic",
"username": "<string>"
},
"useTls": true,
"caCertificate": {
"thumbprint": "<string>",
"expiresAt": 123
},
"authCertificate": {
"thumbprint": "<string>",
"expiresAt": 123
}
}
]
}{
"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
Sources to update.
items
(UpdateMqttV3SourceItem · object | UpdateMqttV5SourceItem · object | UpdateEventHubSourceItem · object | UpdateRestSourceItem · object | UpdateKafkaSourceItem · object | UpdateMqttBrokerSourceItem · object)[]
required
Required array length:
1 - 10 elements- UpdateMqttV3SourceItem
- UpdateMqttV5SourceItem
- UpdateEventHubSourceItem
- UpdateRestSourceItem
- UpdateKafkaSourceItem
- UpdateMqttBrokerSourceItem
Show child attributes
Show child attributes
Response
List of updated sources.
items
(MqttV3Source · object | MqttV5Source · object | EventHubSource · object | RestSource · object | object | MqttBrokerSource · object)[]
required
Maximum array length:
100- MqttV3Source
- MqttV5Source
- EventHubSource
- RestSource
- Option 5
- MqttBrokerSource
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I