Public Routes
Health Check
Request:GET /api/v1/public/ping
Response (200):
Authentication
Generate Token
Request:POST /auth/tokens
Volume Management
Create Volume
Request:POST /volumes
Response (201):
Write File
Request:POST /volumes/d6764075/files
Create Folder
Request:POST /volumes/d6764075/folders
Copy File/Folder
Request:POST /volumes/d6764075/copy
List Files
Request:GET /volumes/d6764075/files?path=plugins
Response (200):
Compress Volume
Request:POST /volumes/d6764075/compress
Decompress Archive
Request:POST /volumes/d6764075/decompress
Network Management
Add Port
Request:POST /network/ports
Get Port
Request:GET /network/ports/0.0.0.0/25565
Response (200):
List All Ports
Request:GET /network/ports
Response (200):
Get Random Available Port
Request:GET /network/ports/random
Response (200):
Mark Port In Use
Request:PUT /network/ports/0.0.0.0/25565/use
Delete Port
Request:DELETE /network/ports/0.0.0.0/25565
Response (200):
Bulk Delete Ports
Request:POST /network/ports/bulk-delete
Container Management
Create Container
Request:POST /containers
Get Container State
Request:GET /containers/minecraft-001
Response (200):
List All Containers
Request:GET /containers
Response (200):
Delete Container
Request:DELETE /containers/minecraft-001
Response (200):
Start Container
Request:POST /containers/minecraft-001/start
Response (200):
Kill Container
Request:POST /containers/minecraft-001/kill
Response (200):
Restart Container
Request:POST /containers/minecraft-001/restart
Response (200):
Reinstall Container
Request:POST /containers/minecraft-001/reinstall
Rebind Network
Request:POST /containers/minecraft-001/rebind-network
Remote API
Get Config
Request:GET /remote/config
Response (200):
Reload Config
Request:POST /remote/config/reload
Response (200):