API-Referenz

Integriere die elizon-Plattform über unsere REST-API. Alle authentifizierten Endpunkte erfordern einen x-api-key-Header.

Endpunkte

224

Kategorien

Auth

x-api-key

Basis-URL

https://elizon.app/api

Schnellstart

Erstelle einen API-Schlüssel unter Dashboard → API-Schlüssel und sende ihn im x-api-key-Header mit.

# Eigene Services auflisten

curl https://elizon.app/api/services \

-H "x-api-key: YOUR_API_KEY"

# Ein Support-Ticket erstellen

curl -X POST https://elizon.app/api/tickets \

-H "x-api-key: YOUR_API_KEY" \

-H "Content-Type: application/json" \

-d '{"subject": "Help", "message": "..."}'

So funktioniert’s

Die elizon-API folgt RESTful-Konventionen. Alle Anfragen und Antworten verwenden JSON (Content-Type: application/json). Die Basis-URL für jeden Endpunkt lautet:

https://elizon.app/api

Antwortformat

Jede Antwort enthält ein success-Feld auf oberster Ebene. Bei Erfolg liegen die Nutzdaten direkt daneben – es gibt kein Wrapper-Objekt. Der Entitätsname variiert je nach Endpunkt (user, tickets, invoices usw.).

Erfolg

{
  "success": true,
  "services": [
    { "id": "abc123", "name": "My Server", "status": "RUNNING" }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "pages": 5
  }
}

Fehler

{
  "success": false,
  "error": "Authentication required"
}

Validierungsfehler

{
  "success": false,
  "error": "Validation failed for egg variables",
  "validationErrors": [
    "Variable 'SERVER_PORT' is required",
    "Variable 'MAX_PLAYERS' must be a number"
  ]
}

Authentifizierung

Die meisten Endpunkte erfordern einen gültigen API-Schlüssel. Sende ihn bei jeder Anfrage als benutzerdefinierten Header:

x-api-key: YOUR_API_KEY

Schlüssel sind bereichsbezogen – beim Erstellen wählst du die gewünschten Berechtigungen. Endpunkte mit „Kein API-Key“ sind nur mit einer Session nutzbar (Login, Registrierung usw.) und können nicht mit einem Key angesprochen werden.

Rate-Limiting

Anfragen sind pro Schlüssel begrenzt. Bei Überschreitung erhältst du eine 429-Antwort mit einem retryAfter-Feld und Rate-Limit-Headern.

{
  "success": false,
  "error": "Rate limit exceeded",
  "retryAfter": 60
}

Headers:
  X-RateLimit-Limit: 100
  X-RateLimit-Remaining: 0
  X-RateLimit-Reset: 1677654321000
  Retry-After: 60

Fehlerbehandlung

Alle Fehlerantworten liefern success: false und einen error-String. Manche Endpunkte fügen zusätzlich validationErrors (ein Array von Strings) oder einen errorKey zur programmatischen Verarbeitung hinzu.

Häufige Statuscodes

200 OK – Erfolgreich
201 Created – Ressource erstellt
400 Bad Request – Validierungsfehler oder fehlerhafter Body
401 Unauthorized – Fehlender oder ungültiger API-Schlüssel
403 Forbidden – Schlüssel hat nicht die nötige Berechtigung
404 Not Found – Ressource existiert nicht
429 Too Many Requests – Rate-Limit erreicht
500 Internal Server Error – Serverfehler auf unserer Seite

Paginierung

Listen-Endpunkte unterstützen die Query-Parameter page und limit. Die Antwort enthält ein pagination-Objekt zur Berechnung der Seitenanzahl. Einige Endpunkte verwenden Offset-basierte Paginierung mit offset und hasMore.

GET /api/tickets?page=2&limit=10

{
  "success": true,
  "tickets": [...],
  "pagination": {
    "page": 2,
    "limit": 10,
    "total": 42,
    "pages": 5
  }
}

Offset-basiert

GET /api/invoices?offset=10&limit=10

{
  "success": true,
  "invoices": [...],
  "pagination": {
    "total": 42,
    "limit": 10,
    "offset": 10,
    "hasMore": true
  }
}

Additional

Additional APIs that do not fit one of the primary documentation groups.

GET

/api/easter-2026Öffentlich

Get Easter 2026.

POST

/api/easter-2026Öffentlich

Create or perform Easter 2026.

GET

/api/easter-huntAuth

Get Easter Hunt.

POST

/api/easter-huntAuth

Create or perform Easter Hunt.

GET

/api/ip-managerAuth

Get Ip Manager.

PATCH

/api/ip-manager/[id]Auth

Update Ip Manager / ID.

GET

/api/ssh-keysAuth

Get Ssh Keys.

POST

/api/ssh-keysAuth

Create or perform Ssh Keys.

PATCH

/api/ssh-keys/[id]Auth

Update Ssh Keys / ID.

DELETE

/api/ssh-keys/[id]Auth

Delete Ssh Keys / ID.

POST

/api/ssh-keys/generateAuth

Create or perform Ssh Keys / Generate.

GET

/api/status/selfÖffentlich

Get Status / Self.

Affiliates

Partnerprogramm — Empfehlungslinks, Provisionen und Auszahlungen.

GET

/api/affiliates/meAuth

Get the current user's affiliate profile and stats.

GET

/api/affiliates/me/commissionsAuth

Get the current user's affiliate commissions history.

POST

/api/affiliates/me/convert-to-creditAuth

Convert affiliate earnings to account credit/balance.

GET

/api/affiliates/me/coupon-usageAuth

Get usage stats for the affiliate's coupon code.

POST

/api/affiliates/me/credit-note/[id]/confirmAuth

Confirm and finalize a credit note.

POST

/api/affiliates/me/credit-note/previewAuth

Preview a credit note before generating it.

GET

/api/affiliates/me/credit-notesAuth

List affiliate credit notes (Gutschriften).

GET

/api/affiliates/me/credit-notes/[id]/downloadAuth

Download a specific credit note as PDF.

PATCH

/api/affiliates/me/payout-methodAuth

Update the affiliate's payout method (bank details).

GET

/api/affiliates/me/payout-requestsAuth

List affiliate payout requests.

POST

/api/affiliates/me/payout-requestsAuth

Create a new payout request.

GET

/api/affiliates/me/tax-infoAuth

Get the affiliate's tax information.

PUT

/api/affiliates/me/tax-infoAuth

Update the affiliate's tax information. Address and name come from the user profile; only ustId, taxNumber, and kleinunternehmer are read from the body.

POST

/api/affiliates/validateAuth

Validate an affiliate/referral code.

API-Schlüssel

API-Schlüssel für die Automatisierung erstellen und verwalten.

GET

/api/api-keysAuth

Alle API-Schlüssel auflisten (Tokens werden maskiert).

POST

/api/api-keysAuth

Neuen API-Schlüssel erstellen.

DELETE

/api/api-keysAuth

Revoke/delete an API key by ID.

GET

/api/api-keys/usageAuthKein API-Key

Get API Keys / Usage.

Authentifizierung

Registrieren, einloggen, Konten verifizieren und Sitzungen verwalten.

GET

/api/auth/2fa/setupAuthKein API-Key

Generate TOTP secret and QR code for enabling two-factor authentication.

POST

/api/auth/2fa/setupAuthKein API-Key

Confirm 2FA setup by submitting a valid TOTP code. Generates backup codes.

DELETE

/api/auth/2fa/setupAuthKein API-Key

Delete Auth / 2fa / Setup.

GET

/api/auth/backup-codesAuthKein API-Key

Get Auth / Backup Codes.

POST

/api/auth/backup-codesAuthKein API-Key

Create or perform Auth / Backup Codes.

POST

/api/auth/change-passwordAuthKein API-Key

Change password for the authenticated user. Requires current password and optional 2FA verification.

POST

/api/auth/codeÖffentlichKein API-Key

Create or perform Auth / Code.

POST

/api/auth/forgot-passwordÖffentlichKein API-Key

E-Mail zum Zurücksetzen des Passworts anfordern.

POST

/api/auth/loginÖffentlichKein API-Key

Authentifizierung mit E-Mail & Passwort. Gibt ein Session-Token zurück.

POST

/api/auth/logoutAuthKein API-Key

Aktuelle Sitzung beenden.

DELETE

/api/auth/logoutÖffentlichKein API-Key

Delete Auth / Logout.

GET

/api/auth/meAuthKein API-Key

Get full profile of the currently authenticated user including balances, settings, and account details.

PUT

/api/auth/meAuthKein API-Key

Update current user profile (display name, avatar, locale, etc.).

PATCH

/api/auth/meAuthKein API-Key

Update Auth / Me.

GET

/api/auth/oauth/[provider]ÖffentlichKein API-Key

Initiate OAuth flow with a specific provider. Redirects to provider's authorization URL.

GET

/api/auth/oauth/[provider]/callbackÖffentlichKein API-Key

Handle OAuth provider callback. Creates/links account and creates session.

GET

/api/auth/oauth/link/[provider]AuthKein API-Key

Initiate linking an OAuth provider to an existing account.

DELETE

/api/auth/oauth/link/[provider]AuthKein API-Key

Unlink an OAuth provider from the current account.

GET

/api/auth/oauth/providersÖffentlichKein API-Key

List enabled OAuth providers for the login page (name, icon, color).

GET

/api/auth/passkeysAuthKein API-Key

List all registered passkeys for the authenticated user.

DELETE

/api/auth/passkeysAuthKein API-Key

Delete a registered passkey by ID.

POST

/api/auth/passkeys/authenticateÖffentlichKein API-Key

Generate WebAuthn authentication challenge for login 2FA step.

GET

/api/auth/passkeys/registerAuthKein API-Key

Generate WebAuthn registration options to register a new passkey.

POST

/api/auth/passkeys/registerAuthKein API-Key

Complete passkey registration by submitting the WebAuthn attestation response.

POST

/api/auth/registerÖffentlichKein API-Key

Erstellt ein neues Benutzerkonto. Sendet eine Verifizierungs-E-Mail.

GET

/api/auth/reset-passwordÖffentlichKein API-Key

Validate a password reset token (check if still valid).

POST

/api/auth/reset-passwordÖffentlichKein API-Key

Passwort mithilfe eines Tokens aus der Reset-E-Mail zurücksetzen.

GET

/api/auth/sessionAuthKein API-Key

Gibt den aktuell authentifizierten Benutzer und Session-Informationen zurück.

GET

/api/auth/sessionsAuthKein API-Key

List all active sessions for the current user. Marks which one is the current session.

DELETE

/api/auth/sessionsAuthKein API-Key

Revoke/delete a specific session by ID, or all other sessions.

POST

/api/auth/verify-accountAuthKein API-Key

Submit 6-digit activation code to activate a newly registered account.

POST

/api/auth/verify-account/resendAuthKein API-Key

Resend account activation code via email. 60-second cooldown between resends.

POST

/api/auth/verify-codeÖffentlichKein API-Key

Verify 6-digit email code and complete login (used in email-based 2FA flow). Creates session on success.

GET

/api/auth/verify-emailAuthKein API-Key

Resend email verification link for the authenticated user.

POST

/api/auth/verify-emailÖffentlichKein API-Key

E-Mail-Adresse mit einem Verifizierungstoken bestätigen.

Rechnungen & Zahlung

Rechnungen einsehen, Zahlungsmethoden und Rechnungs-E-Mail verwalten.

GET

/api/balance/auto-topupAuth

Get Balance / Auto Topup.

POST

/api/balance/auto-topupAuth

Create or perform Balance / Auto Topup.

PATCH

/api/balance/auto-topup/[id]Auth

Update Balance / Auto Topup / ID.

DELETE

/api/balance/auto-topup/[id]Auth

Delete Balance / Auto Topup / ID.

GET

/api/balance/sepa-detailsAuth

Get SEPA bank details (IBAN, BIC) for manual balance top-up via bank transfer. Returns user-specific reference.

POST

/api/balance/top-upAuth

Create a Mollie payment link for balance top-up. Min/max amounts configurable via settings. Invoice created only after webhook confirmation.

GET

/api/invoicesAuth

Alle Rechnungen des authentifizierten Benutzers auflisten.

GET

/api/invoices/[id]Auth

Einzelne Rechnung mit Positionen abrufen.

GET

/api/invoices/[id]/documentAuth

Download invoice as a PDF document. Supports Lexware-generated invoices with local caching.

POST

/api/invoices/[id]/payAuth

Create a payment for an invoice. Supports mollie, sepa, guthaben (balance) payment methods. Unsuspends services on successful payment.

GET

/api/invoices/download-allAuth

Download all user's Lexware invoice PDFs as a ZIP archive.

Business

Business verification, invoice-mode billing, and business fund workflows.

GET

/api/business/billingAuth

Get the current user's business billing configuration.

POST

/api/business/billingAuth

Update business billing configuration.

DELETE

/api/business/billingAuth

Remove/reset business billing configuration.

GET

/api/business/eligibilityAuth

Check if the current user is eligible for business features.

GET

/api/business/fundAuth

Get the current user's BusinessFund status (active contracts, pending requests).

POST

/api/business/fundAuth

Request a new BusinessFund (financing for services).

POST

/api/business/fund/[id]/acceptAuth

Accept a BusinessFund offer. Payment via mollie or balance.

POST

/api/business/fund/[id]/cancelAuth

Cancel an active BusinessFund contract (respects binding period).

POST

/api/business/fund/[id]/rejectAuth

Reject a BusinessFund offer.

GET

/api/business/fund/special-terminationAuth

Get pending special termination requests.

POST

/api/business/fund/special-terminationAuth

Request special (extraordinary) termination of a BusinessFund contract.

GET

/api/business/verificationAuth

Get the current user's business verification status and details.

POST

/api/business/verificationAuth

Submit business verification documents for review.

GET

/api/business/verification/documents/[id]Auth

Download a specific verification document (only the document owner can access).

Warenkorb & Checkout

Warenkorb verwalten und Bestellungen abschließen.

POST

/api/cart/calculateAuth

Calculate prices server-side for cart items including upgrade prorata, taxes, and discounts.

POST

/api/cart/upgradeAuth

Calculate upgrade/downgrade pricing for a service. Returns cart item with prorated pricing.

POST

/api/cart/validateAuth

Validate cart items for product availability via provider adapter. Returns unavailable items.

POST

/api/checkoutAuth

Checkout durchführen – erstellt eine Rechnung und startet die Zahlung.

GET

/api/checkout/bootstrapAuth

Get Checkout / Bootstrap.

Produkte

Verfügbare Produkte und Kategorien durchsuchen.

GET

/api/categories/[id]/upgrade-configAuth

Get upgrade/downgrade configuration for a product category (resource pricing, allowed ranges, additional IP pricing).

GET

/api/productsÖffentlich

Alle verfügbaren Produkte auflisten. Unterstützt Filter und Paginierung.

GET

/api/products/[category]Öffentlich

Get a specific product category with its products and child categories.

GET

/api/products/[category]/[product]Öffentlich

Get detailed product info by category key and product slug. Includes pricing, customization options, provider details.

GET

/api/products/by-slug/[slug]Öffentlich

Get product by slug (optionally filtered by category).

GET

/api/products/locationsÖffentlich

Get location options (id, name, flag, city, pingUrl) per product for checkout.

GET

/api/products/templatesÖffentlich

Get available OS templates for a product (from provider cluster config). Respects allowed template IDs in category config.

Gutscheine

Rabattcoupons validieren und einlösen.

POST

/api/coupons/previewAuth

Validate a coupon code and preview the discount amount. Only one coupon per order allowed.

Permissions

Shared-resource permissions and delegated access flows.

GET

/api/permissionsAuthBenötigt: manage_permissions

Get all permissions for a resource. Requires manage_permissions access.

POST

/api/permissionsAuthBenötigt: manage_permissions

Grant permissions on a resource to a user by email. Available permissions: view, start, stop, restart, console, backup, backup_create, backup_restore, backup_delete, backup_schedule, settings, delete, manage_permissions.

DELETE

/api/permissionsAuthBenötigt: manage_permissions

Delete Permissions.

PATCH

/api/permissions/[id]Auth

Update permissions for an existing permission grant.

DELETE

/api/permissions/[id]Auth

Revoke a permission grant.

GET

/api/permissions/[id]/detailsAuth

Get permission invitation details (for acceptance page). Only the invited user can access.

POST

/api/permissions/acceptAuth

Accept a permission invitation.

POST

/api/permissions/declineAuth

Decline a permission invitation.

GET

/api/permissions/meAuth

Get permissions shared with the current user. Supports ?status= filter.

Health

Health-Check- & Konnektivitäts-Endpunkte.

GET

/api/pingÖffentlich

Gibt eine einfache Health-Check-Antwort zurück. Damit lässt sich prüfen, ob die API erreichbar ist.

GET

/api/public/countriesÖffentlich

Get list of all countries with tax rates. Used in registration and checkout forms.

GET

/api/public/navigationÖffentlich

Get navbar/navigation configuration for frontend display. Supports ?lang= for localization.

GET

/api/public/providers/[id]/catalogÖffentlich

Get templates and nodes for a provider (no sensitive data). Used in product/order flow.

GET

/api/public/registration-statusÖffentlich

Check whether registration is allowed (general, private, business). Used by the register page.

GET

/api/public/reviewsÖffentlich

Get moderated customer reviews (4+ stars) approved for homepage display. Returns up to 20 reviews.

GET

/api/public/statusÖffentlich

Get Public / Status.

Rewards & Addresses

NetPoints, address book, and related customer billing context.

GET

/api/addressesAuth

Alle gespeicherten Adressen auflisten.

POST

/api/addressesAuth

Neue Adresse hinzufügen.

PUT

/api/addressesAuth

Update an existing billing address by ID.

DELETE

/api/addressesAuth

Delete a billing address by ID.

GET

/api/netpointsAuth

Aktuellen NetPoints-Stand und Transaktionsverlauf abrufen.

POST

/api/netpoints/previewAuth

Preview maximum redeemable NetPoints for a given order total.

Services

Service lifecycle, console, power actions, files, billing, and runtime management.

GET

/api/servicesAuth

Alle Services des authentifizierten Benutzers auflisten.

POST

/api/servicesAuth

Create a new service instance (typically called by checkout/provisioning system).

GET

/api/services/[id]AuthBenötigt: view

Details eines bestimmten Services abrufen.

PATCH

/api/services/[id]AuthBenötigt: settings

Update service properties (user notes, name).

DELETE

/api/services/[id]AuthBenötigt: delete

Service kündigen / löschen.

POST

/api/services/[id]/actionAuthBenötigt: start, stop, restart, settings

Perform a service action (start, stop, restart, reset, suspend, resume). Permission-based per action.

GET

/api/services/[id]/allocationsAuthBenötigt: view

Get all port allocations for a Pterodactyl server.

POST

/api/services/[id]/apply-downgradeAuthBenötigt: settings

Apply a downgrade immediately: adjust resources, extend subscription period, restart service.

GET

/api/services/[id]/backupsAuthBenötigt: backup

List backups for a service via provider adapter.

POST

/api/services/[id]/backupsAuthBenötigt: backup

Create a new backup via provider adapter.

POST

/api/services/[id]/backups/[backupId]AuthBenötigt: backup

Restore a specific backup via provider adapter.

DELETE

/api/services/[id]/backups/[backupId]AuthBenötigt: backup

Delete a specific backup via provider adapter.

GET

/api/services/[id]/backups/[backupId]/downloadAuthBenötigt: backup

Get download URL for a backup (Pterodactyl only).

GET

/api/services/[id]/bandwidth-usageAuthBenötigt: view

Get aggregated bandwidth usage for the current billing period. Supports ?from=&to= override. Results cached.

GET

/api/services/[id]/billing-cyclesAuthBenötigt: view

Get allowed billing cycles for a service based on product configuration.

GET

/api/services/[id]/consoleAuthBenötigt: console

Get console access info. Returns VNC token/URL for Proxmox, SSE stream for Pterodactyl. Raw wss:// URL never leaves server.

POST

/api/services/[id]/consoleAuthBenötigt: console

Create or perform Services / ID / Console.

POST

/api/services/[id]/console/commandAuthBenötigt: console, start, stop, restart

Send a console command or power action through the server-side WebSocket to Pterodactyl daemon.

GET

/api/services/[id]/console/embedAuthBenötigt: console

Returns HTML page with VNC iframe for Proxmox. Sets PVEAuthCookie server-side.

GET

/api/services/[id]/console/streamAuthBenötigt: console

Server-Sent Events stream for Pterodactyl console output, status, and stats. Server-side WebSocket proxy.

GET

/api/services/[id]/disk-usageAuthBenötigt: view

Get filesystem disk usage from QEMU guest agent (Proxmox only).

GET

/api/services/[id]/eggsAuthBenötigt: view

Get allowed eggs from product category and provider-level variables (Pterodactyl).

GET

/api/services/[id]/filesAuthBenötigt: settings

List, read, write, create, delete, and rename files on a Pterodactyl server. Action specified via query params.

POST

/api/services/[id]/filesAuthBenötigt: view, settings

Create or perform Services / ID / Files.

GET

/api/services/[id]/firewallAuthBenötigt: view

List firewall rules for a service via provider adapter.

POST

/api/services/[id]/firewallAuthBenötigt: settings

Create a new firewall rule.

PATCH

/api/services/[id]/firewall/[ruleId]AuthBenötigt: settings

Update a specific firewall rule. Fields are allowlisted.

DELETE

/api/services/[id]/firewall/[ruleId]AuthBenötigt: settings

Delete a specific firewall rule.

POST

/api/services/[id]/ips/cancelAuthBenötigt: settings

Schedule cancellation of a specific IP address at period end, or undo a scheduled cancellation.

DELETE

/api/services/[id]/ips/cancelAuthBenötigt: settings

Delete Services / ID / Ips / Cancel.

GET

/api/services/[id]/metricsAuthBenötigt: view

Get Services / ID / Metrics.

GET

/api/services/[id]/notificationsAuthBenötigt: view

Get active provider notifications/mass-email alerts for a service.

POST

/api/services/[id]/reinstallAuthBenötigt: settings

Reinstall the service OS/template via provider adapter. Supports templateId, OS, Docker image, egg selection.

POST

/api/services/[id]/renewAuthBenötigt: settings

Preview renewal price for a given billing cycle. Returns price and dates but does NOT create an invoice.

GET

/api/services/[id]/settingsAuthBenötigt: view

Get VM display (standard/serial) and boot (UEFI/Legacy) settings via provider adapter.

POST

/api/services/[id]/settingsAuthBenötigt: view, settings, backup_schedule

Create or perform Services / ID / Settings.

PUT

/api/services/[id]/settingsAuthBenötigt: view, settings, backup_schedule

Replace or update Services / ID / Settings.

PATCH

/api/services/[id]/settingsAuthBenötigt: settings

Update VM display and boot settings via provider adapter.

GET

/api/services/[id]/sftpAuthBenötigt: view

Get Services / ID / Sftp.

POST

/api/services/[id]/sftp/ensure-passwordAuthBenötigt: settings

Create or perform Services / ID / Sftp / Ensure Password.

POST

/api/services/[id]/sftp/rotate-passwordAuthBenötigt: settings

Create or perform Services / ID / Sftp / Rotate Password.

GET

/api/services/[id]/startup-variablesAuthBenötigt: view

List Pterodactyl server environment/startup variables.

PUT

/api/services/[id]/startup-variablesAuthBenötigt: view, settings

Replace or update Services / ID / Startup Variables.

GET

/api/services/[id]/statusAuthBenötigt: view

Get live service status from the provider (CPU, RAM, disk, network usage, power state).

GET

/api/services/[id]/subscriptionAuthBenötigt: view

Get subscription details for a service (billing cycle, period dates, cancel status, extension eligibility).

PATCH

/api/services/[id]/subscription/autopayAuth

Configure autopay settings for a subscription (enable/disable auto billing, NetPoints first).

PATCH

/api/services/[id]/subscription/billing-addressAuth

Set billing address for a subscription (stored in subscription options).

POST

/api/services/[id]/subscription/cancelAuthBenötigt: settings

Cancel subscription immediately or at period end. Immediate cancellation terminates the service via provider.

POST

/api/services/[id]/subscription/extendAuthBenötigt: settings

Extend subscription period. Supports optional 7-day bonus (once per service) and loyalty offer (10% permanent discount + 7 days).

PATCH

/api/services/[id]/subscription/intervalAuthBenötigt: settings

Set the next billing cycle (applied at renewal). Allowed: 7, 14, 30, 60, 90, 120, 365 days.

POST

/api/services/[id]/subscription/reactivateAuthBenötigt: settings

Undo a pending (period-end) cancellation.

GET

/api/services/[id]/templatesAuthBenötigt: view

Get available reinstall templates for a service via provider adapter.

GET

/api/services/[id]/top-ipsAuthBenötigt: view

Get Services / ID / Top Ips.

GET

/api/services/[id]/trafficAuthBenötigt: view

Get traffic/RRD data via provider adapter. Supports ?timeframe=hour|day|week|month.

GET

/api/services/[id]/upgradeAuthBenötigt: view

Get Services / ID / Upgrade.

POST

/api/services/[id]/upgradeAuthBenötigt: settings

Upgrade/resize service resources (CPU, RAM, disk) via provider adapter.

GET

/api/services/maintenance-notificationsAuth

Get Services / Maintenance Notifications.

POST

/api/services/status-batchAuth

Fetch live provider status for multiple authorized services in a single request. Intended for dashboard and list views that only need the visible services refreshed.

GET

/api/services/total-bandwidthAuth

Get total monthly traffic across all user services. Supports ?month=YYYY-MM.

Speicher

Dateien hochladen und verwalten.

GET

/api/storageAuth

List user's storage volumes (standalone services + legacy nested volumes).

POST

/api/storageAuth

Datei hochladen (multipart/form-data).

GET

/api/storage/[id]Auth

Get storage volume details (standalone service or legacy nested volume).

PATCH

/api/storage/[id]Auth

Update storage volume properties (name, attachment).

DELETE

/api/storage/[id]Auth

Delete a storage volume.

POST

/api/storage/[id]/cancelAuth

Cancel storage subscription (immediate or at period end). Detaches volume and restarts VM if needed.

POST

/api/storage/add-to-cartAuth

Add additional storage to cart with pricing calculation. VM assignment happens after payment.

GET

/api/storage/configAuth

Get available storage types and pricing based on node configuration. Optionally scoped to a server.

Subdomains

Customer subdomain DNS records (A, AAAA, CNAME, SRV) for allowed domains. Owner checks and per-user limits apply.

GET

/api/subdomainsAuth

List all subdomain records for the current user. Returns limitUsed/limitMax (max 5). Response includes srvService and srvProtocol for SRV records.

POST

/api/subdomainsAuth

Create a subdomain record. Types: A, AAAA (Proxmox only), CNAME (target = own subdomain FQDN), SRV (Pterodactyl only). SRV requires targetCnameSubdomain: subdomain of an existing CNAME, A or AAAA record for the same domain and service (SRV target must be a hostname). For SRV use presetId (ts3|minecraft) or srvService+srvProtocol. Service must belong to user. A/AAAA: only same owner may add second type for same subdomain. Max 5 records per user.

PATCH

/api/subdomains/[id]Auth

Update a subdomain record (comment only). Only the record owner can update. Uses owner-scoped write (id + userId).

DELETE

/api/subdomains/[id]Auth

Delete a subdomain record and the corresponding Cloudflare DNS record. Only the record owner can delete. Uses owner-scoped delete (id + userId).

GET

/api/subdomains/domainsAuth

List allowed (active) domains for the subdomain tool. Customer-facing; returns id and domain only.

Support & Knowledge Base

Support tickets, customer feedback, and knowledge base content.

GET

/api/feedbackAuth

List current user's feedback with pagination and status filtering.

POST

/api/feedbackAuth

Feedback einreichen.

GET

/api/knowledge-baseÖffentlich

Wissensdatenbank-Kategorien und -Artikel auflisten.

GET

/api/ticketsAuth

Eigene Support-Tickets auflisten.

POST

/api/ticketsAuth

Neues Support-Ticket erstellen.

GET

/api/tickets/[id]Auth

Ticket-Details und Nachrichtenverlauf abrufen.

POST

/api/tickets/[id]Auth

Add a message/reply to an existing ticket.

PATCH

/api/tickets/[id]Auth

Update ticket status (close, reopen, etc.).

GET

/api/tickets/[id]/exportAuth

Export ticket chat history as an HTML document.

Benutzer

Eigenes Konto, Profil und Einstellungen verwalten.

GET

/api/user/audit-logAuth

Get User / Audit Log.

GET

/api/user/autopayÖffentlich

[DEPRECATED - 410 Gone] User-level autopay has been replaced by per-subscription autopay.

PATCH

/api/user/autopayÖffentlich

[DEPRECATED - 410 Gone] User-level autopay has been replaced by per-subscription autopay.

POST

/api/user/change-emailAuth

Step 1: Initiate email change. Validates password + 2FA, sends 6-digit code to new email.

POST

/api/user/change-email/verify-newAuth

Step 2: Verify code sent to the new email address. Sends confirmation code to old email.

POST

/api/user/change-email/verify-oldAuth

Step 3: Verify code sent to the old email. Finalizes the email change on success.

GET

/api/user/gdpr-exportAuth

Generate a comprehensive GDPR data export (PDF or TXT) of all user data.

DELETE

/api/user/gdpr-exportAuth

Permanently delete user account and all associated data (GDPR right to erasure).

GET

/api/user/newsletter-settingsAuth

Get current newsletter opt-in status for the authenticated user.

POST

/api/user/newsletter-settingsAuth

Update newsletter opt-in. Opt-in requires email verification; opt-out is immediate.

PATCH

/api/user/settingsAuth

Update user notification/email preferences (login notification opt-in, email notifications).

GET

/api/user/subscriptionsAuth

Get all active subscriptions for the current user.

POST

/api/user/subscriptionsAuth

Create a new subscription for the current user.

GET

/api/user/support-phoneAuth

Get User / Support Phone.

GET

/api/user/support-pinAuth

Get the current active (non-expired) support PIN for identity verification.

POST

/api/user/support-pinAuth

Generate a new 6-digit support PIN for identity verification with support staff.

API-Referenz

Schnellstart

So funktioniert’s

Antwortformat

Authentifizierung

Rate-Limiting

Fehlerbehandlung

Paginierung

Additional

Affiliates

API-Schlüssel

Authentifizierung

Rechnungen & Zahlung

Business

Warenkorb & Checkout

Produkte

Gutscheine

Newsletter

Permissions

Health

Rewards & Addresses

Services

Speicher

Subdomains

Support & Knowledge Base

Benutzer