Summary

The updateKafkaEventForwarder() GraphQL mutation is used to update a Kafka event forwarder and return it.

API Stability Long-Term

Syntax

graphql
updateKafkaEventForwarder(
     input: UpdateKafkaEventForwarder!
   ): KafkaEventForwarder!

For the input, you'll have to give the name of the repository and the identifier of the Kafka forwarder, the Kafka producer configuration for forwarding events, and whatever else you want to update. Click on Show Query above to find the identifier. See the Input Parameters section for details.

For the results, you can get the identifier for the event forwarder, the Kafka topic to which events should be forwarded, and other details. See the Returned Values section for more.

Example

Raw
graphql
mutation {
  updateKafkaEventForwarder( input:
       { id: "abc123"
         name: "franz-forward",
         description: "Kafka Forwarder",
         properties: "bootstrap.servers=localhost:3456 \n batch.size=100",
         topic: "hot-potatoes",
         enabled: true
      }
  )
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateKafkaEventForwarder( input:
       { id: \"abc123\"
         name: \"franz-forward\",
         description: \"Kafka Forwarder\",
         properties: \"bootstrap.servers=localhost:3456 \n batch.size=100\",
         topic: \"hot-potatoes\",
         enabled: true
      }
  )
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateKafkaEventForwarder( input:
       { id: \"abc123\"
         name: \"franz-forward\",
         description: \"Kafka Forwarder\",
         properties: \"bootstrap.servers=localhost:3456 \n batch.size=100\",
         topic: \"hot-potatoes\",
         enabled: true
      }
  )
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateKafkaEventForwarder( input: ^
       { id: \"abc123\" ^
         name: \"franz-forward\", ^
         description: \"Kafka Forwarder\", ^
         properties: \"bootstrap.servers=localhost:3456 \n batch.size=100\", ^
         topic: \"hot-potatoes\", ^
         enabled: true ^
      } ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateKafkaEventForwarder( input:
       { id: \"abc123\"
         name: \"franz-forward\",
         description: \"Kafka Forwarder\",
         properties: \"bootstrap.servers=localhost:3456 \n batch.size=100\",
         topic: \"hot-potatoes\",
         enabled: true
      }
  )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateKafkaEventForwarder( input:
       { id: \"abc123\"
         name: \"franz-forward\",
         description: \"Kafka Forwarder\",
         properties: \"bootstrap.servers=localhost:3456 \n batch.size=100\",
         topic: \"hot-potatoes\",
         enabled: true
      }
  )
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateKafkaEventForwarder( input:
       { id: \"abc123\"
         name: \"franz-forward\",
         description: \"Kafka Forwarder\",
         properties: \"bootstrap.servers=localhost:3456 \n batch.size=100\",
         topic: \"hot-potatoes\",
         enabled: true
      }
  )
  { id }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateKafkaEventForwarder( input:
       { id: \"abc123\"
         name: \"franz-forward\",
         description: \"Kafka Forwarder\",
         properties: \"bootstrap.servers=localhost:3456 \n batch.size=100\",
         topic: \"hot-potatoes\",
         enabled: true
      }
  )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateKafkaEventForwarder": {
      "id": "abc123"
    }
  }
}

Input Parameters

For the input, you'll have to give the name of the repository and the unique identifier of the Kafka forwarder, the Kafka producer configuration for forwarding events, and whatever else you want to update. Click on the Show Query link above the Syntax section for an example of how to find the identifier.

Table: UpdateKafkaEventForwarder Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Mar 28, 2025
descriptionstringyes Long-TermDescription of the event forwarder.
enabledboolean trueLong-TermWhether the event forwarder enabled,
idstringyes Long-TermThe unique identifier of the event forwarder.
namestringyes Long-TermThe name of the event forwarder.
propertiesstringyes Long-TermThe Kafka producer configuration used to forward events in the form of properties (x.y.z=abc). See Kafka Configuration.
topicstringyes Long-TermThe Kafka topic to which the events should be forwarded.

Returned Values

For the results, you can get the unique identifier for the event forwarder, the Kafka topic to which events should be forwarded, and other details. Below is a list of what you can request, along with descriptions:

Table: KafkaEventForwarder Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Jun 23, 2025
descriptionstringyes Long-TermThe description of the event forwarder.
enabledbooleanyes Long-TermWhether the event forwarder is enabled.
idstringyes Long-TermThe unique identifier of the event forwarder.
namestringyes Long-TermThe name of the event forwarder.
propertiesstringyes Long-TermThe Kafka producer configuration used to forward events in the form of properties (x.y.z=abc). See Kafka Configuration.
topicstringyes Long-TermThe Kafka topic where the events should be forwarded.