API-Dokumentation

SFTP-Datei oder -Verzeichnis löschen

Eine Datei oder ein Verzeichnis auf einem VPS löschen. Standardmäßig werden nur Dateien und leere Verzeichnisse entfernt; mit recursive: true werden Verzeichnisse samt Inhalt gelöscht. Einige Systemwurzeln (/, /usr, /etc, /var, /home) werden grundsätzlich abgelehnt.

Erforderlicher Scope: vps:manage

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
path string Ja Absoluter Pfad der zu löschenden Datei oder des Verzeichnisses
recursive boolean Nein Bei true Verzeichnis samt Inhalt löschen (Standard: false) 
{
  "path": "/tmp/build-cache",
  "recursive": true
}

Antwort

{
  "data": {
    "path": "/tmp/build-cache",
    "deleted": true,
    "recursive": true
  }
}

Antwortfelder

Feld Typ Beschreibung
path string Normalisierter absoluter Pfad, der gelöscht wurde
deleted boolean Bei Erfolg immer true
recursive boolean Ob der rekursive Modus verwendet wurde

Fehler

Status Code Beschreibung
400 INVALID_BODY Anfragekörper ist kein gültiges JSON
400 INVALID_PATH Pfad ist nicht absolut oder ein geschütztes Wurzelverzeichnis
400 DELETE_FAILED Allgemeiner Löschfehler
403 DELETE_FAILED Keine Berechtigung für den Zielpfad
404 NOT_FOUND VPS nicht gefunden, kein Zugriff oder Pfad existiert nicht
409 DELETE_FAILED Verzeichnis ist nicht leer (mit recursive: true erneut versuchen)
502 SSH_AUTH SSH-Authentifizierung fehlgeschlagen
502 SSH_CONN Verbindung zum VPS nicht möglich
504 SSH_TIMEOUT SSH-Befehl hat das Zeitlimit überschritten

Beispiel

curl -X DELETE "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/delete" \
  -H "Authorization: Bearer DEIN_API_SCHLÜSSEL" \
  -H "Content-Type: application/json" \
  -d '{"path": "/tmp/build-cache", "recursive": true}'

MCP

Dieser Endpunkt ist noch nicht als MCP-Tool verfügbar. Den obigen REST-Endpunkt direkt nutzen.