Web Dashboard & REST API

WGS includes a built-in HTTP server — accessible from any browser or script. Monitor and control your servers remotely from any device, including mobile phones.

⚙️ Enabling the Web API

Open WGS and go to Settings → Web Remote Control.
Check Enable Web API and choose a port (default: 8765).
An access token is generated automatically. Copy or customise it.
Click Save — the server starts immediately and the status indicator turns green.
Navigate to http://localhost:8765/ui in any browser to open the dashboard.

Authentication: All API requests require the header Authorization: Bearer <your-token>. The token is shown in Settings → Web Remote Control. Individual users can also be created with their own tokens in Settings → User Management.

Browser Dashboard

🌐 http://your-ip:8765/ui

The web dashboard provides a full management interface accessible from any browser — no installation needed on the remote device.

Real-time server status, CPU, RAM, and player count
Start, stop, and restart servers with one click
Live console log viewer and command input
Network bandwidth graphs per server
Auto-refreshes every 5 seconds
v1.2.5 Sortable server grid (A→Z, Z→A, by game, by status) — remembered in the browser
v1.2.5 Live mini CPU graph on each running server's card

REST API Endpoints

Servers

Method	Endpoint	Description
GET	`/api/servers`	List all servers with current status, CPU, RAM, and player count.
GET	`/api/servers/{id}`	Detailed stats for a specific server.
POST	`/api/servers/{id}/start`	Start the server.
POST	`/api/servers/{id}/stop`	Stop the server.
POST	`/api/servers/{id}/restart`	Restart the server.
POST	`/api/servers/{id}/update`	Trigger a SteamCMD update.
POST	`/api/servers/{id}/backup`	Create an immediate world backup.
GET	`/api/servers/{id}/backups`	List available backups for the server (filename, size, date).
POST	`/api/servers/{id}/restore`	Restore a backup. Body: `{"backup":"2024-01-15_valheim.zip"}`. Stop the server first.
POST	`/api/servers/{id}/cmd`	Send a console command. Body: `{"command":"say hello"}`
GET	`/api/servers/{id}/perf?minutes=N`	v1.2.5 CPU/RAM history samples for the last N minutes (default 5).

System

Method	Endpoint	Description
GET	`/api/system`	Host machine CPU and RAM metrics.
GET	`/api/system/bandwidth`	Total network bandwidth usage for the host.

Quick Start Examples

List all servers

curl -H "Authorization: Bearer YOUR_TOKEN" \
     http://localhost:8765/api/servers

Start a server

curl -X POST \
     -H "Authorization: Bearer YOUR_TOKEN" \
     http://localhost:8765/api/servers/1/start

Send a console command

curl -X POST \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"command":"say Server restarts in 5 minutes"}' \
     http://localhost:8765/api/servers/1/cmd