API Keys

Create and manage API keys for programmatic access.

For complete API key documentation, see the API Key Management guide in the Configuration section.

Quick Reference

Create API Key

  1. Go to Settings > API Keys
  2. Click Create API Key
  3. Enter name and select permissions
  4. Set expiration (optional)
  5. Click Create
  6. Copy the key (shown only once!)

API Key Format

supascale_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Using API Keys

curl https://supascale.example.com/api/v1/projects \
  -H "Authorization: Bearer supascale_your_api_key"

Permissions

ResourceDescription
projectsProject management
backupsBackup operations
tasksScheduled tasks
cloudStorageStorage providers
systemSystem operations

Each resource can have:

  • none - No access
  • read - GET operations only
  • write - All operations

For detailed information on creating, managing, and securing API keys, see the API Key Management documentation.