Skip to main content
PATCH
Update a platform event-stream sink config

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

kind
enum<string>
required

Sink transport to update. One of kafka or http_batch.

Available options:
kafka,
http_batch

Body

application/json

PATCH body for a kafka sink. Only the fields you send are merged.

enabled
boolean
events
string[]
Maximum array length: 200
Required string length: 1 - 120
destination
object
credentials
string

Kafka SASL password, encrypted at rest. Send an empty string to clear.

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

Bootstrap broker as 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

Resulting sink configuration after the merge.

data
object

Current configuration for one event-stream sink. The plaintext credential is never returned — only the credentials_configured presence flag. The last_run_* fields are worker-owned run status, surfaced read-only.

meta
object