> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptoprocessing.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Manage API keys

export function Available({to, except}) {
  const roles = <Tooltip tip="Roles determine what each user can see and do in the portal." cta="See role descriptions" href="/merchant-administration/add-a-user#determine-which-role-to-use">roles</Tooltip>;
  if (to) {
    return <><strong>Available to {roles}:</strong> {to.map(role => <>{" "}<Badge color="blue">{role}</Badge></>)}</>;
  } else {
    return <><strong>Available to all {roles} except</strong> {except.map(role => <>{" "}<Badge color="blue">{role}</Badge></>)}</>;
  }
}

<Available to={["Owner"]} />

Use the **API keys** tab to edit, deactivate, or archive an API key. To create a key, see [Generate and activate API keys](/merchant-administration/generate-and-activate-api-keys).

## Change the name or permissions of an API key

You can change the name and access settings of an API key without generating new credentials. Changes apply immediately.

<Steps>
  <Step title="In your portal, go to the API keys tab." />

  <Step title="Click the three-dot menu next to the key, then click Edit API key." />

  <Step title="Update the key name and its access.">
    * If the key is a Master key, turn **Allow withdrawals** on or off.
    * If the key is a Custom key, under **Allowed functionality**, select the abilities it can use. At least one ability must remain selected.
  </Step>

  <Step title="Click Save, enter your 2FA code, and click Confirm." />
</Steps>

<Note>
  The key type cannot be changed. To switch between Master and Custom access, generate a new key.
</Note>

## Edit the IP whitelist

Update the public IP addresses from which a key can be used to make API requests.

<Steps>
  <Step title="In your portal, go to the API keys tab." />

  <Step title="Click the three-dot menu next to the key, then click Edit IP whitelist." />

  <Step title="Update the list of allowed IP addresses.">
    Use either IPv4 or IPv6 format, and separate multiple IP addresses with commas.
  </Step>

  <Step title="Enter your 2FA code and click Save." />
</Steps>

## Deactivate an API key

Deactivating a key immediately blocks applications that use it. To reactivate the key later, click **Activate** next to it and enter your 2FA code. If you no longer need the key, [archive it](#archive-an-api-key) instead.

<Warning>
  Deactivating the active Master key also stops callbacks: CryptoProcessing doesn't send callbacks while no Master key is active, and callbacks generated in the meantime are not queued or sent later.
</Warning>

<Steps>
  <Step title="In your portal, go to the API keys tab." />

  <Step title="Click Deactivate next to the active API key." />

  <Step title="Optionally add a note, enter your 2FA code, and click Deactivate." />
</Steps>

## Archive an API key

Archive a key when it is no longer needed, its secret key has been lost, or its credentials may have been compromised.

<Card type="danger">
  **Archived API keys cannot be reactivated, and this action cannot be undone.** If you suspect that a secret key was compromised, archive the key immediately and contact our Support team.
</Card>

<Steps>
  <Step title="In your portal, go to the API keys tab." />

  <Step title="Click the three-dot menu next to the key, then click Archive." />

  <Step title="Optionally add a note, enter your 2FA code, and click Archive." />
</Steps>

Archived keys are hidden from the list by default. Expand **Filters** and include the **Archived** status to view them.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.