Runtype APIAgent Aliases

Clear the secret bindings of a release alias

Remove every per-alias secret binding from this pointer, so its executions fall back to the organization secrets. Equivalent to replacing the set with an empty object.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
aliasstringRequired

Headers

if-matchstringOptional

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-keystringOptional<=255 characters
Replay key. Repeating an activation with the same key returns the receipt the first call produced instead of moving the pointer twice.

Response

Bindings cleared
aliasstring
nameslist of strings
revisiondouble
changedbooleanOptional

Present on a write: false when the set was already identical and nothing moved.

receiptIdstring or nullOptional

The bind receipt this write appended, or null when it changed nothing.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
412
Precondition Failed Error
428
Precondition Error
500
Internal Server Error