Skip to content
How to install

Job types

Every kind of job the panel runs, 50 types in all, grouped as the filters on Automations → All jobs group them. The id under each name is what the API and the job log use.

A lane decides what a job waits for. Jobs in one lane run one at a time, and jobs in different lanes run side by side.

Lane What waits for what
Server One job at a time per server: the site’s server, or the server the job works on.
Both servers A move holds the lanes of both servers it works on.
Shared queue Jobs that belong to no server run one at a time among themselves.
A named lane Jobs in a named lane run one at a time within it, beside the server lanes. A lane marked one per server has a lane for each server.
external-0, external-1 Every job of a site hosted elsewhere runs in one of these two, whatever lane its type takes below. Each such site always gets the same one.

The lanes and starters below are read from the places in the code that queue each job. Every job a person starts in the panel goes through the same API.

Job What it does Lane Started by
Create site
site.create
Creates the site’s container and database, installs WordPress, and applies the plugins and recipes chosen on the New site form. A PHP site gets a placeholder page, and a database only when asked. Server API: POST /api/sites
Delete site
site.delete
Removes the site’s container, database and files, after a final backup when one was asked for. Server
Both servers
API: DELETE /api/sites/:slug
Start site
site.start
Starts the site’s container. Server API: POST /api/sites/:slug/start
Custom schedule: Start sites
Stop site
site.stop
Stops the site’s container. The site does not answer until it is started again. Server API: POST /api/sites/:slug/stop
Custom schedule: Stop sites
Restart site
site.restart
Restarts the site’s container. Server API: POST /api/sites/:slug/restart
Custom schedule: Restart sites
Change PHP version
site.changePhp
Recreates the site’s container on another PHP version. Files and database stay as they are. Server API: PUT /api/sites/:slug/php
Switch object cache
site.objectCache
Starts Redis in the site’s container and installs the Redis Object Cache plugin, or stops it again. Server API: PUT /api/sites/:slug/cache
Deploy app
app.deploy
Puts a container app’s new image in place: pulls it by digest or loads the upload, checks it, holds the app’s routes, replaces the container and waits for its health check. When that fails, the old container comes back. Server API: POST /api/hooks/app-deploy, POST /api/sites/:slug/app/deploy, POST /api/sites/:slug/app/image
Built-in schedule: Container app updates
Fill app mount
app.mountUpload
Unpacks an uploaded .tar.gz or .zip into one of a container app’s mounts, as the app’s own user, in a locked-down container that sees nothing else. Then the app restarts onto it. Server API: PUT /api/sites/:slug/app/mounts/:name
Recreate site container
site.reconcile
Recreates the site’s container so it runs under the current isolation policy - its networks, its container capabilities and what it may send mail as - and with the certificate its server gives it now. Server API: DELETE /api/dns/token, PATCH /api/servers/:id, PATCH /api/sites/:slug/app, POST /api/sites/:slug/reconcile, POST /api/sites/reconcile-all, PUT /api/dns/servers/:id/wildcard
Built-in schedule: Site network repair
Another job: Apply container limits, Finish panel update
The panel itself
Change domains
site.updateDomains
Changes the site’s hostnames - going live, adding or removing a domain - and updates WordPress’s own URLs to match. A PHP site’s own config is left to you. Server API: POST /api/sites/:slug/go-live, PUT /api/sites/:slug/domains
Move site
site.move
Copies the site to another server and switches its traffic over. The old copy is parked until every hostname points at the new server. Both servers API: POST /api/sites/:slug/move
Finish move
site.moveFinalize
Removes the copy a move parked on the old server, once every hostname resolves to the new one. Server API: POST /api/sites/:slug/move/finalize
Another job: Nightly housekeeping
Import site
site.import
Pulls an existing site’s files and database from the old host through the migration plugin into a staging folder on the server. import, one per server API: POST /api/imports/:id/retry, POST /api/imports/:id/run
Finish import
site.importFinish
Brings an imported site up from its staging folder: database, container, WordPress fixes and a first backup. Server API: POST /api/imports/:id/retry
Another job: Import site
Refresh import
site.importRefresh
Pulls an imported site’s database and changed files from the old host again, with the old site in maintenance, and replaces this site’s copy. Server API: POST /api/imports/:id/refresh
Shell command
site.shell
Runs a shell command in the site’s folder, inside its container, as www-data, and keeps its output in the job log. exec, one per server API: POST /api/sites/:slug/shell
Custom schedule: Shell command
Job What it does Lane Started by
Back up site
backup.create
Dumps the site’s database, when it has one, and archives its files into a new backup. Server API: POST /api/connections/:id/add, POST /api/sites/:slug/backups
Built-in schedule: Scheduled backups
Custom schedule: Back up
Restore backup
backup.restore
Replaces the site’s files and database with a backup, after a safety copy of the current state unless that was skipped. Server API: POST /api/backups/:id/restore
Offsite copy
backup.offsite
Uploads a backup to every offsite destination that should hold it. offsite, one per server API: PATCH /api/backup-destinations/:id, POST /api/backup-destinations, POST /api/backups/:id/offsite, PUT /api/sites/:slug/offsite-enabled
Built-in schedule: Offsite copies
Another job: Back up site, Panel snapshot
Fetch offsite backup
backup.fetch
Downloads a backup back from an offsite destination, so it can be restored. offsite, one per server API: POST /api/backups/:id/fetch
Empty offsite destination
backup.offsitePurge
Deletes this panel’s copies from an offsite destination. offsite, one per server API: DELETE /api/backup-destinations/:id
Delete backups
backup.delete
Deletes several backups at once: their files on the server and their copies at the remote destinations. A backup that is in use is left alone and named in the log. backup-delete API: DELETE /api/app-uploads/:id, DELETE /api/databases/:serverId/:name, DELETE /api/dns/token, DELETE /api/mail/servers/:serverId/hostname, DELETE /api/security/blocks/:id, DELETE /api/security/never-block/:id, DELETE /api/servers/:id, DELETE /api/sites/:slug/app/deploy-token, DELETE /api/sites/:slug/app/mount-uploads/:id, DELETE /api/sites/:slug/database-uploads/:id, DELETE /api/sites/:slug/ftp/users/:id, GET /api/jobs/types, GET /api/mail/status, GET /api/meta, GET /api/monitor/overview, GET /api/monitor/servers/:id/history, GET /api/security/check, GET /api/servers, GET /api/servers/:id, GET /api/servers/:id/info, GET /api/servers/:id/storage, GET /api/servers/ssh-public-key, GET /api/sites/:slug/app/deploys, GET /api/sites/:slug/app/logs, GET /api/sites/:slug/databases/:db/export, GET /api/system/about, PATCH /api/servers/:id, PATCH /api/sites/:slug/app, POST /api/backups/bulk-delete, POST /api/hooks/app-deploy, POST /api/mail/domains/:domain/publish, POST /api/mail/servers/:serverId/publish-hostname, POST /api/plugins/upload, POST /api/security/blocks, POST /api/security/never-block, POST /api/servers, POST /api/servers/:id/backups/relocate, POST /api/servers/:id/test, POST /api/servers/:id/update, POST /api/sites/:slug/app/deploy, POST /api/sites/:slug/app/deploy-token, POST /api/sites/:slug/app/image, POST /api/sites/:slug/databases/:db/import, POST /api/sites/:slug/security/findings/:id/put-back, POST /api/sites/:slug/shell, POST /api/sites/reconcile-all, POST /api/system/update/check, PUT /api/app-uploads/:id, PUT /api/dns/servers/:id/wildcard, PUT /api/mail/servers/:serverId/hostname, PUT /api/settings, PUT /api/sites/:slug/app/mount-uploads/:id, PUT /api/sites/:slug/app/mounts/:name, PUT /api/sites/:slug/app/registry-auth, PUT /api/sites/:slug/app/routes, PUT /api/sites/:slug/cache, PUT /api/sites/:slug/database-uploads/:id
Built-in schedule: Blocked addresses, Container app routes, Container app updates, Container limits follow-up, Malware scans, Scheduled backups, Site network repair, Update check, Wildcard certificate token, WordPress cron
Another job: Add database, Apply container limits, Back up site, Change PHP version, Change database password, Change domains, Change table structure, Compress files, Create site, Delete backups, Delete database, Delete site, Delete unused database, Deploy app, Empty offsite destination, Extract archive, Fill app mount, Finish import, Finish panel update, Import database, Import site, Move backups, Move site, Panel snapshot, Plugin recipes, Recreate site container, Refresh import, Reinstall original, Restart site, Restore backup, Set up server, Shell command, Start site, Stop site, Switch object cache, Sync plugin library, WordPress inventory scan
The panel itself
Panel snapshot
panel.snapshot
Backs up the panel’s own database - servers, sites, domains, DKIM keys - which is what a fleet is rebuilt from. Server Built-in schedule: Scheduled backups
Custom schedule: Panel snapshot
Job What it does Lane Started by
Update WordPress
wp.coreUpdate
Updates WordPress itself on the site, then re-reads what the site has installed. Server API: POST /api/sites/:slug/wp/core-update
Plugin change
wp.pluginTask
Installs, activates, deactivates, updates or deletes one plugin on the site. Server API: DELETE /api/sites/:slug/wp/plugins/:name, POST /api/sites/:slug/wp/plugins, POST /api/sites/:slug/wp/plugins/:name/activate, POST /api/sites/:slug/wp/plugins/:name/deactivate, POST /api/sites/:slug/wp/plugins/:name/update
Theme change
wp.themeTask
Activates, updates or deletes one theme on the site. Server API: DELETE /api/sites/:slug/wp/themes/:name, POST /api/sites/:slug/wp/themes/:name/activate, POST /api/sites/:slug/wp/themes/:name/update
WordPress updates
wp.bulkTask
Runs a list of plugin, theme and core operations on one site in one go, optionally after a backup and with a check that the site still answers. Bulk runs and update schedules both use it. Server API: POST /api/sites/:slug/wp/bulk, POST /api/wp/bulk
Custom schedule: Update plugins, themes and WordPress
WordPress inventory scan
wp.scanAll
Asks every running site which plugins, themes and WordPress version it has and what has an update, then checks the installed versions against the vulnerability feed. Shared queue API: POST /api/connections/:id/add, POST /api/wp/scan
Built-in schedule: WordPress inventory scan
Custom schedule: Scan WordPress inventory
Plugin recipes
wp.recipes
Runs the recipes that license and set up premium plugins on the site. Server API: POST /api/sites/:slug/wp/recipes/apply
WP-CLI command
wp.cli
Runs a WP-CLI command inside the site’s container and keeps its output in the job log. exec, one per server API: POST /api/sites/:slug/wp/cli
Custom schedule: WP-CLI command
REST API request
wp.rest
Sends a request to one of the site’s WordPress REST API routes (/wp-json/…), signed in with an application password when it has one, and keeps the response in the job log. Anything but a 2xx answer fails the job. exec, one per server API: POST /api/sites/:slug/wp/rest
Custom schedule: REST API request
Job What it does Lane Started by
Extract archive
files.extract
Unpacks an archive among the site’s files. Server API: POST /api/sites/:slug/files/extract
Compress files
files.compress
Packs files and folders of the site into a zip archive. Server API: POST /api/sites/:slug/files/compress
Job What it does Lane Started by
Add database
database.create
Creates another database for the site, for the site’s own database user, or a PHP site’s own database. Server API: POST /api/sites/:slug/database, POST /api/sites/:slug/databases
Delete database
database.delete
Drops one of the databases added to a site. Backups made before keep a copy of it. Server API: DELETE /api/sites/:slug/databases/:db
Change database password
database.password
Gives the site’s database user a new password. A WordPress site restarts with it. Server API: POST /api/sites/:slug/database-password
Import database
database.import
Backs the site up, then loads an uploaded SQL dump into one of its databases as the site’s own database user. Server API: POST /api/sites/:slug/databases/:db/import
Change table structure
database.alter
Creates, changes, empties or drops a table in one of the site’s databases, as the site’s own database user. Server API: POST /api/sites/:slug/databases/:db/query
Delete unused database
database.deleteUnused
Drops a database that no site uses from its server. Server API: DELETE /api/databases/:serverId/:name
Job What it does Lane Started by
Malware scan
site.malwareScan
Checks a site’s files against wordpress.org’s published checksums, then looks for known malware in what those cannot vouch for. Runs in a throwaway container with no network that can only read the site. scan, one per server API: POST /api/security/scans, POST /api/sites/:slug/security/findings/:id/put-back, POST /api/sites/:slug/security/scan
Built-in schedule: Malware scans
Another job: Finish import, Reinstall original
Plugin zip check
plugin.zipCheck
Unpacks a zip from the plugin catalog in a throwaway container with no network, records each file’s hash and scans the files for known malware. Sites that hold its files unchanged have them vouched for. scan, one per server API: POST /api/plugins/:id/check, POST /api/plugins/upload
Built-in schedule: Malware scans
Reinstall original
wp.reinstall
Downloads WordPress or a plugin again from wordpress.org, at the version the site has, over files a malware scan found changed. Then scans the site again. Server API: POST /api/sites/:slug/security/findings/:id/reinstall
Job What it does Lane Started by
Set up server
server.provision
Installs or updates the server’s stack: Docker services, Traefik, MariaDB and the mail relay. Server API: POST /api/servers, POST /api/servers/:id/update
Another job: Finish panel update
Sync plugin library
server.syncPlugins
Copies the panel’s plugin zips to the server, so sites on it can install them. Server API: POST /api/servers
Apply container limits
server.applySiteLimits
Brings every site container on the server to its CPU, memory and process limits - its own, or else those in Settings - and its caches to what Settings says, in place, without a restart. Lifting a CPU cap is the exception: those sites each get a “Recreate site container” job. Server API: PUT /api/settings, PUT /api/sites/:slug/limits
Built-in schedule: Container limits follow-up, Site network repair
Refresh site images
server.refreshSiteImages
Gives the server the newest site image of each PHP version: the published one, or a fresh build on a server that builds its own. Then each site on an older image gets a “Recreate site container” job. images, one per server Built-in schedule: PHP releases
Move backups
server.relocateBackups
Copies a server’s backups to a new location, verifies them, and points the server at it. Server API: POST /api/servers/:id/backups/relocate
Job What it does Lane Started by
Finish panel update
system.postUpdate
What a panel update leaves for the new version to do: bringing servers and sites up to what it expects. Shared queue API: POST /api/system/update/post-update
The panel itself
Nightly housekeeping
system.housekeeping
Prunes old backups, statistics, mail and API logs and finished jobs, applies offsite retention, removes Docker images nothing uses and trims the build cache, finishes moved sites whose DNS has settled and refreshes the vulnerability feed. housekeeping Built-in schedule: Nightly housekeeping