API-Dokumentation

Firewall-Status abrufen

Gibt den aktuellen Firewall-Status und alle Regeln eines VPS zurück. Die Firewall-Verwaltung erfolgt über SSH (unterstützt ufw und firewalld).

Anfrage

GET /api/v1/vps/{id}/firewall

Erforderlicher Scope: vps:manage

Pfadparameter

Parameter Typ Beschreibung
id string Die VPS-ID

Header

Header Erforderlich Wert
Authorization Ja Bearer DEIN_API_SCHLÜSSEL

Antwort

{
  "data": {
    "tool": "ufw",
    "active": true,
    "defaultIncoming": "deny",
    "defaultOutgoing": "allow",
    "rules": [
      {
        "port": "22",
        "proto": "tcp",
        "action": "allow",
        "source": "any"
      },
      {
        "port": "80",
        "proto": "tcp",
        "action": "allow",
        "source": "any"
      },
      {
        "port": "443",
        "proto": "tcp",
        "action": "allow",
        "source": "any"
      }
    ],
    "readViaSSH": true
  }
}

Antwortfelder

Feld Typ Beschreibung
tool string Erkanntes Firewall-Tool (ufw, firewalld oder none)
active boolean Ob die Firewall derzeit aktiv ist
defaultIncoming string Standardrichtlinie für eingehenden Datenverkehr
defaultOutgoing string Standardrichtlinie für ausgehenden Datenverkehr
rules array Liste der Firewall-Regeln
rules[].port string Port oder Portbereich (z.B. 80, 8000:8100)
rules[].proto string Protokoll: tcp, udp oder both
rules[].action string allow oder deny
rules[].source string Quell-IP oder any
readViaSSH boolean Ob der Status per SSH gelesen wurde

Fehler

Status Code Beschreibung
404 NOT_FOUND VPS nicht gefunden oder kein Zugriff
502 FIREWALL_ERROR Firewall-Operation auf dem Server fehlgeschlagen

Beispiel

curl "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/firewall" \
  -H "Authorization: Bearer DEIN_API_SCHLÜSSEL"

MCP

Diese Daten sind auch über das get_firewall MCP-Tool verfügbar.