Sign in
Event Forwarders

Update an event forwarder

Update an existing event forwarder. Only provided fields are updated.

put/v1/event-forwarders/{forwarder-name}

Path parameters

forwarder-namestring required

Event forwarder name

Request body

descriptionstring

Event forwarder description

driverNamestring

Event forwarder driver name

configurationobject

Driver-specific configuration object

Response

Event forwarder updated successfully

namestring

Event forwarder name

descriptionstring

Event forwarder description

driverNamestring

Event forwarder driver name

configurationobject

Driver-specific configuration object

driverInitializedboolean

Whether the driver was initialized successfully

errorMessagestring

Last error message

sendStatusinteger

Last delivery status code

healthCheckStatusboolean

Health check status

lastMessageTimestring

Timestamp of last forwarded event

messageCountinteger

Total events forwarded

failureCountinteger

Total delivery failures

droppedCountinteger

Total events dropped

queueSizeinteger

Current event queue size

Changes

Changed in 2 of the 73 revisions of this API.11