Skip to main content

Delete or replace an API key

Deleting an API key revokes its ability to authenticate new requests to Zvid.

When to use it​

Delete a key that is unused, lost, or exposed. Replace a key when changing the credential used by an application.

Before you begin​

Identify every application or workflow using the key. If you need continuity, create and test a replacement before deleting the old key. If the key is exposed, revoke it promptly.

Delete a key​

Location: Dashboard → API Keys → Delete API key.

  1. Open API Keys from the sidebar.
  2. Find the key by its name and masked prefix.
  3. Click the trash icon labeled Delete API key on that key's card.
  4. Read the browser confirmation, check the key name, and confirm deletion.

The API key deleted successfully message appears and the card disappears.

Deletion cannot be undone

Applications using the deleted key will fail to authenticate subsequent requests. The old secret cannot be restored. Deleting a key does not delete the account's projects, templates, or render history.

Replace a key with minimal interruption​

  1. Create a new key with a distinct name.
  2. Update the saved credential in each application or automation that uses the old key.
  3. Verify that those integrations authenticate successfully with the new key.
  4. Return to API Keys and delete the old key.

Troubleshooting​

My automation stopped working after deletion​

Cause: It is still sending the revoked key.

Solution: Update its credential to an active key, then retry the request. If you do not have the full value of another active key, create a new one.

I cannot find a deleted key​

The dashboard lists active keys. A removed key is not recoverable from that list.