Übersicht

Mit der Developer-API steuerst du deine Server per HTTP: Server lesen, starten und stoppen, Befehle senden, Backups anlegen und Git-Deployments auslösen. Du brauchst dafür ein Zugriffstoken oder einen Bot.

Basis und Format

Basis-URL: https://api.zenit-hosting.de/api/developer/v1
Version: v1 Innerhalb von v1 ändert sich nur Additives.
Format: JSON, Feldnamen in camelCase
Authentifizierung: Authorization: Bearer <Token>
Fehlerkörper: { code, message, requestId }
OpenAPI-Dokument: https://api.zenit-hosting.de/api/developer/v1/openapi.jsonohne Anmeldung abrufbar

Was die API kann

Server: auflisten und lesen, Ressourcen und Aktivität abrufen, starten, stoppen, neu starten und beenden, Konsolenbefehle senden.
Backups: auflisten und anlegen, auf Wunsch gesperrt.
Git: Quellen lesen, einen Deploy auslösen, Deployments und ihren Stand abfragen.
Bots: Installationen und Ereignisse abrufen und Ereignisse per Webhook empfangen. Das geht nur mit dem Token eines Bots.

Jeden Endpunkt mit Parametern, Antworten und Beispielen findest du in der API-Referenz.

Zwei Wege zur API

Zugriffstoken

Ein Zugriffstoken (Präfix zhp_) handelt als du. Es passt zu Skripten, CI und eigenen Werkzeugen. Du legst es in deinem Profil im Reiter „Zugriffstokens“ an, wählst die Rechte und optional Server und IP-Adressen. Es läuft immer ab, nach 90 Tagen oder einer Frist von höchstens 365 Tagen.

Bot

Ein Bot (Token-Präfix zhb_) ist eine eigene App mit Manifest: Er nennt seine Rechte und Ereignisse, der Besitzer eines Servers installiert ihn pro Server und stimmt den Rechten zu. Ein Bot kann einen Webhook bekommen und handelt nie mit mehr Rechten als der User, der ihn installiert hat. Bots legst du im Kundenbereich unter Entwickler an.

Nächste Schritte

Schnellstart: Token anlegen und den ersten Aufruf senden.
Authentifizierung: Präfixe, Ablauf, IP-Bindung und Widerruf.
Rechte: welches Recht welchen Aufruf erlaubt.
Bots und Manifest: Installation, Rechte und Bot-Token.
Webhooks prüfen: Ereignisse empfangen und die Signatur prüfen.