Python SDK
from cognite.client.data_classes.hosted_extractors import EventHubSourceWrite
job_write = EventHubSourceWrite('my_event_hub', 'http://myeventhub.com', "My EventHub", 'my_key', 'my_value')
job = client.hosted_extractors.jobs.create(job_write)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"destinationId": "<string>",
"sourceId": "<string>",
"format": {
"type": "rockwell",
"compression": "gzip",
"prefix": {
"fromTopic": true,
"prefix": "<string>"
}
},
"config": {
"topicFilter": "<string>"
},
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
destinationId: '<string>',
sourceId: '<string>',
format: {
type: 'rockwell',
compression: 'gzip',
prefix: {fromTopic: true, prefix: '<string>'}
},
config: {topicFilter: '<string>'},
name: '<string>',
description: '<string>',
metadata: {}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs', 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/jobs",
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',
'destinationId' => '<string>',
'sourceId' => '<string>',
'format' => [
'type' => 'rockwell',
'compression' => 'gzip',
'prefix' => [
'fromTopic' => true,
'prefix' => '<string>'
]
],
'config' => [
'topicFilter' => '<string>'
],
'name' => '<string>',
'description' => '<string>',
'metadata' => [
]
]
]
]),
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/jobs"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"destinationId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"format\": {\n \"type\": \"rockwell\",\n \"compression\": \"gzip\",\n \"prefix\": {\n \"fromTopic\": true,\n \"prefix\": \"<string>\"\n }\n },\n \"config\": {\n \"topicFilter\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\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/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"destinationId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"format\": {\n \"type\": \"rockwell\",\n \"compression\": \"gzip\",\n \"prefix\": {\n \"fromTopic\": true,\n \"prefix\": \"<string>\"\n }\n },\n \"config\": {\n \"topicFilter\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs")
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 \"destinationId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"format\": {\n \"type\": \"rockwell\",\n \"compression\": \"gzip\",\n \"prefix\": {\n \"fromTopic\": true,\n \"prefix\": \"<string>\"\n }\n },\n \"config\": {\n \"topicFilter\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"destinationId": "<string>",
"sourceId": "<string>",
"format": {
"type": "rockwell",
"compression": "gzip",
"prefix": {
"fromTopic": true,
"prefix": "<string>"
},
"dataModels": {
"space": "<string>"
}
},
"config": {
"topicFilter": "<string>"
},
"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:READhostedExtractors:WRITE
Create up to 10 jobs.
POST
/
hostedextractors
/
jobs
Python SDK
from cognite.client.data_classes.hosted_extractors import EventHubSourceWrite
job_write = EventHubSourceWrite('my_event_hub', 'http://myeventhub.com', "My EventHub", 'my_key', 'my_value')
job = client.hosted_extractors.jobs.create(job_write)curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"destinationId": "<string>",
"sourceId": "<string>",
"format": {
"type": "rockwell",
"compression": "gzip",
"prefix": {
"fromTopic": true,
"prefix": "<string>"
}
},
"config": {
"topicFilter": "<string>"
},
"name": "<string>",
"description": "<string>",
"metadata": {}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
destinationId: '<string>',
sourceId: '<string>',
format: {
type: 'rockwell',
compression: 'gzip',
prefix: {fromTopic: true, prefix: '<string>'}
},
config: {topicFilter: '<string>'},
name: '<string>',
description: '<string>',
metadata: {}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs', 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/jobs",
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',
'destinationId' => '<string>',
'sourceId' => '<string>',
'format' => [
'type' => 'rockwell',
'compression' => 'gzip',
'prefix' => [
'fromTopic' => true,
'prefix' => '<string>'
]
],
'config' => [
'topicFilter' => '<string>'
],
'name' => '<string>',
'description' => '<string>',
'metadata' => [
]
]
]
]),
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/jobs"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"destinationId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"format\": {\n \"type\": \"rockwell\",\n \"compression\": \"gzip\",\n \"prefix\": {\n \"fromTopic\": true,\n \"prefix\": \"<string>\"\n }\n },\n \"config\": {\n \"topicFilter\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\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/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"destinationId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"format\": {\n \"type\": \"rockwell\",\n \"compression\": \"gzip\",\n \"prefix\": {\n \"fromTopic\": true,\n \"prefix\": \"<string>\"\n }\n },\n \"config\": {\n \"topicFilter\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/jobs")
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 \"destinationId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"format\": {\n \"type\": \"rockwell\",\n \"compression\": \"gzip\",\n \"prefix\": {\n \"fromTopic\": true,\n \"prefix\": \"<string>\"\n }\n },\n \"config\": {\n \"topicFilter\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"destinationId": "<string>",
"sourceId": "<string>",
"format": {
"type": "rockwell",
"compression": "gzip",
"prefix": {
"fromTopic": true,
"prefix": "<string>"
},
"dataModels": {
"space": "<string>"
}
},
"config": {
"topicFilter": "<string>"
},
"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
Jobs to create.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I