API-Zugriff aktivieren

WatchGuard stellt öffentliche RESTful APIs zur Verfügung, die Sie für die Integration mit WatchGuard-Produkten und -Diensten nutzen können. Um eine WatchGuard-API zu verwenden, müssen Sie den RESTful API-Zugriff in WatchGuard Cloud aktivieren.

Ausführlichere Informationen finden Sie in der WatchGuard API-Hilfe.

API-Zugriff aktivieren

Wenn Sie den API-Zugriff aktivieren, legen Sie Zugangsdaten für API-Anfragen mit Lese-/Schreibberechtigung und Leseberechtigung fest und generieren einen API-Schlüssel, mit dem Ihr Konto bei Anfragen an die WatchGuard-APIs identifiziert wird. WatchGuard Cloud unterstützt API-Zugriff sowohl für Service-Provider- als auch für Subscriber-Konten. Informationen zu den Nutzungsstatistiken der öffentlichen WatchGuard-API für Ihr Konto finden Sie unter API-Nutzung.

Um den API-Zugriff zu aktivieren, müssen Sie die Operator-Rolle als Owner oder Administrator inne haben.

Aktivieren des API-Zugriffs:

  1. Melden Sie sich bei WatchGuard Cloud an.
    Als Service-Provider wählen Sie im Kontomanager die Option Mein Konto oder ein verwaltetes Konto aus.
  2. Wählen Sie Administration > Verwalteter Zugriff.

  3. Klicken Sie auf API-Zugriff aktivieren.

  4. Legen Sie die Passwörter für die Lese-/Schreibberechtigung und die Leseberechtigung fest, die Sie als Zugangsdaten für den API-Zugriff verwenden möchten. Passwörter müssen einen Großbuchstaben, einen Kleinbuchstaben, eine Zahl und ein Sonderzeichen enthalten.

    Die Passwörter für die Lese-/Schreibberechtigung und die Leseberechtigung müssen sich unterscheiden.

  5. Aktivieren Sie das Kontrollkästchen Ich stimme der Lizenzvereinbarung für die WatchGuard APIs zu.
    Sie können auf Lizenzvereinbarung für WatchGuard APIs anzeigen klicken, um die Details der Vereinbarung zu studieren.
  6. Klicken Sie auf Speichern.

Nachdem Sie den API-Zugriff aktiviert haben, sehen Sie die folgenden Informationen:

  • Zugriffs-ID (Lese-/Schreibberechtigung) — Geben Sie in einem API-Aufruf diese ID und das Passwort für die Lese-/Schreibberechtigung als Zugangsdaten an, um ein API-Zugriffstoken zu generieren, das Lese-/Schreibzugriff ermöglicht.
  • Zugriffs-ID (Lese-/Schreibberechtigung) — Geben Sie in einem API-Aufruf diese ID und das Passwort für die Leseberechtigung als Zugangsdaten an, um ein API-Zugriffstoken zu generieren, das Lesezugriff ermöglicht.
  • URL der Authentifizierungs-API — Um ein Zugriffstoken zu generieren, senden Sie eine Anfrage an die URL dieses Endpoints der WatchGuard-Authentifizierungs-API.
  • API URL (Basis) — Die Basis-URL für Aufrufe der öffentlichen WatchGuard-API.
  • API-Schlüssel — Legen Sie diesen Wert für alle Anfragen an öffentliche WatchGuard-APIs als X-API-Key-Headerparameter fest.

Die URL der Authentifizierungs-API und die URL (Basis) der API hängen von der Datenspeicherregion Ihres WatchGuard Cloud-Kontos ab.

Die öffentlichen APIs von WatchGuard verwenden Token-basierte Authentifizierung. Bei jedem Aufruf einer WatchGuard-API geben Sie einen API-Schlüssel an, mit dem Ihr Konto angegeben wird, sowie ein Zugriffstoken, das den API-Zugriff für eine bestimmte Zeit autorisiert. Um ein Zugriffstoken zu erhalten, senden Sie eine Anfrage an die WatchGuard Authentifizierungs-API. Die Anfrage für das Zugriffstoken muss die in base64 kodierten Zugangsdaten Ihres Kontos für die Lese-/Schreibberechtigung zur API enthalten.

Weitere Informationen darüber, wie Sie API-Zugriffe durchführen, finden Sie in der WatchGuard API-Hilfe. Informationen zu den Nutzungsstatistiken der öffentlichen WatchGuard-API für Ihr Konto finden Sie unter API-Nutzung.

API-Passwörter ändern

Ändern der API-Passwörter für die API-Zugriffs-IDs:

  1. Wählen Sie in Ihrem Subscriber-Konto für WatchGuard Cloud Administration > Verwalteter Zugriff.
    Als Service-Provider wählen Sie im Kontomanager die Option Mein Konto aus.

Screen shot of RESTful API Access enabled

  1. Klicken Sie auf Passwörter ändern.

    Screen shot of the Change Passwords page.

  2. Legen Sie neue Passwörter für die Lese-/Schreibberechtigung und die Leseberechtigung fest.
  3. Aktivieren Sie das Kontrollkästchen Ich stimme der Lizenzvereinbarung für die WatchGuard APIs zu.
    Sie können auf Lizenzvereinbarung für WatchGuard APIs anzeigen klicken, um die Details der Vereinbarung zu studieren.
  4. Klicken Sie auf Passwörter ändern.

API-Zugriff aufheben

So heben Sie den API-Zugriff für Ihr WatchGuard Cloud-Konto auf:

  1. Melden Sie sich bei Ihrem WatchGuard Cloud-Konto an.
    Als Service-Provider wählen Sie im Kontomanager die Option Mein Konto aus.
  2. Wählen Sie Administration > Verwalteter Zugriff.
  3. Klicken Sie auf Zugriff entziehen.

    Screen shot of RESTful API Access enabled

Siehe auch

Dashboard zur Anzeige der API-Nutzung

WatchGuard API-Hilfe

Konfigurieren von MFA für einen RESTful API Client