API-Dokumentation

SFTP-Verzeichnis auflisten

Verzeichnisinhalte auf einem VPS auflisten. Gibt Dateinamen, Typen, Größen und Änderungszeiten zurück.

Anfrage

GET /api/v1/vps/{id}/sftp/list?path=/var/log

Erforderlicher Scope: vps:manage

Pfadparameter

Parameter Typ Beschreibung
id string Die VPS-ID

Abfrageparameter

Parameter Typ Erforderlich Beschreibung
path string Ja Absoluter Pfad des aufzulistenden Verzeichnisses

Header

Header Erforderlich Wert
Authorization Ja Bearer DEIN_API_SCHLÜSSEL

Antwort

{
  "data": {
    "entries": [
      {
        "name": "syslog",
        "isDirectory": false,
        "size": 524288,
        "modifiedAt": "2025-01-15T10:30:00+00:00"
      },
      {
        "name": "nginx",
        "isDirectory": true,
        "size": 4096,
        "modifiedAt": "2025-01-14T08:00:00+00:00"
      }
    ]
  }
}

Antwortfelder

Feld Typ Beschreibung
entries array Liste der Verzeichniseinträge
entries[].name string Datei- oder Verzeichnisname
entries[].isDirectory boolean Ob der Eintrag ein Verzeichnis ist
entries[].size number Größe in Bytes
entries[].modifiedAt string Letzter Änderungszeitpunkt (ISO 8601)

Fehler

Status Code Beschreibung
400 MISSING_PATH Der path-Abfrageparameter fehlt
400 INVALID_PATH Pfad ist nicht absolut
400 LIST_ERROR Verzeichnis konnte nicht aufgelistet werden
404 NOT_FOUND VPS nicht gefunden oder kein Zugriff
408 TIMEOUT Verzeichnisauflistung hat das Zeitlimit überschritten
502 SSH_AUTH_ERROR SSH-Authentifizierung fehlgeschlagen
502 SSH_CONNECTION_ERROR Verbindung zum VPS nicht möglich

Beispiel

curl "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/list?path=/var/log" \
  -H "Authorization: Bearer DEIN_API_SCHLÜSSEL"

MCP

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