Skip to content
SimpleDeploy
Search
Ctrl
K
Cancel
Star
GitHub
RSS
Blog
Select theme
Dark
Light
Auto
Blog
Start Here
What is SimpleDeploy
How it Works
When to Use
5-Minute Quickstart
Install
Overview
macOS (Homebrew)
Ubuntu / Debian (apt)
Generic Linux (binary)
From Source
Docker
Upgrading
Deploy Your First App
Prepare the Server
Generate Config
Create Admin User
Write a docker-compose.yml
Deploy via UI
Deploy via CLI
Verify
Core Concepts
Activity log
Apps and services
Endpoints and routing
How it works
What is SimpleDeploy
Desired-state reconciler
State and storage
Guides
IP access control
alerts
Alert recipes
Alert rules
Alert webhooks
API keys
Audit log
backups
Local target
MongoDB backups
MySQL / MariaDB backups
Backups overview
PostgreSQL backups
Redis backups
Restore
Retention and scheduling
S3 target
SQLite backups
System database backup
Volume snapshots
Community Recipes
Custom certificates
Environment variables and secrets
Export and Import App Config
First deploy
Behind a load balancer
Rate limiting
Private registries
Remote management
Scaling services
Small VPS tuning
TLS and HTTPS
Users and roles
Playground
Compose Label Builder
Reference
Compose Labels
Configuration
CLI
WebSocket Endpoints
Environment Variables
Ports and Firewall
Directory Layout
REST API
Overview
auth
Overview
Liveness probe
Whether first-time setup is required
Create the initial super admin
Log in with username and password
Clear the session cookie
apps
Overview
List all apps the caller can see
Get one app with labels and endpoints
Remove an app
Create or update an app from a docker-compose.yml
Validate compose YAML and labels without deploying
app-actions
Overview
Restart all services for an app
Stop all services for an app
Start (after stop) all services for an app
Pull latest images then redeploy
Scale services up or down
Cancel an in-flight deploy
List running containers for an app
Get the .env file for an app
Replace the .env file for an app
Get the docker-compose.yml for an app
endpoints
Overview
Replace the list of HTTPS endpoints for an app
Update IP access list and rate limits for an app
Upload a custom TLS certificate for a domain
Remove a custom TLS certificate
deploy-history
Overview
List compose versions for an app (newest first)
Roll back to a previous compose version
Edit metadata (name, notes, env snapshot) for a version
Delete a stored compose version
Download the compose YAML for a version
Replace the live compose with a stored version and redeploy
List deploy events for an app
activity
Overview
Per-app activity feed
Global activity feed (all apps + system events)
Purge all activity entries (super admin)
Dashboard mini-feed (scoped to caller's accessible apps)
Single activity entry with full before/after JSON
users
Overview
List all users (super admin or admin)
Create a user (super admin)
Update a user (super admin)
Delete a user (super admin)
Grant a user access to an app
Revoke a user's access to an app
profile
Overview
Get the current user's profile
Update the current user's display name and email
Change the current user's password
apikeys
Overview
List the current user's API keys
Create a new API key (returned ONCE, store it now)
Revoke an API key
metrics
Overview
Host CPU, memory, and disk metrics
Per-app container metrics
HTTP request stats for an app's endpoints
logs
Overview
WebSocket stream of deploy progress
WebSocket stream of container logs
backups
Overview
List backup configs for an app
Create a backup config for an app
Update a backup config
Delete a backup config
List backup runs across all configs for an app
Trigger a backup for every config of this app
Restore from a stored backup run
Download a backup file (local target) or redirect to S3
Upload a backup file and restore it
Cross-app backup summary for the dashboard
Detect candidate backup strategies from an app's compose file
Trigger a single backup config now
Test an S3 target by uploading and deleting a probe object
webhooks
Overview
List webhook destinations
Create a webhook destination
Update a webhook destination
Delete a webhook destination
Send a test event to a webhook
alerts
Overview
List alert rules
Create an alert rule
Update an alert rule
Delete an alert rule
List recent alert events
Clear alert history
registries
Overview
List private container registries
Add a private registry
Update a registry
Delete a registry
docker
Overview
Docker daemon info
Docker disk usage breakdown
List local images
Remove an image by id or repo:tag
List Docker networks
Remove a network
List Docker volumes
Remove a Docker volume
Prune stopped containers
Prune unused images
Prune unused volumes
Prune builder cache
Run every Docker prune at once
system
Overview
Server build info, uptime, host facts
Get the configured public_host (for template sslip.io Quick test)
Update public_host (super_admin only)
Disk usage of the data directory
Get activity log retention config (super admin)
Update activity log retention (super admin)
Tail of the server process log buffer
WebSocket live stream of server process logs
Delete old metric points (super admin)
Delete old request stats (super admin)
Run SQLite VACUUM (super admin)
Stream a one-shot SQLite backup
Get the scheduled DB backup config
Set the scheduled DB backup config
List recent scheduled DB backup runs
Probe the configured Git Sync remote without saving.
tls
Overview
Download the local CA certificate
Operations
Archived apps
Capacity and sizing
Config sidecars and sidecar-based recovery
Disaster recovery
Git sync
Monitoring and observability
Production checklist
Security architecture
Activity & Audit Log
Security hardening
State on disk
Threat model
Troubleshooting
Upgrade and rollback
Integrations
Ansible
GitHub Actions
Terraform
Architecture
Alerts engine
Auth and encryption
Backup architecture
Compose injection (InjectSharedNetwork)
Deployer
Log ring buffer
Metrics pipeline
Architecture overview
Proxy (embedded Caddy)
Realtime events
Reconciler
Storage layer
Threat model
Contributing
Build and test
Contributing a Recipe
Coding conventions
Writing docs
E2E tests
Debugging with an isolated reproduction repo
Migrations and data changes
Releasing
Development setup
Writing a backup strategy
Writing a backup target
Writing a Caddy module
Community
Code of Conduct
Reporting a bug
Reporting a vulnerability
Roadmap
Showcase
Support
FAQ
Changelog
Legal
License
Privacy Policy
Terms of Use
Star
GitHub
RSS
Blog
Select theme
Dark
Light
Auto
List Docker volumes
GET
/docker/volumes
Replace with your server URL.
Authorizations
Section titled “Authorizations ”
sessionAuth
apiKeyAuth
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Volumes.
Select media type
application/json
Array<object>
object
key
additional properties
any
