Skip to main content
POST
Open a console session

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

type
enum<string>
required

The type of operation or resource.

Available options:
novnc,
xtermjs

Response

The record, as a JSON object. There is no envelope.

The connection details and temporary token for a server console.

is_tls_enabled
boolean
required

Whether is tls is enabled.

Example:

true

fqdn
string
required

The value of fqdn.

Example:

"vps.advinservers.com"

port
integer
required

The value of port.

Example:

443

token
string
required

The value of token.

Example:

"YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT"

websocket_url
string
required

Single-use socket address. Request a new session after disconnecting.

Example:

"wss://vps.advinservers.com/console/socket/YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT"

password
string | null
required

Temporary VNC password; null for a serial console.

Example:

"hdFC1nD+9/XQCGKax8QCP59CZQadQHw3A6Xsk1wvb+KT"