Skip to content

System API

Configuration, user management, SSL, updates, OOB, audit logging, and system status.

System & Host

GET/api/system/statusCPU, memory, disk, uptime
GET/api/host/infoHost info (?refresh=true)
GET/api/system/db-statsDB size and stats (admin)
POST/api/system/db-cleanupTrigger DB cleanup (admin)
POST/api/restartRestart application

Configuration

GET/api/configRaw config.yaml (admin)
POST/api/configSave raw YAML (admin)
GET/api/config/jsonConfig as JSON (admin)
POST/api/config/jsonSave JSON config (admin)
GET/api/config/exportExport config CSV
POST/api/config/importImport config

Users

GET/api/meCurrent user
GET/api/usersList users
POST/api/usersCreate user
GET/api/users/:idGet user
PUT/api/users/:idUpdate user
DELETE/api/users/:idDelete user

API Keys

GET/api/api-keysList API keys
POST/api/api-keysCreate key
DELETE/api/api-keys/:idRevoke key

Authentication & 2FA

POST/api/auth/forgot-passwordSend temp password
GET/api/auth/2fa/status2FA enabled?
POST/api/auth/2fa/enrollStart TOTP enrollment (admin)
POST/api/auth/2fa/confirmConfirm TOTP code (admin)
POST/api/auth/2fa/disableDisable 2FA (admin)

Setup & Bootstrap

GET/api/setup/bootstrap-neededFirst-run check
POST/api/setup/bootstrapCreate first admin
GET/api/setup/neededSetup wizard status
POST/api/setup/saveComplete setup (admin)

SSL / HTTPS

POST/api/ssl/uploadUpload PFX certificate
POST/api/ssl/letsencryptConfigure Let's Encrypt
GET/api/ssl/statusCertificate status

Self-Update

GET/api/update/statusUpdate status
POST/api/update/credentialsSet GitHub credentials
GET/api/update/branchesAvailable branches
GET/api/update/checkCheck for updates
POST/api/update/runRun update

OOB Access

ZeroTier

POST/api/oob/zt/joinJoin network
POST/api/oob/zt/leaveLeave network
POST/api/oob/zt/toggleToggle on/off
POST/api/oob/zt/forgetForget network

Tailscale

POST/api/oob/ts/upBring up
POST/api/oob/ts/downBring down
GET/api/oob/ts/login-urlGet login URL

Status

GET/api/oob/statusOOB status
GET/api/oob/installInstall hints

hivem1nd

GET/api/hivemind/statusConnection status
POST/api/hivemind/pairPair with controller
POST/api/hivemind/unpairUnpair

Branding & Identity

GET/api/web-identityGet web identity
POST/api/web-identityUpdate web identity
POST/api/upload/brand-assetUpload branding asset

Audit & Debug

GET/api/audit-logAudit log entries
GET/api/versionApp version
GET/api/developer/routesAll routes (admin)
GET/api/dev/infoDebug info
GET/api/dev/alerts/recentRecent alerts
GET/api/dev/webhooks/recentRecent webhooks
GET/api/dev/emails/recentRecent emails
GET/api/dev/logs/streamLive log stream SSE (admin)

Released under the MIT License.