Roll a release alias back to its previous version
Re-aim an alias at the version recorded as previousVersionId on its most recent pointer-moving receipt, walking steps receipts back. Writes a rollback receipt. Rolling back live follows the same scope and If-Match rules as activation, and restores configuration only: external data and side effects are not rolled back.
Authentication
AuthorizationBearer
API key or Clerk session token
Path parameters
id
alias
Headers
if-match
The alias revision this write expects. Required on a live alias that already exists (428 without it) and refused with 412 when the stored revision has moved on. Optional on preview aliases and on the first live deployment, which has no revision yet.
idempotency-key
Replay key. Repeating an activation with the same key returns the receipt the first call produced instead of moving the pointer twice.
Request
This endpoint expects an object.
reason
steps
Response
Alias rolled back
alias
changed
receiptId
revision
versionId
versionNumber
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
412
Precondition Failed Error
422
Unprocessable Entity Error
428
Precondition Error
500
Internal Server Error