API Reference

This section documents key API endpoints for advanced automation and configuration.

Base URL

All API requests should be prefixed with /api/v1.

Authentication

Requests must be authenticated using a Bearer Token (JWT) or an API Key (future).

Key Endpoints

Server Management

Reconfigure Proxy

Inject custom Traefik dynamic configuration.

• Endpoint: POST /api/v1/servers/{id}/reconfigure-proxy
• Body:

  {
    "traefik_custom_config": "yaml_string_here"
  }
  

Resource Management

Backup Configuration

Manage backup schedules and policies.

• Endpoint: POST /api/v1/resources/{id}/backup-config
• Body:

  {
    "strategy": "postgres",
    "frequency_cron": "0 0 * * *",
    "retention_days": 14,
    "enabled": true,
    "storage_provider_id": "uuid"
  }
  

Authentication & Recovery

Get Recovery Kit

Retrieve the emergency recovery kit (Master Key, Admin Token).

• Endpoint: GET /api/v1/auth/recovery-kit
• Requires: Admin privileges