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
Try it
readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

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.

vserver_idinteger | stringrequired

The vserver_id from manitu_vserver_list - never guess one.

pattern ^[1-9][0-9]*$min 1
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.

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

vserver_idinteger | stringrequired

The vserver_id from manitu_vserver_list - never guess one.

pattern ^[1-9][0-9]*$min 1
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.

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.