API Overview
WebXTerm provides a RESTful API for integrating with your applications and automating machine management. The API is served by two services:
Authentication API
Endpoints for user authentication, OTP verification, tenant selection, and token management. All auth routes live under /api/auth/.
Machines API
Endpoints for managing registered machines, access control, sessions, and executing commands.
Profile API
Endpoints for managing your user profile and API keys.
Sessions & Dashboard API
Endpoints for terminal sessions and dashboard statistics.
Community API
Endpoints for the built-in issue tracker — create issues, post fixes, and vote on solutions. Available in all editions.
Users & Roles API (Enterprise)
Endpoints for user management, role assignment, and listing. These endpoints are served by the vsay-auth service. Most write operations require companyadmin or superadmin role.
Groups API (Enterprise)
Endpoints for managing user groups and associating groups with machines. Groups allow you to organize users and control machine access in bulk. Available in Enterprise editions.
Admin API (Super Admin)
Endpoints for platform-level administration. All endpoints in this section require the super_admin role. They are served by the vsay-auth service under the /api/admin/ prefix.
Audit Logs API (Enterprise)
Endpoints for retrieving audit logs across the organization. Available to companyadmin and superadmin roles. Served by the vsay-auth service.