Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Sink

Patch Sink Headers

Updates the Sink's headers.

Only valid for http or otelTracing sinks.

patch/api/v1/stream/{stream_id}/sink/{sink_id}/headers

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

sink_idstring required

The StreamSink's ID or UID.

Example:unique-identifier

The StreamSink's ID or UID.

Request body

headersobject required

Example request

{
  "headers": {
    "X-Example": "123",
    "X-Foobar": "Bar"
  }
}

Response

The value of the headers is returned in the headers field.

Sensitive headers that have been redacted are returned in the sensitive field.

headersobject required
sensitivestring[] required

Example response

{
  "headers": {
    "X-Example": "123",
    "X-Foobar": "Bar"
  },
  "sensitive": [
    "Authorization"
  ]
}