Developer overview
Build on VaultPanel with its REST API, JavaScript SDK, command-line tool and plugins, and learn how the panel, worker and server agent fit together.
VaultPanel is built to be automated and extended. Everything the web interface does goes through the same REST API, permission checks, job queue and audit log that scripts, the command-line tool, billing systems and plugins use. There is no back door: no endpoint runs arbitrary commands, on the panel or on a server.
Ways to integrate
| You want to | Use |
|---|---|
| Script the panel from CI, cron or your own tools | An API token with the REST API, the JavaScript SDK or the CLI. |
| Manage hosting accounts from a billing system | A billing key with the billing API, or the WHMCS module. |
| Add a feature or connect an outside service | A plugin: its own token, signed events and a page inside the panel. |
| React to deployments, backups and alerts | Webhooks, or plugin events. |
| Deploy on every Git push | Push-to-deploy with a signed webhook from your Git host. |
How the parts fit
Browser, CLI, SDK, plugins, billing systems
│ HTTPS: session cookie + CSRF token, or a Bearer token (vpt_, vpp_, vpk_)
▼
Express API ──── MariaDB (users, servers, jobs, audit log…)
│ └─── Redis (agent nonces, locks, BullMQ)
│ ▲
│ HTTPS, Ed25519-signed │
▼ │
Agent on each server Worker (maintenance every 15 s,
fixed operations, no shell the AI assistant's answers)Read Architecture for the layers, the job lifecycle and the background work.
Building VaultPanel itself
The panel is JavaScript: a React and Vite interface, and an Express API with MariaDB through Knex and Redis with BullMQ. The server agent is one program written in Rust. See Development for the local setup and checks, and Database schema for the tables.
Credentials at a glance
| Prefix | Credential | Belongs to | Reaches |
|---|---|---|---|
vpt_ | API token | A person, narrowed to its scopes | The REST API |
vpp_ | Plugin token | A plugin, narrowed to its approved scopes | The REST API |
vpk_ | Billing API key | The panel | /api/v1/billing only |
vpe_ | Enrollment token | One server, once, for 60 minutes by default | Agent registration |
whsec_ | Plugin signing secret | A plugin | Verifying events and page links |
The panel keeps only a SHA-256 of tokens and keys, and the plugin signing secret encrypted, so all of them are shown once.
Free model on this server
Run the AI assistant on a free open model installed on the panel's own server with Ollama — no API key, nothing leaves the server, reachable only by the panel.
Architecture
How VaultPanel's control plane, background worker and server agents fit together, from an API request through the job queue to a command on a server.