Cafora Docs
Developer

API Keys

Create, manage, and revoke API keys for the Cafora Host API.

API keys authenticate your applications and scripts with the Cafora Host API.

Creating an API Key

Log into the Cafora Store.
Go to Account Settings > API Keys.
Click Create API Key.
Give your key a descriptive name (e.g., "Automated Backups Script").
Select the permissions the key should have.
Copy and securely store the generated key. It will not be shown again.

Key Permissions

API keys can be scoped to specific permissions:

  • Read: View server status, player lists, resource usage
  • Write: Start/stop servers, send commands, create backups
  • Delete: Remove backups, manage files

Managing Keys

  • View all active keys from the API Keys page
  • Revoke any key immediately if compromised
  • Key names help you identify what each key is used for

Revoking an API key is permanent and immediate. Any application using the revoked key will stop working.

On this page