API-Dokumentation

SFTP-Datei lesen

Dateiinhalt von einem VPS lesen. Unterstützt Text- (utf8) und Binär-Kodierung (base64). Maximale Dateigröße ist 10 MB.

Anfrage

GET /api/v1/vps/{id}/sftp/read?path=/etc/nginx/nginx.conf

Erforderlicher Scope: vps:manage

Pfadparameter

Parameter Typ Beschreibung
id string Die VPS-ID

Abfrageparameter

Parameter Typ Erforderlich Beschreibung
path string Ja Absoluter Pfad der zu lesenden Datei
encoding string Nein utf8 (Standard) oder base64

Header

Header Erforderlich Wert
Authorization Ja Bearer DEIN_API_SCHLÜSSEL

Antwort

{
  "data": {
    "path": "/etc/nginx/nginx.conf",
    "content": "worker_processes auto;\nevents { ... }\n",
    "encoding": "utf8",
    "size": 1024
  }
}

Antwortfelder

Feld Typ Beschreibung
path string Normalisierter absoluter Pfad
content string Dateiinhalt in der angeforderten Kodierung
encoding string Die verwendete Kodierung (utf8 oder base64)
size number Dateigröße in Bytes

Fehler

Status Code Beschreibung
400 MISSING_PATH Der path-Abfrageparameter fehlt
400 INVALID_PATH Pfad ist nicht absolut
400 INVALID_ENCODING Kodierung ist nicht utf8 oder base64
400 READ_ERROR Datei konnte nicht gelesen werden
404 NOT_FOUND VPS nicht gefunden oder kein Zugriff
404 FILE_NOT_FOUND Datei existiert nicht
408 TIMEOUT Lesen der Datei hat das Zeitlimit überschritten
413 FILE_TOO_LARGE Datei überschreitet 10 MB
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/read?path=/etc/hostname" \
  -H "Authorization: Bearer DEIN_API_SCHLÜSSEL"

MCP

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