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.

Header
AuthorizationBearer DEIN_API_KEY (erforderlich bei jeder Anfrage)
Content-Typeapplication/json (erforderlich bei POST und PUT mit Request Body)
Acceptapplication/json (optional, die API antwortet immer mit JSON)
Beispiel
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.

Antwortfelder
statesuccess wenn die Anfrage ausgeführt wurde, error bei einem Fehler
messageKurze Meldung in englischer Sprache. Bei Erfolg meist OK, bei einem Fehler der Grund
dataDie eigentlichen Nutzdaten. Das Feld fehlt komplett, wenn eine Aktion keine Daten zurückgibt (zum Beispiel beim Starten eines Servers)
Erfolg
{
  "state": "success",
  "message": "OK",
  "data": { ... }
}
Fehler
{
  "state": "error",
  "message": "Server not found"
}

Einzige Ausnahme ist /domain/pricelist. Dort heißt das Feld für die Meldung response statt message.

Datenformate

idProdukte und Pakete werden über eine UUID angesprochen, zum Beispiel 019d78b5-1e34-822f-97c1-4103528065ef
pricePreise sind Text mit zwei Nachkommastellen und Punkt als Trennzeichen, immer in EUR, zum Beispiel "17.99"
durationLaufzeit in Monaten
expire_atDatum und Uhrzeit im Format JJJJ-MM-TT HH:MM:SS, deutsche Zeit (Europe/Berlin)
auto_renewAutomatische 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
GuthabenAlle Bestellungen und Verlängerungen werden sofort aus deinem Guthaben bezahlt. Reicht das Guthaben nicht, kommt Status 402 und es wird nichts ausgeführt
FreigabenServer 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-LimitErlaubte Anfragen pro 60 Sekunden
X-RateLimit-RemainingWie viele Anfragen im aktuellen Zeitfenster noch übrig sind
Retry-AfterNur bei Status 429: Sekunden, nach denen du es erneut versuchen kannst

HTTP Statuscodes

200Anfrage erfolgreich ausgeführt
400Anfrage nicht ausführbar, zum Beispiel falscher Zustand des Produkts, ungültige Werte oder ungültiges JSON im Request Body
401API Key fehlt oder ist ungültig
402Nicht genug Guthaben. Die Meldung nennt den benötigten Betrag
403Kein Zugriff auf dieses Produkt, Aktion nur für den Inhaber erlaubt oder Account nicht aktiv
404Produkt, Paket oder Endpoint nicht gefunden
405HTTP Methode wird nicht unterstützt
409Konflikt mit dem aktuellen Zustand, zum Beispiel Domain bereits vorhanden oder gerade in Bearbeitung
422Pflichtfeld fehlt oder ein Wert hat das falsche Format. Die Meldung nennt das betroffene Feld
429Rate Limit erreicht
500Interner Fehler. Bitte den Support mit Uhrzeit und Endpoint kontaktieren
501Die Aktion ist für dieses Produkt nicht verfügbar
502Ein angebundenes System (Registrar oder Nameserver) hat nicht oder fehlerhaft geantwortet. Die Anfrage kann später wiederholt werden
503Für dieses Produkt ist gerade kein Host verfügbar

Server

GET /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.

Antwortfelder
serversListe deiner Server, leer wenn du keine Server hast
idUUID des Servers, wird für alle Endpoints unter /server/{id} gebraucht
typeCPU Typ: epyc, ryzen oder xeon. Ältere Server ohne Typ erscheinen als legacy
stateinstall = wird gerade eingerichtet, active = läuft normal, reinstall = wird gerade neu installiert
pricePreis pro Laufzeit in EUR, wird bei jeder Verlängerung berechnet
durationLaufzeit in Monaten
expire_atEnde der bezahlten Laufzeit
created_atZeitpunkt der Bestellung
custom_nameAnzeigename des Servers
auto_renew1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
Response
{
  "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
      }
    ]
  }
}
GET /server/os Auth

Verfügbare Betriebssysteme für Bestellung und Neuinstallation

Keine Parameter.

Antwortfelder
operating_systemsListe aller installierbaren Betriebssysteme
proxmox_idID des Betriebssystems. Diesen Wert gibst du bei /order/server und /server/{id}/reinstall im Feld os an
nameLesbarer Name des Betriebssystems
Response
{
  "state": "success",
  "message": "OK",
  "data": {
    "operating_systems": [
      {
        "proxmox_id": "debian-13",
        "name": "Debian 13"
      }
    ]
  }
}

Für Windows braucht der Server mindestens 50 GB Speicher.

GET /server/{id} Auth

Details, Hardware, Adressen und Live Werte eines Servers abrufen

Pfad Parameter
idUUID des Servers aus /server/list (erforderlich)
Antwortfelder
idUUID des Servers
typeCPU Typ: epyc, ryzen, xeon oder legacy
stateinstall, active oder reinstall
custom_nameAnzeigename des Servers
pricePreis pro Laufzeit in EUR
expire_atEnde der bezahlten Laufzeit
auto_renew1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
hardware.coresAnzahl CPU Kerne
hardware.memory_mbArbeitsspeicher in MB
hardware.disk_gbGebuchter Speicher in GB
hardware.connectionBandbreitenlimit der Netzwerkkarte in MB/s, 1260 entspricht rund 10 Gbit/s geteilt
network.ipv4Haupt IPv4 Adresse, null solange noch keine vergeben ist
network.ipv6Haupt IPv6 Adresse, null solange noch keine vergeben ist
statusrunning = läuft, stopped = ausgeschaltet, unknown = der Server konnte nicht abgefragt werden
osInstalliertes Betriebssystem. Direkt nach der Bestellung steht hier Nach Neuinstallation sichtbar
statsLive Werte. Fehlt komplett, wenn der Server nicht abgefragt werden konnte
stats.cpu_percentAktuelle CPU Auslastung in Prozent
stats.memory_used_mbBelegter Arbeitsspeicher in MB
stats.memory_total_mbVerfügbarer Arbeitsspeicher in MB
stats.uptime_secondsLaufzeit seit dem letzten Start in Sekunden
stats.disk_total_gbGröße aller Dateisysteme in GB. Nur vorhanden, wenn im Server der QEMU Guest Agent läuft
stats.disk_used_gbBelegter Speicher aller Dateisysteme in GB. Nur mit QEMU Guest Agent
Response
{
  "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
    }
  }
}
Mögliche Fehler
404Server not found: Die ID gibt es nicht oder der Server wurde gelöscht
403No access to this server: Der Server gehört dir nicht und ist dir nicht freigegeben
400Product is not a server: Die ID gehört zu einem anderen Produkt
GET /server/{id}/status Auth

Schnellstatus des Servers mit Laufzeit und aktuellen Ressourcenwerten. Schneller als /server/{id}, gut geeignet für regelmäßige Abfragen.

Pfad Parameter
idUUID des Servers (erforderlich)
Antwortfelder
statusrunning, stopped oder unknown
uptimeLaufzeit seit dem letzten Start in Sekunden, 0 wenn der Server aus ist
cpu_percentAktuelle CPU Auslastung in Prozent
memory_used_mbBelegter Arbeitsspeicher in MB
errorNur vorhanden, wenn der Server nicht erreichbar war. Dann steht status auf unknown und die übrigen Werte fehlen
Response
{
  "state": "success",
  "message": "OK",
  "data": {
    "status": "running",
    "uptime": 261355,
    "cpu_percent": 0.29,
    "memory_used_mb": 508.88
  }
}
Response wenn der Server nicht erreichbar ist
{
  "state": "success",
  "message": "OK",
  "data": {
    "status": "unknown",
    "error": "Could not reach server"
  }
}
GET /server/{id}/network Auth

Alle Adressen des Servers mit Gateway. Diese Werte brauchst du, wenn du das Netzwerk im Server selbst einrichtest.

Pfad Parameter
idUUID des Servers (erforderlich)
Antwortfelder
ipv4Liste aller IPv4 Adressen des Servers
ipv6Liste aller IPv6 Subnetze des Servers, immer als /64
ipIPv4 Adresse oder IPv6 Subnetz des Servers
gatewayGateway der jeweiligen Adresse bzw. des Subnetzes
typemain = Hauptadresse bzw. Hauptsubnetz
typeextra = Zusätzliche Adresse bzw. zusätzliches Subnetz
Response
{
  "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"
      }
    ]
  }
}
GET /server/{id}/console Auth

VNC Konsolenzugang im Browser. Damit erreichst du den Server auch dann, wenn das Netzwerk im Server nicht funktioniert.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein
Antwortfelder
console_urlLink zur noVNC Konsole. Für jeden Aufruf wird eine neue Sitzung erzeugt, den Link also direkt öffnen und nicht speichern
Response
{
  "state": "success",
  "message": "OK",
  "data": {
    "console_url": "https://..."
  }
}
Mögliche Fehler
400Server must be active to open console: Der Server wird gerade eingerichtet oder neu installiert
500Failed to create console session: Die Sitzung konnte nicht erzeugt werden
POST /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.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein

Kein Request Body. Bei Erfolg enthält die Antwort kein Feld data.

Response
{
  "state": "success",
  "message": "Server is starting"
}
Mögliche Fehler
400Server is not in active state: Der Server wird gerade eingerichtet oder neu installiert
400Server is already running: Der Server läuft bereits
500Failed to start server: Der Startbefehl konnte nicht abgesetzt werden
POST /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.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein

Kein Request Body. Bei Erfolg enthält die Antwort kein Feld data.

Response
{
  "state": "success",
  "message": "Server is stopping"
}
Mögliche Fehler
400Server is not in active state: Der Server wird gerade eingerichtet oder neu installiert
400Server is already stopped: Der Server ist bereits aus
500Failed to stop server: Der Stoppbefehl konnte nicht abgesetzt werden
POST /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.

Pfad Parameter
idUUID 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.

Response
{
  "state": "success",
  "message": "Server is restarting"
}
Mögliche Fehler
400Server is not in active state: Der Server wird gerade eingerichtet oder neu installiert
500Failed to restart server: Der Neustart konnte nicht abgesetzt werden, zum Beispiel weil der Server schon aus ist. Dann /server/{id}/start verwenden
POST /server/{id}/password Auth

Root Passwort ändern. Das Passwort wird direkt im laufenden Server gesetzt, der Server muss dafür eingeschaltet sein.

Pfad Parameter
idUUID des Servers (erforderlich)
Request Body
passwordText. Neues Passwort, mindestens 8 Zeichen (erforderlich)
Request
{
  "password": "NeuesPasswort123"
}

Bei Erfolg enthält die Antwort kein Feld data.

Response
{
  "state": "success",
  "message": "Password changed successfully"
}
Mögliche Fehler
422Missing required parameters: password: Das Feld fehlt oder ist leer
400Password must be at least 8 characters: Das Passwort ist zu kurz
500Failed to change password: Das Passwort konnte nicht gesetzt werden, meist weil der Server aus ist
POST /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.

Pfad Parameter
idUUID des Servers (erforderlich)
Request Body
osText. Betriebssystem ID (proxmox_id) aus /server/os (erforderlich)
passwordText. Neues Root Passwort (optional, wird automatisch erzeugt wenn nicht angegeben)
Request
{
  "os": "debian-13",
  "password": "NeuesPasswort123"
}
Antwortfelder
passwordRoot Passwort nach der Neuinstallation, entweder dein eigenes oder das automatisch erzeugte. Bitte sicher speichern
Response
{
  "state": "success",
  "message": "Server reinstallation queued",
  "data": {
    "password": "NeuesPasswort123"
  }
}
Mögliche Fehler
422Missing required parameters: os: Das Feld fehlt
400Server is already being reinstalled: Eine Neuinstallation läuft bereits
400Invalid operating system: Die angegebene ID steht nicht in /server/os
400Windows requires at least 50GB disk space: Der Server hat für Windows zu wenig Speicher
POST /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.

Pfad Parameter
idUUID des Servers (erforderlich)

Kein Request Body.

Antwortfelder
new_expire_atNeues Ende der bezahlten Laufzeit
chargedAbgebuchter Betrag in EUR
Response
{
  "state": "success",
  "message": "Server renewed successfully",
  "data": {
    "new_expire_at": "2026-09-10 20:43:48",
    "charged": "17.99"
  }
}
Mögliche Fehler
403Only the owner can renew: Der Server ist dir nur freigegeben
402Insufficient balance. Required: 17.99 EUR, Available: 5.00 EUR: Nicht genug Guthaben
PUT /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.

Pfad Parameter
idUUID des Servers (erforderlich)
Request Body
enabledZahl. 1 = automatische Verlängerung aktivieren, 0 = automatische Verlängerung deaktivieren (optional; ohne Angabe wird der aktuelle Wert umgeschaltet, aus 1 wird 0 und umgekehrt)
Request
{
  "enabled": 1
}
Antwortfelder
auto_renewNeuer Wert: 1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
Response
{
  "state": "success",
  "message": "Auto-renew enabled",
  "data": {
    "auto_renew": 1
  }
}
Mögliche Fehler
403Only the owner can change auto-renew: Der Server ist dir nur freigegeben
GET /server/{id}/traffic Auth

Netzwerk Traffic des Servers über einen Zeitraum, passend für eigene Diagramme

Pfad Parameter
idUUID des Servers (erforderlich)
Query Parameter
periodZeitraum: hour, day, week, month, year (optional, default: hour)
Request
GET /server/{id}/traffic?period=day
Antwortfelder
periodDer angefragte Zeitraum
unitEinheit der Werte, immer bit/s
timeZeitpunkte als Unix Zeitstempel in Sekunden
inEingehender Traffic in bit/s, Durchschnitt des jeweiligen Messintervalls
outAusgehender 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].

Response
{
  "state": "success",
  "message": "OK",
  "data": {
    "period": "hour",
    "unit": "bit/s",
    "time": [
      1723632000,
      1723632060
    ],
    "in": [
      1200000,
      1450000
    ],
    "out": [
      850000,
      930000
    ]
  }
}
Mögliche Fehler
400Invalid period. Use: hour, day, week, month, year: Ungültiger Zeitraum
500Failed to fetch traffic data: Die Werte konnten nicht geladen werden
POST /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.

Pfad Parameter
idUUID des Servers (erforderlich)
Request Body
periodText. Zeitraum: hour, day, week, month, year (optional, default: hour)
Request
{
  "period": "day"
}
Antwortfelder
periodDer angefragte Zeitraum
coresAnzahl CPU Kerne des Servers
memory_total_mbVerfügbarer Arbeitsspeicher in MB
summary.cpuCPU Auslastung in Prozent: current_percent (letzter Messwert), average_percent, max_percent
summary.memoryArbeitsspeicher 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)
pointsMesspunkte, ältester zuerst
points[].timeZeitpunkt als Unix Zeitstempel in Sekunden
points[].cpu_percentCPU Auslastung in Prozent, bezogen auf alle Kerne
points[].memory_percentBelegter Arbeitsspeicher in Prozent
points[].memory_used_mbBelegter Arbeitsspeicher in MB
points[].netin_bpsEingehender Traffic in bit/s, Durchschnitt des jeweiligen Messintervalls
points[].netout_bpsAusgehender 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.

Response
{
  "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
      }
    ]
  }
}
Mögliche Fehler
400Invalid period. Use: hour, day, week, month, year: Ungültiger Zeitraum
409Server is not provisioned yet: Der Server wird gerade noch eingerichtet
500Failed 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).

posRegeln 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
lockedRegeln mit true werden vom Support verwaltet. Sie stehen immer ganz oben und können nicht bearbeitet, verschoben oder gelöscht werden
digestPrü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
SchutzDer 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
ZustandDie Firewall lässt sich nur ändern, wenn der Server im Zustand active ist
GET /server/{id}/firewall Auth

Firewall Regeln, Standardverhalten und die erlaubten Protokolle abrufen

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein

Kein Request Body.

Antwortfelder
cluster_enabledtrue = 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_inStandardverhalten für eingehenden Traffic: ACCEPT, DROP oder REJECT
policy_outStandardverhalten für ausgehenden Traffic: ACCEPT, DROP oder REJECT
digestPrüfsumme der aktuellen Regeln, leer wenn es keine Regeln gibt
rulesRegeln in der Reihenfolge, in der sie geprüft werden
rules[].posPosition der Regel
rules[].typein = eingehend, out = ausgehend
rules[].actionACCEPT = erlauben, DROP = verwerfen ohne Antwort, REJECT = ablehnen mit Antwort an den Absender
rules[].enabledtrue = die Regel ist aktiv
rules[].protoProtokoll, leer = alle Protokolle
rules[].proto_labelAnzeigename des Protokolls
rules[].source / rules[].destQuelle und Ziel, leer = alle Adressen
rules[].sport / rules[].dportQuellport und Zielport, leer = alle Ports
rules[].commentKommentar zur Regel
rules[].lockedtrue = vom Support verwaltet, nicht änderbar
protocolsErlaubte Werte für proto mit Anzeigename (value und label)
Response
{
  "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).

Mögliche Fehler
400Server is not in active state: Der Server ist nicht aktiv
409Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade
500Failed to fetch firewall: Die Firewall konnte nicht geladen werden
POST /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.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein
Request Body
typeText. in = eingehend, out = ausgehend (erforderlich)
actionText. ACCEPT, DROP oder REJECT (erforderlich)
enabledBoolean. true = Regel sofort aktiv, false = Regel nur speichern (optional, default: true)
protoText. Protokoll aus protocols (optional, leer = alle Protokolle)
sourceText. 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)
destText. Zieladresse, gleiches Format wie source (optional, leer = alle)
sportText. 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)
dportText. Zielport, gleiches Format wie sport (optional)
commentText. Kommentar, höchstens 100 Zeichen (optional)
Request
{
  "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.

Response
{
  "state": "success",
  "message": "Firewall rule added",
  "data": {
    "cluster_enabled": true,
    "policy_in": "DROP",
    "policy_out": "ACCEPT",
    "digest": "3afad6926ef5b2bd8be423e25c08b90edde04e55",
    "rules": [ ... ],
    "protocols": [ ... ]
  }
}
Mögliche Fehler
422Missing required parameters: type: Ein Pflichtfeld fehlt
422Invalid type. Use: in, out oder Invalid action. Use: ACCEPT, DROP, REJECT: Ungültiger Wert
422Unknown protocol: Das Protokoll steht nicht in protocols
422source: ..., 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
422Ports can only be used with tcp, udp or sctp: Ports wurden ohne passendes Protokoll angegeben
422Source and destination must both be IPv4 or both be IPv6: Quelle und Ziel passen nicht zusammen
422icmp is only valid for IPv4, use icmpv6 for IPv6 oder icmpv6 is only valid for IPv6: Protokoll passt nicht zur Adresse
422Maximum of 50 firewall rules reached: Es gibt bereits 50 Regeln
400Server is not in active state: Der Server ist nicht aktiv
409Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade
PUT /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.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein
posPosition der Regel aus rules[].pos (erforderlich)
Request Body
RegelDieselben Felder wie bei POST /server/{id}/firewall/rules, type und action sind erforderlich
digestText. Prüfsumme aus GET /server/{id}/firewall (optional)
Request
{
  "type": "in",
  "action": "ACCEPT",
  "proto": "tcp",
  "source": "203.0.113.0/24",
  "dport": "22",
  "comment": "SSH nur aus dem Büro",
  "digest": "3afad6926ef5b2bd8be423e25c08b90edde04e55"
}
Response
{
  "state": "success",
  "message": "Firewall rule updated",
  "data": { ... }
}
Mögliche Fehler
400Invalid rule position: pos ist keine Zahl
422Firewall rule not found: An dieser Position gibt es keine Regel
422This rule is managed by support and cannot be changed: Die Regel ist gesperrt
422Firewall rules were changed in the meantime, please reload them: Der digest passt nicht mehr
422Alle Prüfungen wie beim Anlegen einer Regel
400Server is not in active state: Der Server ist nicht aktiv
409Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade
PUT /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.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein
posPosition der Regel aus rules[].pos (erforderlich)
Request Body
enabledBoolean. true = aktivieren, false = deaktivieren (erforderlich)
digestText. Prüfsumme aus GET /server/{id}/firewall (optional)
Request
{
  "enabled": false
}
Response
{
  "state": "success",
  "message": "Firewall rule disabled",
  "data": { ... }
}
Mögliche Fehler
422Missing required parameters: enabled: Das Feld fehlt
400Invalid rule position: pos ist keine Zahl
422Firewall rule not found, This rule is managed by support and cannot be changed oder Firewall rules were changed in the meantime, please reload them
400Server is not in active state: Der Server ist nicht aktiv
409Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade
POST /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.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein
posAktuelle Position der Regel aus rules[].pos (erforderlich)
Request Body
positionZahl. Neue Position. Ist sie größer als die letzte Position, landet die Regel ganz unten (erforderlich, wenn direction fehlt)
directionText. up = eine Stelle nach oben, down = eine Stelle nach unten (erforderlich, wenn position fehlt)
digestText. Prüfsumme aus GET /server/{id}/firewall (optional)
Request
{
  "position": 0
}
Response
{
  "state": "success",
  "message": "Firewall rule moved",
  "data": { ... }
}
Mögliche Fehler
400Missing position or direction (up, down): Weder position noch eine gültige direction angegeben
400Invalid rule position: pos ist keine Zahl
422Rules cannot be moved above locked rules: Die Zielposition liegt zwischen den Support Regeln
422Firewall rule is already at the top oder Firewall rule is already at the bottom: Die Regel kann nicht weiter verschoben werden
422Firewall rule not found, This rule is managed by support and cannot be changed oder Firewall rules were changed in the meantime, please reload them
400Server is not in active state: Der Server ist nicht aktiv
409Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade
DELETE /server/{id}/firewall/rules/{pos} Auth

Regel löschen. Alle Regeln darunter rücken eine Position nach oben.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein
posPosition der Regel aus rules[].pos (erforderlich)
Request Body
digestText. Prüfsumme aus GET /server/{id}/firewall (optional, der Body kann auch ganz fehlen)
Request
{
  "digest": "3afad6926ef5b2bd8be423e25c08b90edde04e55"
}
Response
{
  "state": "success",
  "message": "Firewall rule deleted",
  "data": { ... }
}
Mögliche Fehler
400Invalid rule position: pos ist keine Zahl
422Firewall rule not found, This rule is managed by support and cannot be changed oder Firewall rules were changed in the meantime, please reload them
422Firewall rule could not be deleted: Die Regel konnte nicht gelöscht werden
400Server is not in active state: Der Server ist nicht aktiv
409Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade
PUT /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.

Pfad Parameter
idUUID des Servers (erforderlich). Der Server muss im Zustand active sein
Request Body
policy_inText. Eingehend: ACCEPT, DROP oder REJECT (erforderlich)
policy_outText. Ausgehend: ACCEPT, DROP oder REJECT (erforderlich)
Request
{
  "policy_in": "DROP",
  "policy_out": "ACCEPT"
}
Response
{
  "state": "success",
  "message": "Firewall policy updated",
  "data": { ... }
}
Mögliche Fehler
422Missing required parameters: policy_in: Ein Pflichtfeld fehlt
422Invalid policy. Use: ACCEPT, DROP, REJECT: Ungültiger Wert
400Server is not in active state: Der Server ist nicht aktiv
409Server is currently being reinstalled, please wait until it is finished: Eine Neuinstallation läuft gerade
GET /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.

Query Parameter
typeNur Pakete eines CPU Typs: epyc, ryzen oder xeon (optional, ohne Angabe kommen alle Typen)
Antwortfelder
typeCPU Typ der folgenden Pakete
packagesPakete dieses Typs, sortiert nach Kernen und Arbeitsspeicher
idPaket ID für /order/server
nameName des Pakets
coresAnzahl CPU Kerne
memoryArbeitsspeicher in MB
diskSpeicher in GB
ipv4Anzahl enthaltener IPv4 Adressen
ipv6Anzahl enthaltener IPv6 Subnetze (/64)
connectionBandbreitenlimit in MB/s, 1260 entspricht rund 10 Gbit/s geteilt
priceRegulärer Preis pro Laufzeit in EUR
offer_pricePreis nach einer aktuell laufenden Aktion. Gibt es keine Aktion, ist der Wert gleich price. Bei der Bestellung wird dieser Preis berechnet
Response
{
  "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"
        }
      ]
    }
  ]
}
Mögliche Fehler
400CPU type not found. Available types: epyc, ryzen, xeon: Unbekannter Typ
GET /order/server/price Auth

Preis für einen frei konfigurierten KVM Server berechnen, ohne zu bestellen

Query Parameter
typeCPU Typ: epyc, ryzen oder xeon (optional, default: ryzen)
coresAnzahl CPU Kerne (optional, default: 1)
memoryArbeitsspeicher in GB (optional, default: 1). Achtung: bei /order/server wird der Arbeitsspeicher in MB angegeben
diskSpeicher in GB (optional, default: 50)
ipv4Anzahl IPv4 Adressen (optional, default: 1)
ipv6Anzahl IPv6 Subnetze (optional, default: 1)
durationLaufzeit in Monaten für die Gesamtberechnung (optional, default: 1)
Request
GET /order/server/price?type=epyc&cores=4&memory=16&disk=150&ipv4=1&ipv6=0
Antwortfelder
cpu_typCPU Typ in Großbuchstaben
monthly_pricePreis pro Monat in EUR
total_priceGesamtpreis für duration Monate inklusive Laufzeitrabatt
duration_monthsDie angefragte Laufzeit
discount_percentLaufzeitrabatt in Prozent: 5 ab 3 Monaten, 10 ab 6 Monaten, 15 ab 12 Monaten, sonst 0
currencyImmer EUR
Response
{
  "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

GET /domain/list Auth

Alle eigenen Domains auflisten, neueste zuerst. Gelöschte Domains erscheinen nicht.

Query Parameter
searchNur Domains, deren Name diesen Text enthält, zum Beispiel beispiel (optional)
Request
GET /domain/list?search=beispiel
Antwortfelder
domainsListe deiner Domains, leer wenn nichts gefunden wurde
idUUID der Domain. Alle Endpoints unter /domain/{id} nehmen diese ID oder direkt den Domainnamen
domainDomainname, Umlautdomains in Punycode (zum Beispiel xn--mller-kva.de)
stateactive = Domain liegt bei uns, pending = Transfer oder Registrierung läuft noch und wird automatisch aktiv, sobald die Registry sie bestätigt
priceVerlängerungspreis pro Jahr in EUR
expire_atAblaufdatum der Domain
auto_renew1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
Response
{
  "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
      }
    ]
  }
}
GET /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.

Query Parameter
tldNur eine Endung, mit oder ohne Punkt, zum Beispiel de oder co.uk (optional)
Request
GET /domain/pricelist?tld=de
Antwortfelder
responseMeldung. Dieser Endpoint nutzt response statt message
dataListe der Endungen, alphabetisch sortiert. Leer, wenn die angefragte Endung nicht angeboten wird
tldEndung ohne Punkt
createPreis für die Registrierung (1 Jahr) in EUR
renewPreis für die Verlängerung um 1 Jahr in EUR
transferPreis für den Transfer zu uns in EUR
restorePreis für die Wiederherstellung einer gelöschten Domain in EUR
0.00Ein Preis von 0.00 bedeutet, dass diese Aktion für die Endung nicht angeboten wird
offerImmer false, Aktionen sind bereits im Preis enthalten
offerTypesImmer null
Response
{
  "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.

POST /domain/check Auth

Prüfen, ob eine Domain frei ist. Ist sie vergeben, kann sie mit AuthCode über /order/domain zu uns transferiert werden.

Request Body
domainText. Domainname ohne http:// und ohne Pfad, zum Beispiel beispiel.de. Großschreibung und Umlaute sind erlaubt (erforderlich)
Request
{
  "domain": "beispiel.de"
}
Antwortfelder
domainGeprüfter Domainname in Kleinbuchstaben, Umlautdomains in Punycode
availabletrue = frei und registrierbar, false = vergeben, nur ein Transfer ist möglich
premiumtrue = Premiumdomain mit Sonderpreis der Registry. Premiumdomains können nicht über die API bestellt werden
Response
{
  "state": "success",
  "message": "OK",
  "data": {
    "domain": "beispiel.de",
    "available": true,
    "premium": false
  }
}
Mögliche Fehler
422Please provide a valid domain name: Kein gültiger Domainname
422Please provide a domain name, not a URL: Es wurde eine URL statt eines Domainnamens geschickt
422TLD not available: .xyz: Diese Endung bieten wir nicht an
502Domain check failed: Die Prüfung konnte gerade nicht durchgeführt werden
GET /domain/{id} Auth

Domain Details abrufen, inklusive der aktuellen Daten aus der Registry

Pfad Parameter
idUUID der Domain oder direkt der Domainname, zum Beispiel /domain/beispiel.de (erforderlich)
Antwortfelder
idUUID der Domain
domainDomainname
stateactive oder pending
priceVerlängerungspreis pro Jahr in EUR
expire_atAblaufdatum laut unserem System
auto_renew1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
provider_infoAktuelle Daten aus der Registry. Fehlt, wenn die Registry gerade nicht erreichbar war
provider_info.expires_atAblaufdatum laut Registry. Das Format kann von expire_at abweichen
provider_info.nameserversAktuell eingetragene Nameserver
provider_info.auto_renewVerlä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_lock1 = Transfersperre aktiv, 0 = keine Transfersperre, null wenn nicht bekannt
provider_info.statusStatus der Domain bei der Registry, null wenn nicht bekannt
Response
{
  "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"
    }
  }
}
Mögliche Fehler
404Domain not found: Die Domain gibt es bei uns nicht oder sie wurde gelöscht
403No access to this domain: Die Domain gehört dir nicht und ist dir nicht freigegeben
GET /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.

Pfad Parameter
idUUID der Domain oder der Domainname (erforderlich)
Antwortfelder
domainDomainname
zone_existstrue = die DNS Zone liegt bei uns. false = es gibt noch keine Zone, sie wird beim Umstellen auf unsere Nameserver angelegt
recordsListe aller Records, sortiert nach Name und Typ. Leer, wenn noch keine Records angelegt sind
nameName relativ zur Domain. Leer bedeutet die Domain selbst, www bedeutet www.beispiel.de
typeRecord Typ, zum Beispiel A, AAAA, CNAME, MX oder TXT
dataInhalt des Records in lesbarer Form: TXT ohne Anführungszeichen, Hostnamen ohne Punkt am Ende, MX als Priorität Ziel
ttlGültigkeit in Sekunden
Response
{
  "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
      }
    ]
  }
}
Mögliche Fehler
502Failed to fetch DNS records: Die Nameserver waren gerade nicht erreichbar
POST /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.

Pfad Parameter
idUUID der Domain oder der Domainname (erforderlich)
Request Body
recordsArray. Komplette Liste der gewünschten Records, höchstens 250. Ein leeres Array löscht alle Records (erforderlich)
nameText. 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)
typeText. Erlaubt sind A, AAAA, CNAME, ALIAS, MX, SRV, TXT, CAA, PTR, TLSA (erforderlich)
dataText. Inhalt des Records, Format siehe unten (erforderlich)
ttlZahl. Gültigkeit in Sekunden von 60 bis 604800. Werte außerhalb werden auf 3600 gesetzt (optional, default: 3600)
Format von data je Typ
AIPv4 Adresse, zum Beispiel 203.0.113.10
AAAAIPv6 Adresse, zum Beispiel 2001:db8::10
CNAMEZielhostname, 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
ALIASZielhostname wie bei CNAME, aber auch auf der Domain selbst erlaubt
MXPriorität Ziel, zum Beispiel 10 mail.beispiel.de. Ohne Priorität wird 10 verwendet
SRVPriorität Gewicht Port Ziel, zum Beispiel 0 5 25565 mc.beispiel.de. Der Name enthält Dienst und Protokoll, zum Beispiel _minecraft._tcp
TXTBeliebiger Text, mit oder ohne Anführungszeichen. Texte über 255 Zeichen werden automatisch aufgeteilt
CAAFlag Tag "Wert", zum Beispiel 0 issue "letsencrypt.org"
PTRZielhostname
TLSAUsage Selector Matching Hash, zum Beispiel 3 1 1 0123ABCD...
Request
{
  "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" }
  ]
}
Antwortfelder
recordsDie Records, wie sie jetzt gespeichert sind, im selben Format wie bei GET /domain/{id}/dns
Response
{
  "state": "success",
  "message": "DNS records updated",
  "data": {
    "records": [
      {
        "name": "",
        "type": "A",
        "data": "203.0.113.10",
        "ttl": 3600
      }
    ]
  }
}
Mögliche Fehler
422Missing required parameters: records oder records must be an array: Das Feld fehlt oder ist keine Liste
422Record 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
422DNS records rejected: ...: Der Nameserver hat die Liste abgelehnt, der Grund steht hinter dem Doppelpunkt
409There is no DNS zone for this domain yet. Point the domain to our nameservers first.: Es gibt noch keine Zone
409The domain is not delegated to our nameservers: Die Domain zeigt auf fremde Nameserver
502The delegation of this domain could not be verified, please retry oder Failed to update DNS records: Registry oder Nameserver waren gerade nicht erreichbar
GET /domain/{id}/nameserver Auth

Aktuell bei der Registry eingetragene Nameserver abrufen

Pfad Parameter
idUUID der Domain oder der Domainname (erforderlich)
Antwortfelder
domainDomainname
nameserversEingetragene Nameserver
delegatedtrue = alle Nameserver sind unsere oder deine Whitelabel Nameserver, DNS Records lassen sich über /domain/{id}/dns bearbeiten. false = die Domain nutzt fremde Nameserver
Response
{
  "state": "success",
  "message": "OK",
  "data": {
    "domain": "beispiel.de",
    "nameservers": [
      "ns1.nameserver.zip",
      "ns2.nameserver.zip"
    ],
    "delegated": true
  }
}
Mögliche Fehler
502Failed to fetch nameservers: Die Registry war gerade nicht erreichbar
501This action is not available for this domain: Für diese Domain nicht möglich
POST /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.

Pfad Parameter
idUUID der Domain oder der Domainname (erforderlich)
Request Body
nameserversArray 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.

Request
{
  "nameservers": [
    "ns1.nameserver.zip",
    "ns2.nameserver.zip"
  ]
}
Antwortfelder
nameserversDie Nameserver, die tatsächlich gesetzt wurden
delegatedtrue = die Domain zeigt jetzt auf unsere oder deine Whitelabel Nameserver, DNS Records lassen sich bearbeiten
Response
{
  "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.

Mögliche Fehler
422Missing required parameters: nameservers: Das Feld fehlt komplett
400Failed to update nameservers (DOM-3005): Die Registry hat die Nameserver abgelehnt, zum Beispiel weil sie nicht erreichbar sind
502Failed to update nameservers oder DNS zone could not be prepared, please retry: Registry oder Nameserver waren gerade nicht erreichbar
GET /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.

Pfad Parameter
idUUID der Domain oder der Domainname (erforderlich)
Antwortfelder
domainDomainname
authcodeDer AuthCode als Text. Diesen Code beim neuen Anbieter angeben
Response
{
  "state": "success",
  "message": "OK",
  "data": {
    "domain": "beispiel.de",
    "authcode": "Ab3$kL9#pQ2x"
  }
}
Mögliche Fehler
403No access to this domain: Die Domain ist dir nur freigegeben
409The authcode is only available for active domains: Die Domain ist noch im Zustand pending
400Failed to fetch authcode (DOM-3006): Die Domain ist bei der Registry gesperrt
502Failed to fetch authcode: Die Registry war gerade nicht erreichbar
POST /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.

Pfad Parameter
idUUID der Domain oder der Domainname (erforderlich)

Kein Request Body.

Antwortfelder
new_expire_atNeues Ablaufdatum. Gerechnet wird vom bisherigen Ablaufdatum aus, ist das schon vorbei, ab heute
Response
{
  "state": "success",
  "message": "Domain renewed",
  "data": {
    "new_expire_at": "2028-10-03 12:00:00"
  }
}
Mögliche Fehler
403Only the owner can renew: Die Domain ist dir nur freigegeben
409Only active domains can be renewed: Die Domain ist noch im Zustand pending
409Another request for this domain is in progress, please retry: Für diese Domain läuft gerade schon eine Bestellung oder Verlängerung
402Insufficient balance. Required: 4.99 EUR: Nicht genug Guthaben
502Domain renewal failed at provider: Die Registry hat abgelehnt, das Guthaben wurde zurückgebucht

Webspace

GET /webspace/list Auth

Alle eigenen Webspaces auflisten, neueste zuerst. Gelöschte Webspaces erscheinen nicht.

Keine Parameter.

Antwortfelder
webspacesListe deiner Webspaces, leer wenn du keine hast
idUUID des Webspaces, wird für alle Endpoints unter /webspace/{id} gebraucht
typeImmer webspace
stateinstall = wird gerade eingerichtet, active = bereit, reinstall = wird gerade neu installiert
pricePreis pro Laufzeit in EUR, wird bei jeder Verlängerung berechnet
durationLaufzeit in Monaten
expire_atEnde der bezahlten Laufzeit
created_atZeitpunkt der Bestellung
auto_renew1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
planName des gebuchten Pakets
Response
{
  "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"
      }
    ]
  }
}
GET /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.

Antwortfelder
idPaket ID für /order/webspace
nameName des Pakets
diskSpeicherplatz in GB
domainsAnzahl Domains, die im Webspace angelegt werden können
subdomainsAnzahl Subdomains
databasesAnzahl Datenbanken
ftp_accountsAnzahl FTP Zugänge
emailsAnzahl E Mail Postfächer
pricePreis pro Laufzeit in EUR
offer_priceAktionspreis in EUR. Gibt es keine Aktion, ist der Wert gleich price
durationLaufzeit in Monaten
Response
{
  "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
    }
  ]
}
GET /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.

Antwortfelder
plansListe der Pakete, Felder wie bei /products/webspace/packages ohne subdomains
Response
{
  "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
      }
    ]
  }
}
GET /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.

Pfad Parameter
idUUID des Webspaces aus /webspace/list (erforderlich)
Antwortfelder
idUUID des Webspaces
typeImmer webspace
stateinstall, active oder reinstall
pricePreis pro Laufzeit in EUR
durationLaufzeit in Monaten
created_atZeitpunkt der Bestellung
expire_atEnde der bezahlten Laufzeit
auto_renew1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
credentials.usernameBenutzername für die Anmeldung im Webspace Panel
credentials.ftp_usernameEigener FTP Benutzername. Bei KeyHelp Webspaces null, dort gilt der normale Benutzername auch für FTP
planName des gebuchten Pakets
Response
{
  "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"
  }
}
Mögliche Fehler
404Webspace not found: Die ID gibt es nicht oder der Webspace wurde gelöscht
403No access to this webspace: Der Webspace gehört dir nicht
POST /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.

Pfad Parameter
idUUID des Webspaces (erforderlich)

Kein Request Body.

Antwortfelder
new_expire_atNeues Ende der bezahlten Laufzeit. Gerechnet wird vom bisherigen Ablaufdatum aus, ist das schon vorbei, ab jetzt
Response
{
  "state": "success",
  "message": "Webspace renewed",
  "data": {
    "new_expire_at": "2026-11-20 12:00:00"
  }
}
Mögliche Fehler
403Only the owner can renew: Nur der Inhaber darf verlängern
400Webspace is not active and cannot be renewed right now: Der Webspace wird gerade eingerichtet oder neu installiert
402Insufficient balance. Required: 4.99 EUR: Nicht genug Guthaben
POST /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.

Pfad Parameter
idUUID des Webspaces (erforderlich)
Request Body
passwordText. Neues Passwort, mindestens 8 Zeichen (optional, ohne Angabe wird automatisch ein neues Passwort erzeugt)
Request
{
  "password": "NeuesPasswort123"
}
Antwortfelder
product_idUUID des Webspaces
stateImmer reinstall. Nach Abschluss steht der Webspace wieder auf active
usernameBenutzername, unverändert
passwordNeues Passwort, entweder dein eigenes oder das automatisch erzeugte. Bitte sicher speichern
Response
{
  "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.

Mögliche Fehler
403Only the owner can reinstall: Nur der Inhaber darf neu installieren
400Webspace must be active to reinstall: Der Webspace ist nicht im Zustand active
400Only KeyHelp webspaces can be reinstalled: Ältere Webspaces lassen sich nicht über die API neu installieren
400Webspace is not ready for reinstallation: Die Einrichtung ist noch nicht vollständig abgeschlossen
400Password must be at least 8 characters: Das Passwort ist zu kurz
400Webspace reinstallation is already in progress: Eine Neuinstallation läuft bereits

Bestellungen

POST /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.

Request Body
package_idText. Paket ID aus /products/server/packages. Nur für den Paketmodus, nicht zusammen mit type, cores, memory, disk, ipv4 oder ipv6 verwenden
typeText. CPU Typ für den Konfigurationsmodus: epyc, ryzen oder xeon (im Konfigurationsmodus erforderlich)
coresZahl. Anzahl CPU Kerne (im Konfigurationsmodus erforderlich)
memoryZahl. RAM in MB, nur volle GB Schritte (Vielfaches von 1024), zum Beispiel 16384 für 16 GB (im Konfigurationsmodus erforderlich)
diskZahl. Speicher in GB (im Konfigurationsmodus erforderlich)
ipv4Zahl. Anzahl IPv4 Adressen (optional, Standard: 1)
ipv6Zahl. Anzahl IPv6 Subnetze (/64) (optional, Standard: 1). Für nur eine IPv4 Adresse 0 setzen
osText. Betriebssystem ID (proxmox_id) aus /server/os (erforderlich)
passwordText. Root Passwort (optional, ohne Angabe wird automatisch eines erzeugt)
nameText. Anzeigename (optional, Standard: Paketname bzw. KVM Server)
auto_renewZahl. 1 = automatische Verlängerung von Anfang an aktiv, 0 = aus (optional, Standard: 0)
tosBoolean. AGB und Datenschutz müssen mit true akzeptiert werden (erforderlich)
cancellationBoolean. Widerrufsverzicht muss mit true bestätigt werden (erforderlich)
Beispiel: KVM nur mit einer IPv4 Adresse
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.

Beispiel: Paketbestellung
{
  "package_id": "PACKAGE-UUID",
  "os": "debian-13",
  "name": "Mein Server",
  "tos": true,
  "cancellation": true
}
Antwortfelder
product_idUUID des neuen Servers, damit rufst du ihn später über /server/{id} ab
proxmox_idInterne Nummer der VM. Direkt nach der Bestellung noch null, sie wird bei der Einrichtung vergeben
order_modepackage = Paketbestellung, config = freie Konfiguration
package_idDie bestellte Paket ID, im Konfigurationsmodus null
typeInterner Produkttyp des Servers, zum Beispiel server-epyc
cpu_typCPU Typ in Großbuchstaben
stateImmer install. Sobald der Server fertig ist, steht er auf active
coresBestellte CPU Kerne
memoryBestellter Arbeitsspeicher in MB
diskBestellter Speicher in GB
ipv4_amountAnzahl IPv4 Adressen
ipv6_amountAnzahl IPv6 Subnetze
durationLaufzeit in Monaten
priceAbgebuchter Betrag in EUR
offer_pricePreis pro Laufzeit für spätere Verlängerungen in EUR, nach einer eventuell laufenden Aktion
passwordRoot Passwort des Servers. Bitte sicher speichern
expire_atEnde der bezahlten Laufzeit
Response
{
  "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.

Mögliche Fehler
400Provide either "package_id" OR an individual configuration ...: Paket und Einzelwerte wurden zusammen geschickt
400Missing parameters: provide "package_id" or "type", "cores", "memory", "disk": Weder Paket noch Konfiguration angegeben
422Missing required parameters: os: Ein Pflichtfeld fehlt
400You must accept our Terms of Service and Privacy Policy: tos fehlt oder ist nicht true
400You must accept the cancellation policy ...: cancellation fehlt oder ist nicht true
404Package not found: Die Paket ID gibt es nicht
400CPU type not found. Available types: ...: Unbekannter CPU Typ
400Cores 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
400Invalid operating system oder Windows requires at least 50GB disk space: Betriebssystem ungültig oder zu wenig Speicher für Windows
400Not enough IPv4 addresses available bzw. Not enough IPv6 addresses available: Gerade keine freien Adressen
402Insufficient balance. Required: 17.99 EUR, Available: 5.00 EUR: Nicht genug Guthaben
POST /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.

Request Body
domainText. Domainname, zum Beispiel beispiel.de. Umlaute sind erlaubt (erforderlich)
authcodeText. AuthCode vom bisherigen Anbieter. Nur für einen Transfer nötig, bei einer freien Domain wird er ignoriert (bei Transfer erforderlich)
companyText. Firmenname des Inhabers (optional)
firstnameText. Vorname des Inhabers (erforderlich)
lastnameText. Nachname des Inhabers (erforderlich)
streetText. Straße ohne Hausnummer (erforderlich)
numberText. Hausnummer (erforderlich)
postcodeText. Postleitzahl (erforderlich)
cityText. Stadt (erforderlich)
stateText. Bundesland, Kanton oder Provinz (erforderlich)
countryText. Land als zweistelliger ISO Code, zum Beispiel DE, AT oder CH (erforderlich)
emailText. E Mail Adresse des Inhabers (erforderlich)
phoneText. 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)
nameserversArray. 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.

Request
{
  "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"
}
Request für einen Transfer
{
  "domain": "vergeben.de",
  "authcode": "Ab3$kL9#pQ2x",
  "firstname": "Max",
  ...
}
Antwortfelder
product_idUUID der neuen Domain, damit rufst du sie später über /domain/{id} ab
domainBestellter Domainname, Umlautdomains in Punycode
stateactive = Domain ist registriert. pending = Transfer läuft noch. Das kann je nach Endung mehrere Tage dauern, danach wird die Domain automatisch aktiv
typeregister = Neuregistrierung, transfer = Transfer mit AuthCode
priceAbgebuchter Betrag in EUR
renew_pricePreis der jährlichen Verlängerung in EUR
expire_atAblaufdatum der Domain. Bei pending vorläufig, das echte Datum wird nach dem Transfer eingetragen
dns_zonetrue = die DNS Zone wurde bei uns angelegt. false = die Zone konnte gerade nicht angelegt werden, sie entsteht dann beim Umstellen auf unsere Nameserver
warningNur vorhanden, wenn die Domain bestellt wurde, die gewünschten Nameserver aber nicht gesetzt werden konnten. Dann bitte über /domain/{id}/nameserver nachtragen
Response
{
  "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.

Mögliche Fehler
422Missing required parameters: ...: Ein Pflichtfeld fehlt, die Meldung nennt alle fehlenden Felder
422Please provide a valid domain name oder TLD not available: .xyz: Domainname ungültig oder Endung nicht im Angebot
422Invalid phone number, use the format +49.65112345: Die Telefonnummer konnte nicht erkannt werden
422Invalid 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
422Domain is not available. Provide an authcode for transfer.: Die Domain ist vergeben und es wurde kein AuthCode mitgeschickt
422Premium domains cannot be ordered via API. Contact support.: Premiumdomain
422This 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
409Domain already exists in our system: Die Domain liegt bereits bei uns
409Another request for this domain is in progress, please retry: Für diese Domain läuft gerade schon eine Bestellung
402Insufficient balance. Required: 4.99 EUR, Available: 1.00 EUR: Nicht genug Guthaben
400Domain order failed (DOM-2001): Die Registry hat die Bestellung abgelehnt, siehe Fehlercodes unten. Das Guthaben wurde zurückgebucht
502Domain order failed oder Domain check failed: Die Registry war gerade nicht erreichbar. Das Guthaben wurde zurückgebucht
500Domain 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
Fehlercodes der Registry
DOM-2001Die Telefonnummer wurde abgelehnt
DOM-2002Die E Mail Adresse wurde abgelehnt
DOM-2003Die Adresse wurde abgelehnt (Straße, Hausnummer, Postleitzahl oder Stadt)
DOM-2004Der Name wurde abgelehnt (Vorname, Nachname oder Firma)
DOM-2005Das Land wurde abgelehnt
DOM-3001Die Domain ist nicht verfügbar
DOM-3002Der AuthCode wurde nicht akzeptiert
DOM-3003Die Endung wird derzeit nicht unterstützt
DOM-3004Die Domain ist nur zu Sonderkonditionen erhältlich
DOM-3005Die Nameserver wurden abgelehnt
DOM-3006Die Domain ist gesperrt
DOM-3007Der Auftrag wurde abgelehnt, meist fehlt eine Angabe
POST /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.

Request Body
package_idText. Paket ID aus /products/webspace/packages (erforderlich)
passwordText. KeyHelp Passwort, mindestens 8 Zeichen (optional, ohne Angabe wird automatisch eines erzeugt)
nameText. Anzeigename des Webspaces (optional, Standard: Paketname)
auto_renewZahl. 1 = automatische Verlängerung von Anfang an aktiv, 0 = aus (optional, Standard: 0)
tosBoolean. AGB und Datenschutz müssen mit true akzeptiert werden (erforderlich)
cancellationBoolean. Widerrufsverzicht muss mit true bestätigt werden (erforderlich)
Request
{
  "package_id": "PACKAGE-UUID",
  "password": "NeuesPasswort123",
  "name": "Mein Webspace",
  "auto_renew": 0,
  "tos": true,
  "cancellation": true
}
Antwortfelder
product_idUUID des neuen Webspaces, damit rufst du ihn später über /webspace/{id} ab
typeImmer webspace
stateImmer install. Sobald die Einrichtung fertig ist, steht der Webspace auf active
package_idDie bestellte Paket ID
packageName des Pakets
usernameBenutzername für KeyHelp, wird automatisch erzeugt
passwordKeyHelp Passwort. Bitte sicher speichern, es wird später nicht mehr ausgegeben
durationLaufzeit in Monaten
priceAbgebuchter Betrag in EUR
expire_atEnde der bezahlten Laufzeit
auto_renew1 = automatische Verlängerung ist aktiv, 0 = automatische Verlängerung ist aus
Response
{
  "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.

Mögliche Fehler
422Missing required parameters: package_id: Die Paket ID fehlt
400You must accept our Terms of Service and Privacy Policy: tos fehlt oder ist nicht true
400You must accept the cancellation policy ...: cancellation fehlt oder ist nicht true
404Webspace package not found: Die Paket ID gibt es nicht
400Password must be at least 8 characters: Das Passwort ist zu kurz
402Insufficient balance. Required: 4.99 EUR, Available: 1.00 EUR: Nicht genug Guthaben
503No active KeyHelp webspace host available: Gerade kein Host verfügbar, bitte später erneut versuchen