curl --request POST \
--url https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "novnc"
}
'import requests
url = "https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session"
payload = { "type": "novnc" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'novnc'})
};
fetch('https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'novnc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session"
payload := strings.NewReader("{\n \"type\": \"novnc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"novnc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"novnc\"\n}"
response = http.request(request)
puts response.read_body{
"is_tls_enabled": true,
"fqdn": "vps.advinservers.com",
"port": 443,
"token": "YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT",
"websocket_url": "wss://vps.advinservers.com/console/socket/YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT",
"password": "hdFC1nD+9/XQCGKax8QCP59CZQadQHw3A6Xsk1wvb+KT"
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Not found."
}{
"message": "The name field is required.",
"errors": {}
}{
"message": "Too Many Attempts."
}Open a console session
Overview
Creates a connection through the integrated console proxy. Send type as novnc for a graphical console or xtermjs for a serial console. Connect to websocket_url immediately. The single-use connection token expires after 30 seconds. For a graphical console, use password as the VNC password. Serial authentication is handled by the proxy. Request a new session after every disconnect, including a server restart. The existing is_tls_enabled, fqdn, port and token fields describe the panel connection. A temporary failure returns 503; retry after the delay in Retry-After.
Permissions
Requires the server.console (Use the console) permission for the selected team. Resources outside that team return 404.
curl --request POST \
--url https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "novnc"
}
'import requests
url = "https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session"
payload = { "type": "novnc" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'novnc'})
};
fetch('https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'novnc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session"
payload := strings.NewReader("{\n \"type\": \"novnc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"novnc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/servers/{server}/create-console-session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"novnc\"\n}"
response = http.request(request)
puts response.read_body{
"is_tls_enabled": true,
"fqdn": "vps.advinservers.com",
"port": 443,
"token": "YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT",
"websocket_url": "wss://vps.advinservers.com/console/socket/YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT",
"password": "hdFC1nD+9/XQCGKax8QCP59CZQadQHw3A6Xsk1wvb+KT"
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Not found."
}{
"message": "The name field is required.",
"errors": {}
}{
"message": "Too Many Attempts."
}Authorizations
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
The server UUID
"ecc6f4f1"
Body
Send a JSON object containing the fields below. Required fields are marked in the schema.
The type of operation or resource.
novnc, xtermjs Response
The record, as a JSON object. There is no envelope.
The connection details and temporary token for a server console.
Whether is tls is enabled.
true
The value of fqdn.
"vps.advinservers.com"
The value of port.
443
The value of token.
"YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT"
Single-use socket address. Request a new session after disconnecting.
"wss://vps.advinservers.com/console/socket/YSAH2tawwS9CGsecn2x66O42hhTY2B8a1u5TaFRCX5NjnhA8ZUKuHw9FsZZfM4tT"
Temporary VNC password; null for a serial console.
"hdFC1nD+9/XQCGKax8QCP59CZQadQHw3A6Xsk1wvb+KT"