API Reference

Supascale provides a comprehensive REST API for programmatic access to all features. Automate project management, backups, and system operations.

Base URL

All API endpoints are prefixed with:

/api/v1

API Sections

• Authentication - Auth methods and API keys
• Projects API - Project management
• Certificates API - SSL certificate management
• Backups API - Backup operations
• Cloud Storage API - Storage providers
• Tasks API - Scheduled tasks
• System API - System management
• Settings API - User settings

Authentication Methods

1. Session Authentication - For web UI (automatic via cookies)
2. API Key Authentication - For programmatic access via X-API-Key header

Response Format

All responses follow a consistent JSON format:

{
  "success": true,
  "data": { ... }
}

Error responses:

{
  "success": false,
  "error": "Error message"
}