Get bare metal server console URL

Returns a URL to access the remote console for a bare metal server.

GET /cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console

Get bare metal server console URL

cURL

curl --request GET \
  --url https://api.gcore.com/cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console', 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://api.gcore.com/cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v3/baremetal/{project_id}/{region_id}/{server_id}/get_console")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "remote_console": {
    "protocol": "<string>",
    "type": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id · integer · required

Project ID

Example:

1

region_id · integer · required

Region ID

Example:

1

server_id · string<uuid4> · required

Server ID

Example:

"024a29e-b4b7-4c91-9a46-505be123d9f8"

Query Parameters

console_type · enum<string>

Console type

Available options: serial, vnc

Example:

"vnc"

Response

200 - application/json

OK

remote_console · RemoteConsoleData · object · required

Remote console information

Show child attributes

Example:

{
  "protocol": "vnc",
  "type": "novnc",
  "url": "https://console-novnc.example.com/vnc_auto.html?path=%3Ftoken%3Df445c4b6-0a77-4fae-bc0e-147201dbfbea"
}