Skip to main content
Backups
InfrastructureSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the backups panel with new terminalsbooleanfalseShow the backups panel beside every SSH terminal that has it turned on. You can still open and close it from the button on the right edge.
Backups panel sideselect"right"Where the backups panel sits next to a terminal.
Backups panel sizenumber380Width in pixels, or height when it is at the bottom. You can also drag its edge.
Show the panel buttonbooleantrueShow a small button on the right edge of a terminal that opens the backups panel.

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
Show backups panel in terminalsbooleanfalseLet the backups panel open beside this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
backups.useadmin, userSet up backup jobs and repositories, run backups, and browse, download and restore snapshots on hosts they can edit.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
backups.list-jobs
List backup jobs
A hostRead only
backups.failed
Failed backups
A hostRead only
backups.run-job
Run backup
One item on a hostChanges
backups.cancel-run
Stop backup
One item on a hostChanges
backups.list-snapshots
List snapshots
One item on a hostRead only

Events​

Automations can start when one of these happens.

EventWhat it means
backups.run-finishedBackup finished
backups.run-failedBackup failed

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Works with other plugins​

Works better with: databases ^1.2.0.

Services​

Services are how plugins call each other. Plugin authors can use these.

UsesVersionOptional
databases.logins^1.0.0yes
storage-health.access^1.0.0yes

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS