Allgemein
Authentifizierung
Jeder Endpoint dieser Dokumentation verlangt einen API Key, auch die Preislisten und die Verfügbarkeitsprüfung. Den Key findest du im Kundenbereich unter API. Er beginnt immer mit bkkt_ und wird bei jeder Anfrage im Header mitgeschickt.
Authorization | Bearer DEIN_API_KEY (erforderlich bei jeder Anfrage) |
Content-Type | application/json (erforderlich bei POST und PUT mit Request Body) |
Accept | application/json (optional, die API antwortet immer mit JSON) |
curl "https://Bukkit-Hosting.eu/api/v1/server/list" \
-H "Authorization: Bearer DEIN_API_KEY"
Alle Pfade in dieser Dokumentation beziehen sich auf die Base URL https://Bukkit-Hosting.eu/api/v1. Aus /server/list wird also https://Bukkit-Hosting.eu/api/v1/server/list.
Aufbau einer Antwort
Jede Antwort ist ein JSON Objekt mit denselben drei Feldern. Ob eine Anfrage geklappt hat, erkennst du am HTTP Statuscode und am Feld state.
state | success wenn die Anfrage ausgeführt wurde, error bei einem Fehler |
message | Kurze Meldung in englischer Sprache. Bei Erfolg meist OK, bei einem Fehler der Grund |
data | Die eigentlichen Nutzdaten. Das Feld fehlt komplett, wenn eine Aktion keine Daten zurückgibt (zum Beispiel beim Starten eines Servers) |
{
"state": "success",
"message": "OK",
"data": { ... }
}
{
"state": "error",
"message": "Server not found"
}
Einzige Ausnahme ist /domain/pricelist. Dort heißt das Feld für die Meldung response statt message.
Datenformate
id | Produkte und Pakete werden über eine UUID angesprochen, zum Beispiel 019d78b5-1e34-822f-97c1-4103528065ef |
price | Preise sind Text mit zwei Nachkommastellen und Punkt als Trennzeichen, immer in EUR, zum Beispiel "17.99" |
duration | Laufzeit in Monaten |
expire_at | Datum und Uhrzeit im Format JJJJ-MM-TT HH:MM:SS, deutsche Zeit (Europe/Berlin) |
auto_renew | Automatische Verlängerung aus dem Guthaben, bei allen Produkten und Endpoints immer als Zahl. 1 = aktiv: kurz vor Ablauf wird das Produkt automatisch um seine Laufzeit verlängert und der Preis vom Guthaben abgebucht. Reicht das Guthaben nicht, wird nicht verlängert und du bekommst eine E Mail. 0 = aus: das Produkt läuft am Ablaufdatum aus, wenn du es nicht selbst verlängerst. Bei Eingaben gilt dasselbe, 1 für aktiv und 0 für aus |
| Guthaben | Alle Bestellungen und Verlängerungen werden sofort aus deinem Guthaben bezahlt. Reicht das Guthaben nicht, kommt Status 402 und es wird nichts ausgeführt |
| Freigaben | Server und Domains, die dir von einem anderen Kunden freigegeben wurden, kannst du über die API verwalten. Verlängern, den AuthCode abrufen und die automatische Verlängerung ändern darf nur der Inhaber |
Rate Limit
Pro API Key sind 120 Anfragen innerhalb von 60 Sekunden erlaubt. Bei Bedarf kann das Limit über den Support erhöht werden. Jede Antwort enthält den aktuellen Stand im Header.
X-RateLimit-Limit | Erlaubte Anfragen pro 60 Sekunden |
X-RateLimit-Remaining | Wie viele Anfragen im aktuellen Zeitfenster noch übrig sind |
Retry-After | Nur bei Status 429: Sekunden, nach denen du es erneut versuchen kannst |
HTTP Statuscodes
200 | Anfrage erfolgreich ausgeführt |
400 | Anfrage nicht ausführbar, zum Beispiel falscher Zustand des Produkts, ungültige Werte oder ungültiges JSON im Request Body |
401 | API Key fehlt oder ist ungültig |
402 | Nicht genug Guthaben. Die Meldung nennt den benötigten Betrag |
403 | Kein Zugriff auf dieses Produkt, Aktion nur für den Inhaber erlaubt oder Account nicht aktiv |
404 | Produkt, Paket oder Endpoint nicht gefunden |
405 | HTTP Methode wird nicht unterstützt |
409 | Konflikt mit dem aktuellen Zustand, zum Beispiel Domain bereits vorhanden oder gerade in Bearbeitung |
422 | Pflichtfeld fehlt oder ein Wert hat das falsche Format. Die Meldung nennt das betroffene Feld |
429 | Rate Limit erreicht |
500 | Interner Fehler. Bitte den Support mit Uhrzeit und Endpoint kontaktieren |
501 | Die Aktion ist für dieses Produkt nicht verfügbar |
502 | Ein angebundenes System (Registrar oder Nameserver) hat nicht oder fehlerhaft geantwortet. Die Anfrage kann später wiederholt werden |
503 | Für dieses Produkt ist gerade kein Host verfügbar |
Server
/server/list
Auth
Alle eigenen KVM Server auflisten, neueste zuerst. Gelöschte Server erscheinen nicht. Server, die dir nur freigegeben wurden, sind hier nicht enthalten, lassen sich aber direkt über ihre ID abrufen.
Keine Parameter.
servers | Liste deiner Server, leer wenn du keine Server hast |
id | UUID des Servers, wird für alle Endpoints unter /server/{id} gebraucht |
type | CPU Typ: epyc, ryzen oder xeon. Ältere Server ohne Typ erscheinen als legacy |
state | install = wird gerade eingerichtet, active = läuft normal, reinstall = wird gerade neu installiert |
price | Preis pro Laufzeit in EUR, wird bei jeder Verlängerung berechnet |
duration | Laufzeit in Monaten |
expire_at | Ende der bezahlten Laufzeit |
created_at | Zeitpunkt der Bestellung |
custom_name | Anzeigename des Servers |
auto_renew | 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
{
"state": "success",
"message": "OK",
"data": {
"servers": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"type": "epyc",
"state": "active",
"price": "17.99",
"duration": 1,
"expire_at": "2026-08-10 20:43:48",
"created_at": "2026-07-10 20:43:48",
"custom_name": "KVM Server",
"auto_renew": 0
}
]
}
}
/server/os
Auth
Verfügbare Betriebssysteme für Bestellung und Neuinstallation
Keine Parameter.
operating_systems | Liste aller installierbaren Betriebssysteme |
proxmox_id | ID des Betriebssystems. Diesen Wert gibst du bei /order/server und /server/{id}/reinstall im Feld os an |
name | Lesbarer Name des Betriebssystems |
{
"state": "success",
"message": "OK",
"data": {
"operating_systems": [
{
"proxmox_id": "debian-13",
"name": "Debian 13"
}
]
}
}
Für Windows braucht der Server mindestens 50 GB Speicher.
/server/{id}
Auth
Details, Hardware, Adressen und Live Werte eines Servers abrufen
id | UUID des Servers aus /server/list (erforderlich) |
id | UUID des Servers |
type | CPU Typ: epyc, ryzen, xeon oder legacy |
state | install, active oder reinstall |
custom_name | Anzeigename des Servers |
price | Preis pro Laufzeit in EUR |
expire_at | Ende der bezahlten Laufzeit |
auto_renew | 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
hardware.cores | Anzahl CPU Kerne |
hardware.memory_mb | Arbeitsspeicher in MB |
hardware.disk_gb | Gebuchter Speicher in GB |
hardware.connection | Bandbreitenlimit der Netzwerkkarte in MB/s, 1260 entspricht rund 10 Gbit/s geteilt |
network.ipv4 | Haupt IPv4 Adresse, null solange noch keine vergeben ist |
network.ipv6 | Haupt IPv6 Adresse, null solange noch keine vergeben ist |
status | running = läuft, stopped = ausgeschaltet, unknown = der Server konnte nicht abgefragt werden |
os | Installiertes Betriebssystem. Direkt nach der Bestellung steht hier Nach Neuinstallation sichtbar |
stats | Live Werte. Fehlt komplett, wenn der Server nicht abgefragt werden konnte |
stats.cpu_percent | Aktuelle CPU Auslastung in Prozent |
stats.memory_used_mb | Belegter Arbeitsspeicher in MB |
stats.memory_total_mb | Verfügbarer Arbeitsspeicher in MB |
stats.uptime_seconds | Laufzeit seit dem letzten Start in Sekunden |
stats.disk_total_gb | Größe aller Dateisysteme in GB. Nur vorhanden, wenn im Server der QEMU Guest Agent läuft |
stats.disk_used_gb | Belegter Speicher aller Dateisysteme in GB. Nur mit QEMU Guest Agent |
{
"state": "success",
"message": "OK",
"data": {
"id": "019d78b5-1e34-822f-97c1-4103528065ef",
"type": "ryzen",
"state": "active",
"custom_name": "Test",
"price": "17.99",
"expire_at": "2026-08-10 20:43:48",
"auto_renew": 0,
"hardware": {
"cores": 4,
"memory_mb": 16384,
"disk_gb": 150,
"connection": 1260
},
"network": {
"ipv4": "5.175.176.21",
"ipv6": "2a06:1283:890b:a21::"
},
"status": "running",
"os": "Debian 11 (Bullseye)",
"stats": {
"cpu_percent": 0,
"memory_used_mb": 1480.91,
"memory_total_mb": 16384,
"uptime_seconds": 688637,
"disk_total_gb": 150,
"disk_used_gb": 38.42
}
}
}
404 | Server not found: Die ID gibt es nicht oder der Server wurde gelöscht |
403 | No access to this server: Der Server gehört dir nicht und ist dir nicht freigegeben |
400 | Product is not a server: Die ID gehört zu einem anderen Produkt |
/server/{id}/status
Auth
Schnellstatus des Servers mit Laufzeit und aktuellen Ressourcenwerten. Schneller als /server/{id}, gut geeignet für regelmäßige Abfragen.
id | UUID des Servers (erforderlich) |
status | running, stopped oder unknown |
uptime | Laufzeit seit dem letzten Start in Sekunden, 0 wenn der Server aus ist |
cpu_percent | Aktuelle CPU Auslastung in Prozent |
memory_used_mb | Belegter Arbeitsspeicher in MB |
error | Nur vorhanden, wenn der Server nicht erreichbar war. Dann steht status auf unknown und die übrigen Werte fehlen |
{
"state": "success",
"message": "OK",
"data": {
"status": "running",
"uptime": 261355,
"cpu_percent": 0.29,
"memory_used_mb": 508.88
}
}
{
"state": "success",
"message": "OK",
"data": {
"status": "unknown",
"error": "Could not reach server"
}
}
/server/{id}/network
Auth
Alle Adressen des Servers mit Gateway. Diese Werte brauchst du, wenn du das Netzwerk im Server selbst einrichtest.
id | UUID des Servers (erforderlich) |
ipv4 | Liste aller IPv4 Adressen des Servers |
ipv6 | Liste aller IPv6 Subnetze des Servers, immer als /64 |
ip | IPv4 Adresse oder IPv6 Subnetz des Servers |
gateway | Gateway der jeweiligen Adresse bzw. des Subnetzes |
type | main = Hauptadresse bzw. Hauptsubnetz |
type | extra = Zusätzliche Adresse bzw. zusätzliches Subnetz |
{
"state": "success",
"message": "OK",
"data": {
"ipv4": [
{
"ip": "127.0.0.100",
"gateway": "127.0.0.1",
"type": "main"
}
],
"ipv6": [
{
"ip": "2001:db8::/64",
"gateway": "2001:db8::1",
"type": "main"
}
]
}
}
/server/{id}/console
Auth
VNC Konsolenzugang im Browser. Damit erreichst du den Server auch dann, wenn das Netzwerk im Server nicht funktioniert.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
console_url | Link zur noVNC Konsole. Für jeden Aufruf wird eine neue Sitzung erzeugt, den Link also direkt öffnen und nicht speichern |
{
"state": "success",
"message": "OK",
"data": {
"console_url": "https://..."
}
}
400 | Server must be active to open console: Der Server wird gerade eingerichtet oder neu installiert |
500 | Failed to create console session: Die Sitzung konnte nicht erzeugt werden |
/server/{id}/start
Auth
Server starten. Der Befehl wird sofort abgesetzt, der Server braucht danach noch einige Sekunden bis er läuft. Den Fortschritt kannst du über /server/{id}/status abfragen.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
Kein Request Body. Bei Erfolg enthält die Antwort kein Feld data.
{
"state": "success",
"message": "Server is starting"
}
400 | Server is not in active state: Der Server wird gerade eingerichtet oder neu installiert |
400 | Server is already running: Der Server läuft bereits |
500 | Failed to start server: Der Startbefehl konnte nicht abgesetzt werden |
/server/{id}/stop
Auth
Server stoppen. Der Server wird sofort ausgeschaltet, vergleichbar mit dem Ziehen des Stromkabels. Für ein sauberes Herunterfahren den Server vorher im Betriebssystem herunterfahren.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
Kein Request Body. Bei Erfolg enthält die Antwort kein Feld data.
{
"state": "success",
"message": "Server is stopping"
}
400 | Server is not in active state: Der Server wird gerade eingerichtet oder neu installiert |
400 | Server is already stopped: Der Server ist bereits aus |
500 | Failed to stop server: Der Stoppbefehl konnte nicht abgesetzt werden |
/server/{id}/restart
Auth
Server neustarten. Der Server wird ausgeschaltet und danach automatisch wieder gestartet. Bis er wieder läuft, kann es einen Moment dauern.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein und sollte laufen |
Kein Request Body. Bei Erfolg enthält die Antwort kein Feld data.
{
"state": "success",
"message": "Server is restarting"
}
400 | Server is not in active state: Der Server wird gerade eingerichtet oder neu installiert |
500 | Failed to restart server: Der Neustart konnte nicht abgesetzt werden, zum Beispiel weil der Server schon aus ist. Dann /server/{id}/start verwenden |
/server/{id}/password
Auth
Root Passwort ändern. Das Passwort wird direkt im laufenden Server gesetzt, der Server muss dafür eingeschaltet sein.
id | UUID des Servers (erforderlich) |
password | Text. Neues Passwort, mindestens 8 Zeichen (erforderlich) |
{
"password": "NeuesPasswort123"
}
Bei Erfolg enthält die Antwort kein Feld data.
{
"state": "success",
"message": "Password changed successfully"
}
422 | Missing required parameters: password: Das Feld fehlt oder ist leer |
400 | Password must be at least 8 characters: Das Passwort ist zu kurz |
500 | Failed to change password: Das Passwort konnte nicht gesetzt werden, meist weil der Server aus ist |
/server/{id}/reinstall
Auth
Server mit einem neuen Betriebssystem neu installieren. Alle Daten auf dem Server werden dabei gelöscht. Adressen, Hardware und Laufzeit bleiben gleich. Der Server steht danach auf reinstall, bis die Installation fertig ist.
id | UUID des Servers (erforderlich) |
os | Text. Betriebssystem ID (proxmox_id) aus /server/os (erforderlich) |
password | Text. Neues Root Passwort (optional, wird automatisch erzeugt wenn nicht angegeben) |
{
"os": "debian-13",
"password": "NeuesPasswort123"
}
password | Root Passwort nach der Neuinstallation, entweder dein eigenes oder das automatisch erzeugte. Bitte sicher speichern |
{
"state": "success",
"message": "Server reinstallation queued",
"data": {
"password": "NeuesPasswort123"
}
}
422 | Missing required parameters: os: Das Feld fehlt |
400 | Server is already being reinstalled: Eine Neuinstallation läuft bereits |
400 | Invalid operating system: Die angegebene ID steht nicht in /server/os |
400 | Windows requires at least 50GB disk space: Der Server hat für Windows zu wenig Speicher |
/server/{id}/renew
Auth
Server um seine Laufzeit verlängern. Der Preis aus price wird sofort vom Guthaben abgebucht, das neue Ende wird vom bisherigen Ablaufdatum aus gerechnet. Nur der Inhaber darf verlängern.
id | UUID des Servers (erforderlich) |
Kein Request Body.
new_expire_at | Neues Ende der bezahlten Laufzeit |
charged | Abgebuchter Betrag in EUR |
{
"state": "success",
"message": "Server renewed successfully",
"data": {
"new_expire_at": "2026-09-10 20:43:48",
"charged": "17.99"
}
}
403 | Only the owner can renew: Der Server ist dir nur freigegeben |
402 | Insufficient balance. Required: 17.99 EUR, Available: 5.00 EUR: Nicht genug Guthaben |
/server/{id}/auto-renew
Auth
Automatische Verlängerung aktivieren oder deaktivieren. Ist sie aktiv, wird der Server kurz vor Ablauf automatisch aus dem Guthaben verlängert, sofern genug Guthaben vorhanden ist. Nur der Inhaber darf das ändern.
id | UUID des Servers (erforderlich) |
enabled | Zahl. 1 = automatische Verlängerung aktivieren, 0 = automatische Verlängerung deaktivieren (optional; ohne Angabe wird der aktuelle Wert umgeschaltet, aus 1 wird 0 und umgekehrt) |
{
"enabled": 1
}
auto_renew | Neuer Wert: 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
{
"state": "success",
"message": "Auto-renew enabled",
"data": {
"auto_renew": 1
}
}
403 | Only the owner can change auto-renew: Der Server ist dir nur freigegeben |
/server/{id}/traffic
Auth
Netzwerk Traffic des Servers über einen Zeitraum, passend für eigene Diagramme
id | UUID des Servers (erforderlich) |
period | Zeitraum: hour, day, week, month, year (optional, default: hour) |
GET /server/{id}/traffic?period=day
period | Der angefragte Zeitraum |
unit | Einheit der Werte, immer bit/s |
time | Zeitpunkte als Unix Zeitstempel in Sekunden |
in | Eingehender Traffic in bit/s, Durchschnitt des jeweiligen Messintervalls |
out | Ausgehender Traffic in bit/s, Durchschnitt des jeweiligen Messintervalls |
Die drei Listen time, in und out sind gleich lang. Der Wert an derselben Position gehört zum selben Zeitpunkt, also time[0] zu in[0] und out[0].
{
"state": "success",
"message": "OK",
"data": {
"period": "hour",
"unit": "bit/s",
"time": [
1723632000,
1723632060
],
"in": [
1200000,
1450000
],
"out": [
850000,
930000
]
}
}
400 | Invalid period. Use: hour, day, week, month, year: Ungültiger Zeitraum |
500 | Failed to fetch traffic data: Die Werte konnten nicht geladen werden |
/server/{id}/stats
Auth
Verlauf von CPU, Arbeitsspeicher und Netzwerk Traffic über einen Zeitraum, dieselben Werte wie auf der Statistik Seite im Kundenbereich. Zusätzlich gibt es eine Zusammenfassung mit aktuellem Wert, Durchschnitt und Maximum.
id | UUID des Servers (erforderlich) |
period | Text. Zeitraum: hour, day, week, month, year (optional, default: hour) |
{
"period": "day"
}
period | Der angefragte Zeitraum |
cores | Anzahl CPU Kerne des Servers |
memory_total_mb | Verfügbarer Arbeitsspeicher in MB |
summary.cpu | CPU Auslastung in Prozent: current_percent (letzter Messwert), average_percent, max_percent |
summary.memory | Arbeitsspeicher in Prozent: current_percent, average_percent, max_percent, dazu used_mb als letzter belegter Wert in MB |
summary.traffic | Übertragene Datenmenge im Zeitraum in Bytes: in_bytes (eingehend), out_bytes (ausgehend) |
points | Messpunkte, ältester zuerst |
points[].time | Zeitpunkt als Unix Zeitstempel in Sekunden |
points[].cpu_percent | CPU Auslastung in Prozent, bezogen auf alle Kerne |
points[].memory_percent | Belegter Arbeitsspeicher in Prozent |
points[].memory_used_mb | Belegter Arbeitsspeicher in MB |
points[].netin_bps | Eingehender Traffic in bit/s, Durchschnitt des jeweiligen Messintervalls |
points[].netout_bps | Ausgehender Traffic in bit/s, Durchschnitt des jeweiligen Messintervalls |
War der Server zu einem Zeitpunkt aus, sind die Werte dieses Messpunkts null, damit im Diagramm eine Lücke statt einer 0 entsteht. Die Abstände der Messpunkte richten sich nach dem Zeitraum, bei hour zum Beispiel eine Minute.
{
"state": "success",
"message": "OK",
"data": {
"period": "day",
"cores": 4,
"memory_total_mb": 8192,
"summary": {
"cpu": {
"current_percent": 12.4,
"average_percent": 8.91,
"max_percent": 47.2
},
"memory": {
"current_percent": 41.3,
"average_percent": 39.85,
"max_percent": 52.1,
"used_mb": 3383.3
},
"traffic": {
"in_bytes": 1843200000,
"out_bytes": 921600000
}
},
"points": [
{
"time": 1723632000,
"cpu_percent": 11.2,
"memory_percent": 40.8,
"memory_used_mb": 3342.34,
"netin_bps": 1200000,
"netout_bps": 850000
},
{
"time": 1723633800,
"cpu_percent": null,
"memory_percent": null,
"memory_used_mb": null,
"netin_bps": null,
"netout_bps": null
}
]
}
}
400 | Invalid period. Use: hour, day, week, month, year: Ungültiger Zeitraum |
409 | Server is not provisioned yet: Der Server wird gerade noch eingerichtet |
500 | Failed to fetch stats: Die Werte konnten nicht geladen werden |
Firewall
Jeder Server hat eine eigene Firewall mit Regeln für eingehenden und ausgehenden Traffic. Die Regeln werden von oben nach unten geprüft, die erste passende Regel entscheidet. Greift keine Regel, gilt das Standardverhalten (policy_in und policy_out).
pos | Regeln werden über ihre Position angesprochen, die oberste Regel hat 0. Nach dem Verschieben oder Löschen ändern sich die Positionen, deshalb gibt jede Firewall Aktion die neue Liste zurück |
locked | Regeln mit true werden vom Support verwaltet. Sie stehen immer ganz oben und können nicht bearbeitet, verschoben oder gelöscht werden |
digest | Prüfsumme der aktuellen Regeln aus GET /server/{id}/firewall (optional bei allen Änderungen). Schickst du sie mit, wird die Änderung abgelehnt, wenn die Regeln in der Zwischenzeit geändert wurden, zum Beispiel im Kundenbereich. Ohne Angabe gilt immer der aktuelle Stand |
| Schutz | Der Schutz gegen gefälschte Absender Adressen ist immer aktiv und lässt sich über Regeln nicht umgehen. Der Server kann nur mit seinen eigenen Adressen senden |
| Zustand | Die Firewall lässt sich nur ändern, wenn der Server im Zustand active ist |
/server/{id}/firewall
Auth
Firewall Regeln, Standardverhalten und die erlaubten Protokolle abrufen
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
Kein Request Body.
cluster_enabled | true = die Firewall ist auf unserer Seite aktiv. false = sie ist gerade global abgeschaltet, Regeln werden gespeichert, greifen aber erst wieder nach dem Einschalten. null = der Zustand konnte nicht ermittelt werden |
policy_in | Standardverhalten für eingehenden Traffic: ACCEPT, DROP oder REJECT |
policy_out | Standardverhalten für ausgehenden Traffic: ACCEPT, DROP oder REJECT |
digest | Prüfsumme der aktuellen Regeln, leer wenn es keine Regeln gibt |
rules | Regeln in der Reihenfolge, in der sie geprüft werden |
rules[].pos | Position der Regel |
rules[].type | in = eingehend, out = ausgehend |
rules[].action | ACCEPT = erlauben, DROP = verwerfen ohne Antwort, REJECT = ablehnen mit Antwort an den Absender |
rules[].enabled | true = die Regel ist aktiv |
rules[].proto | Protokoll, leer = alle Protokolle |
rules[].proto_label | Anzeigename des Protokolls |
rules[].source / rules[].dest | Quelle und Ziel, leer = alle Adressen |
rules[].sport / rules[].dport | Quellport und Zielport, leer = alle Ports |
rules[].comment | Kommentar zur Regel |
rules[].locked | true = vom Support verwaltet, nicht änderbar |
protocols | Erlaubte Werte für proto mit Anzeigename (value und label) |
{
"state": "success",
"message": "OK",
"data": {
"cluster_enabled": true,
"policy_in": "DROP",
"policy_out": "ACCEPT",
"digest": "3afad6926ef5b2bd8be423e25c08b90edde04e55",
"rules": [
{
"pos": 0,
"type": "in",
"action": "ACCEPT",
"enabled": true,
"proto": "tcp",
"proto_label": "TCP",
"source": "",
"sport": "",
"dest": "",
"dport": "22,80,443",
"comment": "SSH und Webserver",
"locked": false
}
],
"protocols": [
{ "value": "", "label": "Alle Protokolle" },
{ "value": "tcp", "label": "TCP" },
{ "value": "udp", "label": "UDP" },
{ "value": "icmp", "label": "ICMP" }
]
}
}
Die Liste protocols ist hier gekürzt. Erlaubt sind tcp, udp, icmp, icmpv6, ipv6-icmp, sctp sowie die Protokollnummern 2 (IGMP), 47 (GRE), 50 (ESP), 51 (AH), 89 (OSPF), 94 (IPIP), 41 (IPv6), 115 (L2TP), 112 (VRRP) und 103 (PIM).
400 | Server is not in active state: Der Server ist nicht aktiv |
409 | Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade |
500 | Failed to fetch firewall: Die Firewall konnte nicht geladen werden |
/server/{id}/firewall/rules
Auth
Neue Firewall Regel anlegen. Die Regel wird direkt unter den Support Regeln eingefügt, also vor allen deinen bisherigen Regeln. Pro Server sind bis zu 50 Regeln möglich.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
type | Text. in = eingehend, out = ausgehend (erforderlich) |
action | Text. ACCEPT, DROP oder REJECT (erforderlich) |
enabled | Boolean. true = Regel sofort aktiv, false = Regel nur speichern (optional, default: true) |
proto | Text. Protokoll aus protocols (optional, leer = alle Protokolle) |
source | Text. Quelladresse: eine IP, ein Netz in CIDR Schreibweise (203.0.113.0/24), ein Bereich (203.0.113.10-203.0.113.20) oder mehrere IPs und Netze mit Komma getrennt. IPv4 und IPv6 dürfen nicht gemischt werden (optional, leer = alle) |
dest | Text. Zieladresse, gleiches Format wie source (optional, leer = alle) |
sport | Text. Quellport: ein Port (80), mehrere mit Komma (80,443) oder ein Bereich (8000:8100). Höchstens 15 Ports pro Regel, ein Bereich zählt doppelt. Nur mit tcp, udp oder sctp (optional) |
dport | Text. Zielport, gleiches Format wie sport (optional) |
comment | Text. Kommentar, höchstens 100 Zeichen (optional) |
{
"type": "in",
"action": "ACCEPT",
"enabled": true,
"proto": "tcp",
"dport": "22,80,443",
"comment": "SSH und Webserver"
}
Die Antwort enthält in data den neuen Stand der Firewall im selben Format wie GET /server/{id}/firewall. Das gilt für alle Firewall Aktionen.
{
"state": "success",
"message": "Firewall rule added",
"data": {
"cluster_enabled": true,
"policy_in": "DROP",
"policy_out": "ACCEPT",
"digest": "3afad6926ef5b2bd8be423e25c08b90edde04e55",
"rules": [ ... ],
"protocols": [ ... ]
}
}
422 | Missing required parameters: type: Ein Pflichtfeld fehlt |
422 | Invalid type. Use: in, out oder Invalid action. Use: ACCEPT, DROP, REJECT: Ungültiger Wert |
422 | Unknown protocol: Das Protokoll steht nicht in protocols |
422 | source: ..., dest: ..., sport: ... oder dport: ...: Das genannte Feld ist ungültig, der Grund steht hinter dem Doppelpunkt, zum Beispiel dport: Ports must be between 1 and 65535 |
422 | Ports can only be used with tcp, udp or sctp: Ports wurden ohne passendes Protokoll angegeben |
422 | Source and destination must both be IPv4 or both be IPv6: Quelle und Ziel passen nicht zusammen |
422 | icmp is only valid for IPv4, use icmpv6 for IPv6 oder icmpv6 is only valid for IPv6: Protokoll passt nicht zur Adresse |
422 | Maximum of 50 firewall rules reached: Es gibt bereits 50 Regeln |
400 | Server is not in active state: Der Server ist nicht aktiv |
409 | Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade |
/server/{id}/firewall/rules/{pos}
Auth
Bestehende Regel bearbeiten. Die Regel wird komplett ersetzt, Felder die du nicht mitschickst werden geleert. Die Position bleibt gleich.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
pos | Position der Regel aus rules[].pos (erforderlich) |
| Regel | Dieselben Felder wie bei POST /server/{id}/firewall/rules, type und action sind erforderlich |
digest | Text. Prüfsumme aus GET /server/{id}/firewall (optional) |
{
"type": "in",
"action": "ACCEPT",
"proto": "tcp",
"source": "203.0.113.0/24",
"dport": "22",
"comment": "SSH nur aus dem Büro",
"digest": "3afad6926ef5b2bd8be423e25c08b90edde04e55"
}
{
"state": "success",
"message": "Firewall rule updated",
"data": { ... }
}
400 | Invalid rule position: pos ist keine Zahl |
422 | Firewall rule not found: An dieser Position gibt es keine Regel |
422 | This rule is managed by support and cannot be changed: Die Regel ist gesperrt |
422 | Firewall rules were changed in the meantime, please reload them: Der digest passt nicht mehr |
422 | Alle Prüfungen wie beim Anlegen einer Regel |
400 | Server is not in active state: Der Server ist nicht aktiv |
409 | Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade |
/server/{id}/firewall/rules/{pos}/enabled
Auth
Regel aktivieren oder deaktivieren, ohne sie zu löschen. Eine deaktivierte Regel bleibt an ihrer Position, wird aber nicht geprüft.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
pos | Position der Regel aus rules[].pos (erforderlich) |
enabled | Boolean. true = aktivieren, false = deaktivieren (erforderlich) |
digest | Text. Prüfsumme aus GET /server/{id}/firewall (optional) |
{
"enabled": false
}
{
"state": "success",
"message": "Firewall rule disabled",
"data": { ... }
}
422 | Missing required parameters: enabled: Das Feld fehlt |
400 | Invalid rule position: pos ist keine Zahl |
422 | Firewall rule not found, This rule is managed by support and cannot be changed oder Firewall rules were changed in the meantime, please reload them |
400 | Server is not in active state: Der Server ist nicht aktiv |
409 | Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade |
/server/{id}/firewall/rules/{pos}/move
Auth
Regel verschieben. Entweder direkt an eine neue Position oder um eine Stelle nach oben oder unten. Über die Support Regeln kann nicht geschoben werden.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
pos | Aktuelle Position der Regel aus rules[].pos (erforderlich) |
position | Zahl. Neue Position. Ist sie größer als die letzte Position, landet die Regel ganz unten (erforderlich, wenn direction fehlt) |
direction | Text. up = eine Stelle nach oben, down = eine Stelle nach unten (erforderlich, wenn position fehlt) |
digest | Text. Prüfsumme aus GET /server/{id}/firewall (optional) |
{
"position": 0
}
{
"state": "success",
"message": "Firewall rule moved",
"data": { ... }
}
400 | Missing position or direction (up, down): Weder position noch eine gültige direction angegeben |
400 | Invalid rule position: pos ist keine Zahl |
422 | Rules cannot be moved above locked rules: Die Zielposition liegt zwischen den Support Regeln |
422 | Firewall rule is already at the top oder Firewall rule is already at the bottom: Die Regel kann nicht weiter verschoben werden |
422 | Firewall rule not found, This rule is managed by support and cannot be changed oder Firewall rules were changed in the meantime, please reload them |
400 | Server is not in active state: Der Server ist nicht aktiv |
409 | Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade |
/server/{id}/firewall/rules/{pos}
Auth
Regel löschen. Alle Regeln darunter rücken eine Position nach oben.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
pos | Position der Regel aus rules[].pos (erforderlich) |
digest | Text. Prüfsumme aus GET /server/{id}/firewall (optional, der Body kann auch ganz fehlen) |
{
"digest": "3afad6926ef5b2bd8be423e25c08b90edde04e55"
}
{
"state": "success",
"message": "Firewall rule deleted",
"data": { ... }
}
400 | Invalid rule position: pos ist keine Zahl |
422 | Firewall rule not found, This rule is managed by support and cannot be changed oder Firewall rules were changed in the meantime, please reload them |
422 | Firewall rule could not be deleted: Die Regel konnte nicht gelöscht werden |
400 | Server is not in active state: Der Server ist nicht aktiv |
409 | Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade |
/server/{id}/firewall/policy
Auth
Standardverhalten festlegen, das gilt wenn keine Regel greift. Ohne eigene Einstellung wird eingehender Traffic verworfen (DROP) und ausgehender erlaubt (ACCEPT). Achtung: Mit policy_in auf DROP oder REJECT und ohne passende Regel ist der Server zum Beispiel per SSH nicht mehr erreichbar.
id | UUID des Servers (erforderlich). Der Server muss im Zustand active sein |
policy_in | Text. Eingehend: ACCEPT, DROP oder REJECT (erforderlich) |
policy_out | Text. Ausgehend: ACCEPT, DROP oder REJECT (erforderlich) |
{
"policy_in": "DROP",
"policy_out": "ACCEPT"
}
{
"state": "success",
"message": "Firewall policy updated",
"data": { ... }
}
422 | Missing required parameters: policy_in: Ein Pflichtfeld fehlt |
422 | Invalid policy. Use: ACCEPT, DROP, REJECT: Ungültiger Wert |
400 | Server is not in active state: Der Server ist nicht aktiv |
409 | Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade |
/products/server/packages
Auth
Alle bestellbaren KVM Pakete, gruppiert nach CPU Typ. Die id eines Pakets gibst du bei /order/server als package_id an.
type | Nur Pakete eines CPU Typs: epyc, ryzen oder xeon (optional, ohne Angabe kommen alle Typen) |
type | CPU Typ der folgenden Pakete |
packages | Pakete dieses Typs, sortiert nach Kernen und Arbeitsspeicher |
id | Paket ID für /order/server |
name | Name des Pakets |
cores | Anzahl CPU Kerne |
memory | Arbeitsspeicher in MB |
disk | Speicher in GB |
ipv4 | Anzahl enthaltener IPv4 Adressen |
ipv6 | Anzahl enthaltener IPv6 Subnetze (/64) |
connection | Bandbreitenlimit in MB/s, 1260 entspricht rund 10 Gbit/s geteilt |
price | Regulärer Preis pro Laufzeit in EUR |
offer_price | Preis nach einer aktuell laufenden Aktion. Gibt es keine Aktion, ist der Wert gleich price. Bei der Bestellung wird dieser Preis berechnet |
{
"state": "success",
"message": "OK",
"data": [
{
"type": "epyc",
"packages": [
{
"id": "PACKAGE-UUID",
"name": "EPYC S",
"cores": 2,
"memory": 4096,
"disk": 50,
"ipv4": 1,
"ipv6": 1,
"connection": 1260,
"price": "7.99",
"offer_price": "7.19"
}
]
}
]
}
400 | CPU type not found. Available types: epyc, ryzen, xeon: Unbekannter Typ |
/order/server/price
Auth
Preis für einen frei konfigurierten KVM Server berechnen, ohne zu bestellen
type | CPU Typ: epyc, ryzen oder xeon (optional, default: ryzen) |
cores | Anzahl CPU Kerne (optional, default: 1) |
memory | Arbeitsspeicher in GB (optional, default: 1). Achtung: bei /order/server wird der Arbeitsspeicher in MB angegeben |
disk | Speicher in GB (optional, default: 50) |
ipv4 | Anzahl IPv4 Adressen (optional, default: 1) |
ipv6 | Anzahl IPv6 Subnetze (optional, default: 1) |
duration | Laufzeit in Monaten für die Gesamtberechnung (optional, default: 1) |
GET /order/server/price?type=epyc&cores=4&memory=16&disk=150&ipv4=1&ipv6=0
cpu_typ | CPU Typ in Großbuchstaben |
monthly_price | Preis pro Monat in EUR |
total_price | Gesamtpreis für duration Monate inklusive Laufzeitrabatt |
duration_months | Die angefragte Laufzeit |
discount_percent | Laufzeitrabatt in Prozent: 5 ab 3 Monaten, 10 ab 6 Monaten, 15 ab 12 Monaten, sonst 0 |
currency | Immer EUR |
{
"state": "success",
"message": "OK",
"data": {
"cpu_typ": "EPYC",
"monthly_price": "17.99",
"total_price": "17.99",
"duration_months": 1,
"discount_percent": 0,
"currency": "EUR"
}
}
Die Berechnung prüft keine Grenzen für Kerne, Arbeitsspeicher oder Speicher, das passiert erst bei der Bestellung. Aktionsrabatte sind hier nicht enthalten, sie werden bei /order/server automatisch abgezogen. Eine Bestellung im Konfigurationsmodus läuft immer über 1 Monat.
Domain
/domain/list
Auth
Alle eigenen Domains auflisten, neueste zuerst. Gelöschte Domains erscheinen nicht.
search | Nur Domains, deren Name diesen Text enthält, zum Beispiel beispiel (optional) |
GET /domain/list?search=beispiel
domains | Liste deiner Domains, leer wenn nichts gefunden wurde |
id | UUID der Domain. Alle Endpoints unter /domain/{id} nehmen diese ID oder direkt den Domainnamen |
domain | Domainname, Umlautdomains in Punycode (zum Beispiel xn--mller-kva.de) |
state | active = Domain liegt bei uns, pending = Transfer oder Registrierung läuft noch und wird automatisch aktiv, sobald die Registry sie bestätigt |
price | Verlängerungspreis pro Jahr in EUR |
expire_at | Ablaufdatum der Domain |
auto_renew | 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
{
"state": "success",
"message": "OK",
"data": {
"domains": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "beispiel.de",
"state": "active",
"price": "4.99",
"expire_at": "2027-10-03 12:00:00",
"auto_renew": 0
}
]
}
}
/domain/pricelist
Auth
Domain Preisliste für alle angebotenen Endungen. Die Preise gelten für deine aktuelle Resellerstufe und sind genau die Beträge, die bei einer Bestellung oder Verlängerung berechnet werden.
tld | Nur eine Endung, mit oder ohne Punkt, zum Beispiel de oder co.uk (optional) |
GET /domain/pricelist?tld=de
response | Meldung. Dieser Endpoint nutzt response statt message |
data | Liste der Endungen, alphabetisch sortiert. Leer, wenn die angefragte Endung nicht angeboten wird |
tld | Endung ohne Punkt |
create | Preis für die Registrierung (1 Jahr) in EUR |
renew | Preis für die Verlängerung um 1 Jahr in EUR |
transfer | Preis für den Transfer zu uns in EUR |
restore | Preis für die Wiederherstellung einer gelöschten Domain in EUR |
0.00 | Ein Preis von 0.00 bedeutet, dass diese Aktion für die Endung nicht angeboten wird |
offer | Immer false, Aktionen sind bereits im Preis enthalten |
offerTypes | Immer null |
{
"response": "Successfully fetched pricelist",
"state": "success",
"data": [
{
"tld": "de",
"create": "4.99",
"renew": "4.99",
"transfer": "0.99",
"restore": "0.00",
"offer": false,
"offerTypes": null
}
]
}
Die Preisliste wird regelmäßig aktualisiert. Für einen eigenen Shop empfiehlt es sich, sie stündlich abzurufen und zwischenzuspeichern.
/domain/check
Auth
Prüfen, ob eine Domain frei ist. Ist sie vergeben, kann sie mit AuthCode über /order/domain zu uns transferiert werden.
domain | Text. Domainname ohne http:// und ohne Pfad, zum Beispiel beispiel.de. Großschreibung und Umlaute sind erlaubt (erforderlich) |
{
"domain": "beispiel.de"
}
domain | Geprüfter Domainname in Kleinbuchstaben, Umlautdomains in Punycode |
available | true = frei und registrierbar, false = vergeben, nur ein Transfer ist möglich |
premium | true = Premiumdomain mit Sonderpreis der Registry. Premiumdomains können nicht über die API bestellt werden |
{
"state": "success",
"message": "OK",
"data": {
"domain": "beispiel.de",
"available": true,
"premium": false
}
}
422 | Please provide a valid domain name: Kein gültiger Domainname |
422 | Please provide a domain name, not a URL: Es wurde eine URL statt eines Domainnamens geschickt |
422 | TLD not available: .xyz: Diese Endung bieten wir nicht an |
502 | Domain check failed: Die Prüfung konnte gerade nicht durchgeführt werden |
/domain/{id}
Auth
Domain Details abrufen, inklusive der aktuellen Daten aus der Registry
id | UUID der Domain oder direkt der Domainname, zum Beispiel /domain/beispiel.de (erforderlich) |
id | UUID der Domain |
domain | Domainname |
state | active oder pending |
price | Verlängerungspreis pro Jahr in EUR |
expire_at | Ablaufdatum laut unserem System |
auto_renew | 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
provider_info | Aktuelle Daten aus der Registry. Fehlt, wenn die Registry gerade nicht erreichbar war |
provider_info.expires_at | Ablaufdatum laut Registry. Das Format kann von expire_at abweichen |
provider_info.nameservers | Aktuell eingetragene Nameserver |
provider_info.auto_renew | Verlängerungseinstellung direkt bei der Registry: 1 = aktiv, 0 = aus, null wenn die Registry dazu nichts liefert. Für die Abrechnung zählt nur auto_renew oben |
provider_info.transfer_lock | 1 = Transfersperre aktiv, 0 = keine Transfersperre, null wenn nicht bekannt |
provider_info.status | Status der Domain bei der Registry, null wenn nicht bekannt |
{
"state": "success",
"message": "OK",
"data": {
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "beispiel.de",
"state": "active",
"price": "4.99",
"expire_at": "2027-10-03 12:00:00",
"auto_renew": 0,
"provider_info": {
"expires_at": "2027-10-03T12:00:00+02:00",
"nameservers": [
"ns1.nameserver.zip",
"ns2.nameserver.zip"
],
"auto_renew": null,
"transfer_lock": 1,
"status": "ok"
}
}
}
404 | Domain not found: Die Domain gibt es bei uns nicht oder sie wurde gelöscht |
403 | No access to this domain: Die Domain gehört dir nicht und ist dir nicht freigegeben |
/domain/{id}/dns
Auth
DNS Records der Domain auf unseren Nameservern auflisten. Die Zone wird bei jeder Bestellung automatisch angelegt. SOA und NS Records verwalten wir selbst, sie erscheinen hier nicht.
id | UUID der Domain oder der Domainname (erforderlich) |
domain | Domainname |
zone_exists | true = die DNS Zone liegt bei uns. false = es gibt noch keine Zone, sie wird beim Umstellen auf unsere Nameserver angelegt |
records | Liste aller Records, sortiert nach Name und Typ. Leer, wenn noch keine Records angelegt sind |
name | Name relativ zur Domain. Leer bedeutet die Domain selbst, www bedeutet www.beispiel.de |
type | Record Typ, zum Beispiel A, AAAA, CNAME, MX oder TXT |
data | Inhalt des Records in lesbarer Form: TXT ohne Anführungszeichen, Hostnamen ohne Punkt am Ende, MX als Priorität Ziel |
ttl | Gültigkeit in Sekunden |
{
"state": "success",
"message": "OK",
"data": {
"domain": "beispiel.de",
"zone_exists": true,
"records": [
{
"name": "",
"type": "A",
"data": "203.0.113.10",
"ttl": 3600
},
{
"name": "",
"type": "MX",
"data": "10 mail.beispiel.de",
"ttl": 3600
},
{
"name": "",
"type": "TXT",
"data": "v=spf1 mx -all",
"ttl": 3600
},
{
"name": "www",
"type": "CNAME",
"data": "beispiel.de",
"ttl": 3600
}
]
}
}
502 | Failed to fetch DNS records: Die Nameserver waren gerade nicht erreichbar |
/domain/{id}/dns
Auth
DNS Records ändern. Es wird immer die komplette Liste geschickt: alles, was nicht in der Liste steht, wird gelöscht. Am einfachsten lädst du die Liste über GET /domain/{id}/dns, änderst sie und schickst sie zurück. Die Ausgabe von GET kann unverändert wieder gesendet werden.
Voraussetzung: Die Zone existiert und die Domain zeigt auf unsere Nameserver oder auf deine Whitelabel Nameserver. Das kannst du über GET /domain/{id}/nameserver im Feld delegated prüfen.
id | UUID der Domain oder der Domainname (erforderlich) |
records | Array. Komplette Liste der gewünschten Records, höchstens 250. Ein leeres Array löscht alle Records (erforderlich) |
name | Text. Name relativ zur Domain. Leer oder @ für die Domain selbst, www für www.beispiel.de, * für Wildcard. Der volle Name wie www.beispiel.de wird ebenfalls erkannt (optional, default: leer) |
type | Text. Erlaubt sind A, AAAA, CNAME, ALIAS, MX, SRV, TXT, CAA, PTR, TLSA (erforderlich) |
data | Text. Inhalt des Records, Format siehe unten (erforderlich) |
ttl | Zahl. Gültigkeit in Sekunden von 60 bis 604800. Werte außerhalb werden auf 3600 gesetzt (optional, default: 3600) |
A | IPv4 Adresse, zum Beispiel 203.0.113.10 |
AAAA | IPv6 Adresse, zum Beispiel 2001:db8::10 |
CNAME | Zielhostname, zum Beispiel beispiel.de. Nicht auf der Domain selbst erlaubt (dafür ALIAS verwenden) und nicht zusammen mit anderen Records auf demselben Namen. Pro Name nur ein CNAME |
ALIAS | Zielhostname wie bei CNAME, aber auch auf der Domain selbst erlaubt |
MX | Priorität Ziel, zum Beispiel 10 mail.beispiel.de. Ohne Priorität wird 10 verwendet |
SRV | Priorität Gewicht Port Ziel, zum Beispiel 0 5 25565 mc.beispiel.de. Der Name enthält Dienst und Protokoll, zum Beispiel _minecraft._tcp |
TXT | Beliebiger Text, mit oder ohne Anführungszeichen. Texte über 255 Zeichen werden automatisch aufgeteilt |
CAA | Flag Tag "Wert", zum Beispiel 0 issue "letsencrypt.org" |
PTR | Zielhostname |
TLSA | Usage Selector Matching Hash, zum Beispiel 3 1 1 0123ABCD... |
{
"records": [
{ "name": "@", "type": "A", "data": "203.0.113.10", "ttl": 3600 },
{ "name": "@", "type": "AAAA", "data": "2001:db8::10" },
{ "name": "www", "type": "CNAME", "data": "beispiel.de" },
{ "name": "@", "type": "MX", "data": "10 mail.beispiel.de" },
{ "name": "mail", "type": "A", "data": "203.0.113.20" },
{ "name": "@", "type": "TXT", "data": "v=spf1 mx -all" },
{ "name": "_minecraft._tcp", "type": "SRV", "data": "0 5 25565 mc.beispiel.de" }
]
}
records | Die Records, wie sie jetzt gespeichert sind, im selben Format wie bei GET /domain/{id}/dns |
{
"state": "success",
"message": "DNS records updated",
"data": {
"records": [
{
"name": "",
"type": "A",
"data": "203.0.113.10",
"ttl": 3600
}
]
}
}
422 | Missing required parameters: records oder records must be an array: Das Feld fehlt oder ist keine Liste |
422 | Record 3: invalid type. Allowed: ...: Ein Record ist ungültig. Die Nummer gibt die Position in deiner Liste an, beginnend bei 1. Es wird dann nichts gespeichert |
422 | DNS records rejected: ...: Der Nameserver hat die Liste abgelehnt, der Grund steht hinter dem Doppelpunkt |
409 | There is no DNS zone for this domain yet. Point the domain to our nameservers first.: Es gibt noch keine Zone |
409 | The domain is not delegated to our nameservers: Die Domain zeigt auf fremde Nameserver |
502 | The delegation of this domain could not be verified, please retry oder Failed to update DNS records: Registry oder Nameserver waren gerade nicht erreichbar |
/domain/{id}/nameserver
Auth
Aktuell bei der Registry eingetragene Nameserver abrufen
id | UUID der Domain oder der Domainname (erforderlich) |
domain | Domainname |
nameservers | Eingetragene Nameserver |
delegated | true = alle Nameserver sind unsere oder deine Whitelabel Nameserver, DNS Records lassen sich über /domain/{id}/dns bearbeiten. false = die Domain nutzt fremde Nameserver |
{
"state": "success",
"message": "OK",
"data": {
"domain": "beispiel.de",
"nameservers": [
"ns1.nameserver.zip",
"ns2.nameserver.zip"
],
"delegated": true
}
}
502 | Failed to fetch nameservers: Die Registry war gerade nicht erreichbar |
501 | This action is not available for this domain: Für diese Domain nicht möglich |
/domain/{id}/nameserver
Auth
Nameserver der Domain bei der Registry ändern. Fremde Nameserver sind erlaubt. Stellst du auf unsere oder deine Whitelabel Nameserver um, wird die DNS Zone dabei automatisch angelegt, falls sie noch fehlt.
id | UUID der Domain oder der Domainname (erforderlich) |
nameservers | Array aus Hostnamen, mindestens 2 und höchstens 5 verschiedene. Groß und Kleinschreibung sowie ein Punkt am Ende sind egal (erforderlich) |
Ist die Liste ungültig (kein Array, ein ungültiger Hostname, weniger als 2 oder mehr als 5 Einträge), werden stattdessen unsere Standard Nameserver gesetzt. Welche Nameserver tatsächlich eingetragen wurden, steht immer im Feld nameservers der Antwort.
{
"nameservers": [
"ns1.nameserver.zip",
"ns2.nameserver.zip"
]
}
nameservers | Die Nameserver, die tatsächlich gesetzt wurden |
delegated | true = die Domain zeigt jetzt auf unsere oder deine Whitelabel Nameserver, DNS Records lassen sich bearbeiten |
{
"state": "success",
"message": "Nameservers updated",
"data": {
"nameservers": [
"ns1.nameserver.zip",
"ns2.nameserver.zip"
],
"delegated": true
}
}
Die Änderung ist sofort bei der Registry eingetragen. Bis sie weltweit sichtbar ist, können je nach Endung einige Stunden vergehen.
422 | Missing required parameters: nameservers: Das Feld fehlt komplett |
400 | Failed to update nameservers (DOM-3005): Die Registry hat die Nameserver abgelehnt, zum Beispiel weil sie nicht erreichbar sind |
502 | Failed to update nameservers oder DNS zone could not be prepared, please retry: Registry oder Nameserver waren gerade nicht erreichbar |
/domain/{id}/authcode
Auth
AuthCode für den Transfer der Domain zu einem anderen Anbieter abrufen. Nur für den Inhaber, nicht bei Freigaben, und nur bei aktiven Domains.
id | UUID der Domain oder der Domainname (erforderlich) |
domain | Domainname |
authcode | Der AuthCode als Text. Diesen Code beim neuen Anbieter angeben |
{
"state": "success",
"message": "OK",
"data": {
"domain": "beispiel.de",
"authcode": "Ab3$kL9#pQ2x"
}
}
403 | No access to this domain: Die Domain ist dir nur freigegeben |
409 | The authcode is only available for active domains: Die Domain ist noch im Zustand pending |
400 | Failed to fetch authcode (DOM-3006): Die Domain ist bei der Registry gesperrt |
502 | Failed to fetch authcode: Die Registry war gerade nicht erreichbar |
/domain/{id}/renew
Auth
Domain um ihre Laufzeit verlängern (bei Domains 12 Monate). Der Verlängerungspreis wird vom Guthaben abgebucht. Lehnt die Registry ab, wird der Betrag sofort zurückgebucht. Nur der Inhaber darf verlängern, nur aktive Domains.
id | UUID der Domain oder der Domainname (erforderlich) |
Kein Request Body.
new_expire_at | Neues Ablaufdatum. Gerechnet wird vom bisherigen Ablaufdatum aus, ist das schon vorbei, ab heute |
{
"state": "success",
"message": "Domain renewed",
"data": {
"new_expire_at": "2028-10-03 12:00:00"
}
}
403 | Only the owner can renew: Die Domain ist dir nur freigegeben |
409 | Only active domains can be renewed: Die Domain ist noch im Zustand pending |
409 | Another request for this domain is in progress, please retry: Für diese Domain läuft gerade schon eine Bestellung oder Verlängerung |
402 | Insufficient balance. Required: 4.99 EUR: Nicht genug Guthaben |
502 | Domain renewal failed at provider: Die Registry hat abgelehnt, das Guthaben wurde zurückgebucht |
Webspace
/webspace/list
Auth
Alle eigenen Webspaces auflisten, neueste zuerst. Gelöschte Webspaces erscheinen nicht.
Keine Parameter.
webspaces | Liste deiner Webspaces, leer wenn du keine hast |
id | UUID des Webspaces, wird für alle Endpoints unter /webspace/{id} gebraucht |
type | Immer webspace |
state | install = wird gerade eingerichtet, active = bereit, reinstall = wird gerade neu installiert |
price | Preis pro Laufzeit in EUR, wird bei jeder Verlängerung berechnet |
duration | Laufzeit in Monaten |
expire_at | Ende der bezahlten Laufzeit |
created_at | Zeitpunkt der Bestellung |
auto_renew | 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
plan | Name des gebuchten Pakets |
{
"state": "success",
"message": "OK",
"data": {
"webspaces": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"type": "webspace",
"state": "active",
"price": "4.99",
"duration": 1,
"expire_at": "2026-10-20 12:00:00",
"created_at": "2026-09-20 12:00:00",
"auto_renew": 0,
"plan": "WEB STARTER"
}
]
}
}
/products/webspace/packages
Auth
Alle bestellbaren Webspace Pakete mit Leistungen und Preisen, günstigstes zuerst. Die id gibst du bei /order/webspace als package_id an.
Keine Parameter.
id | Paket ID für /order/webspace |
name | Name des Pakets |
disk | Speicherplatz in GB |
domains | Anzahl Domains, die im Webspace angelegt werden können |
subdomains | Anzahl Subdomains |
databases | Anzahl Datenbanken |
ftp_accounts | Anzahl FTP Zugänge |
emails | Anzahl E Mail Postfächer |
price | Preis pro Laufzeit in EUR |
offer_price | Aktionspreis in EUR. Gibt es keine Aktion, ist der Wert gleich price |
duration | Laufzeit in Monaten |
{
"state": "success",
"message": "OK",
"data": [
{
"id": "PACKAGE-UUID",
"name": "WEB STARTER",
"disk": 25,
"domains": 1,
"subdomains": 5,
"databases": 5,
"ftp_accounts": 5,
"emails": 10,
"price": "4.99",
"offer_price": "4.49",
"duration": 1
}
]
}
/webspace/plans
Auth
Ältere Variante von /products/webspace/packages, bleibt für bestehende Anbindungen erhalten. Liefert dieselben Pakete, aber innerhalb von plans und ohne das Feld subdomains. Für neue Anbindungen bitte /products/webspace/packages verwenden.
Keine Parameter.
plans | Liste der Pakete, Felder wie bei /products/webspace/packages ohne subdomains |
{
"state": "success",
"message": "OK",
"data": {
"plans": [
{
"id": "PACKAGE-UUID",
"name": "WEB STARTER",
"disk": 25,
"domains": 1,
"databases": 5,
"ftp_accounts": 5,
"emails": 10,
"price": "4.99",
"offer_price": "4.49",
"duration": 1
}
]
}
}
/webspace/{id}
Auth
Details und Benutzername eines Webspaces abrufen. Nur für den Inhaber. Das Passwort wird aus Sicherheitsgründen nicht ausgegeben, es steht nur in der Antwort der Bestellung bzw. der Neuinstallation.
id | UUID des Webspaces aus /webspace/list (erforderlich) |
id | UUID des Webspaces |
type | Immer webspace |
state | install, active oder reinstall |
price | Preis pro Laufzeit in EUR |
duration | Laufzeit in Monaten |
created_at | Zeitpunkt der Bestellung |
expire_at | Ende der bezahlten Laufzeit |
auto_renew | 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
credentials.username | Benutzername für die Anmeldung im Webspace Panel |
credentials.ftp_username | Eigener FTP Benutzername. Bei KeyHelp Webspaces null, dort gilt der normale Benutzername auch für FTP |
plan | Name des gebuchten Pakets |
{
"state": "success",
"message": "OK",
"data": {
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"type": "webspace",
"state": "active",
"price": "4.99",
"duration": 1,
"created_at": "2026-09-20 12:00:00",
"expire_at": "2026-10-20 12:00:00",
"auto_renew": 0,
"credentials": {
"username": "web1268ec03",
"ftp_username": null
},
"plan": "WEB STARTER"
}
}
404 | Webspace not found: Die ID gibt es nicht oder der Webspace wurde gelöscht |
403 | No access to this webspace: Der Webspace gehört dir nicht |
/webspace/{id}/renew
Auth
Aktiven Webspace um seine hinterlegte Laufzeit verlängern. Der Betrag entspricht dem im Webspace gespeicherten Preis pro Laufzeit und wird sofort vom Guthaben abgebucht.
id | UUID des Webspaces (erforderlich) |
Kein Request Body.
new_expire_at | Neues Ende der bezahlten Laufzeit. Gerechnet wird vom bisherigen Ablaufdatum aus, ist das schon vorbei, ab jetzt |
{
"state": "success",
"message": "Webspace renewed",
"data": {
"new_expire_at": "2026-11-20 12:00:00"
}
}
403 | Only the owner can renew: Nur der Inhaber darf verlängern |
400 | Webspace is not active and cannot be renewed right now: Der Webspace wird gerade eingerichtet oder neu installiert |
402 | Insufficient balance. Required: 4.99 EUR: Nicht genug Guthaben |
/webspace/{id}/reinstall
Auth
KeyHelp Webspace vollständig neu installieren. Alle Dateien, Datenbanken und Postfächer werden dabei gelöscht. Der bestehende Benutzername bleibt erhalten. Nur für den Inhaber und nur bei aktiven KeyHelp Webspaces.
id | UUID des Webspaces (erforderlich) |
password | Text. Neues Passwort, mindestens 8 Zeichen (optional, ohne Angabe wird automatisch ein neues Passwort erzeugt) |
{
"password": "NeuesPasswort123"
}
product_id | UUID des Webspaces |
state | Immer reinstall. Nach Abschluss steht der Webspace wieder auf active |
username | Benutzername, unverändert |
password | Neues Passwort, entweder dein eigenes oder das automatisch erzeugte. Bitte sicher speichern |
{
"state": "success",
"message": "Webspace reinstallation queued",
"data": {
"product_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"state": "reinstall",
"username": "web1268ec03",
"password": "NeuesPasswort123"
}
}
Während der Reinstallation wird der Vorgang serverseitig über die Queue verarbeitet. Ein paralleler Reinstall desselben Webspaces wird verhindert.
403 | Only the owner can reinstall: Nur der Inhaber darf neu installieren |
400 | Webspace must be active to reinstall: Der Webspace ist nicht im Zustand active |
400 | Only KeyHelp webspaces can be reinstalled: Ältere Webspaces lassen sich nicht über die API neu installieren |
400 | Webspace is not ready for reinstallation: Die Einrichtung ist noch nicht vollständig abgeschlossen |
400 | Password must be at least 8 characters: Das Passwort ist zu kurz |
400 | Webspace reinstallation is already in progress: Eine Neuinstallation läuft bereits |
Bestellungen
/order/server
Auth
Neuen KVM Server bestellen. Es gibt zwei Modi: Paketbestellung über package_id oder frei konfigurierbar über CPU, RAM, Speicher und IP Anzahl. Beides zusammen ist nicht erlaubt. Pro Anfrage wird genau ein Server bestellt, der Preis wird sofort vom Guthaben abgebucht.
package_id | Text. Paket ID aus /products/server/packages. Nur für den Paketmodus, nicht zusammen mit type, cores, memory, disk, ipv4 oder ipv6 verwenden |
type | Text. CPU Typ für den Konfigurationsmodus: epyc, ryzen oder xeon (im Konfigurationsmodus erforderlich) |
cores | Zahl. Anzahl CPU Kerne (im Konfigurationsmodus erforderlich) |
memory | Zahl. RAM in MB, nur volle GB Schritte (Vielfaches von 1024), zum Beispiel 16384 für 16 GB (im Konfigurationsmodus erforderlich) |
disk | Zahl. Speicher in GB (im Konfigurationsmodus erforderlich) |
ipv4 | Zahl. Anzahl IPv4 Adressen (optional, Standard: 1) |
ipv6 | Zahl. Anzahl IPv6 Subnetze (/64) (optional, Standard: 1). Für nur eine IPv4 Adresse 0 setzen |
os | Text. Betriebssystem ID (proxmox_id) aus /server/os (erforderlich) |
password | Text. Root Passwort (optional, ohne Angabe wird automatisch eines erzeugt) |
name | Text. Anzeigename (optional, Standard: Paketname bzw. KVM Server) |
auto_renew | Zahl. 1 = automatische Verlängerung von Anfang an aktiv, 0 = aus (optional, Standard: 0) |
tos | Boolean. AGB und Datenschutz müssen mit true akzeptiert werden (erforderlich) |
cancellation | Boolean. Widerrufsverzicht muss mit true bestätigt werden (erforderlich) |
curl -X POST "https://Bukkit-Hosting.eu/api/v1/order/server" \
-H "Authorization: Bearer DEIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "epyc",
"cores": 4,
"memory": 16384,
"disk": 150,
"ipv4": 1,
"ipv6": 0,
"os": "debian-13",
"tos": true,
"cancellation": true,
"auto_renew": 0
}'
Dieses Beispiel bestellt genau eine IPv4 Adresse und keine IPv6 Adresse. Die Werte für CPU, RAM, Disk und IP Anzahl werden serverseitig gegen die für den gewählten Host erlaubten Grenzen geprüft.
{
"package_id": "PACKAGE-UUID",
"os": "debian-13",
"name": "Mein Server",
"tos": true,
"cancellation": true
}
product_id | UUID des neuen Servers, damit rufst du ihn später über /server/{id} ab |
proxmox_id | Interne Nummer der VM. Direkt nach der Bestellung noch null, sie wird bei der Einrichtung vergeben |
order_mode | package = Paketbestellung, config = freie Konfiguration |
package_id | Die bestellte Paket ID, im Konfigurationsmodus null |
type | Interner Produkttyp des Servers, zum Beispiel server-epyc |
cpu_typ | CPU Typ in Großbuchstaben |
state | Immer install. Sobald der Server fertig ist, steht er auf active |
cores | Bestellte CPU Kerne |
memory | Bestellter Arbeitsspeicher in MB |
disk | Bestellter Speicher in GB |
ipv4_amount | Anzahl IPv4 Adressen |
ipv6_amount | Anzahl IPv6 Subnetze |
duration | Laufzeit in Monaten |
price | Abgebuchter Betrag in EUR |
offer_price | Preis pro Laufzeit für spätere Verlängerungen in EUR, nach einer eventuell laufenden Aktion |
password | Root Passwort des Servers. Bitte sicher speichern |
expire_at | Ende der bezahlten Laufzeit |
{
"state": "success",
"message": "Server order placed. Installation in progress.",
"data": {
"product_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"proxmox_id": null,
"order_mode": "config",
"package_id": null,
"type": "server-epyc",
"cpu_typ": "EPYC",
"state": "install",
"cores": 4,
"memory": 16384,
"disk": 150,
"ipv4_amount": 1,
"ipv6_amount": 0,
"duration": 1,
"price": "17.99",
"offer_price": "17.99",
"password": "...",
"expire_at": "2026-10-20 12:00:00"
}
}
Im Konfigurationsmodus beträgt die Laufzeit aktuell 1 Monat. Bei package_id wird die im Paket hinterlegte Laufzeit verwendet. Eine laufende Aktion wird automatisch vom Preis abgezogen.
400 | Provide either "package_id" OR an individual configuration ...: Paket und Einzelwerte wurden zusammen geschickt |
400 | Missing parameters: provide "package_id" or "type", "cores", "memory", "disk": Weder Paket noch Konfiguration angegeben |
422 | Missing required parameters: os: Ein Pflichtfeld fehlt |
400 | You must accept our Terms of Service and Privacy Policy: tos fehlt oder ist nicht true |
400 | You must accept the cancellation policy ...: cancellation fehlt oder ist nicht true |
404 | Package not found: Die Paket ID gibt es nicht |
400 | CPU type not found. Available types: ...: Unbekannter CPU Typ |
400 | Cores must be between ..., Memory must be ..., Disk must be between ..., IPv4 count must be between ..., IPv6 count must be between ...: Wert außerhalb der erlaubten Grenzen, die Meldung nennt den gültigen Bereich |
400 | Invalid operating system oder Windows requires at least 50GB disk space: Betriebssystem ungültig oder zu wenig Speicher für Windows |
400 | Not enough IPv4 addresses available bzw. Not enough IPv6 addresses available: Gerade keine freien Adressen |
402 | Insufficient balance. Required: 17.99 EUR, Available: 5.00 EUR: Nicht genug Guthaben |
/order/domain
Auth
Neue Domain registrieren oder eine bestehende Domain zu uns transferieren. Ist die Domain frei, wird sie registriert. Ist sie vergeben, wird mit authcode ein Transfer gestartet. Der Preis aus /domain/pricelist wird sofort vom Guthaben abgebucht. Lehnt die Registry ab, wird der Betrag sofort zurückgebucht.
domain | Text. Domainname, zum Beispiel beispiel.de. Umlaute sind erlaubt (erforderlich) |
authcode | Text. AuthCode vom bisherigen Anbieter. Nur für einen Transfer nötig, bei einer freien Domain wird er ignoriert (bei Transfer erforderlich) |
company | Text. Firmenname des Inhabers (optional) |
firstname | Text. Vorname des Inhabers (erforderlich) |
lastname | Text. Nachname des Inhabers (erforderlich) |
street | Text. Straße ohne Hausnummer (erforderlich) |
number | Text. Hausnummer (erforderlich) |
postcode | Text. Postleitzahl (erforderlich) |
city | Text. Stadt (erforderlich) |
state | Text. Bundesland, Kanton oder Provinz (erforderlich) |
country | Text. Land als zweistelliger ISO Code, zum Beispiel DE, AT oder CH (erforderlich) |
email | Text. E Mail Adresse des Inhabers (erforderlich) |
phone | Text. Telefonnummer, am sichersten im Format +49.65112345. Auch +49 651 12345 oder 0651 12345 werden erkannt, ohne Landesvorwahl wird die Vorwahl aus country genommen (erforderlich) |
nameservers | Array. 2 bis 5 Nameserver, die direkt gesetzt werden (optional). Ohne Angabe werden unsere Nameserver eingetragen. Ist die Liste ungültig, werden ebenfalls unsere Nameserver gesetzt |
Die Kontaktdaten werden als Inhaber der Domain bei der Registry hinterlegt und müssen deshalb zu einer echten Person oder Firma gehören.
{
"domain": "beispiel.de",
"company": "Muster GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"street": "Musterstraße",
"number": "1",
"postcode": "54290",
"city": "Trier",
"state": "Rheinland Pfalz",
"country": "DE",
"email": "max@beispiel.de",
"phone": "+49.65112345"
}
{
"domain": "vergeben.de",
"authcode": "Ab3$kL9#pQ2x",
"firstname": "Max",
...
}
product_id | UUID der neuen Domain, damit rufst du sie später über /domain/{id} ab |
domain | Bestellter Domainname, Umlautdomains in Punycode |
state | active = Domain ist registriert. pending = Transfer läuft noch. Das kann je nach Endung mehrere Tage dauern, danach wird die Domain automatisch aktiv |
type | register = Neuregistrierung, transfer = Transfer mit AuthCode |
price | Abgebuchter Betrag in EUR |
renew_price | Preis der jährlichen Verlängerung in EUR |
expire_at | Ablaufdatum der Domain. Bei pending vorläufig, das echte Datum wird nach dem Transfer eingetragen |
dns_zone | true = die DNS Zone wurde bei uns angelegt. false = die Zone konnte gerade nicht angelegt werden, sie entsteht dann beim Umstellen auf unsere Nameserver |
warning | Nur vorhanden, wenn die Domain bestellt wurde, die gewünschten Nameserver aber nicht gesetzt werden konnten. Dann bitte über /domain/{id}/nameserver nachtragen |
{
"state": "success",
"message": "Domain ordered successfully",
"data": {
"product_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "beispiel.de",
"state": "active",
"type": "register",
"price": "4.99",
"renew_price": "4.99",
"expire_at": "2027-10-03 12:00:00",
"dns_zone": true
}
}
Bei einem Transfer, der noch läuft, lautet message Domain order accepted, waiting for the registry und state steht auf pending.
422 | Missing required parameters: ...: Ein Pflichtfeld fehlt, die Meldung nennt alle fehlenden Felder |
422 | Please provide a valid domain name oder TLD not available: .xyz: Domainname ungültig oder Endung nicht im Angebot |
422 | Invalid phone number, use the format +49.65112345: Die Telefonnummer konnte nicht erkannt werden |
422 | Invalid contact: ... oder country must be an ISO 3166 code like DE: Kontaktdaten unvollständig, E Mail Adresse ungültig oder Land nicht als ISO Code |
422 | Domain is not available. Provide an authcode for transfer.: Die Domain ist vergeben und es wurde kein AuthCode mitgeschickt |
422 | Premium domains cannot be ordered via API. Contact support.: Premiumdomain |
422 | This TLD cannot be registered at the moment bzw. A transfer is not possible for this TLD at the moment: Für diese Endung gerade nicht möglich |
409 | Domain already exists in our system: Die Domain liegt bereits bei uns |
409 | Another request for this domain is in progress, please retry: Für diese Domain läuft gerade schon eine Bestellung |
402 | Insufficient balance. Required: 4.99 EUR, Available: 1.00 EUR: Nicht genug Guthaben |
400 | Domain order failed (DOM-2001): Die Registry hat die Bestellung abgelehnt, siehe Fehlercodes unten. Das Guthaben wurde zurückgebucht |
502 | Domain order failed oder Domain check failed: Die Registry war gerade nicht erreichbar. Das Guthaben wurde zurückgebucht |
500 | Domain ordered but booking failed, please contact support: Die Domain wurde registriert, die Buchung bei uns ist aber fehlgeschlagen. Bitte nicht erneut bestellen, sondern den Support kontaktieren |
DOM-2001 | Die Telefonnummer wurde abgelehnt |
DOM-2002 | Die E Mail Adresse wurde abgelehnt |
DOM-2003 | Die Adresse wurde abgelehnt (Straße, Hausnummer, Postleitzahl oder Stadt) |
DOM-2004 | Der Name wurde abgelehnt (Vorname, Nachname oder Firma) |
DOM-2005 | Das Land wurde abgelehnt |
DOM-3001 | Die Domain ist nicht verfügbar |
DOM-3002 | Der AuthCode wurde nicht akzeptiert |
DOM-3003 | Die Endung wird derzeit nicht unterstützt |
DOM-3004 | Die Domain ist nur zu Sonderkonditionen erhältlich |
DOM-3005 | Die Nameserver wurden abgelehnt |
DOM-3006 | Die Domain ist gesperrt |
DOM-3007 | Der Auftrag wurde abgelehnt, meist fehlt eine Angabe |
/order/webspace
Auth
Neuen KeyHelp Webspace bestellen. Das passende Paket wird über die Paket ID aus /products/webspace/packages ausgewählt. Der Preis wird sofort vom Guthaben abgebucht, die Einrichtung läuft danach automatisch.
package_id | Text. Paket ID aus /products/webspace/packages (erforderlich) |
password | Text. KeyHelp Passwort, mindestens 8 Zeichen (optional, ohne Angabe wird automatisch eines erzeugt) |
name | Text. Anzeigename des Webspaces (optional, Standard: Paketname) |
auto_renew | Zahl. 1 = automatische Verlängerung von Anfang an aktiv, 0 = aus (optional, Standard: 0) |
tos | Boolean. AGB und Datenschutz müssen mit true akzeptiert werden (erforderlich) |
cancellation | Boolean. Widerrufsverzicht muss mit true bestätigt werden (erforderlich) |
{
"package_id": "PACKAGE-UUID",
"password": "NeuesPasswort123",
"name": "Mein Webspace",
"auto_renew": 0,
"tos": true,
"cancellation": true
}
product_id | UUID des neuen Webspaces, damit rufst du ihn später über /webspace/{id} ab |
type | Immer webspace |
state | Immer install. Sobald die Einrichtung fertig ist, steht der Webspace auf active |
package_id | Die bestellte Paket ID |
package | Name des Pakets |
username | Benutzername für KeyHelp, wird automatisch erzeugt |
password | KeyHelp Passwort. Bitte sicher speichern, es wird später nicht mehr ausgegeben |
duration | Laufzeit in Monaten |
price | Abgebuchter Betrag in EUR |
expire_at | Ende der bezahlten Laufzeit |
auto_renew | 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus |
{
"state": "success",
"message": "Webspace order placed. Installation in progress.",
"data": {
"product_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"type": "webspace",
"state": "install",
"package_id": "PACKAGE-UUID",
"package": "WEB STARTER",
"username": "web1268ec03",
"password": "NeuesPasswort123",
"duration": 1,
"price": "4.99",
"expire_at": "2026-10-20 12:00:00",
"auto_renew": 0
}
}
KeyHelp verwendet intern eine neutrale Webspace Adresse auf Basis des generierten Benutzernamens. Die E Mail Adresse des Kunden wird dafür nicht verwendet.
422 | Missing required parameters: package_id: Die Paket ID fehlt |
400 | You must accept our Terms of Service and Privacy Policy: tos fehlt oder ist nicht true |
400 | You must accept the cancellation policy ...: cancellation fehlt oder ist nicht true |
404 | Webspace package not found: Die Paket ID gibt es nicht |
400 | Password must be at least 8 characters: Das Passwort ist zu kurz |
402 | Insufficient balance. Required: 4.99 EUR, Available: 1.00 EUR: Nicht genug Guthaben |
503 | No active KeyHelp webspace host available: Gerade kein Host verfügbar, bitte später erneut versuchen |