Skip to content

Terminal/Shell

Command-line access, native or in-browser. See How users connect for native vs browser, and the Payload reference for every field.

SSH

Native and browser. See the SSH reference, credentials, and command filtering.

ssh.json
{
  "transaction_id": "txn-ssh-001",
  "protocol": "ssh",
  "username": "alice@corp",
  "target_host": "10.0.4.21",
  "target_port": 22,
  "target_username": "ec2-user",
  "private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----",
  "user_public_key": "ssh-ed25519 AAAAC3Nz... alice",
  "record_session": true,
  "allowed_commands": ["ls", "cat", "grep"],
  "blocked_patterns": ["rm\\s+-rf"],
  "expires_at": 1750000000
}
terminal
broker-bridge-api.sh checkout-create --file ssh.json
  • Native - ssh (or PuTTY, an IDE terminal) at the Bridge’s SSH port (default 22).
  • Browser - an in-page terminal via Connect / /connect?transaction_id=txn-ssh-001.

Telnet

Native and browser. For legacy equipment; see the Telnet reference.

telnet.json
{
  "transaction_id": "txn-telnet-010",
  "protocol": "telnet",
  "username": "alice@corp",
  "target_host": "10.0.9.30",
  "target_port": 23,
  "target_username": "operator",
  "record_session": true,
  "expires_at": 1750000000
}
terminal
broker-bridge-api.sh checkout-create --file telnet.json
  • Native - a telnet client at the Bridge’s Telnet port (default 23).
  • Browser - an in-page terminal via Connect.

WinRM

Native and browser; see the WinRM reference. Output redaction can be forced on/off per checkout with redact_response_bodies.

winrm.json
{
  "transaction_id": "txn-winrm-013",
  "protocol": "winrm",
  "username": "grace@corp",
  "target_host": "win-app.corp.local",
  "target_port": 5986,
  "target_username": "Administrator",
  "target_password": "S3cr3t!",
  "blocked_commands": ["Remove-Item"],
  "redact_response_bodies": true,
  "record_session": true,
  "expires_at": 1750000000
}
terminal
broker-bridge-api.sh checkout-create --file winrm.json
  • Native - a WS-Man client at the Bridge’s WinRM port (default 5986).
  • Browser - an in-page command session via Connect.
Last updated on