REST API

Auf dieser Seite können sie API-Token anlegen und löschen.

RESTful API ermöglicht Benutzern, Programme oder Skripte zu schreiben, die ein oder mehrere UTMs automatisch konfigurieren. Ehe ein Programm oder Skript die RESTful API verwenden kann, muss sich die UTM an ihr authentifizieren. Es gibt zwei Wege, um sich an der RESTful API zu authentifizieren: Verwendung des Namens eines UTM-Benutzers oder über ein API-Token. API-Token sind zufällig generierte Zeichen, die mit einem UTM-Benutzer verknüpft sind und dieselben Zugriffsrechte besitzen wie der Benutzer. Bei der Authentifizierung wird immer HTTP Basic Authentication verwendet. Wenn Sie ein API-Token anstelle eines UTM-Benutzers verwenden, wird der Benutzername der HTTP Basic Authentication als Token verwendet und das API-Token als Kennwort.

Um ein API-Token zu konfigurieren, gehen Sie folgendermaßen vor:

  1. Aktivieren Sie RESTful API.

    Klicken Sie auf den Schieberegler.

    Hinweis – Wenn Die UTM-Instanz in Amazon Web Services (AWS) läuft, ist RESTful API standardmäßig eingeschaltet.

  2. Klicken Sie auf die Schaltfläche Neues API-Token.

    Das Dialogfeld API-Token hinzufügen wird geöffnet.

  3. Nehmen Sie die folgenden Einstellungen vor:

    API-Token: Geben Sie das API-Token ein oder verwenden Sie das automatisch generierte API-Token.

    Hinweis – API-Token ist eine alternative Authentifizierungsmethode, wie ein Kennwort aber ohne Benutzernamen. Es wird empfohlen, das automatisch generierte API-Token zu verwenden, das von der UTM generiert wurde, um sicherzustellen, dass das API-Token einmalig und hinreichend komplex ist.

    Benutzer: Wählen Sie einen Benutzer für das API-Token aus.

  4. Klicken Sie auf Speichern.

    Das API-Token wird zu der Liste API-Token hinzugefügt.