---
title: "Open a VM VNC WebSocket"
method: GET
path: "/vnc/{port}"
tags: ["VM"]
---

# Open a VM VNC WebSocket

`GET /vnc/{port}`

Validate the requested VM-owned VNC port and upgrade to the existing authenticated WebSocket relay. This documents the HTTP handshake, not WebSocket frames.

## Path parameters

- `port` integer, required

## Query parameters

- `auth` string, required
- `overtake` boolean

## Other responses

- `101` — Switching Protocols
- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — VNC Port Not Found
- `500` — Internal Server Error
- `502` — Bad Gateway
- `503` — Service Unavailable

## Changes

- **2026-08-12** `9a5026bf9057` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/vnc/:port/get.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) · [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) · [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/f1c5f8388fd6?raw)