VELOBOX API

Liefert einen kompakten Systemstatus mit Station-ID, Hostname, Gerätetyp, Version, Port und primärer IP-Adresse.

Liefert erweiterte Geräte-, Netzwerk- und vmkstationd-Informationen.

Liefert aktuelle Informationen zur CPU-Auslastung, zum Arbeitsspeicher und zum Speicherplatz der VELOBOX.

{
  "ts": "2026-07-23T08:20:00.000Z",
  "cpu": {
    "cores": 4,
    "load1": 0.42,
    "load5": 0.31,
    "load15": 0.28,
    "usagePercent": 17.4
  },
  "memory": {
    "total": 8051236864,
    "used": 2153648128,
    "available": 5897588736,
    "usedPercent": 26.75
  },
  "storage": {
    "mount": "/",
    "total": 62547517440,
    "used": 17324597248,
    "available": 42618163200,
    "usedPercent": 27.7
  }
}

Liest alle gespeicherten Einstellungen aus der settings.json.

{
  "success": true,
  "settings": {
    "system": {
      "language": "de"
    }
  }
}

Ersetzt die vollständige settings.json durch das übermittelte JSON-Objekt.

{
  "system": {
    "language": "de",
    "theme": "dark"
  }
}

Liest einen einzelnen Wert aus einem Settings-Bereich.

{
  "success": true,
  "key": "system.language",
  "path": [
    "system",
    "language"
  ],
  "value": "de"
}

Erstellt oder aktualisiert einen einzelnen Settings-Wert. Andere gespeicherte Keys bleiben unverändert.

{
  "value": "de"
}

Entfernt einen einzelnen Settings-Key. Andere Einstellungen bleiben unverändert.

{
  "success": true,
  "deleted": true,
  "key": "system.language",
  "path": [
    "system",
    "language"
  ],
  "previousValue": "de"
}

Vereinfachte Funktionen für den Zugriff aus der Benutzeroberfläche.

const language = await apiSettingsGet(
  'language',
  'system'
);

await apiSettingsSet(
  'language',
  'system',
  'de'
);

await apiSettingsDel(
  'language',
  'system'
);

Listet Dateien und Verzeichnisse innerhalb von FS_ROOT auf.

Liefert eine Datei direkt über sendFile() aus.

Liest eine Textdatei und liefert deren Inhalt als JSON.

Schreibt eine Textdatei innerhalb von FS_ROOT.

{
  "filePath": "ClientData/123/test.json",
  "content": "{\"ok\":true}",
  "mkdir": true
}

Lädt eine Datei per multipart/form-data hoch.

Löscht eine Datei oder ein Verzeichnis rekursiv.

Liefert den aktuellen Backup- und Restore-Status.

Erstellt ein vollständiges Backup als tar.gz-Download.

Stellt ein Backup wieder her. Das Archiv wird direkt als binärer Request-Body übertragen.

Liefert den aktuellen Status von vmkstationd.

Ruft die Developer-Statusinformationen von vmkstationd ab.

Liefert Statistiken zur Client-Datenbank.

Listet verfügbare Dateien aus /var/local/log auf.

Liefert den vollständigen Inhalt einer Logdatei als Text.

Öffnet einen Server-Sent-Events-Stream und liefert zunächst die letzten 100 Logzeilen sowie anschließend neue Einträge.

Erstellt und liefert die aktuellen Telemetriedaten, ohne sie zu übertragen.

Erstellt die aktuellen Telemetriedaten und sendet sie an den konfigurierten Telemetrie-Server.

Technische Backend-Testoberfläche für WLAN-Status, Scan, gespeicherte Netzwerke sowie Connect und Disconnect.

Liefert eine kombinierte WLAN-Übersicht mit vorhandenen WLAN-Interfaces, aktuellem Verbindungsstatus und gespeicherten Netzwerken.

{
  "interfaces": [
    "wlan0"
  ],
  "status": {
    "available": true,
    "interface": "wlan0",
    "connected": true,
    "ssid": "Velometrik",
    "accessPoint": "E4:C3:2A:91:A6:9A",
    "ip": "10.1.11.35"
  },
  "savedNetworks": [
    {
      "ssid": "Velometrik",
      "keyMgmt": "WPA-PSK",
      "saved": true
    }
  ]
}

Liefert den aktuellen WLAN-Verbindungsstatus.

{
  "available": true,
  "interface": "wlan0",
  "connected": true,
  "ssid": "Velometrik",
  "accessPoint": "E4:C3:2A:91:A6:9A",
  "ip": "10.1.11.35"
}

Scannt über das aktuelle WLAN-Interface nach verfügbaren Access Points.

{
  "available": true,
  "scanAvailable": true,
  "interface": "wlan0",
  "networks": [
    {
      "cell": 1,
      "address": "E4:C3:2A:91:A6:9A",
      "essid": "Velometrik",
      "level": "-42"
    }
  ]
}

Liefert die gespeicherten WLAN-Netzwerke.

{
  "networks": [
    {
      "ssid": "Velometrik",
      "keyMgmt": "WPA-PSK",
      "saved": true
    }
  ]
}

Verbindet die VELOBOX mit einem WLAN und speichert die Zugangsdaten in der WLAN-Konfiguration.

{
  "ssid": "Velometrik",
  "psk": "WLAN-Passwort",
  "hidden": false
}

Verbindet die VELOBOX mit einem bereits gespeicherten WLAN. Das Passwort muss nicht erneut übermittelt werden.

{
  "ssid": "Velometrik"
}

Trennt die aktuelle WLAN-Verbindung. Das gespeicherte Netzwerk und dessen Zugangsdaten bleiben erhalten.

{
  "success": true,
  "interface": "wlan0",
  "disconnectedFrom": "Velometrik",
  "configPreserved": true
}

Weboberfläche zum manuellen Einspielen lokaler Updatepakete.

Liefert den aktuellen Status eines laufenden oder abgeschlossenen Offline-Updates.

Lädt ein lokales Updatepaket hoch und startet die Installation automatisch.

<gerät>_update_<version>.tar.gz
      

velobox_update_3.2.0.tar.gz
cube_update_2.4.0.tar.gz
smartcube_update_1.8.5.tar.gz
      

velobox_update_3.2.0.sh