CLI

Servers and operations

Manage servers, backup workflows, mail, and instance configuration.

These operations require an authorized connection to a self-hosted installation. Provider and host permissions still apply in native mode.

Servers

synq server list
synq server check srv_123

Use the server reference to register connections, install components, set rate limits, and monitor a server. The Servers API also exposes container, Git credential, and tunnel operations. Start with the server guide for prerequisites.

Backups and restores

The workflow has four parts:

StepCommands
Configure and verify storagebackup destination
Choose a source, schedule, and retentionbackup policy
Inspect executions or prepare a restorebackup run
Inspect, apply, or cancel a prepared restorebackup restore
synq backup destination list
synq backup policy list --project proj_123
synq backup policy run policy_123
synq backup run list --project proj_123

Preparing a restore does not apply it. Inspect the returned restore session and confirmation requirements before using the apply command. See backups and restores.

Mail

Use mail commands to provision or adopt a server, manage domains and mailboxes, and inspect delivery health. The email guide covers DNS, relay configuration, and webmail. Mail commands currently require an HTTP context.

Installation settings and data

Use system commands for instance settings, onboarding, filesystem browsing, and data transfer. Settings have native SDK support; remaining setup and migration actions require HTTP.

For moving an installation, follow control-plane migration. For moving a workload, follow server-to-server migration.

Reverse proxy

The edge workflow covers setup, domains, and traffic rules. Its complete options are in the edge reference.

On this page