API
Everything the Termix app does goes through this HTTP API, so scripts can do it too. The CLI is built on it.
Sign in
Send an API key as a bearer token:
curl -H "Authorization: Bearer tmx_your_key" https://termix.example.com/host/db/host
A key acts as the user who made it, with their permissions.
Paths
| Path | What is there |
|---|---|
/host, /users, /rbac, /plugins, ... | Core routes. |
/plugin-api/<id>/... | A plugin's routes. Only there while the plugin is installed and on. A disabled plugin answers 503. |
/plugin-ws/<id>/... | A plugin's WebSockets. |
The APIs
Each plugin documents its own routes. These pages are made from the code of each release.
| API | What it covers |
|---|---|
| Termix core | Hosts, credentials, users, roles, sharing, plugins, sync and settings. |
| ACME Certificates | Gets the Termix HTTPS certificate from Let's Encrypt or any ACME provider and renews it for you. |
| AI Assistant | An AI assistant that reads your setup and proposes changes for you to approve. |
| Alerts | One inbox for every alert in Termix, with delivery to the mobile app, webhooks, ntfy, Discord and email. |
| Ansible | Run Ansible playbooks and ad-hoc commands from a control host, with an inventory made from your Termix hosts. |
| Audit Tools | Send the audit log to your SIEM and export it as CSV or NDJSON. |
| Automations | Run steps on your hosts on a schedule or when something happens. |
| Backups | Back up folders, databases and Docker data on your hosts with restic, then browse, download and restore. |
| Certificates | See, issue and renew TLS certificates on your hosts with certbot and acme.sh, and get an alert before they expire. |
| Classic Layout | The classic Termix layout with an icon rail, sidebar, tab bar and dock. |
| Cloud Providers | Add hosts from AWS, Azure, Google Cloud, DigitalOcean, Hetzner and other clouds, and keep them in sync. |
| Credential Tools | Generate SSH keys, check them and copy a public key to a host. |
| Cron | See, add and run cron jobs on your hosts, with a schedule preview and the system cron files. |
| Databases | Browse and edit MySQL, MariaDB, PostgreSQL, SQL Server, SQLite, Redis and MongoDB databases on your hosts from one tab. |
| DNS | Manage DNS records and domains across Cloudflare, Route 53, Namecheap and other providers. |
| Docker | Manage Docker and Podman containers on your hosts over SSH, with logs, stats and a console. |
| File Manager | Browse, edit and move files over SFTP, FTP, WebDAV and SMB, including straight from one server to another. |
| Firewall | Manage UFW, firewalld, nftables and iptables rules on your hosts over SSH, with lockout protection. |
| Fleets | Group hosts into fleets and run commands, package actions and file transfers on all of them at once. |
| Git | See, pull, commit and push git repos on your hosts, and keep them up to date with auto pull. |
| Homepage | A drag and drop widget page for your servers and services, plus service links for the dashboard. |
| Host Metrics | Live CPU, memory, disk, network and GPU stats, plus tools to manage your hosts. |
| Host Status | Shows if each host is online with a dot in the host list, checked by connecting to its port. |
| Hosts Config | Keep hosts, folders and sharing in a YAML or JSON file. Termix loads them as read only hosts and reloads when the file changes. |
| Import and Export | Import hosts from Termix, SSH config, Termius, MobaXterm, PuTTY, SecureCRT or mRemoteNG and export them to share or back up. |
| IP-KVM | See and control machines through PiKVM, NanoKVM and JetKVM devices. |
| Kubernetes | Manage Kubernetes clusters from your hosts over SSH, with logs, metrics, YAML and a shell. |
| LDAP | Sign in with your LDAP or Active Directory username and password. |
| Log Search | Search logs from the journal, log files and Docker containers across many hosts at once. |
| Login Security | Sign people out when idle, limit session length, turn off remember me and require a second factor at login. |
| Network Devices | See and manage routers, switches and access points over SNMP and router APIs. |
| Network Topology | Draws your hosts and the links between them as a live, interactive graph. |
| Notes | Write markdown notes for each host, folder or yourself, with commands you can copy or send to the terminal. |
| Object Storage | Browse and manage S3-compatible object storage buckets and files. |
| Operations Center | Run, roll out, approve and track every plugin action across your hosts, with a page per host and tables across all of them. |
| OPKSSH | Connect to hosts with short-lived OpenPubkey SSH certificates after signing in with your identity provider. |
| Out-of-band | Power, sensors, event logs and consoles for server BMCs over Redfish, IPMI and Intel AMT. |
| Packages | See and install updates on your hosts, search, install and remove packages, and read the package history. |
| Passkeys | Sign in with a passkey or security key instead of a password. |
| Privileged Access | Ask for approval before anyone connects to a privileged host, with access that ends on its own and a full audit trail. |
| Process Manager | See and control running processes, pm2 and supervisor apps on your hosts, read their logs and get alerts when they fail. |
| Proxmox | Import Proxmox VE guests as hosts, keep them in sync and watch node stats. |
| Remote Desktop | RDP, VNC, Apple Remote Desktop, RustDesk and Telnet sessions in your browser, with clipboard, file transfer, sharing and recording. |
| Reverse Proxy | Reverse proxy for TCP, UDP, HTTP and HTTPS with free certificates and Termix login, managed per host. |
| Samba Shares | Create and manage Samba (SMB) file shares, users and permissions on your hosts from one tab. |
| SCIM Provisioning | Create, update and remove Termix accounts and roles from your identity provider with SCIM. |
| Secret Sources | Pull host passwords and keys from 1Password, Bitwarden, Infisical, HashiCorp Vault, KeePass, AWS, Azure or Google Cloud when you connect instead of storing them in Termix. |
| Security Center | Audit SSH keys, rotate them and scan hosts for known vulnerabilities over SSH. |
| Services | Manage services, timers and logs on your hosts over SSH. |
| Session Recording | Record terminal and remote desktop sessions, watch them live, and keep an audited, encrypted record of who did what. |
| Session Sharing | Share live sessions by link or with another user, and present sessions to a group in meeting rooms. |
| Single sign-on | Sign in with any OpenID Connect or SAML provider, GitHub or Google. |
| Snippets | Save the commands you run often and run them in a terminal or on many hosts in one click. |
| SSH Certificate Signer | Connect to hosts with short-lived SSH certificates signed by HashiCorp Vault or OpenBao. |
| SSH Terminal | SSH terminal sessions with tabs, split screen, history, macros and a local terminal in the desktop app. |
| Step CA | Connect to hosts with short-lived SSH certificates from a smallstep step-ca server. |
| Storage Health | Watch drive and array health over SSH: SMART, NVMe, ZFS, mdadm, btrfs and LVM, with history, alerts and self tests. |
| Sync | Sync the desktop app with one or more servers, and manage other Termix servers as remote sites from a master. |
| Tailscale | Add tailnet devices as hosts and connect with Tailscale SSH. |
| Termix Identity | Publish your SSH public keys under a public handle and run your own SSH certificate authority. |
| Tmux Monitor | Browse and control tmux sessions, windows and panes across your hosts. |
| TOTP | Two-factor sign in with a code from an authenticator app, with backup codes. |
| Tunnels | SSH port forwarding that reconnects on its own, WireGuard gateways that publish private services, and client tunnels from the desktop app. |
| UPS Manager | Watch your UPS devices over NUT, apcupsd or SNMP, with history, alerts and self tests. |
| Uptime | Watch websites, ports, hosts and services, get alerts when they go down, and publish status pages. |
| Usage Statistics | Sends a small anonymous daily report so we can see how Termix is used. |
| Users | Manage the user accounts, groups, passwords and SSH keys on your hosts. |
| Virtual Machines | Create and manage KVM virtual machines on your Linux hosts over SSH with libvirt. |
| Wake-on-LAN | Wake, shut down and track your machines from one power dashboard. |
| Web Endpoint | Open a host's web UI inside Termix, directly or over an SSH tunnel. |
| Web Servers | Manage nginx, Apache and Caddy on your hosts: sites, config, logs and HTTPS, with every change tested first. |
| WireGuard | Install WireGuard on your hosts and manage interfaces, clients and configs from one tab. |
| Workspaces | Save your open tabs and split layouts and reopen them in one click. |