Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Sink

Rotate Sink Secret

Rotates the signing secret (only supported for http sinks).

post/api/v1/stream/{stream_id}/sink/{sink_id}/secret/rotate

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.

Headers

idempotency-keystring

The request's idempotency key

Request body

keystring nullable

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

gracePeriodSecondsinteger nullable

How long the old secret will be valid for, in seconds.

Valid values are between 0 (immediate expiry) and 7 days. The default is 24 hours.

Example request

{
  "key": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}

Response

EmptyResponse required