Skip to main content
PATCH
Update a streaming destination config

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

provider
enum<string>
required
Available options:
kafka,
kinesis

Body

application/json

Kafka streaming-destination PATCH body (mirrors kafkaPatchBodySchema). Every field optional; only supplied keys are merged.

enabled
boolean
destination
object
credentials
string
write-only

Kafka SASL password. Encrypted at rest; never returned. Empty string clears it.

Maximum string length: 4096
brokers
string[]
Required array length: 1 - 16 elements

Bootstrap broker host:port (no scheme, no path).

sasl_mechanism
enum<string>
Available options:
plain,
scram-sha-256,
scram-sha-512
sasl_username
string
Required string length: 1 - 256

Response

The updated streaming-destination config

data
object

Public streaming-destination config for one provider. The encrypted credential is never returned — only the credentials_configured presence flag. Worker-owned run-status fields (last_run_*, consecutive_failures) are read-only.

meta
object