Guide

Revoke API Key

Overview

API keys in Hyperspell grant programmatic access to your account and services. Revoking a key immediately invalidates it, preventing any further authentication or access using that credential. This is a critical security operation — revoked keys cannot be restored, and any integrations or applications relying on the key will lose access. You should revoke keys when decommissioning integrations, rotating credentials for security, or responding to a potential breach. The revocation process requires explicit confirmation to prevent accidental disabling of active keys.

Before you begin

  • You must be logged into your Hyperspell account at app.hyperspell.com
  • You must have permission to manage API keys (typically an account owner or administrator role)
  • You must know which API key you intend to revoke
  • The API key must already exist in your account (accessible via the API Keys section)

Step by step

1
ClickAPI Keys

Navigate to the API Keys section of your Hyperspell account by clicking the 'API Keys' option in the account menu. This displays all API keys associated with your account, including active and previously revoked keys.

Tip. The API Keys section is usually located in account settings or the developer panel. If you don't see it immediately, check the navigation menu or use the search/command palette in Hyperspell.
Step 1
2
ClickRevoke

Click the 'Revoke' button next to the specific API key you want to disable. This initiates the revocation process and triggers a confirmation prompt.

Tip. Ensure you've selected the correct API key before clicking Revoke — double-check the key's name, creation date, or associated service to avoid revoking the wrong credential.
Step 2
3
ClickCancel Revoke Key

Review the confirmation dialog that appears. Click 'Cancel Revoke Key' only if you've selected the wrong key or changed your mind. This will cancel the revocation and return you to the API Keys list without making any changes.

Tip. Take a moment to confirm you are revoking the intended key. The confirmation dialog is your last opportunity to prevent the permanent revocation.
Step 3
4
ClickRevoke Key

Click the 'Revoke Key' button in the confirmation dialog to finalize and permanently revoke the API key. Once confirmed, the key will be immediately invalidated and cannot be restored.

Warning. This action is irreversible. After clicking 'Revoke Key', the API key will be permanently disabled, and any applications or services using it will lose access. Ensure all dependent integrations have been updated with a new key or alternative authentication method before confirming.
Step 4

Confirm it worked

  1. 1After completing the revocation, the revoked API key no longer appears in the active API Keys list, or it is marked as 'Revoked' or 'Inactive'
  2. 2Any attempts to use the revoked API key for authentication receive an error or unauthorized response
  3. 3The Hyperspell dashboard or settings reflects the key's revoked status in the API Keys history or audit log

Common issues

Keep reading