Patch

/kafkabrokers/{id}/

This endpoint modifies an external event broker configuration.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Body parameters

Expand All

object

name

string

Name of the event broker configuration

tenant_id

integer

Tenant ID. If missing, accessed by all tenants.

addresses

Array of object (KafkaBrokerAddressParams)

List of server addresses for an external event broker

object

host

string

IP or hostname of an external event broker server

port

integer

Port of externel event broker server

certificate_set_id

integer

Certificate Set ID

hostname_verification_enabled

boolean

Hostname verification is enabled when mTLS certificate is used

Responses

200

Expand All

object

id

integer

Configuration ID for external event broker configuration

guid

string

The GUID for the external event broker configuration

name

string

Name of the event broker configuration

tenant_id

integer

Tenant ID. If missing, accessed by all tenants

addresses

Array of object (KafkaBrokerAddressParams)

List of server addresses for an external event broker

object

host

string

IP or hostname of an external event broker server

port

integer

Port of externel event broker server

certificate_set_id

integer

Certificate Set ID

hostname_verification_enabled

boolean

Hostname verification is enabled when mTLS certificate is used

Modify External Event Broker Configuration