23.1. Allgemein

Ihr VT AIR-Gerät ist mit einer REST-API ausgestattet, so dass Sie Konfigurationsänderungen in sehr großen Netzwerken automatisieren und Zeit sparen können. Anstatt auf die Web-GUI von möglicherweise Hunderten von Geräten zuzugreifen, können Sie die Konfigurationsänderungen einmal eingeben und an eine ganze Liste von IP-Adressen senden.

Die REST-API bietet Ihnen die gleichen Konfigurationsmöglichkeiten wie die Web-GUI in textbasierter Form. Die API kann über die Command Line, Ihren Web-Browser oder spezialisierte Programme, die REST-APIs lesen und schreiben, aufgerufen werden.

Über GET-, POST- und DELETE-Befehle können Sie den Inhalt der einzelnen Felder ändern. Sie können eine GET-Anfrage ausführen, um alle Felder innerhalb dieses Endpunkts zu laden. Beispielsweise können Sie die Benutzer von VT AIR mit der Anfrage GET /api/user/ anzeigen.

Wenn Sie über Ihren Webbrowser auf die API zugreifen, können Sie POST-Befehle direkt von Ihrem Browserfenster aus ausführen.

23.1.1. Zugriff auf die API über eine Konsole

23.1.1.1. GET-Requests

Auf Ihrem Mac oder Linux-Gerät

curl -k -u BENUTZER:PASSWORT https://IPADDRESS/api/user/

ein, um auf die Benutzerdaten Ihres VT AIR-Gerätes zuzugreifen, das unter IPADDRESS mit den Benutzerdaten USER und PASSWORD erreichbar ist. Dies liest den Konfigurationsstring aller derzeit auf dem System konfigurierten Benutzer aus.

Die Option -k bewirkt, dass das SSL Zertifikat nicht überprüft wird, falls es nicht vertraut wird.

23.1.1.2. POST-Requests

Um Daten auf Ihr Gerät zu schreiben, können Sie einen POST-Request verwenden. Geben Sie

curl -k -u BENUTZER:PASSWORT -d ‚DATEN‘ https://IPADDRESS/api/user/

die DATA-Zeichenkette muss alle Felder enthalten, die Sie durch & getrennt werden müssen. Zum Beispiel (aus Gründen der Lesbarkeit gekürzt):

‚uuid=null&first_name=John&lastname=Doe&username=johnDoe&lang=en‘