Skip to content

API Reference

The dashboard talks to the backend through the gateway at http://SERVER_IP:8080. Browser clients use same-origin /api/... paths. In local development the API listens on http://localhost:8000.

Most endpoints require an authenticated admin session (cookie/JWT). Destructive operations may also require step-up password verification.

Health (no project auth):

bash
curl -s http://SERVER_IP:8080/api/health

Projects

MethodEndpointDescription
GET/api/projectsList all projects
GET/api/projects/:idGet project details
POST/api/projectsCreate project
PATCH/api/projects/:idUpdate project
DELETE/api/projects/:idDelete project
GET/api/projects/:id/build/detectDetect build / services
GET/api/projects/:id/envList env vars
POST/api/projects/:id/envCreate env var
POST/api/projects/:id/env/bulkBulk upsert env
DELETE/api/projects/:id/env/:envIdDelete env var
GET/api/projects/:id/storageList storage mounts
POST/api/projects/:id/storageAdd storage mount
DELETE/api/projects/:id/storage/:storageIdRemove storage mount
GET/api/projects/:id/auto-deployAuto-deploy status
PATCH/api/projects/:id/auto-deployEnable/disable auto-deploy

Deployments

MethodEndpointDescription
POST/api/deployments/:projectId/deployDeploy (streams logs)
POST/api/deployments/:projectId/redeployRebuild and redeploy
POST/api/deployments/:projectId/stopStop containers
POST/api/deployments/:projectId/restartRestart containers
POST/api/deployments/:projectId/cancelCancel in-flight deploy
GET/api/deployments/:projectIdDeployment info / history
GET/api/deployments/:projectId/logsDeployment logs
GET/api/deployments/:projectId/servicesService list
PUT/api/deployments/:projectId/services/:serviceIdUpdate service settings

Databases

MethodEndpointDescription
GET/api/databases/enginesSupported engines
GET/api/databasesList managed databases
POST/api/databasesCreate database
GET/api/databases/:id/connectionConnection URL panel data
GET/api/databases/:id/linksLinked apps
POST/api/databases/:id/linksLink to project/service
DELETE/api/databases/:id/links/:linkIdUnlink
GET/api/databases/links/by-app/:appProjectIdLinks for an app

System

MethodEndpointDescription
GET/api/system/statsFull system stats
GET/api/system/quickLightweight stats
GET/api/system/ipServer public IP
GET/api/system/versionRunning version info
GET/api/system/logs/:servicePlatform log stream helper
POST/api/system/purgeDocklift-scoped cleanup (step-up; not host-wide prune)
POST/api/system/resetRestart Docklift services
POST/api/system/rebootReboot server (step-up)
POST/api/system/executeExecute shell command (terminal / gated)
POST/api/system/upgradeTrigger Docklift upgrade flow
POST/api/system/update-systemHost package update flow

GitHub

MethodEndpointDescription
GET/api/github/app-statusApp status
POST/api/github/manifestCreate app via manifest
POST/api/github/install-sessionInstall session
POST/api/github/check-installationPoll installation
GET/api/github/reposList repositories
GET/api/github/branchesList branches (?repo=owner/name&type=public|private)
GET/api/github/tagsList tags newest-first (?repo=owner/name&type=public|private)
POST/api/github/disconnectDisconnect app
POST/api/github/webhookWebhook receiver

Auth, domains, ports, files, backup

MethodEndpointDescription
GET/api/auth/statusSetup / auth status
POST/api/auth/loginLogin
POST/api/auth/registerFirst admin (setup)
GET/api/auth/meCurrent user
PATCH/api/auth/profileUpdate profile
POST/api/auth/change-passwordChange password
GET/api/domainsPanel/service domain configs
POST/api/domainsAdd domain
DELETE/api/domains/:domainRemove domain
GET/api/portsHost port pool + projects running without a host port
GET/api/files/:projectIdFile tree
GET/api/files/:projectId/contentRead file
PUT/api/files/:projectId/contentWrite file
POST/api/backup/createCreate backup
POST/api/backup/restore/:filenameRestore (step-up / locks)

This is a practical operator map, not an OpenAPI dump. Paths and payloads evolve with releases — inspect the running UI network tab or backend routes under backend/src/routes/ when integrating.

Open-source self-hosted PaaS for Docker