The Termix REST API exposes every resource the platform manages — users, SSH hosts, credentials, tunnels, files, Docker containers, server stats, and more. All requests and responses use JSON. The API is versioned through Termix releases; the current specification targets OpenAPI 3.0.3.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Termix-SSH/Termix/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
Termix runs several internal services on separate ports, but all of them are reverse-proxied through the single main port you expose when deploying. You never need to call the internal ports directly.your-server:8080 with the actual host and port where Termix is running.
The internal service ports (30001 for auth, 30003 for tunnels, 30004 for file manager, 30005 for server stats, 30006 for dashboard, 30007 for Docker) are implementation details. Always use the main proxy port —
8080 by default — in your API requests.Authentication
Every protected endpoint requires anAuthorization: Bearer header containing either a JWT obtained from POST /users/login or a long-lived API key created in the admin panel. See the Authentication page for full details.
Response format
All responses are JSON objects. Successful responses return the requested data directly. Errors return an object with anerror field and, when available, a details field.
API resources
Users
User management, authentication, OIDC, TOTP, sessions, and API keys.
SSH Hosts
Add, update, and remove SSH host connections.
Credentials
Manage reusable SSH credentials shared across hosts.
SSH Tunnels
Start, stop, and inspect local, remote, and SOCKS5 tunnels.
File Manager
Browse, upload, download, and manage remote files over SSH.
Docker
List containers, start and stop them, and stream logs.
Server Stats
Retrieve CPU, memory, disk, and network metrics for monitored hosts.
Snippets
Create and manage reusable command snippets.
RBAC
Role-based access control for sharing hosts and credentials between users.
Internal service routing
The table below shows which internal service handles each resource group. This is useful if you are deploying Termix behind your own reverse proxy and need to route traffic yourself.| Resource group | Internal port | Description |
|---|---|---|
| Users, Credentials, Hosts, Snippets, RBAC | 30001 | Main database and authentication server |
| SSH Tunnels | 30003 | Tunnel connection management |
| File Manager | 30004 | SSH file operations |
| Server Stats | 30005 | Metrics collection and monitoring |
| Dashboard | 30006 | Dashboard statistics and activity |
| Docker | 30007 | Docker container management |