API-Dokumentation

ISO einbinden

ISO-Image auf einem VPS einbinden oder aushängen. Das Einbinden eines ISO ermöglicht das Booten von einem benutzerdefinierten Installationsimage.

Anfrage

POST /api/v1/vps/{id}/iso

Erforderlicher Scope: vps:write

Pfadparameter

Parameter Typ Beschreibung
id string Die VPS-ID

Header

Header Erforderlich Wert
Authorization Ja Bearer DEIN_API_SCHLÜSSEL
Content-Type Ja application/json

Anfragekörper

Feld Typ Erforderlich Beschreibung
os string | null Ja ISO-Kennung zum Einbinden oder null zum Aushängen

ISO einbinden:

{
  "os": "ubuntu-24.04-live"
}

Aktuelles ISO aushängen:

{
  "os": null
}

Antwort

Einbinden-Antwort:

{
  "data": {
    "mounted": true,
    "os": "ubuntu-24.04-live",
    "success": true
  }
}

Aushängen-Antwort:

{
  "data": {
    "mounted": false,
    "success": true
  }
}

Antwortfelder

Feld Typ Beschreibung
mounted boolean Ob ein ISO jetzt eingebunden ist
os string Die eingebundene ISO-Kennung (nur beim Einbinden vorhanden)
success boolean Ob die Aktion akzeptiert wurde

Fehler

Status Code Beschreibung
400 MISSING_FIELD Das os-Feld ist nicht im Anfragekörper vorhanden
400 INVALID_OS Der os-Wert ist weder ein String noch null
404 NOT_FOUND VPS nicht gefunden oder kein Zugriff
502 PROVIDER_ERROR Upstream-Anbieterfehler

Beispiel

curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/iso" \
  -H "Authorization: Bearer DEIN_API_SCHLÜSSEL" \
  -H "Content-Type: application/json" \
  -d '{"os": "ubuntu-24.04-live"}'

MCP

Diese Aktion ist auch über das vm_mount_iso MCP-Tool verfügbar.