24.1. Allgemein¶
Ihr VT AIR Gerät verfügt über eine REST-API, mit der 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 sie 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 die Inhalte der einzelnen Felder ändern. Sie können eine GET-Anfrage ausführen, um alle Felder innerhalb dieses Endpunkts zu laden. Zum Beispiel können Sie sich mit der Anfrage GET /api/user/ die Benutzer Ihres Namens anzeigen lassen.
Wenn Sie über Ihren Webbrowser auf die API zugreifen, können Sie POST-Befehle direkt von Ihrem Browserfenster aus ausführen.
24.1.1. Zugriff auf die API über eine Konsole¶
24.1.1.1. GET-Requests¶
Auf Ihrem Mac oder Linux-Gerät
curl -k -u BENUTZER:PASSWORT https://IPADDRESS/api/user/
um auf die Benutzerdaten Ihres VT AIR unter IPADDRESS erreichbaren Geräts mit den Benutzerdaten USER und PASSWORD zuzugreifen. Dies liest die Konfigurationszeichenfolge aller derzeit auf Ihrem System konfigurierten Benutzer zurück.
Die Option -k bewirkt, dass das SSL Zertifikat nicht überprüft wird, falls es nicht vertraut wird.
24.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‘
24.1.1.3. Token¶
Jeder Benutzer hat ein API-Token, das anstelle von Benutzer und Passwort verwendet werden kann. Das Format des Autorisierungs-Headers lautet „Token <ACCESS_TOKEN>“.
curl -k -H „Authorization: Token <ACCESS_TOKEN>“ https://IPADDRESS/api/user/