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.
Ihre Operator-Rolle bestimmt, was Sie in WatchGuard Cloud anzeigen und tun können. Sie müssen Kontoadministrations-Berechtigungen in der Rolle Owner oder Administrator haben, um diese Funktion anzuzeigen oder zu konfigurieren. Weitere Informationen finden Sie unter WatchGuard Cloud-Operatoren und -Rollen verwalten.
API-Zugriff aktivieren
Wenn Sie den API-Zugriff aktivieren, legen Sie Zugangsdaten für API-Anfragen mit Lese-/Schreib-Berechtigung und Nur-Lese-Berechtigung 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 anzeigen.
Um den API-Zugriff zu aktivieren, müssen Sie die Operator-Rolle als Owner oder Administrator inne haben.
Aktivieren des API-Zugriffs:
- Melden Sie sich bei WatchGuard Cloud an.
Als Service-Provider wählen Sie im Kontomanager die Option Mein Konto oder ein verwaltetes Konto aus. - Wählen Sie Administration > Verwalteter Zugriff.
- Klicken Sie auf API-Zugriff aktivieren.
-
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 mindestens 12 Zeichen lang sein und einen Kleinbuchstaben, einen Großbuchstaben, eine Zahl und ein Sonderzeichen enthalten. Das Passwort darf keine <, >, Emojis oder Leerzeichen enthalten.
Die Passwörter für die Lese-/Schreibberechtigung und die Leseberechtigung müssen sich unterscheiden.
- Aktivieren Sie das Kontrollkästchen Ich stimme den Bedingungen in der Lizenzvereinbarung für WatchGuard APIs zu.
Sie können auf Lizenzvereinbarung für WatchGuard-APIs anzeigen klicken, um die Details der Vereinbarung zu studieren. - 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-/Schreib-Berechtigung als Zugangsdaten an, um ein API-Zugriffstoken zu generieren, das Lese-/Schreib-Zugriff ermöglicht.
- Zugriffs-ID (Lese-/Schreibberechtigung) — Geben Sie in einem API-Aufruf diese ID und das Passwort für die Nur-Lese-Berechtigung als Zugangsdaten an, um ein API-Zugriffstoken zu generieren, das den Nur-Lese-Zugriff 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-Schlüssel-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-/Schreib-Berechtigung 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 anzeigen.
API-Passwörter ändern
Ändern der API-Passwörter für die API-Zugriffs-IDs:
- Wählen Sie in Ihrem WatchGuard Cloud-Subscriber-Konto Administration > Verwalteter Zugriff.
Als Service-Provider wählen Sie im Kontomanager die Option Mein Konto aus.
- Klicken Sie auf Passwörter ändern.
- Legen Sie neue Passwörter für die Lese-/Schreib-Berechtigung und die Nur-Lese-Berechtigung fest.
- Aktivieren Sie das Kontrollkästchen Ich stimme den Bedingungen in der Lizenzvereinbarung für WatchGuard APIs zu.
Sie können auf Lizenzvereinbarung für WatchGuard-APIs anzeigen klicken, um die Details der Vereinbarung zu studieren. - Klicken Sie auf Passwörter ändern.
API-Zugriff aufheben
So heben Sie den API-Zugriff für Ihr WatchGuard Cloud-Konto auf:
- Melden Sie sich bei Ihrem WatchGuard Cloud-Konto an.
Als Service-Provider wählen Sie im Kontomanager die Option Mein Konto aus. - Wählen Sie Administration > Verwalteter Zugriff.
- Klicken Sie auf Zugriff entziehen.