Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cyberdesk.io/llms.txt

Use this file to discover all available pages before exploring further.

Keepalive helps prevent idle locks and session timeouts while a machine is connected but not actively receiving work.

​
How it works in Cyberdriver 1.x

Cyberdriver tracks the last request received from Cyberdesk. If the machine is idle for the configured threshold, Cyberdriver performs a tiny cursor nudge and restores the cursor position. This is intentionally less disruptive than the legacy Python agent’s click-and-type keepalive behavior.

​
Enable or disable keepalive

Open Cyberdriver → Settings → Network and toggle Cyberdesk keepalive. Keepalive is enabled by default unless disabled locally.

​
Remote Keepalive (Host + VM)

When automating a Windows VM managed by remote desktop software (RDP, Avatara, AnyDesk, and similar tools), the VM often locks or shuts off after inactivity. Because that idle timer is enforced by the remote desktop layer, running keepalive inside the VM may not help. Remote Keepalive solves this by running a second Cyberdriver on the host where the remote desktop software runs. The host Cyberdriver keeps the VM session active while the main Cyberdriver inside the VM is idle. This matters because it keeps the VM ready for work without repeatedly passing 2FA every time you want to run a workflow.

​
Quick setup

  1. Install and connect Cyberdriver inside the VM as usual.
  2. Copy the VM’s Cyberdesk machine ID from the Cyberdesk dashboard.
  3. Install Cyberdriver on the host machine.
  4. Open Cyberdriver → Settings → Network on the host.
  5. Enter the VM’s machine ID in Remote keepalive for.
  6. Click Save and make sure Cyberdesk keepalive is enabled.
You can also configure the host from the CLI: 
cyberdriver join --secret YOUR_API_KEY --keepalive --register-as-keepalive-for <MAIN_MACHINE_ID>

​
What happens under the hood

  • The host Cyberdriver links itself to your VM’s Cyberdriver.
  • Cyberdesk enforces that both machines belong to the same organization.
  • Self-links are rejected.
  • The host Cyberdriver will not interfere while a workflow runs on the VM.
  • Remote activity resets the linked host keepalive machine’s idle timer with a small random jitter around the keepalive threshold.
  • If the host Cyberdriver disconnects, the link is removed automatically. When it reconnects, the link is re-established.

​
API coordination

Cyberdesk coordinates remote keepalive internally through Cyberdriver’s tunnel endpoints. You normally do not need to call these directly. Any /computer/* request also refreshes activity automatically.

​
When to use it

Use keepalive for:
  • long-running workflows
  • hosted Windows desktops that lock quickly
  • machines where remote desktop software enforces inactivity timers
Keepalive is not a substitute for a healthy display/session. For RDP-related display loss, see Display reliability.