Admin Operations•Last updated: 2026-10-20•3 min read
How to issue and revoke an API key from the console
Issue a scoped API key (Super Administrator) and revoke it when it is no longer needed.
Have questions or need step-by-step guidance on this topic?
Step-by-Step Procedure
1
Issue
Admin → Integrations → API Connections → New Record: Label, Environment, explicit Scopes, optional expiry in days. Copy the token from the banner immediately: it is never stored or shown again.
2
Check
The key appears with its hint and status ACTIVE; the token never appears in the list.
3
Revoke
The row icon "Revoke key" asks for confirmation; the key stops working at once on this server and within a minute everywhere.
Expected Operational Outcome
The key is registered and audited; a revoked key shows REVOKED.
Troubleshooting & Failure Modes
Symptom: "I8_API_KEY_SECRET is unset or shorter than 32 characters"
Likely Cause: Keys cannot be verified without a signing secret.
Resolution: Configure it in the deployment environment.
Was this guide helpful?
Help us refine our platform documentation