Rotate Endpoint Secret

Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.

post/endpoint/{endpoint_id}/secret/rotate

Path parameters

endpoint_idstring required

The ep's ID or UID

Example:unique-ep-identifier

The ep's ID or UID To retrieve your endpoints ids, use GET /endpoint.

Headers

idempotency-keystring

The request's idempotency key

Request body

keystring nullable

The endpoint's verification secret. If null is passed, a secret is automatically generated. Format: base64 encoded random bytes optionally prefixed with whsec_. Recommended size: 24.

Example request

{
  "key": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}

Response

No content. Your secret has been rotated, but we won't show it here.

Changes

No recorded changes to this endpoint across all 1 revision of this API.