Overview

Single-binary Docker Compose deployer with proxy, backups, alerts, and metrics.

SimpleDeploy REST API (1.2.0)

The SimpleDeploy HTTP API drives the dashboard UI and exposes every operation available in the CLI. All endpoints are mounted under the /api prefix.

Authentication

There are two ways to call the API:

• Session cookie (session): set by POST /auth/login for browser clients. The cookie carries a JWT and is HttpOnly, SameSite=Strict (or Lax when TLS is off).
• API key bearer (Authorization: Bearer sd_...): create at POST /apikeys. API keys belong to a user and inherit that user’s role and per-app access grants.

Most endpoints accept either auth method. A handful of dashboard-only routes require a real session.

App scope

Every app-scoped path is gated by an “app access” middleware. Super admins and admins can reach any app. Regular users only see apps explicitly granted to them via POST /users/{id}/access.

Errors

Errors are returned as text/plain with a one-line, generic message and the appropriate HTTP status. The detailed reason is logged server-side, never returned to the client. Treat any non-2xx status as a failure.

• SimpleDeploy on GitHub: https://github.com/vazra/simpledeploy
• License: MIT
• OpenAPI version: 3.1.0

Authentication

sessionAuth

Session cookie set by POST /auth/login. Carries a JWT.

Security scheme type: apiKey

Cookie parameter name: session

apiKeyAuth

Personal API key. Created via POST /apikeys.

Security scheme type: http

Bearer format: sd_<token>