# Show VNC access

> How to reach the VNC console of one vServer with a VNC client: host, port, password.

- Effect: Read - Changes nothing.
- Idempotent: yes
- Stability: beta
- MCP tool: `manitu_vserver_vnc_get` on https://mcp.manitu.de/mcp
- REST: `POST https://api.manitu.de/v1/vserver/vnc/get`
- Needs: `service_vserver`
- Page: /reference/vserver/vnc/get/

## MCP tool

`manitu_vserver_vnc_get`

### Description for the model

Returns whether the VNC console of a virtual server (vServer) is on, and where a VNC client connects to (host, port) - by its vserver_id from manitu_vserver_list. For helping the customer connect. The password is NOT given here (secrets_withheld): the customer finds it in the manitu customer panel - never ask them to type it into this chat. For the console in the browser, without a VNC client, see manitu_vserver_vnc_web_get.

### Arguments

- `vserver_id` (integer | string, required) - The vserver_id from manitu_vserver_list - never guess one. (pattern `"^[1-9][0-9]*$"`; minimum `1`)

### Example

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "manitu_vserver_vnc_get",
    "arguments": {
      "vserver_id": 12345
    }
  }
}
```

## REST

`POST https://api.manitu.de/v1/vserver/vnc/get`

### Authentication

One of `X-API-Key`, `Authorization: Bearer …` - never more than one in a request.

### Request body

JSON; unknown fields are refused.

- `vserver_id` (integer | string, required) - The vserver_id from manitu_vserver_list - never guess one. (pattern `"^[1-9][0-9]*$"`; minimum `1`)

### Response

In `data`; the rest of the body as on every call.

- `vnc_enabled` (boolean, required) - The VNC console is switched on; if not, everything else is null.
- `host` (string | null, required) - Where a VNC client connects to.
- `port` (integer | null, required)
- `password` (string | null, required) - The VNC password - a secret; null where it is withheld (secrets_withheld).
- `secrets_withheld` (boolean, required) - The password is left out here (an answer to an agent) - the customer finds it in the customer panel.

### Statuses

- `200` Success.
- `400` The request does not match the declared input schema.
- `401` No credential was presented, or it was not recognised.
- `403` The credential is not permitted to use this operation.
- `500` The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.
- `503` The channel this operation forwards through is unavailable.

### Example

```sh
curl -X POST 'https://api.manitu.de/v1/vserver/vnc/get' \
  -H 'X-API-Key: $API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"vserver_id":12345}'
```

## Example result

```json
{
  "vnc_enabled": true,
  "host": "string",
  "port": 1,
  "password": "correct-horse-battery",
  "secrets_withheld": true
}
```