Die Funktion „API-Tokens“ in cPanel ermöglicht es Ihnen, API-Tokens zu erstellen, aufzulisten, zu aktualisieren und zu widerrufen. Diese Funktion befindet sich derzeit in der Testphase und kann sich noch ändern.
Sie können API-Tokens ausstellen, um anderen die Ausführung von API-Funktionen mit den Daten Ihres Kontos zu ermöglichen.
Beispielsweise könnten Sie einem Reseller ein API-Token ausstellen. Der Reseller könnte dieses Token nutzen, um den Speicherplatzverbrauch zu überprüfen.
Hinweis: API-Tokens führen UAPI-Funktionen und cPanel API 2-Funktionen aus, jedoch keine Funktionen der cPanel API 1.
Verwenden Sie API-Tokens, um API-Funktionen über die Kommandozeile auszuführen.
Weitere Informationen finden Sie in der cPanel-Dokumentation zu „So verwenden Sie cPanel API-Tokens“.
Weitere Informationen zur Verwendung von API-Funktionen finden Sie in cPanels Quickstart Development Guide.
Ein API-Token erstellen
So erstellen Sie ein API-Token:
1) Klicken Sie auf „Erstellen“. Die Oberfläche „API-Token erstellen“ wird angezeigt.
2) Geben Sie einen eindeutigen Namen in das Textfeld „API-Token-Name“ ein.
Hinweis: Ein API-Token-Name darf maximal 50 Zeichen enthalten.
Erlaubt sind nur Buchstaben (a - z und A - Z), Zahlen (0 - 9), Bindestriche ( - ) und Unterstriche ( _ ).
3) Wählen Sie im Abschnitt „Soll das API-Token ablaufen?“ eine der folgenden Optionen aus:
Das API-Token läuft nicht ab. – Erstellt ein Token ohne Ablaufdatum.
Ablaufdatum festlegen. – Erlaubt Ihnen, ein Ablaufdatum für das Token zu definieren. Standardmäßig läuft das Token ein Jahr ab dem aktuellen Datum ab. Wenn Sie diese Option wählen, erscheint der Abschnitt „Ablaufdatum des API-Tokens“. Verwenden Sie das Kalender-Symbol (Kalender), um ein Datum auszuwählen, oder geben Sie ein Datum im Format YYYY-MM-DD ein. Das Token läuft am ausgewählten Tag um 23:59:59 Uhr Serverzeit ab.
Wichtig: Sie können das Ablaufdatum eines API-Tokens nach dem Erstellen nicht mehr ändern.
Wenn ein API-Token abläuft, wird es nicht automatisch entfernt. Sie müssen es manuell löschen.
4) Klicken Sie auf „Erstellen“. Eine neue Oberfläche wird angezeigt.
5) Um das API-Token zu kopieren, klicken Sie auf „Kopieren“. Behandeln Sie dieses Token wie ein Passwort. Es muss jedes Mal eingegeben werden, wenn Sie es verwenden.
Warnung: Sie können das Token nicht erneut anzeigen, nachdem Sie die Seite verlassen haben. Wenn Sie das Token vergessen oder verlieren, müssen Sie es widerrufen und ein neues erstellen.
6) Klicken Sie auf „Ja, ich habe mein Token gespeichert“.
Um direkt ein weiteres Token zu erstellen, aktivieren Sie das Kontrollkästchen „Ein weiteres Token erstellen, nachdem ich auf ‚Ja, ich habe mein Token gespeichert‘ geklickt habe“.
Um zur Liste der API-Tokens zurückzukehren, deaktivieren Sie das Kontrollkästchen.
Die API-Token-Tabelle
Diese Tabelle zeigt alle Ihre API-Tokens an. Sie können folgende Aktionen durchführen:
Um mehr Tokens pro Seite anzuzeigen, klicken Sie auf das Zahnradsymbol (Einstellungen) und wählen eine Anzahl aus.
Um mehrere Tokens zu widerrufen:
1) Aktivieren Sie die Kontrollkästchen der Tokens, die widerrufen werden sollen. Um alle Tokens auszuwählen, aktivieren Sie das oberste Kontrollkästchen.
2) Klicken Sie auf „Widerrufen“. Eine Bestätigungsmeldung erscheint.
3) Klicken Sie auf „Ausgewählte API-Tokens widerrufen“.
Die API-Token-Tabelle enthält folgende Informationen:
Token-Name – Der Name des API-Tokens.
Erstellt – Datum und Uhrzeit der Erstellung.
Läuft ab – Falls ein Ablaufdatum vorhanden ist, wird es hier angezeigt:
Wenn ein Token bald abläuft, wird die Zeile gelb hervorgehoben und ein Hinweis-Icon eingeblendet.
Abgelaufene Tokens werden rot hervorgehoben und ebenfalls mit einem Hinweis-Icon versehen.
Wenn ein API-Token abläuft, wird es nicht automatisch entfernt. Sie müssen es manuell löschen.
Verwalten – Klicken Sie auf „Verwalten“, um eine neue Oberfläche zu öffnen, in der Sie folgende Aktionen durchführen können:
Token umbenennen – Weisen Sie dem Token einen neuen Namen zu.
Token widerrufen – Löschen Sie das Token und verhindern Sie den Zugriff auf den Server oder API-Funktionen.
Ein API-Token verwalten
Um ein API-Token zu verwalten, suchen Sie das Token in der Tabelle und klicken Sie auf „Verwalten“. Die Verwaltungsoberfläche wird geöffnet.
Token umbenennen
Geben Sie im Feld „Neuer API-Token-Name“ einen neuen Namen ein und klicken Sie dann auf „Aktualisieren“.
Token widerrufen
Warnung: Wenn Sie ein API-Token widerrufen, können Benutzer keine Skripte oder API-Funktionen mehr mit diesem Token ausführen.
So widerrufen Sie ein API-Token:
1) Klicken Sie auf „Widerrufen“. Eine Bestätigungsmeldung erscheint.
2) Klicken Sie auf „Ja, Token widerrufen“, um das Token zu löschen.
Hinweis: Um ein API-Token über die Kommandozeile zu entfernen, verwenden Sie die UAPI-Funktion Tokens::revoke.
