API Reference

⚠️ The public API is still under development and subject to change.

IPC Interface

WSL Dashboard exposes a local IPC socket for integration with scripts and third-party tools.

Connection

Connect to the Unix domain socket at:

\\.\pipe\wsl-dashboard

Commands

list_distributions

Returns a list of all installed WSL distributions.

Request:

{ "cmd": "list_distributions" }

Response:

{
  "distributions": [
    { "name": "Ubuntu-22.04", "state": "Running", "version": 2 },
    { "name": "Debian", "state": "Stopped", "version": 2 }
  ]
}

start_distribution

Starts a stopped distribution.

Request:

{ "cmd": "start_distribution", "name": "Ubuntu-22.04" }

Response:

{ "success": true }

stop_distribution

Stops a running distribution.

Request:

{ "cmd": "stop_distribution", "name": "Ubuntu-22.04" }

Response:

{ "success": true }