HELPER VPS

VPS API, Cloud Server per JSON REST automatisieren

Eine Cloud-Server-API, mit der Sie alles vom Erstellen bis zum Löschen per Code steuern

  • JSON REST API
  • Authentifizierung per API-Key (Bearer)
  • 300 Anfragen pro Minute

Eine VPS API ist eine programmatische Möglichkeit, die Arbeit zu erledigen, die Sie im Control Panel erledigen würden, wie das Erstellen, Starten, Stoppen und Löschen von Servern, mit HTTP-Anfragen. Die HELPER VPS Cloud Server API ist für alle Mitglieder kostenlos; nach Ihrer ersten Zahlung erstellen Sie einen API-Schlüssel und verbinden sich sofort.

  • REST API

    Alle Mitglieder

    Kostenlos

    Monatliche Abrechnung

    • JSON REST
    • API-Key (Bearer)
    • 300 pro Minute
    • Kostenlos
    Erste Schritte

Zu Anfragebeispielen und Antwortformat direkt API Dokumentation

Was können Sie mit der VPS API automatisieren?

Die VPS API entfaltet ihre Stärke, wenn Sie oft Server erstellen und löschen oder mehrere Server auf einmal verwalten. Hier vier häufige Automatisierungen.

Control Panel oder VPS API: wann was?

Das Control Panel und die API arbeiten mit demselben Konto und denselben Servern. Für die manuelle Verwaltung von ein oder zwei Servern ist das Control Panel praktisch; für wiederkehrende Aufgaben oder viele Server ist die API schneller.

Control Panel

Verwaltung per Klick in der Oberfläche

Empfohlen für

  • Wenn Sie zum ersten Mal einen Server erstellen
  • Wenn Sie ein, zwei Server selbst verwalten
  • Neuinstallation des Betriebssystems und Hinterlegen von SSH-Keys
  • Wenn Sie das root-Passwort erneut prüfen

VPS API

Verwaltung per Anfrage aus dem Code

Empfohlen für

  • Testumgebungen, in denen oft Server erstellt und gelöscht werden
  • Deployment-Pipelines und Skriptautomatisierung
  • Wenn Sie den Status mehrerer Server auf einmal lesen
  • Wenn Sie Ihre eigene Verwaltungsoberfläche oder einen Bot anbinden

Wie verbinden Sie sich mit der Cloud-Server-API?

Es sind drei Schritte erforderlich. Zuerst leisten Sie Ihre erste Zahlung, und sobald diese bestätigt ist, erstellen Sie einen Schlüssel auf der API-Schlüssel-Seite. Als Nächstes fügen Sie den Schlüssel in den Authorization-Header jeder Anfrage ein, indem Sie das Bearer-Schema verwenden. Schließlich senden Sie Anfragen an den gewünschten Pfad nach der Basisadresse https://helpervps.com/api/v1, und die Ergebnisse werden als JSON zurückgegeben.

Rufen Sie zu Beginn GET /catalog auf. Sie erhalten auf einmal verfügbare Servertypen und Größen, Regionscodes, Codes für Betriebssysteme und Ein-Klick-Apps sowie Preise für automatisches Backup, Zusatzfestplatte und DDoS-Schutz. Die erhaltenen Codes für plan, location und image setzen Sie unverändert in die Anfrage zum Erstellen ein.

Um einen Server zu erstellen, senden Sie die Werte für Plan, Standort, Image und Label als JSON an POST /servers. Sie können auch die ID eines hinzugefügten SSH-Schlüssels sowie die Optionen backups, extra_disk_gb und ddos_protection einbeziehen. Sie zahlen für den gewählten Zeitraum im Voraus, und die Antwort enthält die Server-ID, den Status und das Root-Passwort, speichern Sie diese daher sofort an einem sicheren Ort.

Welche Vorgänge erledigt die VPS API?

Die VPS API deckt den ganzen Lebenszyklus eines Servers ab. Mit GET /catalog lesen Sie den Katalog, mit POST /servers erstellen Sie Server, mit GET /servers lesen Sie Ihre Serverliste und mit GET /servers/{id} die Daten eines Servers. Die Antwort enthält Servername, Status, IPv4- und IPv6-Adressen, Monatspreis, gewählte Optionen und nächsten Abrechnungstag.

Den Strom schalten Sie mit POST /servers/{id}/start, stop und reboot ein, aus und neu. POST /servers/{id}/renew bezahlt den Monat sofort, ohne auf den Abrechnungstag zu warten, und verlängert direkt; DELETE /servers/{id} löscht den Server. Passt eine Anfrage nicht zum aktuellen Serverstatus, meldet der Code wrong_state dies, so entscheidet das Skript leicht über den nächsten Schritt.

Fehler kommen als JSON mit Statuscode und Wert error zurück. Falscher Key unauthorized, zu wenig Guthaben not_enough_balance, Serverlimit des Kontos erreicht limit, zu viele Anfragen rate_limited: Die Gründe sind nach Codes getrennt und im Programm leicht je Situation zu behandeln. Die vollständige Liste und Antwortbeispiele stehen in der API-Dokumentation.

Was kostet die VPS API?

Die VPS API ist für alle Mitglieder kostenlos. Server und Optionen, die mit der API erstellt werden, werden zu denselben Preisen wie Server bezahlt, die im Control Panel erstellt wurden.

HELPER VPS in Zahlen

Wählen Sie aus 40 Regionen, 12 Betriebssystemen und 10 Ein-Klick-Apps in einem Konto und bezahlen Sie sofort. Die Zahlen unten basieren auf dem aktuellen Angebot.

Automatisierungstools für die VPS API

Jedes Tool, das HTTP-Anfragen senden kann, verbindet sich mit der VPS API. Von einer curl-Zeile über Python- und Node.js-Skripte bis zu Deployment-Pipelines funktioniert es gleich.

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

Warum die API von HELPER VPS

Häufige Fragen zur VPS API

Antworten zu Verbindung, Authentifizierung und Anfragelimits der VPS API

Ist die VPS API kostenlos?

Ja, die VPS API ist für alle Mitglieder kostenlos. Die Ausstellung von API-Schlüsseln und das Stellen von Anfragen ist kostenlos, und Server und Optionen, die mit der API erstellt werden, werden zu denselben Preisen wie im Control Panel bezahlt. Jedes Mitglied, das seine erste Zahlung geleistet hat, kann sofort einen Schlüssel auf der API-Schlüssel-Seite erstellen.

Wo erstelle ich einen API-Key?

Sobald Sie Ihre erste Zahlung geleistet haben, öffnet sich die API-Schlüssel-Seite (/api-key) und Sie erstellen dort Schlüssel. Fügen Sie den Schlüssel in den Authorization-Header jeder Anfrage ein, indem Sie das Bearer-Schema verwenden. Der Schlüssel entsperrt Ihr gesamtes Konto, daher sollten Sie ihn nicht in Code-Repositorys ablegen; bewahren Sie ihn in Umgebungsvariablen oder einem Secret-Speicher auf.

Welche Vorgänge kann ich per API erledigen?

Katalog lesen (GET /catalog), Serverliste und Daten eines Servers lesen (GET /servers, GET /servers/{id}), Server erstellen (POST /servers), ein- und ausschalten und neu starten (start, stop, reboot), um einen Monat verlängern (renew) und löschen (DELETE /servers/{id}). Anfragebeispiele und Antwortformat stehen in der API-Dokumentation.

Wie hoch ist das Anfragelimit?

Bis zu 300 Anfragen pro Minute mit einem Key. Darüber kommen Statuscode 429 und der Fehler rate_limited zurück; lassen Sie Ihr Skript kurz warten und erneut senden. Alltägliche Automatisierung wie Prüfung der Serverliste und Stromsteuerung läuft locker innerhalb dieses Limits. Kosten nach Anfragezahl gibt es nicht.

Wie werden Kosten für per API erstellte Server abgebucht?

Wenn eine POST /servers-Anfrage erfolgreich ist, wird die Zahlung für Ihren gewählten Abrechnungszeitraum verarbeitet und der Server erstellt. Die Zahlung für einen Server, dessen Erstellung fehlschlägt, wird auf Ihr Guthaben zurückerstattet.

Wie erhalte ich das root-Passwort per API?

Der Wert root_password ist einmalig in der Antwort auf die Erstellungsanfrage enthalten. Speichern Sie ihn sofort nach Erhalt an einem sicheren Ort. Im Control Panel ist er zudem 7 Tage sichtbar; senden Sie eine SSH-Key-Nummer mit, verbinden Sie sich direkt per Key ohne Passwort. Mit dem Wert ipv4 der Antwort starten Sie sofort die SSH-Verbindung, ideal für Deployment-Skripte.

Kann ich SSH-Keys per API einfügen?

Ja, tragen Sie in der Erstellungsanfrage im Wert ssh_key_id die Nummer eines hinterlegten SSH-Keys ein, wird dieser Key auf dem neuen Server installiert. Hinterlegen Sie den Key einmal im Bereich SSH-Keys des Control Panels; der Fingerabdruck wird wie bei ssh-keygen angezeigt, Sie erkennen den Key sofort. Legen Sie die Nummer einmal fest und verwenden Sie sie wieder.

Mit welchen Sprachen und Tools kann ich sie nutzen?

Mit jeder Sprache und jedem Tool, das HTTP-Anfragen senden kann. Testen Sie sofort mit curl und rufen Sie dieselbe Adresse mit denselben Headern aus requests in Python, fetch in Node.js, Skriptschritten in GitLab CI oder HTTP-Anfragen in Terraform auf. Alle Antworten sind JSON und leicht zu lesen.

Wie erkenne ich einen Fehler?

Fehler kommen mit einem Statuscode außerhalb von 2xx und JSON mit dem Wert error zurück. Falscher Key unauthorized, fehlender Wert bad_request, zu wenig Guthaben not_enough_balance, Anfrage passt nicht zum Serverstatus wrong_state: Die Gründe sind getrennt, Ihr Programm behandelt jede Situation.

Erscheinen per API erstellte Server auch im Control Panel?

Ja, API und Control Panel bedienen dasselbe Konto und dieselben Server. Per API erstellte Server erscheinen unverändert in der Liste des Control Panels, wo Sie das Betriebssystem neu installieren oder das Passwort prüfen. Das Limit von 10 Servern pro Konto gilt für beide Wege. Auch wenn Sie manuelle und programmierte Arbeit mischen, sehen Status und Abrechnungstage stets gleich aus.

Anleitungen zur VPS API

Anleitungen für die erste Anbindung der API

Die VPS API ist für alle Mitglieder kostenlos, und Sie können einen API-Schlüssel erstellen, nachdem Sie Ihre erste Zahlung geleistet haben. Server und Optionen, die mit der API erstellt werden, werden zu denselben Preisen wie in der Preisliste bezahlt und verlängern sich automatisch zum selben Betrag an jedem Abrechnungsdatum.

Anfragelimit: 300 pro Minute pro API-Schlüssel | 10 Server pro Konto | Wenn die Zahlung fehlschlägt: Server gesperrt, dann 3 Tage später gelöscht | Die Restlaufzeit gelöschter Server wird nicht erstattet. Erstattungen werden auf Ihr Guthaben gutgeschrieben.