The stackregent.exe command line

Where stackregent.exe is and how to run it#

stackregent.exe is in the bin folder of the installation, normally:

C:\Program Files\StackRegent\bin\stackregent.exe

Run it in a command prompt or PowerShell opened with Run as administrator on the server. The folder is not on the PATH, so change into it or call it by full path:

cd 'C:\Program Files\StackRegent\bin'
.\stackregent version

Most commands read the panel configuration from the installation folder and open the panel database directly, so they work even when the web service is stopped. The exceptions are api, which talks to the running panel over HTTPS, and the task commands (website-apply, run-task, site-run), which need the StackRegentTask service to run the task.

Exit codes#

stackregent.exe command line reference#

api: call the REST API on the server#

stackregent api GET /api/subscriptions
stackregent api GET "/api/subscriptions?q=example.com"
stackregent api POST /api/subscriptions/12/status '{"status":"suspended"}'
stackregent api PUT /api/subscriptions/12/plan @plan.json
stackregent api DELETE /api/domains/31

The method is GET, POST, PUT or DELETE, and the path must start with /api/. For POST and PUT, add the JSON body as the third argument, or @file.json to read it from a file. Use a file from Windows PowerShell 5.1, which mangles quotes inside arguments passed to programs; a byte order mark at the start of the file is ignored.

For each call, the command creates a key for the main administrator that works only from 127.0.0.1 and ::1, lasts one minute and is deleted after the call. It connects to https://127.0.0.1 on the panel's configured HTTPS port, so it keeps working after panel-port and with a self-signed certificate. JSON answers are printed indented, and a call may take up to 10 minutes. The endpoints and fields are the same as over the network; see the REST API reference.

admin-password: reset an administrator's password#

stackregent admin-password
stackregent admin-password -login support1

Without -login, it resets admin. It prints the new password, turns off two-step sign-in for that administrator, closes their sessions and clears their failed-login counter. Turn two-step sign-in on again under Profile after logging in.

admin-add and admin-remove#

stackregent admin-add support1
stackregent admin-remove support1

admin-add creates a support administrator with a random 16-character password and prints it once. The login is stored in lower case and must not exist already. admin-remove deletes the administrator and their sessions; the main administrator cannot be removed.

Recovery after a lockout#

These undo a lockout without a browser:

• sessions-purge closes every panel session and prints how many were closed.
• ip-access-reset removes the administrator IP access restriction after it locks you out.
• firewall-reset turns off Panic Mode and access limits and disables your own firewall rules.
• panel-url-reset clears Customize Panel URL, so the panel answers on every host name again.

panel-port: move the panel to other ports#

stackregent panel-port 8443
stackregent panel-port 8443 8080

Both ports must be between 1024 and 65535, different from each other, and not one of the ports used by websites (80, 443), website preview (9444), FTP (21), mail (25), DNS (53), MariaDB (3306), SQL Server (1433) or the panel database. The command checks that the ports are free, saves them, replaces the StackRegent panel rules in Windows Firewall and restarts the panel service. Without the second argument the HTTP port stays as it is. Open the new port in any provider firewall too, and update the port in a custom panel URL if you use one.

license-set and license-check#

stackregent license-set SR-XXXXX-XXXXX-XXXXX-XXXXX

$env:STACKREGENT_LICENSE_KEY = 'SR-XXXXX-XXXXX-XXXXX-XXXXX'
stackregent license-set
Remove-Item Env:STACKREGENT_LICENSE_KEY

stackregent license-check

license-set saves the key and checks it with the license server at once. If you leave out the argument, the key is read from STACKREGENT_LICENSE_KEY, which keeps it out of command histories and transcripts; the installer uses it that way. license-check checks the saved key again. Both print a line such as Licence: licensed. ..., where the state is licensed, grace or restricted, followed by the license server's message. They wait up to 30 seconds for the license server.

website-apply: apply a website's settings again#

stackregent website-apply example.com

Queues the task that writes one website's IIS and hosting settings again, waits up to five minutes, and prints the task log followed by success or failure. Use it after something was changed by hand in IIS Manager, or to see exactly where a website's configuration fails.

run-task: queue a panel task#

stackregent run-task update.check
stackregent run-task component.install @component.json

Queues a task of the given kind with optional JSON parameters (inline or from @file), waits up to 10 minutes and prints the log followed by success or failure. The installer uses it to set up hosting components, with a file such as:

{"id":"git","key":""}

Component IDs are listed under Tools & Settings › Server Components and on the install script page. Other task kinds take parameters that are internal to the panel; prefer the REST API for anything it covers.

site-run: run a program as the subscription user#

stackregent site-run 31 whoami

ID is the domain's ID (from GET /api/domains). The task service runs the program as the Windows user of that website's subscription, so it sees exactly the permissions the website has. The output and success or failure are printed; the command waits up to 15 minutes.

dkim-verify: check a message's DKIM signatures#

stackregent dkim-verify C:\temp\message.eml
stackregent dkim-verify C:\temp\message.eml 1.1.1.1

Checks the DKIM signatures in a saved message, looking up the public keys in DNS, optionally through the DNS server you name.

defender-exclude#

Adds Microsoft Defender exclusions for the panel's database folders and prints the result. Run it again if a policy removed them.

Migration agent options#

migration-agent runs on a Plesk for Windows server, from a copy of stackregent.exe taken from the bin folder of the StackRegent package, so that a StackRegent server can migrate accounts from it over HTTPS.

stackregent migration-agent --allow 203.0.113.50
stackregent migration-agent --allow 203.0.113.50,198.51.100.0/24 --port 9445 --key MY-FIXED-KEY

The agent uses a self-signed certificate and prints its SHA-256 fingerprint, so you can compare it when the new server connects. It runs until you press Ctrl+C. The Plesk extension controls its background agent with migration-agent-ctl. See the migration chapter of the administrator guide.

Commands used by the installer and the services#

These exist for the installer, the Windows services and support. You normally do not run them yourself; to repair or upgrade an installation, run the installer again.

setup options#

setup writes the configuration, creates the panel database schema and, on the first run only, creates the admin account and prints ADMIN_LOGIN=admin and ADMIN_PASSWORD=.... On later runs it leaves the password alone.

Use the install script rather than calling setup yourself; the script also prepares the database, services and firewall.