NoVNC Konsole

POST /vm/:vmid/novnc

URL Variablen

Name Beschreibung
vmid Identifier der VM (fünfstellige Zahl)

Body Parameter (application/x-www-form-urlencoded)

Name Format Beschreibung Optional
ui_title String Titel oben rechts in der Konsole (Standard: NoVNC Console)
ui_language Enum (vm.novnc.ui_language) Sprache der UI (Standard: de)
ui_hide_fullscreen Boolean Entfernt den "Vollbild" Button in der UI. Sinnvoll bei Einbindung der Konsole in ein iframe, da ein Vollbildmodus hier nicht mehr möglich ist (Standard: false)

Response (application/json) 

{
    "status": "success",
    "requestID": "61b5d42c-68cd-4d44-9496-36c077583f1b",
    "message": "NoVNC Console URL generated",
    "data": {
        "link": "https:\/\/console.novnc.de\/console?session_id=..."
    }
}

cURL

curl "https://live.fireapi.de/vm/:vmid/novnc" -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "X-FIRE-APIKEY: REPLACE_API-KEY" -d "ui_title=REPLACE_VALUE&ui_language=REPLACE_VALUE&ui_hide_fullscreen=REPLACE_VALUE"

Anfrage testen