API Keys
API keys authenticate your StudioTwin UE5 plugin with the cloud platform. Every key belongs to your organization.
info
To see how to configure the API Key in your project check out the instructions here
Creating an API Key
- Click "+ Create key" in the top right
- Enter a Name to identify the key, for example "Production" or "CI Pipeline"
- Optionally add a Description
- Click "+ Create key"
The secret is shown only once at creation. Copy it immediately. It cannot be retrieved again.
After creation, the key appears in the table with its masked value, state, and creation date.
API Keys Table
| Column | Description |
|---|---|
| Name | The identifier you gave the key |
| Key | The key value, partially masked for security |
| State | Active or Suspended |
| Created | Date the key was created |
| Actions | View, suspend, or delete the key |
Suspending and Activating a Key
Click the suspend icon to deactivate a key. The state changes to Suspended and the key can no longer be used.
Click the activate icon to re-enable a suspended key. The state returns to Active.
Suspending a key does not delete it or its history.
Deleting a Key
Click the delete icon to permanently remove a key. This cannot be undone.
Security Guidance
- Never expose keys in browser-side code, public repositories, or logs
- Rotate keys regularly and revoke any that may have been compromised
- Use separate keys per environment, for example production, CI, and local dev
- Restrict key usage to the minimum required scope when scoped keys become available