Kinsta API

Die REST-API (Application Programming Interface) von Kinsta ist ein leistungsfähiges Werkzeug, das Entwicklern den einfachen Zugriff auf und die Interaktion mit deinem Kinsta-Konto und deinen Projekten ermöglicht. Unsere API bietet eine optimierte und effiziente Möglichkeit, mit unserer Plattform zu arbeiten und Daten abzurufen, Aktionen durchzuführen und Aufgaben zu automatisieren.

Alle Details zu den verfügbaren API-Endpunkten, die OpenAPI-Spezifikation zum Herunterladen und das Ausprobieren der Endpunkte findest du in unserer API-Referenz.

Um dich mit anderen Entwicklern auszutauschen und ausführliche Anleitungen, Tipps und Best Practices zur Nutzung der Kinsta-REST-API zu finden, besuche die Kategorie Kinsta-API in unserem Kinsta-Community-Forum.

Voraussetzungen

Um die Kinsta-API nutzen zu können, brauchst du ein Konto und mindestens eine WordPress-Site, -Anwendung oder -Datenbank in MyKinsta. Außerdem musst du einen API-Schlüssel erstellen, um dich zu authentifizieren und über die API auf dein Konto zuzugreifen.

Authentifizierung und Benutzerzugriff (API-Schlüssel)

Um mit deinem Konto auf die API zugreifen und sie nutzen zu können, musst du zunächst einen API-Schlüssel in MyKinsta erstellen. Gehe dazu auf die Seite API-Schlüssel (Dein Name > Unternehmenseinstellungen > API-Schlüssel) und klicke auf API-Schlüssel erstellen.

1. Wähle ein Ablaufdatum oder lege ein benutzerdefiniertes Startdatum und die Anzahl der Stunden fest, nach denen der Schlüssel abläuft.
2. Gib dem Schlüssel einen Namen.
3. Klicke auf Erzeugen.

Wenn der API-Schlüssel bereitgestellt wird, ist dies das einzige Mal, dass du ihn sehen kannst. Stelle sicher, dass du ihn kopierst und an einem sicheren Ort aufbewahrst.

Betriebseigentümer, Betriebsadministratoren und Betriebsentwickler können API-Schlüssel erstellen. Die Zugriffsstufe auf die API hängt von der Zugangsberechtigung des Nutzers ab. Ein API-Schlüssel, der von einem Unternehmensentwickler erstellt wurde, hat zum Beispiel nicht den gleichen Zugang wie ein Schlüssel, der von einem Unternehmensinhaber oder Administrator erstellt wurde.

Du kannst mehrere API-Schlüssel erstellen, die auf der Seite API-Schlüssel aufgelistet sind. Wenn du einen API-Schlüssel widerrufen musst, klicke auf Widerruf neben dem Schlüssel, den du widerrufen möchtest.

API Endpunkte

Mit der API von Kinsta kannst du Folgendes machen:

WordPress Hosting

• Hol dir eine Liste der WordPress-Seiten deines Unternehmens, Details zu einer bestimmten Seite und Infos zur Umgebung einer Seite.
• Erstell eine neue WordPress-Seite, kopier eine bestehende Seite, erstell eine leere Seite ohne WordPress und lösch eine Seite.
• Erstell eine neue Staging-Seite, schick eine Staging-Umgebung live und lösch eine Staging-Umgebung.
• Leer den Cache einer Seite, start PHP neu und aktualisier es und hol dir eine Liste der abgelehnten IP-Adressen.
• Hol dir eine Liste der Plugins und Themes deiner Seite und aktualisiere sie.
• Füge eine Domain hinzu oder entferne sie.
• Leere den Edge-Cache und den CDN-Cache auf deiner Seite.
• Hol dir eine Liste der Backups deiner Seite und eine Liste der herunterladbaren Backups, stelle ein Backup auf deiner Seite wieder her und lösche ein Backup.
• Hol dir die Logdateien der Seite.

Statisches Seiten-Hosting

• Hol dir eine Liste der statischen Seiten deines Unternehmens und Details zu einer bestimmten Seite, aktualisiere die Einstellungen deiner Seite und lösche eine Seite.
• Hol dir die Bereitstellungsdetails einer statischen Seite und stell deine Seite manuell oder programmgesteuert bereit.

Anwendungs-Hosting

• Hol dir eine Liste der Anwendungen deines Unternehmens und Details zu einer bestimmten Anwendung, einschließlich der Bereitstellungsdetails und -prozesse, aktualisiere die Einstellungen der Anwendung und lösche eine Anwendung.
• Hol dir die Bereitstellungsdetails einer Anwendung und stell deine Anwendung manuell oder programmgesteuert bereit.
• Hol dir Infos aus den Analytics deiner Anwendung.
• Erstell eine interne Verbindung zwischen deiner Anwendung und der Datenbank.
• Aktiviere CDN und Edge-Caching und leere den Cache für beide.

Datenbank-Hosting

• Hol dir eine Liste der Datenbanken deines Unternehmens und Infos zu einer bestimmten Datenbank, leg eine neue Datenbank an, aktualisier die Datenbank-Einstellungen und lösche eine Datenbank.

Unternehmen

• Hol dir eine Liste der Nutzer deines Unternehmens, einschließlich ihrer E-Mail-Adressen, vollständigen Namen und Links zu ihren Profilbildern.

Häufige Anwendungsfälle

Reporting

APIs können zum Lesen von Daten verwendet werden, damit du deine eigenen Berichte erstellen oder Kinsta-Leistungen in deine internen Tracking-Systeme integrieren kannst. Wenn du beispielsweise eine Agentur betreibst und eine Anwendung verwendest, die alle deine Kunden auflistet, kannst du die API verwenden, um alle von Kinsta gehosteten WordPress-Seiten, Anwendungen und Datenbanken aufzulisten, die zu jedem Kunden gehören.

Geplante Aufgaben

Du kannst deine eigene Anwendung erstellen, um Aufgaben zu planen, die über Nacht ausgeführt werden und die Leistung deiner Seite beeinträchtigen oder Ausfallzeiten verursachen können. Beispielsweise kann das Leeren des Seiten-Caches über Nacht dazu beitragen, Störungen für die Besucher deiner Seite zu minimieren.

Seite verwalten

Mit Node.js und der API kannst du einen Slackbot für die Seitenverwaltung erstellen, um Zeit zu sparen und deine Seiten effizienter zu verwalten. Du kannst den Slackbot für Aufgaben wie die Überprüfung des Seitenstatus, das Leeren des Seiten-Caches und das Neustarten der PHP-Engine einer Seite verwenden.

Erstellung einer WordPress-Seite

Du kannst über die API automatisch eine neue WordPress-Seite hinzufügen/installieren. Wenn du zum Beispiel eine Agentur betreibst und den Prozess der Seitenerstellung automatisieren möchtest, ohne dich jedes Mal bei MyKinsta anmelden zu müssen, kannst du die API verwenden, um die Seite zu erstellen und WooCommerce, Yoast SEO und Easy Digital Downloads zu installieren.

Du kannst auch eine WordPress-Multisite-Installation (is_multisite TRUE) machen und eine Subdomain (is_subdomain_multisite TRUE) oder ein Unterverzeichnis (is_subdomain_multisite FALSE) einrichten.

Um zu sehen, ob die Seite erstellt wurde, check einfach den Operations-Endpunkt.

Vorgangsstatus prüfen

Bei potenziell langwierigen Vorgängen (z. B. Website-Erstellung, Löschen des Cache, Neustart von PHP usw.) antwortet die API nicht sofort mit dem Ergebnis. So kannst du verhindern, dass ein Server-Thread oder ein Gateway-Timeout blockiert wird, weil ein Vorgang lange dauert.

Um den Status eines Vorgangs zu überprüfen, verwendest du den Endpunkt /operations. Wenn du einen Vorgang startest, enthält die unmittelbare Antwort der API eine operation_id, die du mit dem Endpunkt /operations verwenden kannst. Weitere Einzelheiten und Beispiele findest du in der Referenz für Vorgänge.

Ratenbegrenzung

Um unsere API vor zu vielen Anfragen zu schützen, ist die Anzahl der Anfragen pro Minute auf Folgendes begrenzt:

• 120 Anfragen pro Minute pro Unternehmens-ID, die über den API-Schlüssel erkannt wird.
• 1000 Anfragen pro Minute pro IP-Adresse. Das gilt, wenn du Zugriff auf mehrere Unternehmen hast.
• 5 Anfragen pro Minute für die Erstellung von Ressourcen, zum Beispiel beim Erstellen einer WordPress-Seite.

Um zu sehen, wie viele Anfragen du gerade machen darfst, check die RateLimit-Header in der letzten API-Antwort. Im Moment kannst du die Rate Limit nicht erhöhen.

Fehlersuche

Wenn du eine Anfrage an einen Endpunkt stellst, auf den dein API-Schlüssel keinen Zugriff hat, erhältst du eine Fehlermeldung, die dir mitteilt, dass du keinen Zugriff hast. Wenn du Zugang zu diesem Endpunkt brauchst, muss ein Firmeninhaber oder Administrator einen API-Schlüssel für dich erstellen.

API-Referenz

Ausführliche Informationen zu den verfügbaren API-Endpunkten, zum Herunterladen unserer OpenAPI-Spezifikation und zum Ausprobieren der Endpunkte findest du in unserer API-Referenz.