Skip to content

Suspend, resume or revoke an exchange

Stop all of an exchange's grants at once, bring them back, or end the exchange for good. Suspending is reversible; revoking is not.

Who can do it

A tenant administrator, a tenant key manager, or a platform super administrator from inside the tenant, where the console acts as a tenant administrator. Suspending, resuming and revoking an exchange each need their own permission on exchanges, which these three roles hold.

Before you start

  • Decide which you need. Suspend when the exchange will resume: cryptographic operations on it are rejected until it is resumed, and nothing is destroyed — the keys, the constraints and the context all survive. Revoke when the exchange has ended: it stops authorizing operations permanently, and its history is kept for audit.
  • Prepare a reason. Suspending and revoking both require one, and it is recorded in the audit trail against your account.
  • Only an active exchange can be suspended, and only a suspended one resumed. Any exchange that has not ended can be revoked.

Steps

  1. Open Cryptographic Exchanges. To find the exchange, filter by status (All statuses), by counterparty or by name.
  2. Select the exchange's row. The exchange opens in the editor; its actions are next to its name.
  3. To suspend it, select Suspend, give a Reason, and select Suspend in the confirmation.
  4. To resume a suspended exchange, select Resume. No confirmation is asked.
  5. To revoke it, select Revoke, give a Reason, and select Revoke in the confirmation.

What you see when it worked

The status beside the exchange's name changes to Suspended, Active or Revoked, and the change is recorded in the exchange's activity, in the side column. The Cryptographic Exchanges list shows the same status. A revoked exchange can no longer be edited; select Clone to start a new draft from it.

If it fails

What you see Cause What to do
The confirm button stays unavailable The reason is empty Give a reason
The exchange's current state does not allow this action. The exchange is not in a state the action applies to, for example it was already suspended or revoked Reload the exchange and check its status
Someone else changed this exchange while this page was open, so nothing was applied. Review its current state and try again. Another administrator changed the exchange Review its current state and repeat the action. See Concurrent Modification
Suspend, Resume or Revoke is not shown The exchange is not in a state the action applies to Check the status beside the exchange's name

Without the console

Surface How
Key management CLI ankasecure-km exchanges suspend --id <uuid> --reason <text>; exchanges resume --id <uuid>; exchanges revoke --id <uuid> --reason <text> (each also takes --expected-version <n>)
Admin SDK ExchangeOperations.suspend(UUID, SuspendExchangeRequest), ExchangeOperations.resume(UUID, ResumeExchangeRequest), ExchangeOperations.revoke(UUID, RevokeExchangeRequest)
API POST /api/v3/admin/exchanges/{id}/suspend (operation suspendExchange); POST /api/v3/admin/exchanges/{id}/resume (operation resumeExchange); POST /api/v3/admin/exchanges/{id}/revoke (operation revokeExchange)