Skip to main content

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​

PathWhat 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.

APIWhat it covers
Termix coreHosts, credentials, users, roles, sharing, plugins, sync and settings.
ACME CertificatesGets the Termix HTTPS certificate from Let's Encrypt or any ACME provider and renews it for you.
AI AssistantAn AI assistant that reads your setup and proposes changes for you to approve.
AlertsOne inbox for every alert in Termix, with delivery to the mobile app, webhooks, ntfy, Discord and email.
AnsibleRun Ansible playbooks and ad-hoc commands from a control host, with an inventory made from your Termix hosts.
Audit ToolsSend the audit log to your SIEM and export it as CSV or NDJSON.
AutomationsRun steps on your hosts on a schedule or when something happens.
BackupsBack up folders, databases and Docker data on your hosts with restic, then browse, download and restore.
CertificatesSee, issue and renew TLS certificates on your hosts with certbot and acme.sh, and get an alert before they expire.
Classic LayoutThe classic Termix layout with an icon rail, sidebar, tab bar and dock.
Cloud ProvidersAdd hosts from AWS, Azure, Google Cloud, DigitalOcean, Hetzner and other clouds, and keep them in sync.
Credential ToolsGenerate SSH keys, check them and copy a public key to a host.
CronSee, add and run cron jobs on your hosts, with a schedule preview and the system cron files.
DatabasesBrowse and edit MySQL, MariaDB, PostgreSQL, SQL Server, SQLite, Redis and MongoDB databases on your hosts from one tab.
DNSManage DNS records and domains across Cloudflare, Route 53, Namecheap and other providers.
DockerManage Docker and Podman containers on your hosts over SSH, with logs, stats and a console.
File ManagerBrowse, edit and move files over SFTP, FTP, WebDAV and SMB, including straight from one server to another.
FirewallManage UFW, firewalld, nftables and iptables rules on your hosts over SSH, with lockout protection.
FleetsGroup hosts into fleets and run commands, package actions and file transfers on all of them at once.
GitSee, pull, commit and push git repos on your hosts, and keep them up to date with auto pull.
HomepageA drag and drop widget page for your servers and services, plus service links for the dashboard.
Host MetricsLive CPU, memory, disk, network and GPU stats, plus tools to manage your hosts.
Host StatusShows if each host is online with a dot in the host list, checked by connecting to its port.
Hosts ConfigKeep 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 ExportImport hosts from Termix, SSH config, Termius, MobaXterm, PuTTY, SecureCRT or mRemoteNG and export them to share or back up.
IP-KVMSee and control machines through PiKVM, NanoKVM and JetKVM devices.
KubernetesManage Kubernetes clusters from your hosts over SSH, with logs, metrics, YAML and a shell.
LDAPSign in with your LDAP or Active Directory username and password.
Log SearchSearch logs from the journal, log files and Docker containers across many hosts at once.
Login SecuritySign people out when idle, limit session length, turn off remember me and require a second factor at login.
Network DevicesSee and manage routers, switches and access points over SNMP and router APIs.
Network TopologyDraws your hosts and the links between them as a live, interactive graph.
NotesWrite markdown notes for each host, folder or yourself, with commands you can copy or send to the terminal.
Object StorageBrowse and manage S3-compatible object storage buckets and files.
Operations CenterRun, roll out, approve and track every plugin action across your hosts, with a page per host and tables across all of them.
OPKSSHConnect to hosts with short-lived OpenPubkey SSH certificates after signing in with your identity provider.
Out-of-bandPower, sensors, event logs and consoles for server BMCs over Redfish, IPMI and Intel AMT.
PackagesSee and install updates on your hosts, search, install and remove packages, and read the package history.
PasskeysSign in with a passkey or security key instead of a password.
Privileged AccessAsk for approval before anyone connects to a privileged host, with access that ends on its own and a full audit trail.
Process ManagerSee and control running processes, pm2 and supervisor apps on your hosts, read their logs and get alerts when they fail.
ProxmoxImport Proxmox VE guests as hosts, keep them in sync and watch node stats.
Remote DesktopRDP, VNC, Apple Remote Desktop, RustDesk and Telnet sessions in your browser, with clipboard, file transfer, sharing and recording.
Reverse ProxyReverse proxy for TCP, UDP, HTTP and HTTPS with free certificates and Termix login, managed per host.
Samba SharesCreate and manage Samba (SMB) file shares, users and permissions on your hosts from one tab.
SCIM ProvisioningCreate, update and remove Termix accounts and roles from your identity provider with SCIM.
Secret SourcesPull 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 CenterAudit SSH keys, rotate them and scan hosts for known vulnerabilities over SSH.
ServicesManage services, timers and logs on your hosts over SSH.
Session RecordingRecord terminal and remote desktop sessions, watch them live, and keep an audited, encrypted record of who did what.
Session SharingShare live sessions by link or with another user, and present sessions to a group in meeting rooms.
Single sign-onSign in with any OpenID Connect or SAML provider, GitHub or Google.
SnippetsSave the commands you run often and run them in a terminal or on many hosts in one click.
SSH Certificate SignerConnect to hosts with short-lived SSH certificates signed by HashiCorp Vault or OpenBao.
SSH TerminalSSH terminal sessions with tabs, split screen, history, macros and a local terminal in the desktop app.
Step CAConnect to hosts with short-lived SSH certificates from a smallstep step-ca server.
Storage HealthWatch drive and array health over SSH: SMART, NVMe, ZFS, mdadm, btrfs and LVM, with history, alerts and self tests.
SyncSync the desktop app with one or more servers, and manage other Termix servers as remote sites from a master.
TailscaleAdd tailnet devices as hosts and connect with Tailscale SSH.
Termix IdentityPublish your SSH public keys under a public handle and run your own SSH certificate authority.
Tmux MonitorBrowse and control tmux sessions, windows and panes across your hosts.
TOTPTwo-factor sign in with a code from an authenticator app, with backup codes.
TunnelsSSH port forwarding that reconnects on its own, WireGuard gateways that publish private services, and client tunnels from the desktop app.
UPS ManagerWatch your UPS devices over NUT, apcupsd or SNMP, with history, alerts and self tests.
UptimeWatch websites, ports, hosts and services, get alerts when they go down, and publish status pages.
Usage StatisticsSends a small anonymous daily report so we can see how Termix is used.
UsersManage the user accounts, groups, passwords and SSH keys on your hosts.
Virtual MachinesCreate and manage KVM virtual machines on your Linux hosts over SSH with libvirt.
Wake-on-LANWake, shut down and track your machines from one power dashboard.
Web EndpointOpen a host's web UI inside Termix, directly or over an SSH tunnel.
Web ServersManage nginx, Apache and Caddy on your hosts: sites, config, logs and HTTPS, with every change tested first.
WireGuardInstall WireGuard on your hosts and manage interfaces, clients and configs from one tab.
WorkspacesSave your open tabs and split layouts and reopen them in one click.