Update a platform event-stream sink config
Merge a partial configuration into one sink kind. Only the fields you send are written; worker-owned last_run_* run-status fields are never accepted. The request body is discriminated on the path kind: an http_batch sink takes destination.url (https-only, SSRF-checked) and an optional max_batch_size; a kafka sink takes destination.topic plus brokers, sasl_mechanism, and sasl_username. A destination.kind must equal the path kind. Send credentials to store the encrypted secret (Kafka SASL password or HTTP bearer token); send an empty string to clear it. Requires an owner, admin, or developer role; every write is audit-logged (key names only, never the credential).
Authorizations
Dashboard JWT token from Clerk
Path Parameters
Sink transport to update. One of kafka or http_batch.
kafka, http_batch Body
- Option 1
- Option 2
PATCH body for a kafka sink. Only the fields you send are merged.
2001 - 120Kafka SASL password, encrypted at rest. Send an empty string to clear.
40961 - 16 elementsBootstrap broker as host:port (no scheme, no path).
plain, scram-sha-256, scram-sha-512 1 - 256