{ "openapi": "3.0.3", "info": { "title": "NXTByte Reseller API", "description": "REST-API für NXTByte-Reseller. Authentifizierung über den X-API-Key-Header. Live-Orders laufen über NXTBYTE-Accounting (user_logs + Verfügungsrahmen). Reseller haben kein Guthaben; Verlängerungen laufen über die monatliche Sammelrechnung. Unzureichender Rahmen oder zwei offene Monatsrechnungen → HTTP 402. Sandbox-Keys (`nxtbytesand-…`) provisionieren nicht, belasten nicht und zählen nicht zum Verbrauch; GET /me sowie Abrechnung sind live read-only. Für echte Bestellungen den Live-Key (`nxtbyte-…`) verwenden.", "version": "2.1.3", "contact": { "name": "NXTBYTE.DE Support", "url": "https://nxtbyte.de" } }, "servers": [ { "url": "https://api.nxtbyte.de", "description": "Produktion (api.*)" }, { "url": "https://api.nxtbyte.de/reseller-api", "description": "Alternativer Basispfad (/reseller-api/v1/…)" } ], "tags": [ { "name": "Konto", "description": "Profil & Verfügungsrahmen" }, { "name": "Abrechnung", "description": "Rechnungen (user_invoices), Bestellungen (user_logs / Sandbox-Ressourcen), Transaktionen (user_transaction). Sandbox-GETs sind live read-only; Listen = JSON-Array (leer = [] wenn keine Daten). Detail-Endpoints → 404 wenn unbekannt." }, { "name": "Domains", "description": "Domains, DNS, Handles" }, { "name": "KVM", "description": "Cloudserver / KVM" }, { "name": "Preislisten", "description": "Kompakte Domain-Preisliste ({success,data})" } ], "paths": { "/v1/me": { "get": { "tags": [ "Konto" ], "summary": "Reseller-Konto (Guthaben & Verfügungsrahmen)", "operationId": "GET_me", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/invoices": { "get": { "tags": [ "Abrechnung" ], "summary": "Eigene Rechnungen (user_invoices; Sandbox = live read-only)", "operationId": "GET_invoices", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/invoices/{id}": { "get": { "tags": [ "Abrechnung" ], "summary": "Einzelne Rechnung (404 wenn unbekannt; Sandbox = live read-only)", "operationId": "GET_invoices_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/orders": { "get": { "tags": [ "Abrechnung" ], "summary": "Bestellungen: Live = user_logs; Sandbox = Sandbox-Ressourcen + live read-only", "operationId": "GET_orders", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/orders/{id}": { "get": { "tags": [ "Abrechnung" ], "summary": "Einzelne Bestellung (404 wenn unbekannt)", "operationId": "GET_orders_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/transactions": { "get": { "tags": [ "Abrechnung" ], "summary": "Guthaben-Bewegungen (user_transaction; Sandbox = live read-only)", "operationId": "GET_transactions", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDto" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/domain/preise": { "get": { "tags": [ "Preislisten" ], "summary": "Kompakte Domain-Preisliste ({success,data}; gleiche markierte Preise wie /domains/pricing)", "operationId": "GET_domain_preise", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/domains/pricing": { "get": { "tags": [ "Domains" ], "summary": "Domain-Preise inkl. NXTBYTE-Aufschlag (CategoryPricingDto[] mit operations)", "operationId": "GET_domains_pricing", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/domains/check": { "post": { "tags": [ "Domains" ], "summary": "Verfügbarkeit über alle TLDs (price inkl. Aufschlag)", "operationId": "POST_domains_check", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCheckResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCheckRequest" } } } } } }, "/v1/domains/order": { "post": { "tags": [ "Domains" ], "summary": "Registrierung oder Transfer", "operationId": "POST_domains_order", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains": { "get": { "tags": [ "Domains" ], "summary": "Eigene Domains auflisten", "operationId": "GET_domains", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/domains/{id}": { "get": { "tags": [ "Domains" ], "summary": "Domain-Details", "operationId": "GET_domains_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Domains" ], "summary": "Domain kündigen", "operationId": "DELETE_domains_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/domains/{id}/info": { "get": { "tags": [ "Domains" ], "summary": "Registry-Rohinfos", "operationId": "GET_domains_id_info", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/domains/{id}/dns": { "get": { "tags": [ "Domains" ], "summary": "DNS-Records", "operationId": "GET_domains_id_dns", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Domains" ], "summary": "DNS-Record anlegen", "operationId": "POST_domains_id_dns", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/{id}/dns/{recordId}": { "patch": { "tags": [ "Domains" ], "summary": "DNS-Record ändern", "operationId": "PATCH_domains_id_dns_recordId_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Domains" ], "summary": "DNS-Record löschen", "operationId": "DELETE_domains_id_dns_recordId_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/domains/{id}/nameservers/default": { "get": { "tags": [ "Domains" ], "summary": "Standard-Nameserver", "operationId": "GET_domains_id_nameservers_default", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/domains/{id}/nameservers": { "put": { "tags": [ "Domains" ], "summary": "Nameserver setzen", "operationId": "PUT_domains_id_nameservers", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/{id}/auth-code": { "get": { "tags": [ "Domains" ], "summary": "Auth-/EPP-Code", "operationId": "GET_domains_id_auth_code", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/domains/{id}/auto-renew": { "patch": { "tags": [ "Domains" ], "summary": "Auto-Renew umschalten", "operationId": "PATCH_domains_id_auto_renew", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/{id}/renewal": { "get": { "tags": [ "Domains" ], "summary": "Verlängerungsquote (inkl. Aufschlag)", "operationId": "GET_domains_id_renewal", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/domains/{id}/renew": { "post": { "tags": [ "Domains" ], "summary": "Domain verlängern", "operationId": "POST_domains_id_renew", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domain/handle": { "get": { "tags": [ "Domains" ], "summary": "WHOIS-Handles auflisten", "operationId": "GET_domain_handle", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } }, "post": { "tags": [ "Domains" ], "summary": "Handle anlegen", "operationId": "POST_domain_handle", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domain/handle/{id}": { "get": { "tags": [ "Domains" ], "summary": "Handle abrufen", "operationId": "GET_domain_handle_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Domains" ], "summary": "Handle aktualisieren", "operationId": "PATCH_domain_handle_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Domains" ], "summary": "Handle löschen (sonst 501)", "operationId": "DELETE_domain_handle_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/pricing": { "get": { "tags": [ "KVM" ], "summary": "KVM-Pakete (Shop-VK) + Konfigurator-Hinweis", "operationId": "GET_kvm_pricing", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/kvm/configurator": { "get": { "tags": [ "KVM" ], "summary": "Standorte + Ressourcenpreise inkl. Aufschlag (pricePerCore …)", "operationId": "GET_kvm_configurator", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/kvm/configurator/{locationId}/templates": { "get": { "tags": [ "KVM" ], "summary": "OS-Templates", "operationId": "GET_kvm_configurator_locationId_templates", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/configurator/quote": { "post": { "tags": [ "KVM" ], "summary": "Preisvorschau inkl. Aufschlag", "operationId": "POST_kvm_configurator_quote", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/configurator/order": { "post": { "tags": [ "KVM" ], "summary": "Konfigurierten KVM bestellen", "operationId": "POST_kvm_configurator_order", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/order": { "post": { "tags": [ "KVM" ], "summary": "Paket bestellen", "operationId": "POST_kvm_order", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm": { "get": { "tags": [ "KVM" ], "summary": "KVM-Server auflisten", "operationId": "GET_kvm", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } } } }, "/v1/kvm/{id}": { "get": { "tags": [ "KVM" ], "summary": "KVM-Details", "operationId": "GET_kvm_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "KVM" ], "summary": "KVM kündigen", "operationId": "DELETE_kvm_id_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/actions/{action}": { "post": { "tags": [ "KVM" ], "summary": "start|stop|restart|rebuild", "operationId": "POST_kvm_id_actions_action_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/manage": { "get": { "tags": [ "KVM" ], "summary": "Capabilities", "operationId": "GET_kvm_id_manage", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/status": { "get": { "tags": [ "KVM" ], "summary": "Live-Status", "operationId": "GET_kvm_id_status", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/templates": { "get": { "tags": [ "KVM" ], "summary": "Reinstall-Templates", "operationId": "GET_kvm_id_templates", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/reinstall": { "post": { "tags": [ "KVM" ], "summary": "Neuinstallation", "operationId": "POST_kvm_id_reinstall", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/password-reset": { "post": { "tags": [ "KVM" ], "summary": "Passwort-Reset (sonst 501)", "operationId": "POST_kvm_id_password_reset", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/console": { "get": { "tags": [ "KVM" ], "summary": "Konsolen-URL", "operationId": "GET_kvm_id_console", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/backups": { "get": { "tags": [ "KVM" ], "summary": "Backups", "operationId": "GET_kvm_id_backups", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "KVM" ], "summary": "Backup erstellen", "operationId": "POST_kvm_id_backups", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/backups/{backupId}/restore": { "post": { "tags": [ "KVM" ], "summary": "Backup restore", "operationId": "POST_kvm_id_backups_backupId_restore", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/backups/{backupId}": { "delete": { "tags": [ "KVM" ], "summary": "Backup löschen", "operationId": "DELETE_kvm_id_backups_backupId_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/firewall": { "get": { "tags": [ "KVM" ], "summary": "Firewall (sonst 501)", "operationId": "GET_kvm_id_firewall", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "KVM" ], "summary": "Firewall-Policy (sonst 501)", "operationId": "PUT_kvm_id_firewall", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/firewall/rules": { "post": { "tags": [ "KVM" ], "summary": "Firewall-Regel (sonst 501)", "operationId": "POST_kvm_id_firewall_rules", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/firewall/rules/{ruleId}": { "delete": { "tags": [ "KVM" ], "summary": "Firewall-Regel löschen (sonst 501)", "operationId": "DELETE_kvm_id_firewall_rules_ruleId_", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/traffic": { "get": { "tags": [ "KVM" ], "summary": "Traffic", "operationId": "GET_kvm_id_traffic", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/network": { "get": { "tags": [ "KVM" ], "summary": "Netzwerk", "operationId": "GET_kvm_id_network", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/rescue": { "get": { "tags": [ "KVM" ], "summary": "Rescue (sonst 501)", "operationId": "GET_kvm_id_rescue", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "KVM" ], "summary": "Rescue aktivieren (sonst 501)", "operationId": "POST_kvm_id_rescue", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "KVM" ], "summary": "Rescue deaktivieren (sonst 501)", "operationId": "DELETE_kvm_id_rescue", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/isos": { "get": { "tags": [ "KVM" ], "summary": "ISOs (sonst 501)", "operationId": "GET_kvm_id_isos", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/iso": { "post": { "tags": [ "KVM" ], "summary": "ISO mount (sonst 501)", "operationId": "POST_kvm_id_iso", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "KVM" ], "summary": "ISO unmount (sonst 501)", "operationId": "DELETE_kvm_id_iso", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/boot": { "get": { "tags": [ "KVM" ], "summary": "Boot-Order (sonst 501)", "operationId": "GET_kvm_id_boot", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "tags": [ "KVM" ], "summary": "Boot-Order setzen (sonst 501)", "operationId": "PUT_kvm_id_boot", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/name": { "patch": { "tags": [ "KVM" ], "summary": "Umbenennen", "operationId": "PATCH_kvm_id_name", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/rdns": { "put": { "tags": [ "KVM" ], "summary": "Reverse-DNS", "operationId": "PUT_kvm_id_rdns", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/kvm/{id}/incidents": { "get": { "tags": [ "KVM" ], "summary": "Incidents/Tasks", "operationId": "GET_kvm_id_incidents", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/renewal": { "get": { "tags": [ "KVM" ], "summary": "Verlängerungsquote", "operationId": "GET_kvm_id_renewal", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/kvm/{id}/renew": { "post": { "tags": [ "KVM" ], "summary": "Verlängern", "operationId": "POST_kvm_id_renew", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "OK (JSON-Body laut Schema; Listen ohne Wrapper)", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "501": { "description": "Nicht implementiert für aktuellen Provider" }, "503": { "description": "API deaktiviert" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "Live-Key (`nxtbyte-…`) oder Sandbox-Key (`nxtbytesand-…`) aus dem Kundenpanel. Sandbox: keine Provisionierung/Belastung; Abrechnung-GETs lesen live (read-only)." } }, "schemas": { "MeResponse": { "type": "object", "required": [ "id", "name", "email", "company", "balance", "creditLimit", "available" ], "properties": { "id": { "type": "string", "description": "Kundennummer (Reseller-Konto)" }, "name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string", "nullable": true }, "balance": { "type": "number", "description": "Immer 0 (Reseller ohne Wallet)" }, "creditLimit": { "type": "number", "description": "Verfügungsrahmen EUR" }, "available": { "type": "number", "description": "Rest-Verfügungsrahmen (creditLimit minus monatlicher Verbrauch)" } } }, "InvoiceDto": { "type": "object", "required": [ "id", "invoiceNumber", "amount", "currency", "status", "paidAt", "createdAt" ], "properties": { "id": { "type": "string" }, "invoiceNumber": { "type": "string" }, "amount": { "type": "string", "description": "Decimal as string" }, "currency": { "type": "string", "example": "EUR" }, "status": { "type": "string", "description": "DRAFT|SENT|PAID|OVERDUE|CANCELLED" }, "paidAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" } } }, "OrderDto": { "type": "object", "required": [ "id", "status", "amount", "domain", "note", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "amount": { "type": "string" }, "domain": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "product": { "$ref": "#/components/schemas/OrderProductDto" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "OrderProductDto": { "type": "object", "required": [ "name", "category" ], "properties": { "name": { "type": "string" }, "category": { "type": "string" } } }, "TransactionDto": { "type": "object", "required": [ "id", "type", "amount", "balanceAfter", "description", "createdAt" ], "properties": { "id": { "type": "string" }, "type": { "type": "string", "description": "TOPUP|PAYMENT|REFUND|ADJUSTMENT" }, "amount": { "type": "string", "description": "Signed Decimal as string" }, "balanceAfter": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string" } } }, "DomainCheckRequest": { "type": "object", "required": [ "query" ], "properties": { "query": { "type": "string", "description": "Second-Level-Label ohne TLD (z. B. meinprojekt). Endung wird ignoriert.", "example": "meinprojekt" } } }, "DomainCheckResult": { "type": "object", "required": [ "productId", "tld", "domain", "price", "available" ], "properties": { "productId": { "type": "string", "description": "Produkt-ID aus GET /v1/domains/pricing" }, "tld": { "type": "string", "example": "bayern" }, "domain": { "type": "string", "example": "meinprojekt.bayern" }, "price": { "type": "number", "description": "Reseller-/Kundenpreis EUR (mit NXTBYTE-Markup)" }, "available": { "type": "boolean", "description": "Provider-Verfügbarkeit" } } }, "DomainCheckResponse": { "type": "object", "required": [ "query", "results" ], "properties": { "query": { "type": "string", "example": "meinprojekt" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DomainCheckResult" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }