Checks whether the Termix backend is up and responding.

Returns the Termix instance's local version. Does not contact GitHub for update checks.

Lists recent Termix releases from GitHub, as seen by the Termix backend.

Check if setup is required. Checks if the system requires initial setup (i.e., no users exist).

Get autostart status. Retrieves the autostart status for the user's SSH configurations.

Get command history. Retrieves the command history for a specific host.

Get all SSH hosts. Retrieves all SSH hosts for the authenticated user.

Get SSH host by ID. Retrieves a specific SSH host by its ID.

Get pinned files. Retrieves a list of pinned files for a specific host.

Get recent files. Retrieves a list of recent files for a specific host.

Get shortcuts. Retrieves a list of shortcuts for a specific host.

Get all folders. Retrieves all folders for the authenticated user.

Get OPKSSH token status for a host

Bulk update partial fields on multiple SSH hosts

Enable autostart for SSH configuration. Enables autostart for a specific SSH configuration.

Bulk import SSH hosts. Bulk imports multiple SSH hosts.

Create SSH host. Creates a new SSH host configuration.

Test proxy connectivity. Tests connectivity through a proxy configuration to a target host.

Enroll a host with an API key. Creates a host owned by the user assigned to the API key. The user's encrypted data must be unlocked by an active sign-in.

Add pinned file. Adds a file to the list of pinned files for a host.

Add recent file. Adds a file to the list of recent files for a host.

Add shortcut. Adds a shortcut for a specific host.

Create a temporary SSH connection without saving to database. Returns a temporary host configuration for immediate use

Import hosts from an OpenSSH config file. Parses an OpenSSH ~/.ssh/config file and imports the defined hosts.

Update SSH host. Updates an existing SSH host configuration. IMPORTANT: this replaces the host's configuration, it does not merge. Any field you omit is reset to its default - including username, password/key, and every enableX toggle. Call termix_hosts_get_ssh_host_id first and resend its fields alongside the ones you're changing.

Update folder metadata. Updates the metadata (color, icon, assigned credential) of a folder.

Rename folder. Renames a folder for SSH hosts and credentials.

Reorder folders. Sets a manual sortOrder for multiple sibling folders, used by drag-to-reorder in the sidebar's manual sort mode. Folders with no existing metadata row are created.

Reorder hosts. Sets a manual sortOrder for multiple hosts within the same folder, used by drag-to-reorder in the sidebar's manual sort mode.

Get all credentials. Retrieves all SSH credentials for the authenticated user.

Get a specific credential. Retrieves a specific credential by its ID, including secrets.

Get hosts using a credential. Retrieves a list of hosts that are using a specific credential.

Get credential folders. Retrieves all unique credential folders for the authenticated user.

Create a new credential. Creates a new SSH credential for the authenticated user.

Apply a credential to a host. Applies a credential to an SSH host for quick application.

Deploy SSH key to a host. Deploys an SSH public key to a target host's authorized_keys file.

Duplicate a credential. Creates a new credential from an existing one, optionally overriding fields (e.g. password), leaving the original credential untouched.

Detect SSH key type. Detects the type of an SSH private key.

Detect SSH public key type. Detects the type of an SSH public key.

Generate public key from private key. Generates a public key from a given private key.

Validate SSH key pair. Validates if a given SSH private key and public key match.

Update a credential. Updates a specific credential by its ID.

Rename a credential folder. Renames a credential folder for the authenticated user.

Reorder credentials. Sets a manual sortOrder for multiple credentials within the same folder, used by drag-to-reorder in the sidebar's manual sort mode.

Get all snippets. Retrieves all snippets for the authenticated user.

Get a specific snippet. Retrieves a specific snippet by its ID.

Export all snippets and folders as JSON. Returns all snippets and snippet folders for the authenticated user as a JSON export.

Get all snippet folders. Retrieves all snippet folders for the authenticated user.

Create a new snippet. Creates a new snippet for the authenticated user.

Bulk import snippets and folders from JSON. Imports snippets and folders. Existing folders are skipped; existing snippets (matched by name+folder) can be skipped or overwritten.

Execute a snippet on a host. Executes a snippet on a specified host.

Create a new snippet folder. Creates a new snippet folder for the authenticated user.

Update a snippet. Updates a specific snippet by its ID.

Update snippet folder metadata. Updates the metadata (color, icon) of a snippet folder.

Rename a snippet folder. Renames a snippet folder for the authenticated user.

Reorder snippets. Bulk updates the order and folder of snippets. Accepts snippets and the legacy updates payload key.

List the current user's fleets

Read the last-known inventory snapshot for a fleet's members. No live connection - reads back whatever the most recent POST refresh stored. Latest-only per host, no history.

List the resolved effective members of a fleet. Returns the union of statically-added hosts and hosts matched by the fleet's tag rules, each annotated with the caller's permission level on that host.

Update a fleet

Create a fleet

Run a command across every host in a fleet. Fans out concurrently to every effective member host the caller has edit-level access to. $HOST/$USER/$PORT/$NAME/$INPUT_n substitution is applied per host, same grammar as snippet execution. One host failing does not stop the others.

Refresh the inventory snapshot for every host in a fleet. Connects to every effective member host the caller has view-level access to, collects OS/kernel/arch/hostname/uptime, and overwrites the stored latest-only snapshot per host.

Add a host to a fleet's static membership

Run a package action across every host in a fleet. Auto-detects each host's package manager (apt/dnf/yum/pacman) and runs install/remove/upgrade-all, elevating with the host's stored sudo password. Requires manage-level access per host.

Share a fleet's current member hosts with users or roles. Snapshot at share time - grants hostAccess for every current member host to each target. Hosts added to the fleet later are not automatically shared; re-run this route to extend sharing to new members.

Pull the same remote path from every host in a fleet. Fans out concurrently to every effective member host the caller has edit-level access to, reads remotePath via SFTP from each, and returns a single zip archive with one entry per successful host (/). Single file only (v1).

Push an uploaded file to the same remote path on every host in a fleet. Fans out concurrently to every effective member host the caller has edit-level access to. Single file only (v1) - the file is buffered once server-side and written to each host via SFTP.

Get global monitoring defaults

Get metrics history retention setting

List processes (rich, sortable, filterable client-side)

List systemd services

Get Tailscale status and IPs

Get WireGuard interfaces and peers

Detect available management tooling on a host

Get the Host Metrics layout for a host. Returns the current user's saved card layout for the host, or a default layout derived from the host's enabled widgets when none is saved.

Get host metrics. Retrieves current metrics for a specific host including CPU, memory, disk, network, processes, and system information.

Get historical metrics for a host

Get all host statuses. Retrieves the status of all hosts for the authenticated user.

Get host status by ID. Retrieves the status of a specific host by its ID.

Update global monitoring defaults

Update metrics history retention setting

Stop polling for deleted host. Stops polling for a specific host after it has been deleted.

Send a signal to a process (TERM/KILL/HUP/INT)

Start/stop/restart/enable/disable a systemd service

Connect or disconnect Tailscale

Bring a WireGuard interface up or down

Save the Host Metrics layout for a host. Persists the current user's card layout for the host and keeps statsConfig.enabledWidgets in sync (for hosts the user owns) so the mobile app keeps working.

Start polling for updated host. Starts polling for a specific host after it has been updated.

Complete TOTP verification for metrics. Verifies the TOTP code and completes the metrics SSH connection.

Update viewer heartbeat. Updates the heartbeat timestamp for a metrics viewer session to keep it alive.

Register metrics viewer. Registers a new viewer session for a host to track who is viewing metrics.

Start metrics collection. Establishes an SSH connection and starts collecting metrics for a specific host.

Stop metrics collection. Stops metrics collection for a specific host and cleans up the SSH session.

Unregister metrics viewer. Unregisters a viewer session when they stop viewing metrics for a host.

Refresh polling. Refreshes host polling for the authenticated user.

List all containers. Lists all Docker containers on the host.

Get container details. Retrieves detailed information about a specific container.

Get container logs. Retrieves logs for a specific container.

Get container stats. Retrieves stats for a specific container.

Check SSH session status. Checks the status of an active SSH session.

Validate Docker availability. Validates if Docker is available on the host.

Pause container. Pauses a specific container.

Restart container. Restarts a specific container.

Start container. Starts a specific container.

Stop container. Stops a specific container.

Unpause container. Unpauses a specific container.

Establish SSH session for Docker. Establishes an SSH session to a host for Docker operations.

Verify TOTP and complete connection. Verifies the TOTP code and completes the SSH connection.

Complete Warpgate authentication. Submits empty response to complete Warpgate authentication after user completes browser auth.

Disconnect SSH session. Closes an active SSH session for Docker operations.

Keep SSH session alive. Keeps an active SSH session alive.

Identify symbolic link. Identifies the target of a symbolic link.

List files in a directory. Lists the files and directories in a given path on the remote host.

Read a file. Reads the content of a file from the remote host.

Resolve a path with environment variables. Expands environment variables and ~ in a path via the SSH session.

Get SSH connection status. Checks the status of an SSH connection for file manager.

Change file permissions. Changes the permissions of a file on the remote host.

Compress files. Compresses files and/or directories on the remote host.

Connect to SSH for file management. Establishes an SSH/SFTP connection for file manager operations. Supports password, key-based, and keyboard-interactive authentication, as well as jump hosts and SOCKS5 proxies.

Verify TOTP and complete connection. Verifies the TOTP code and completes the SSH connection for file manager.

Complete Warpgate authentication. Submits empty response to complete Warpgate authentication after user completes browser auth.

Copy a file or directory. Copies a file or directory on the remote host.

Create a file. Creates an empty file on the remote host.

Create a folder. Creates a new folder on the remote host.

Disconnect from SSH. Closes an active SSH connection for file manager.

Download a file. Downloads a file from the remote host. Uses SCP legacy mode (cat over exec) when the host has scpLegacy enabled, otherwise uses SFTP.

Stream-download a file. Downloads a file as a binary stream. Uses SCP legacy mode (cat over exec) when the host has scpLegacy enabled, otherwise uses SFTP.

Execute a file. Executes a file on the remote host.

Extract archive file. Extracts an archive file (.tar, .tar.gz, .tgz, .zip, .tar.bz2, .tbz2, .tar.xz, .txz) to a specified or default location on the remote host.

Keep SSH session alive. Keeps an active SSH session for file manager alive.

Upload a file. Uploads a file to the remote host.

Upload one raw file chunk. Writes a raw request body to the remote file at the supplied byte offset, allowing browser clients to avoid multipart/FormData 2GB limits.

Stream-upload a file via multipart form. Uploads a file to the remote host by streaming multipart form data directly into an SFTP write stream, avoiding full in-memory buffering.

Write to a file. Writes content to a file on the remote host and preserves the existing permissions when the file already exists.

Set sudo password for session. Stores sudo password temporarily in session for elevated operations.

Move a file or directory. Moves a file or directory on the remote host.

Rename a file or directory. Renames a file or directory on the remote host.

List client tunnel presets. Returns the authenticated user's saved client-to-server tunnel presets.

Get all tunnel statuses. Retrieves the status of all SSH tunnels.

Get tunnel status by name. Retrieves the status of a specific SSH tunnel by its name.

Create a client tunnel preset. Saves a named client-to-server tunnel configuration for the authenticated user.

Cancel tunnel retry. Cancels the retry mechanism for a failed SSH tunnel connection.

Connect SSH tunnel. Establishes an SSH tunnel connection with the specified configuration.

Disconnect SSH tunnel. Disconnects an active SSH tunnel.

Update a client tunnel preset. Updates the name or config of one of the authenticated user's tunnel presets.

List the current user's automations. Returns every automation the caller owns, with its parsed definition and linked notification channels.

Fetch a single automation

List automation runs

Step-by-step results for a run

Create an automation. Validates the trigger and every step before storing the definition. A schedule trigger also registers its next due time.

Run an automation now. Runs immediately, as the automation's owner. Pass dryRun to record what each step would do without touching anything outside Termix.

Trigger an automation from an external system. Unauthenticated by design; the 32-byte token in the path is the credential and is compared against a stored hash in constant time.

Update an automation

List alert firings for the current user

List alert rules for the current user

Get active alerts. Fetches active alerts for the authenticated user, excluding those that have been dismissed.

Get dismissed alerts. Fetches a list of alerts that have been dismissed by the authenticated user.

List notification channels for the current user

Acknowledge an alert firing

Acknowledge all alert firings for the current user

Create an alert rule

Dismiss an alert. Marks an alert as dismissed for the authenticated user.

Create a notification channel

Send a test notification

Update an alert rule

Update a notification channel

List audit logs. Returns paginated, filterable audit log entries. Admin only.

List distinct audit log action types. Returns all distinct action values in the audit log for filter dropdowns. Admin only.

Export audit logs. Streams the full filtered result set as CSV or NDJSON. Accepts the same filters as GET /audit-logs. Admin only. The export is itself audited.

List session logs. Returns all terminal session recordings for the authenticated user.

Get session log metadata. Returns metadata for a single session recording.

Get session log content. Returns the raw text content of a session log file.

Get cached Proxmox node stats for a host. Returns the most recently polled Proxmox Stats snapshot for a host, or an empty skeleton if none has been collected yet.

Get historical Proxmox node stats for a host

Start Proxmox stats collection. Registers a viewer and starts (or reuses) polling for a host's Proxmox node stats.

Stop Proxmox stats collection. Unregisters a viewer session for a host's Proxmox node stats polling.

Discover Proxmox guests on a node. Connects to an existing SSH host (a Proxmox node) using its stored credentials, runs pvesh to enumerate all guests (VMs and LXC containers) in the cluster, and returns them ready to be imported as Termix hosts. No separate Proxmox API token is required.

List Tailscale devices. Returns the list of devices in the configured tailnet using the stored API key.

Get command history. Retrieves the command history for a specific host.

Get session persistence settings. Returns the session timeout and persistence enabled flag.

Save command to history. Saves a command to the command history for a specific host.

Delete a specific command from history. Deletes a specific command from the history of a host.

Update session persistence settings. Saves session timeout and persistence enabled flag.