Auf unseren Serversystemen mit Plesk stellen wir eine eigene Erweiterung für die direkte Anbindung an unser Nameserver-Produkt zur Verfügung. Damit können DNS-Zonen aus Plesk heraus über die NSentry-API verwaltet werden.
Neue Plesk-Server werden mit aktivierter und bereits konfigurierter Erweiterung einschließlich API-Token ausgeliefert. Eine manuelle Ersteinrichtung ist daher normalerweise nicht erforderlich.
Die nachfolgende Anleitung benötigen Sie, wenn Sie die Erweiterung neu konfigurieren oder einen abgelaufenen, verlorenen beziehungsweise widerrufenen API-Token ersetzen möchten.
Wie erstelle ich einen neuen API-Token?
Melden Sie sich in der NSentry-Verwaltung an und öffnen Sie links im Menü den Bereich „API-Token“ (1).
Unter „Neuen Token erstellen“ (2) können Sie die Einstellungen für den neuen API-Token festlegen:
- Vergeben Sie einen eindeutigen Namen, beispielsweise „Plesk-Server“.
- Aktivieren Sie die Berechtigungen „zones:read“, „zones:write“ und „zones:delete“.
- Wählen Sie aus, wie lange der Token gültig sein soll.
Klicken Sie anschließend auf „Token erstellen“ (3).
Nach dem Erstellen wird der vollständige API-Token angezeigt. Kopieren Sie ihn über die Schaltfläche „In die Zwischenablage kopieren“ und bewahren Sie ihn sicher auf.
Wichtig: Der vollständige API-Token wird aus Sicherheitsgründen nur einmal angezeigt. Wenn Sie ihn nicht gespeichert haben oder später verlieren, müssen Sie einen neuen Token erstellen.
Behandeln Sie den API-Token wie ein Passwort. Geben Sie ihn nicht an unbefugte Personen weiter und versenden Sie ihn nicht unverschlüsselt per E-Mail.
Wo sehe und verwalte ich meine aktiven API-Token?
Im Bereich „Aktive Token“ sehen Sie alle derzeit vorhandenen API-Token. Angezeigt werden unter anderem der Name, die zugewiesenen Berechtigungen, das Erstellungsdatum, das Ablaufdatum und die letzte Verwendung.
Ein nicht mehr benötigter oder möglicherweise bekannt gewordener Token kann über „Widerrufen“ sofort deaktiviert werden. Die zugehörige Plesk-Erweiterung kann danach nicht mehr auf die NSentry-API zugreifen.
Beachten Sie außerdem das Ablaufdatum. Nach Ablauf des Tokens müssen Sie einen neuen API-Token erstellen und in der Plesk-Erweiterung hinterlegen.
Wie hinterlege ich einen neuen API-Token in Plesk?
Öffnen Sie in Plesk die Erweiterung „DNS Admin“ (1). Tragen Sie dort Ihren DNS-Benutzernamen (2) und den zuvor erstellten API-Token (3) ein.
Aktivieren Sie anschließend die Option „NSentry API verwenden“ (4).
Bevor Sie die Einstellungen speichern, sollten Sie die Verbindung prüfen. Klicken Sie dazu auf „API-VERBINDUNG TEST“ (5). Wenn die Verbindung erfolgreich hergestellt wurde, speichern Sie die Einstellungen über „Speichern“ (6).
Wenn die Angaben korrekt sind, bestätigt die Erweiterung den erfolgreichen Verbindungstest mit der Meldung „Ihre Zugangsdaten wurden erfolgreich getestet“.
Alternativ können Sie die Funktion „LOGIN (SSO)“ verwenden, um sich testweise direkt aus Plesk an der NSentry-Verwaltung anzumelden.
Wichtig: Wenn Sie einen bisherigen API-Token durch einen neuen Token ersetzen, sollten Sie den alten Token erst widerrufen, nachdem die Verbindung mit dem neuen Token erfolgreich getestet wurde.
Wie schalte ich die NSentry-Funktion für Kunden frei?
Ob Ihre Kunden die NSentry-Funktion verwenden dürfen, legen Sie über die Berechtigungen des jeweiligen Service-Pakets fest.
Öffnen Sie in Plesk den Bereich „Service-Pakete“ (1) und wählen Sie das gewünschte Service-Paket aus, beispielsweise „NVMe Webhosting Plus“ (2).
Wechseln Sie innerhalb des Service-Pakets zum Reiter „Berechtigungen“ (3). Klappen Sie bei Bedarf rechts die zusätzlichen Berechtigungen auf und scrollen Sie bis zur Einstellung „NS-Entry-DNS freischalten“ (4).
Setzen Sie den Haken, wenn Kunden mit diesem Service-Paket ihre DNS-Zonen über die Erweiterung verwalten dürfen. Lassen Sie die Option deaktiviert, wenn diese Möglichkeit nicht bereitgestellt werden soll.
Bestätigen Sie die Anpassung am Seitenende über „Aktualisieren & Synchronisieren“.
Wiederholen Sie den Vorgang bei Bedarf für weitere Service-Pakete.
Was kann ich tun, wenn die API-Verbindung fehlschlägt?
Prüfen Sie in diesem Fall zunächst folgende Punkte:
- Wurde der DNS-Benutzername korrekt eingegeben?
- Wurde der vollständige API-Token ohne zusätzliche Leerzeichen eingefügt?
- Besitzt der Token die Berechtigungen „zones:read“, „zones:write“ und „zones:delete“?
- Ist der Token noch gültig und wurde er nicht widerrufen?
- Ist die Option „NSentry API verwenden“ aktiviert?
Erstellen Sie bei einem abgelaufenen, verlorenen oder widerrufenen Token einen neuen API-Token und ersetzen Sie den bisherigen Wert in der Plesk-Erweiterung.
