Skip to content

The Hoody Terminal service provides a unified interface for executing commands, managing persistent sessions, and monitoring system resources. Whether you need to run one-off commands in isolated containers, stream interactive shell sessions over WebSocket, or inspect process and network activity, the Terminal API exposes a consistent set of endpoints backed by the Hoody daemon.

Use this section when you need to:

  • Execute a command in a fresh or existing container and retrieve its output.
  • List, inspect, or terminate long-running terminal sessions.
  • Connect to a session interactively via WebSocket.
  • Query the web terminal UI and explore the auto-generated API documentation.
  • Monitor host resources such as CPU, memory, disk, processes, and listening ports.

The Terminal service is organized into the following sub-pages. Each page documents the operations, parameters, and response formats for that capability area.

Command Execution

Execute commands and retrieve results.

Run one-off or tracked commands inside containers, stream output, and poll for completion. Useful for automation, CI/CD pipelines, and scripted workflows.

Open Command Execution →

Session Management

List, inspect, connect via WebSocket, and manage sessions.

Enumerate active and historical terminal sessions, retrieve session metadata, attach a WebSocket client for real-time I/O, and terminate sessions that are no longer needed.

Open Session Management →

Web UI & API Access

Access web-based terminal and API docs.

Retrieve the URL of the built-in web terminal interface and the auto-generated OpenAPI/Swagger documentation for the daemon’s HTTP surface.

Open Web UI & API Access →

System Monitoring

Monitor resources, processes, and network ports.

Query host-level metrics including CPU, memory, and disk usage, list running processes, and inspect the set of listening network ports.

Open System Monitoring →