Revoke a webhook signing key
Revokes a webhook signing key for an enterprise. This is a soft delete — the key row is preserved for audit purposes but marked as REVOKED.
Revoked keys cannot be used for webhook signature verification. Revocation is irreversible — a new key must be registered to restore access.
Key ID tombstoning: Once a keyId is revoked, it is permanently tombstoned
for this enterprise. Attempting to register a new key under the same keyId will
return a 400 error, even after revocation. This is intentional security design that
prevents key-reuse attacks. Choose a stable, unique keyId from the start (e.g.
use a version suffix such as my-key-v2) so that key rotation does not require
updating secrets or configuration files that reference the keyId.
Authorization: Caller must be an admin of the specified enterprise.
Path Params
-
enterpriseIdstring requiredThe enterprise ID. -
keyIdstring requiredThe customer-provided key identifier.
Header Params
-
X-BitGo-OTPstring requiredOTP code for verification. Required for webhook key management operations.
Responses
200
Key successfully revoked.
Response Body
object
-
successboolean requiredWhether the revocation was successful. -
keyIdstring requiredThe customer-provided key identifier that was revoked. -
revokedAtstring date-time requiredWhen the key was revoked. -
revokedBystring requiredUser who revoked the key.
401
Unauthorized
Response Body
object
-
codestring -
messagestring -
statusinteger
403
Forbidden
Response Body
object
-
codestring -
messagestring -
statusinteger
404
The specified resource was not found
Response Body
object
-
codestring -
messagestring -
statusinteger
409
Conflict - The request conflicts with the current state of the resource
Response Body
object
-
codestring -
messagestring -
statusinteger
500
Server Error - Transient error please try again
Response Body
object
-
codestring -
messagestring -
statusinteger