Show VNC access

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

RReadIdempotentbetaNeeds service_vserver

Tool

manitu_vserver_vnc_geton https://mcp.manitu.de/mcp

POST

/v1/vserver/vnc/geton https://api.manitu.de

Annotations as tools/list sends them

readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

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_idinteger | stringrequired

The vserver_id from manitu_vserver_list - never guess one.

pattern ^[1-9][0-9]*$min 1

Result structuredContent, checked against the schema

vnc_enabledbooleanrequired

The VNC console is switched on; if not, everything else is null.

hoststring | nullrequired

Where a VNC client connects to.

portinteger | nullrequired

passwordstring | nullrequired

The VNC password - a secret; null where it is withheld (secrets_withheld).

secrets_withheldbooleanrequired

The password is left out here (an answer to an agent) - the customer finds it in the customer panel.

Authentication

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

Request body JSON; unknown fields are refused

vserver_idinteger | stringrequired

The vserver_id from manitu_vserver_list - never guess one.

pattern ^[1-9][0-9]*$min 1

Response in `data`; the rest of the body as on every call

vnc_enabledbooleanrequired

The VNC console is switched on; if not, everything else is null.

hoststring | nullrequired

Where a VNC client connects to.

portinteger | nullrequired

passwordstring | nullrequired

The VNC password - a secret; null where it is withheld (secrets_withheld).

secrets_withheldbooleanrequired

The password is left out here (an answer to an agent) - the customer finds it in the customer panel.

Statuses

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

MCPtools/call

Request

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

Result

{
  "structuredContent": {
    "vnc_enabled": true,
    "host": "string",
    "port": 1,
    "password": "correct-horse-battery",
    "secrets_withheld": true
  },
  "content": [
    {
      "type": "text",
      "text": "… the same answer as text …"
    }
  ],
  "isError": false
}

POST/v1/vserver/vnc/get

Request

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
  }'

const response = await fetch('https://api.manitu.de/v1/vserver/vnc/get', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "vserver_id": 12345
  }),
});
const answer = await response.json();

<?php

$curl = curl_init('https://api.manitu.de/v1/vserver/vnc/get');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_HTTPHEADER     => [
        'X-API-Key: ' . getenv('API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => '{"vserver_id":12345}',
    CURLOPT_RETURNTRANSFER => true,
]);

$answer = json_decode(curl_exec($curl), true);

import os

import requests

response = requests.request(
    "POST",
    "https://api.manitu.de/v1/vserver/vnc/get",
    headers={"X-API-Key": os.environ["API_KEY"]},
    json={
        "vserver_id": 12345,
    },
)
answer = response.json()

Response 200

{
  "status": {
    "type": "success",
    "code": 200
  },
  "meta": {},
  "data": {
    "vnc_enabled": true,
    "host": "string",
    "port": 1,
    "password": "correct-horse-battery",
    "secrets_withheld": true
  }
}