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
- Go to Settings > API Keys
- Click Create API Key
- Enter name and select permissions
- Set expiration (optional)
- Click Create
- 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
| Resource | Description |
|---|---|
projects | Project management |
backups | Backup operations |
tasks | Scheduled tasks |
cloudStorage | Storage providers |
system | System operations |
Each resource can have:
none- No accessread- GET operations onlywrite- All operations
For detailed information on creating, managing, and securing API keys, see the API Key Management documentation.