Create a connection profile
curl --request POST \
--url http://{controllerHost}:8000/api/v1/connection_profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "production-kafka",
"connector": "kafka",
"config": {
"bootstrap_servers": "kafka-1:9092,kafka-2:9092",
"authentication": {
"type": "sasl_plain",
"username": "user",
"password": "pass"
}
}
}
'import requests
url = "http://{controllerHost}:8000/api/v1/connection_profiles"
payload = {
"name": "production-kafka",
"connector": "kafka",
"config": {
"bootstrap_servers": "kafka-1:9092,kafka-2:9092",
"authentication": {
"type": "sasl_plain",
"username": "user",
"password": "pass"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'production-kafka',
connector: 'kafka',
config: {
bootstrap_servers: 'kafka-1:9092,kafka-2:9092',
authentication: {type: 'sasl_plain', username: 'user', password: 'pass'}
}
})
};
fetch('http://{controllerHost}:8000/api/v1/connection_profiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://{controllerHost}:8000/api/v1/connection_profiles",
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([
'name' => 'production-kafka',
'connector' => 'kafka',
'config' => [
'bootstrap_servers' => 'kafka-1:9092,kafka-2:9092',
'authentication' => [
'type' => 'sasl_plain',
'username' => 'user',
'password' => 'pass'
]
]
]),
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 := "http://{controllerHost}:8000/api/v1/connection_profiles"
payload := strings.NewReader("{\n \"name\": \"production-kafka\",\n \"connector\": \"kafka\",\n \"config\": {\n \"bootstrap_servers\": \"kafka-1:9092,kafka-2:9092\",\n \"authentication\": {\n \"type\": \"sasl_plain\",\n \"username\": \"user\",\n \"password\": \"pass\"\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("http://{controllerHost}:8000/api/v1/connection_profiles")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"production-kafka\",\n \"connector\": \"kafka\",\n \"config\": {\n \"bootstrap_servers\": \"kafka-1:9092,kafka-2:9092\",\n \"authentication\": {\n \"type\": \"sasl_plain\",\n \"username\": \"user\",\n \"password\": \"pass\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{controllerHost}:8000/api/v1/connection_profiles")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"production-kafka\",\n \"connector\": \"kafka\",\n \"config\": {\n \"bootstrap_servers\": \"kafka-1:9092,kafka-2:9092\",\n \"authentication\": {\n \"type\": \"sasl_plain\",\n \"username\": \"user\",\n \"password\": \"pass\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "prof-123",
"name": "production-kafka",
"connector": "kafka",
"config": {},
"description": "Kafka cluster"
}{
"error": "descriptive error message"
}Create a connection profile
Creates a connection profile.
Typed endpoints are also available for specific connectors: POST /connectors/kafka/profiles
and POST /connectors/confluent/profiles.
POST
/
connection_profiles
Create a connection profile
curl --request POST \
--url http://{controllerHost}:8000/api/v1/connection_profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "production-kafka",
"connector": "kafka",
"config": {
"bootstrap_servers": "kafka-1:9092,kafka-2:9092",
"authentication": {
"type": "sasl_plain",
"username": "user",
"password": "pass"
}
}
}
'import requests
url = "http://{controllerHost}:8000/api/v1/connection_profiles"
payload = {
"name": "production-kafka",
"connector": "kafka",
"config": {
"bootstrap_servers": "kafka-1:9092,kafka-2:9092",
"authentication": {
"type": "sasl_plain",
"username": "user",
"password": "pass"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'production-kafka',
connector: 'kafka',
config: {
bootstrap_servers: 'kafka-1:9092,kafka-2:9092',
authentication: {type: 'sasl_plain', username: 'user', password: 'pass'}
}
})
};
fetch('http://{controllerHost}:8000/api/v1/connection_profiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://{controllerHost}:8000/api/v1/connection_profiles",
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([
'name' => 'production-kafka',
'connector' => 'kafka',
'config' => [
'bootstrap_servers' => 'kafka-1:9092,kafka-2:9092',
'authentication' => [
'type' => 'sasl_plain',
'username' => 'user',
'password' => 'pass'
]
]
]),
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 := "http://{controllerHost}:8000/api/v1/connection_profiles"
payload := strings.NewReader("{\n \"name\": \"production-kafka\",\n \"connector\": \"kafka\",\n \"config\": {\n \"bootstrap_servers\": \"kafka-1:9092,kafka-2:9092\",\n \"authentication\": {\n \"type\": \"sasl_plain\",\n \"username\": \"user\",\n \"password\": \"pass\"\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("http://{controllerHost}:8000/api/v1/connection_profiles")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"production-kafka\",\n \"connector\": \"kafka\",\n \"config\": {\n \"bootstrap_servers\": \"kafka-1:9092,kafka-2:9092\",\n \"authentication\": {\n \"type\": \"sasl_plain\",\n \"username\": \"user\",\n \"password\": \"pass\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://{controllerHost}:8000/api/v1/connection_profiles")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"production-kafka\",\n \"connector\": \"kafka\",\n \"config\": {\n \"bootstrap_servers\": \"kafka-1:9092,kafka-2:9092\",\n \"authentication\": {\n \"type\": \"sasl_plain\",\n \"username\": \"user\",\n \"password\": \"pass\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "prof-123",
"name": "production-kafka",
"connector": "kafka",
"config": {},
"description": "Kafka cluster"
}{
"error": "descriptive error message"
}Authorizations
Send the API token as Authorization: Bearer <token>.
Body
application/json