Skip to main content
Uptime
MonitoringSourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
Shortest check intervalnumber20In seconds. Monitors that log in over SSH never go below 60.
Default check intervalnumber60In seconds, for new monitors.
Keep history fornumber90Days of daily uptime numbers and incidents.
Allow public status pagesbooleantrueTurn off to hide every status page. Push URLs keep working.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the panel with each terminalbooleanfalseShow the uptime panel when a terminal opens.
Panel sideselect"right"Where the uptime panel opens.
Panel sizenumber360Width or height of the panel in pixels.
Show the edge buttonbooleantrueA button on the terminal edge that opens the panel.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
uptime.viewadmin, userSee monitors, history and incidents.
uptime.manageadmin, userAdd and change monitors and maintenance windows.
uptime.private-targetsadminPoint monitors at LAN, Tailscale and other private addresses the Termix server can reach.
uptime.run-commandsadminAdd monitors that run a command on a host over SSH.
uptime.publishadminMake status pages anyone with the link can see.

Actions​

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

ActionRuns onRiskInputs
uptime.summary
Uptime summary
The serverRead only
uptime.monitors
List monitors
The serverRead only
uptime.host-monitors
Monitors on this host
A hostRead only
uptime.host-health
Uptime
A hostRead only
uptime.run
Check a monitor now
The serverRead onlymonitor
uptime.pause
Pause a monitor
The serverChangesmonitor
uptime.resume
Resume a monitor
The serverChangesmonitor
uptime.add-host
Add an uptime monitor
A hostChanges

Events​

Automations can start when one of these happens.

EventWhat it means
uptime.monitor-downA monitor went down
uptime.monitor-upA monitor came back up
uptime.cert-expiringA certificate is about to end

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.
process:spawnHighRun programs on this machine. Programs run on the Termix server itself, not on your hosts.
db:core-refsHighRead core account tables. Can query users, roles and hosts directly from the database.
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.
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
network:probeMediumCheck if ports answer. Can open a plain connection to any address from the server, to see if it is reachable, and look up host names.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
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.
files:ownLowStore its own files. In its own folder on disk, 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.

Services​

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

ProvidesVersionPermission
uptime.access1.0.0uptime.view

API​

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

Platforms​

Linux, Windows, macOS