VPS API Dokumentation, REST API zum Erstellen und Verwalten von Servern

Was Sie mit der API tun können

Die API ist für den Fall gedacht, dass Sie viele Server verwalten oder die Bereitstellung automatisieren möchten. Laden Sie die Listen der Tarife, Regionen und Images; wenn Sie einen Server erstellen, wird die Zahlung verarbeitet und Ihr Server nach Bestätigung erstellt. Es gelten dieselben Regeln wie auf den Webseiten, sodass Server, die mit der API erstellt wurden, auch in der Serverliste Ihres Kontos erscheinen.

Wenn Sie neu einsteigen, folgen Sie der API Schnellstartanleitung Schritt für Schritt, vom Erstellen des Keys bis zum ersten Server. Diese Seite ist die Referenz mit allen Endpunkten und Feldern an einem Ort.

Basis-URL

Alle Anfragen gehen an die folgende Adresse mit angehängtem Pfad. Anfrage- und Antwortinhalte sind durchgehend JSON (UTF-8).

https://helpervps.com/api/v1

Authentifizierung

Senden Sie den Header Authorization: Bearer YOUR_API_KEY. Sie können einen Schlüssel nach Ihrer ersten Zahlung im Menü API-Schlüssel Ihres Kontos erstellen; Schlüssel beginnen mit hvp_. Der vollständige Schlüssel wird nur einmal direkt nach der Erstellung angezeigt, und das Erstellen eines neuen Schlüssels deaktiviert den alten sofort.

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Anfragelimits

Servercode

Server werden nicht über Nummern, sondern über Servercodes wie S-7K2M-9QX4-HB3T unterschieden. Setzen Sie den id-Wert aus der Serverliste oder der Erstellungsantwort einfach in den Pfad ein. Groß- und Kleinschreibung spielt keine Rolle.

GET /catalog

Liefert in einem Aufruf die angebotenen Tarife (plans), Regionen (locations), Images (images) und Zusatzoptionen (addons). Alle Codes, die Sie beim Erstellen eines Servers angeben, stammen von hier. monthly ist der Monatspreis in US-Dollar, nicht angebotene Optionen kommen als null. Bei der Zusatzfestplatte wird monthly_per_gb mit drei Nachkommastellen angezeigt.

Anfragebeispiel

curl https://helpervps.com/api/v1/catalog \
  -H "Authorization: Bearer YOUR_API_KEY"

Antwortbeispiel

{
  "plans": [
    { "code": "s2", "type": "basic", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "transfer_tb": 2, "monthly": "2.48" }
  ],
  "locations": ["frankfurt", "singapore", "seoul"],
  "images": ["ubuntu-24-04", "debian-13", "almalinux-10", "app-docker"],
  "addons": {
    "backups": { "percent_of_plan": 5.6 },
    "extra_disk": { "sizes_gb": [50, 100, 250, 500, 1000], "monthly_per_gb": "0.028" },
    "ddos_protection": { "monthly": "1.68" }
  }
}

GET /servers

Liefert Ihre Serverliste, die zuletzt erstellten zuerst. Gelöschte oder nicht erstellte Server sind nicht enthalten.

Anfragebeispiel

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Antwortbeispiel

[
  {
    "id": "S-7K2M-9QX4-HB3T",
    "label": "web-1",
    "state": "running",
    "ipv4": "192.0.2.15",
    "ipv6": "2001:db8::15",
    "monthly": "2.48",
    "backups": false,
    "extra_disk_gb": 0,
    "ddos_protection": false,
    "paid_until": "2026-11-18T09:00:00.000Z"
  }
]

POST /servers

Erstellt einen Server und verarbeitet die Zahlung. Verwenden Sie die Katalogcodes für Tarif, Standort und Image unverändert. label kann bis zu 40 lateinische Buchstaben, Ziffern, Punkte und Bindestriche enthalten; andere Zeichen werden in Bindestriche umgewandelt. backups, extra_disk_gb und ddos_protection sind optional. Bei Erfolg erhalten Sie 201 mit den Serverdetails, und root_password ist einmalig in dieser Antwort enthalten (Sie können es auch 7 Tage lang auf der Serverseite Ihres Kontos einsehen).

Anfragebeispiel

curl -X POST https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1","backups":true,"extra_disk_gb":0,"ddos_protection":false}'

Antwortbeispiel

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "creating",
  "ipv4": null,
  "ipv6": null,
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z",
  "root_password": "..."
}

GET /servers/{id}

Liefert Status, Adressen, Monatspreis und Ablaufdatum der Abrechnung eines Servers. Ein neuer Server startet mit creating, wechselt nach der Bereitstellung zu running, und ipv4 sowie ipv6 werden befüllt. Eine Abfrage alle paar Sekunden reicht völlig.

Anfragebeispiel

curl https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Antwortbeispiel

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "running",
  "ipv4": "192.0.2.15",
  "ipv6": "2001:db8::15",
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z"
}

POST /servers/{id}/start (stop, reboot)

start schaltet einen gestoppten (stopped) Server ein, stop und reboot fahren einen laufenden (running) Server herunter oder starten ihn neu. Die Antwort enthält die aktualisierten Serverdaten.

Anfragebeispiel

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/reboot \
  -H "Authorization: Bearer YOUR_API_KEY"

Antwortbeispiel

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "rebooting",
  ...
}

POST /servers/{id}/renew

Bezahlen Sie jetzt, um den Gültigkeitszeitraum zu verlängern. Ein Server, der nach Ablauf gesperrt wurde, wird mit dieser Anfrage ebenfalls wieder aktiviert.

Anfragebeispiel

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/renew \
  -H "Authorization: Bearer YOUR_API_KEY"

Antwortbeispiel

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "running",
  "paid_until": "2026-12-18T09:00:00.000Z",
  ...
}

DELETE /servers/{id}

Löscht Server und Festplatte. Ab dem nächsten Abrechnungstag fallen keine Kosten mehr an; der Rest des bereits bezahlten Monats wird nicht erstattet.

Anfragebeispiel

curl -X DELETE https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Antwortbeispiel

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "deleted"
}

Felder der Serverantwort

Statuswerte

Fehler

Bei einem Fehler kommt ein Statuscode zusammen mit JSON der Form {"error": "code"} zurück. Steuern Sie die Verarbeitung anhand des Codes.

Weiterführende Anleitungen

Zahlungen erfolgen über das sichere PayGate-Kassensystem. Sie können auf der Serverseite Ihres Kontos eine Neuinstallation durchführen und ein neues root-Passwort erstellen; die Schritte finden Sie in der Anleitung zur Neuinstallation.

Was Sie mit der API tun können und Beispiele für Automatisierung finden Sie auf der Seite VPS API, die Monatspreise je Tarif auf der Preisseite.