Help Center/Admin Operations/How to use the API Connections screen (Integrations)
Admin Operations•Last updated: 2026-10-20•3 min read

How to use the API Connections screen (Integrations)

API keys issued on the platform, shown by hint, with their scopes and owner. Issuing and revoking need a Super Administrator.

Have questions or need step-by-step guidance on this topic?

Ask AI Copilot

Step-by-Step Procedure

1

Open the page

Sign in as an administrator and use Admin sidebar → Integrations → API Connections, or go to /admin/integrations/api-connections. The heading reads "API Connections".

2

Know where the data comes from

This page reads i8_api_keys through the API key engine. KPI tiles Active, Revoked, Expired, "Signing configured". Columns: Label, Key hint, Env, Owner (masked), Scopes, Status, Expires, Last used.

3

Issue a key

New Record: Label, "Owner DID (blank = you)", Environment, "Scopes (comma separated)" (explicit scopes only; the wildcard is refused) and "Expires in (days)". The token appears once in the banner and is never stored.

4

Revoke a key

The row icon "Revoke key" asks for confirmation, then rejects the key at once on this server and within a minute everywhere.

5

Use the shared controls

Use the shared controls: the search box ("Search records, hashes, DIDs...") filters rows by any text; "Status:" offers ALL, ACTIVE, REVOKED, EXPIRED; "Page Size:" sets 10, 15, 25 or 50 rows; Refresh reloads; Export saves the rows currently loaded as a JSON file; New Record opens the form described above. The line "Data:" under the heading names the real source.

Expected Operational Outcome

A key is issued or revoked for real and audited without the token ever being stored or listed.

Troubleshooting & Failure Modes

Symptom: Error "Failed to load integrations/api-connections: HTTP 401" or "HTTP 403"
Likely Cause: The session is not signed in or does not hold an administrative role.
Resolution: Sign in again with an administrator account and click Refresh.

Was this guide helpful?

Help us refine our platform documentation