Skip to main content
PATCH
/
kafka-clusters
/
{cluster_name}
Update Kafka cluster
curl --request PATCH \
  --url https://api.example.com/kafka-clusters/{cluster_name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "properties": {}
}
'
import requests

url = "https://api.example.com/kafka-clusters/{cluster_name}"

payload = { "properties": {} }
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({properties: {}})
};

fetch('https://api.example.com/kafka-clusters/{cluster_name}', 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://api.example.com/kafka-clusters/{cluster_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'properties' => [

]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/kafka-clusters/{cluster_name}"

payload := strings.NewReader("{\n \"properties\": {}\n}")

req, _ := http.NewRequest("PATCH", url, payload)

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.patch("https://api.example.com/kafka-clusters/{cluster_name}")
.header("Content-Type", "application/json")
.body("{\n \"properties\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/kafka-clusters/{cluster_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"properties\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "created_at": "<string>",
  "name": "<string>",
  "properties": {},
  "info": [
    {
      "message": "<string>",
      "code": "<string>"
    }
  ]
}
{
"message": "<string>",
"restate_code": "<string>"
}
{
"message": "<string>",
"restate_code": "<string>"
}
{
"message": "<string>",
"restate_code": "<string>"
}
{
"message": "<string>",
"restate_code": "<string>"
}
{
"message": "<string>",
"restate_code": "<string>"
}

Path Parameters

cluster_name
string
required

Kafka cluster name

Body

application/json

Update Kafka cluster request

properties
object
required

Properties

Updated Kafka cluster configuration properties. Must contain either 'bootstrap.servers' or 'metadata.broker.list'.

For a full list of configuration properties, check the librdkafka documentation.

Response

Kafka cluster updated successfully

Kafka cluster simple response.

created_at
string
required

Created at

When the Kafka cluster configuration was created.

name
string<hostname>
required

Cluster Name

Name for the Kafka cluster, used to identify this Kafka cluster configuration in subscriptions. Must be a valid hostname format.

properties
object
required

Properties

Properties for connecting to the kafka cluster.

For a full list of configuration properties, check the librdkafka documentation.

info
object[]

Info

List of configuration/deprecation information related to this deployment.