# SKRIME API > All documented endpoints of the SKRIME API. Descriptions in German, structure in English. Revision: bc6f3978ef6a Sandbox base URL (use first): https://skrime.eu/sandbox/ Live base URL: https://skrime.eu/api/ Auth: Authorization: Bearer $SKRIME_API_KEY Envelope: every JSON response is {"response": string, "state": "success" or "error", "data": payload}; the HTTP status carries the code. ## GET /api/account/user Name: Kundendaten abrufen Group: Account Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/user Live: https://skrime.eu/api/account/user Request body: none Response example: ```json { "response": "Successfully fetched user data", "state": "success", "data": { "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "active", "role": "customer", "username": "Max Mustermann", "email": "max@domain.tld", "profile": { "verified": false, "company": "Musterfirma GmbH", "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "state": "Musterstaat", "country": "DE", "phone": "+49.123456789" }, "balance": { "amount": "0.00", "coins": "125", "dispo": "0.00", "reservedAmount": "0.00", "total": "0.00" }, "sepaCode": "XXXXXX-XXXXXX", "legalAccepted": "1", "api": { "state": "active", "legalAccepted": "1" }, "affiliate": { "id": "maxmustermann", "redirect": "mainpage" }, "spin": "XXX-XXX-XXX", "avatar": "https://skrime.eu/data/avatar/XXXXX.svg", "tags": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Christmas", "icon": "fa-solid fa-star", "color": "#FFD700", "code": "XXXXXX", "visible": true, "order": 1, "claimedAt": "2024-01-01 00:00:00" } ], "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ], "instanceLimit": 0, "theme": "normal", "language": "de", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## POST /api/account/avatar Name: Avatar setzen Group: Account Erlaubte Formate: png, jpg, jpeg, gif. Höchstens 2 MB und 1024x1024 Pixel Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/avatar Live: https://skrime.eu/api/account/avatar Request example: ```json { "action": "upload", "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==" } ``` Response example: ```json { "response": "Successfully updated avatar", "state": "success", "data": { "avatar": "https://skrime.eu/data/custom/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.png" } } ``` ## DELETE /api/account/avatar Name: Avatar entfernen Group: Account Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/avatar Live: https://skrime.eu/api/account/avatar Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request body: none Response example: ```json { "response": "Successfully deleted avatar", "state": "success", "data": { "avatar": "https://skrime.eu/data/avatar/XXXXX.svg" } } ``` ## POST /api/account/profile Name: Profil setzen Group: Account Die Parameter "company" und "phone" sind optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/profile Live: https://skrime.eu/api/account/profile Request example: ```json { "company": "Musterfirma GmbH", "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "state": "Musterstaat", "country": "DE", "phone": "+49.123456789" } ``` Response example: ```json { "response": "Successfully updated profile", "state": "success", "data": { "profile": { "verified": false, "company": "Musterfirma GmbH", "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "state": "Musterstaat", "country": "DE", "phone": "+49.123456789" } } } ``` ## GET /api/account/auditlog Name: Audit Log abrufen Group: Account Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/auditlog Live: https://skrime.eu/api/account/auditlog Request body: none Response example: ```json { "response": "Successfully fetched audit logs", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "product": "Konto", "message": "Sprache geändert", "userAddr": "127.0.0.1", "userAgent": "Mozilla/5.0", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## POST /api/account/nameserver Name: Standard Nameserver setzen Group: Account Mindestens 2 und maximal 6 Nameserver müssen angegeben werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/nameserver Live: https://skrime.eu/api/account/nameserver Request example: ```json { "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } ``` Response example: ```json { "response": "Successfully updated default nameservers", "state": "success", "data": { "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } } ``` ## GET /api/account/notifications Name: Benachrichtigungen abrufen Group: Account Verfügbare "type": general, maintenance, product Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/notifications Live: https://skrime.eu/api/account/notifications Request example: ```json { "type": "general" } ``` Response example: ```json { "response": "Successfully fetched notifications", "state": "success", "data": { "notify": { "type": "general", "emailEnabled": true, "discord": false, "discordWebhook": "", "pushover": false, "pushoverUser": "" } } } ``` ## POST /api/account/notifications Name: Benachrichtigungen aktualisieren Group: Account Verfügbare "type": general, maintenance, product. Mindestens eine der Arten "emailEnabled", "discord" oder "pushover" muss aktiviert sein Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/notifications Live: https://skrime.eu/api/account/notifications Request example: ```json { "type": "general", "emailEnabled": true, "discord": false, "discordWebhook": "", "pushover": false, "pushoverUser": "" } ``` Response example: ```json { "response": "Successfully updated notifications", "state": "success", "data": { "notify": { "type": "general", "emailEnabled": true, "discord": false, "discordWebhook": "", "pushover": false, "pushoverUser": "" } } } ``` ## GET /api/account/charge Name: Zahlungsmethoden abrufen Group: Account Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/charge Live: https://skrime.eu/api/account/charge Request body: none Response example: ```json { "response": "Successfully fetched charge data", "state": "success", "data": { "minCharge": "0.00", "maxCharge": "0.00", "userRole": "customer", "paymentMethods": [ { "type": "MOLLIE_PAYPAL", "name": "PayPal", "active": true, "available": true, "background": "https://skrime.eu/data/payment/paypal.png" } ], "bonus": { "charge": { "enabled": false, "percent": "0.00" }, "transfer": { "enabled": true, "percent": "0.00" }, "partner": { "enabled": false, "percent": "0.00" } }, "bankTransfer": { "bank": "Musterbank", "accountHolder": "Max Mustermann", "iban": "DEXXXXXXXXXXXXXXXXXXXX", "bic": "XXXXXXXXXXX", "purpose": "XXXXXX-XXXXXX", "qrCode": "iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAA", "available": true } } } ``` ## POST /api/account/charge Name: Guthaben aufladen Group: Account Der Parameter "redirectUrl" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/charge Live: https://skrime.eu/api/account/charge Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Variant: Guthaben aufladen Request example: ```json { "action": "charge", "tos": true, "nochargeback": true, "amount": "0.00", "paymentMethod": "MOLLIE_PAYPAL", "redirectUrl": "https://domain.tld" } ``` Response example: ```json { "response": "Successfully created charge", "state": "success", "data": { "orderId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "amount": "0.00", "transactionId": "tr_XXXXXXXXXX", "gateway": "mollie", "paymentMethod": "PAYPAL", "paymentUrl": "https://www.mollie.com/checkout/select-method/XXXXXXXXXX" } } ``` Variant: Gutschein einlösen Request example: ```json { "action": "voucher", "voucherCode": "XXXXXX" } ``` Response example: ```json { "response": "Successfully redeemed voucher code", "state": "success", "data": { "voucherCode": "XXXXXX", "amount": "0.00" } } ``` ## GET /api/account/transactions Name: Transaktionsliste abrufen Group: Account Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/transactions Live: https://skrime.eu/api/account/transactions Request body: none Response example: ```json { "response": "Successfully fetched all transactions", "state": "success", "data": { "transactions": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "transaction", "amount": "0.00", "description": "Domain Verlängerung", "createdAt": "2024-01-01 00:00:00" }, { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "credit", "state": "success", "gateway": "mollie", "invoiceId": "XXXXX", "invoiceUuid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "amount": "0.00", "description": "PAYPAL", "tid": "tr_XXXXXXXXXX", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } ], "externalInvoices": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "paid", "invoiceId": "XXXXX", "invoiceUuid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "amount": "0.00", "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## GET /api/account/affiliate Name: Affiliate Daten abrufen Group: Account Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/affiliate Live: https://skrime.eu/api/account/affiliate Request body: none Response example: ```json { "response": "Successfully fetched affiliate data", "state": "success", "data": { "affiliateId": "maxmustermann", "redirect": "mainpage", "hasAffiliate": true, "referredBy": null, "canSetReferrer": false, "affiliateFirst": "0.00", "affiliateRecurring": "0.00", "stats": { "registers": 12, "clicks": 248, "payouts": "0.00" }, "chartData": { "clicks": [ [ 1767225600000, 18 ], [ 1769904000000, 24 ] ], "registrations": [ [ 1767225600000, 2 ], [ 1769904000000, 3 ] ], "balance": [ [ 1767225600000, "15.00" ], [ 1769904000000, "20.00" ] ] } } } ``` ## POST /api/account/affiliate Name: Referrer zuweisen Group: Account Nur innerhalb von 60 Minuten nach der Registrierung und nur, solange kein Referrer gesetzt ist Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/affiliate Live: https://skrime.eu/api/account/affiliate Variant: Referrer zuweisen Request example: ```json { "action": "referrer", "referrerId": "maxmustermann" } ``` Response example: ```json { "response": "Successfully assigned referrer", "state": "success", "data": { "referredBy": "maxmustermann" } } ``` Variant: Affiliate Link erstellen Request example: ```json { "affiliateId": "maxmustermann", "redirect": "mainpage" } ``` Response example: ```json { "response": "Successfully created affiliate link", "state": "success", "data": { "affiliateId": "maxmustermann", "redirect": "mainpage" } } ``` Variant: Affiliate Link aktualisieren Request example: ```json { "redirect": "mainpage" } ``` Response example: ```json { "response": "Successfully updated affiliate link", "state": "success", "data": { "affiliateId": "maxmustermann", "redirect": "mainpage" } } ``` ## GET /api/account/api Name: API Logs abrufen Group: Account Alle Parameter sind optional. Verfügbare "orderColumn": created_at, path, method, status_code, ip_address. Verfügbare "orderDir": asc, desc Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/api Live: https://skrime.eu/api/account/api Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "pagination": { "page": 1, "length": 25, "search": "", "orderColumn": "created_at", "orderDir": "desc" } } ``` Response example: ```json { "response": "Successfully fetched API data", "state": "success", "data": { "apiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "hasApiAccess": true, "logs": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "path": "account/auditlog", "method": "GET", "input": "{}", "output": "{}", "statusCode": "200", "ipAddress": "127.0.0.1", "createdAt": "2024-01-01 00:00:00" } ], "pagination": { "recordsTotal": 100, "recordsFiltered": 100, "currentPage": 1, "perPage": 25, "totalPages": 4, "hasNext": true, "hasPrev": false } } } ``` ## GET /api/account/counters Name: Zähler abrufen Group: Account Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/account/counters Live: https://skrime.eu/api/account/counters Request body: none Response example: ```json { "response": "Successfully fetched counters", "state": "success", "data": { "unpaidInvoices": 0 } } ``` ## GET /api/product/all Name: Alle Produkte abrufen Group: Produkt Der Parameter "type" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/all Live: https://skrime.eu/api/product/all Request example: ```json { "type": "server" } ``` Response example: ```json { "response": "Successfully fetched products", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "server", "state": "active", "userRights": [], "productInfo": { "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Mein Server", "autoRenew": true, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## GET /api/product/search Name: Produkte durchsuchen Group: Produkt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/search Live: https://skrime.eu/api/product/search Request example: ```json { "search": "127.0.0.1" } ``` Response example: ```json { "response": "Successfully fetched products", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "server", "state": "active", "userRights": [], "productInfo": { "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Mein Server", "autoRenew": true, "ipv4": [ { "ipAddress": "127.0.0.1", "gateway": "127.0.0.1", "type": "main" } ], "ipv6": [ { "ipAddress": "fe80::", "gateway": "fe80::", "type": "main" } ], "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## GET /api/product/single Name: Einzelnes Produkt abrufen Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/single Live: https://skrime.eu/api/product/single Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "server", "state": "active", "userRights": [], "productInfo": { "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Mein Server", "autoRenew": true, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/product/status Name: Störungsstatus abrufen Group: Produkt Meldet Störungen der Plattform, nicht den Zustand einer bestellten Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/status Live: https://skrime.eu/api/product/status Request body: none Response example: ```json { "response": "Successfully fetched status", "state": "success", "data": { "hasOffline": false, "hasNotifications": true, "hasIssues": true } } ``` ## POST /api/product/name Name: Produktname ändern Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden. Der Parameter "name" ist optional und darf höchstens 50 Zeichen enthalten, ohne Angabe wird der Standardname des Produkttyps gesetzt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/name Live: https://skrime.eu/api/product/name Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Mein Server" } ``` Response example: ```json { "response": "Successfully updated product name", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "customName": "Mein Server" } } ``` ## GET /api/product/rights Name: Benutzer abrufen Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/rights Live: https://skrime.eu/api/product/rights Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched user rights", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "users": [ { "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "username": "Max Mustermann", "avatar": "https://skrime.eu/data/avatar/XXXXX.svg", "description": "Administrator" } ] } } ``` ## POST /api/product/rights Name: Benutzer hinzufügen Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden. Der Parameter "description" darf höchstens 25 Zeichen enthalten Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/rights Live: https://skrime.eu/api/product/rights Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "description": "Administrator" } ``` Response example: ```json { "response": "Successfully added user rights", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "description": "Administrator" } } ``` ## DELETE /api/product/rights Name: Benutzer entfernen Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/rights Live: https://skrime.eu/api/product/rights Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully removed user from product", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/product/renew Name: Verlängerungsoptionen abrufen Group: Produkt Nur Produkte vom Typ "server" mit einer Laufzeit von einem Monat werden unterstützt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/renew Live: https://skrime.eu/api/product/renew Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched renew options", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "duration": "1", "renewPrice": "0.00", "options": [ { "months": 1, "loyaltyPercent": 0, "subtotal": "0.00", "loyaltyDiscount": "0.00", "finalTotal": "0.00" }, { "months": 12, "loyaltyPercent": 0, "subtotal": "0.00", "loyaltyDiscount": "0.00", "finalTotal": "0.00" } ] } } ``` ## POST /api/product/renew Name: Produkt verlängern Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden. Der Parameter "prepayMonths" ist optional, erlaubte Werte sind 1, 2, 3, 6, 12, 24. Produkte vom Typ "instance" und "dns" werden nicht unterstützt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/renew Live: https://skrime.eu/api/product/renew Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully renewed product", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "price": "0.00", "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00" } } ``` ## POST /api/product/autorenew Name: Automatische Verlängerung setzen Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden. Der Parameter "autoRenew" muss true oder false sein. Produkte vom Typ "instance" und "dns" werden nicht unterstützt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/autorenew Live: https://skrime.eu/api/product/autorenew Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "autoRenew": true } ``` Response example: ```json { "response": "Successfully updated auto renewal status", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "autoRenew": true } } ``` ## GET /api/product/log Name: Produkt Log abrufen Group: Produkt Alternativ kann "domain" statt "productId" verwendet werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/product/log Live: https://skrime.eu/api/product/log Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched product logs", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "logs": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "username": "Max Mustermann", "message": "Produkt verlängert", "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## GET /api/server/pricelist Name: Preisliste abrufen Group: KVM Server Die Parameter "catalog" und "voucher" sind optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/pricelist Live: https://skrime.eu/api/server/pricelist Variant: Preisliste abrufen Request example: ```json { "type": "server" } ``` Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "server", "state": "active", "productInfo": { "cores": 4, "memory": 8192, "disk": 100, "ipv4": 1, "ipv6": 1, "connection": 10, "type": "epyc", "vds": false }, "price": "0.00", "duration": "1", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "prepayOptions": [ { "months": 1, "billingCycles": 1, "loyaltyPercent": 0, "listTotal": "0.00", "discountOrderAmount": "0.00", "discountRenewAmount": "0.00", "voucherOrderAmount": "0.00", "voucherRenewAmount": "0.00", "subtotal": "0.00", "loyaltyDiscount": "0.00", "finalTotal": "0.00" }, { "months": 12, "billingCycles": 12, "loyaltyPercent": 0, "listTotal": "0.00", "discountOrderAmount": "0.00", "discountRenewAmount": "0.00", "voucherOrderAmount": "0.00", "voucherRenewAmount": "0.00", "subtotal": "0.00", "loyaltyDiscount": "0.00", "finalTotal": "0.00" } ], "createdAt": "2024-01-01 00:00:00" } ] } ``` Variant: Konfiguratorpreis abrufen Request example: ```json { "type": "server-config", "cores": 4, "memory": 8, "disk": 50, "ipv4": 1, "ipv6": 1, "connection": 10 } ``` Response example: ```json { "response": "Successfully fetched configurator pricing", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "server-config", "state": "active", "productInfo": { "cores": "0.00", "memory": "0.00", "disk": "0.00", "ipv4": "0.00", "ipv6": "0.00", "connection": "0.00", "type": "epyc", "vds": false }, "price": "0.00", "duration": "1", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "prepayOptions": [ { "months": 1, "billingCycles": 1, "loyaltyPercent": 0, "listTotal": "0.00", "discountOrderAmount": "0.00", "discountRenewAmount": "0.00", "voucherOrderAmount": "0.00", "voucherRenewAmount": "0.00", "subtotal": "0.00", "loyaltyDiscount": "0.00", "finalTotal": "0.00" }, { "months": 12, "billingCycles": 12, "loyaltyPercent": 0, "listTotal": "0.00", "discountOrderAmount": "0.00", "discountRenewAmount": "0.00", "voucherOrderAmount": "0.00", "voucherRenewAmount": "0.00", "subtotal": "0.00", "loyaltyDiscount": "0.00", "finalTotal": "0.00" } ], "config": "eyJjIjo0LCJtIjo4LCJkIjo1MCwiNCI6MSwiNiI6MSwiY29uIjoxMH0=", "configuration": { "cores": 4, "memory": 8, "disk": 50, "ipv4": 1, "ipv6": 1, "connection": 10 }, "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/server/os Name: Betriebssysteme abrufen Group: KVM Server Apps sind vorkonfigurierte Debian 13 Templates, die Einrichtung läuft beim ersten SSH Login Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/os Live: https://skrime.eu/api/server/os Request body: none Response example: ```json { "response": "Successfully fetched operating systems", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "os", "name": "Debian 12", "proxmoxId": "debian-12", "image": "https://skrime.eu/data/os/debian.svg", "group": "Debian", "minDisk": 10 } ] } ``` ## POST /api/server/order Name: KVM Server bestellen Group: KVM Server Entweder "planId" oder Konfigurator (cores, memory, disk, ipv4, ipv6, connection) angeben. Parameter "password" optional (min. 8 Zeichen), wird automatisch generiert wenn nicht angegeben. Parameter "prepayMonths" optional und akzeptiert bei monatlicher Laufzeit die Werte 1, 2, 3, 6, 12, 24. Verfügbare Betriebssysteme über GET server/os abrufbar. Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/order Live: https://skrime.eu/api/server/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "osName": "debian-12", "password": "Musterpasswort1", "tos": true, "cancellation": true, "notice": true, "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "server", "state": "install", "userRights": [], "productInfo": { "proxmox_id": 0, "cores": 4, "memory": 8192, "disk": 100, "connection": 1260, "password": "Musterpasswort1", "node_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "epyc", "vds": false, "tasks": [], "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "KVM Server", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/server/information Name: Informationen abrufen Group: KVM Server Parameter "lazy" optional (boolean). Bei lazy=true wird die Festplattenauslastung übersprungen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/information Live: https://skrime.eu/api/server/information Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched information", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "status": "online", "os": "Debian 12", "ipv4": "127.0.0.1", "ipv6": "fe80::", "username": "root", "password": "Musterpasswort1", "coresUsed": "25.50", "memoryUsed": "4.00", "diskUsed": "10.00" } } ``` ## GET /api/server/novnc Name: noVNC URL erzeugen Group: KVM Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/novnc Live: https://skrime.eu/api/server/novnc Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully generated noVNC URL", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "url": "https://novnc.eu/vnc.html#host=novnc.eu&port=443&encrypt=1&path=%3Ftoken=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&password=Xk7pQm2v&autoconnect=1&show_dot=true&scaleViewport=true" } } ``` ## POST /api/server/action Name: KVM Server starten/stoppen Group: KVM Server Parameter "action" muss einer der folgenden Werte sein: start, stop Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/action Live: https://skrime.eu/api/server/action Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "start" } ``` Response example: ```json { "response": "Successfully started server", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "start" } } ``` ## POST /api/server/passwd Name: Passwort ändern Group: KVM Server Parameter "password" mindestens 8 Zeichen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/passwd Live: https://skrime.eu/api/server/passwd Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully updated password", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } } ``` ## GET /api/server/network Name: Netzwerkinformationen abrufen Group: KVM Server Je IPv4- und IPv6-Eintrag kommt das Feld "countryCode" hinzu, sobald der Aufrufer das Recht team.statistic.ipam.view besitzt und das Land hinterlegt ist, bei IPv6 im RIPE-Objekt des /64 oder des übergeordneten Netzes Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/network Live: https://skrime.eu/api/server/network Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched network", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipv4": [ { "ipAddress": "127.0.0.1/24", "gateway": "127.0.0.1", "hostname": "server.domain.tld" } ], "ipv6": [ { "zone": "fe80::/64", "ipAddress": "fe80::/64", "gateway": "fe80::", "hostname": "server.domain.tld" }, { "zone": "fe80::/64", "ipAddress": "fe80::", "gateway": "fe80::", "hostname": "mail.domain.tld" } ] } } ``` ## GET /api/server/ddos Name: DDoS Statistik abrufen Group: KVM Server Verfügbare "period": 10m, 1h, 1d, 1w Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/ddos Live: https://skrime.eu/api/server/ddos Variant: DDoS Statistik abrufen Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "stats", "ipAddress": "127.0.0.1", "period": "1h" } ``` Response example: ```json { "response": "Successfully fetched DDoS statistics", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "period": "1h", "passUnit": "Mbps", "dropUnit": "Mbps", "statistics": [ { "time": "2024-01-01 00:00:00", "passed": 12.5, "dropped": 0.75 } ] } } ``` Variant: DDoS Ports abrufen Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "ports", "ipAddress": "127.0.0.1" } ``` Response example: ```json { "response": "Successfully fetched DDoS ports", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "ports": [ { "ruleId": "XXXXXX", "state": "working", "ipAddress": "127.0.0.1", "name": "SSH", "port": 22, "protocol": "TCP" } ] } } ``` Variant: DDoS Angriffe abrufen Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "attacks", "ipAddress": "127.0.0.1" } ``` Response example: ```json { "response": "Successfully fetched DDoS attacks", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "attacks": [ { "id": "XXXXXX", "type": "UDP_FLOOD", "ipAddress": "127.0.0.1", "peak": 100000000, "start": "2024-01-01 00:00:00", "stop": "2024-01-01 00:00:00" } ] } } ``` Variant: DDoS Angriff abrufen Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "attack", "attackId": "XXXXXX" } ``` Response example: ```json { "response": "Successfully fetched attack details", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "UDP_FLOOD", "attackId": "XXXXXX", "ipAddress": "127.0.0.1", "peak": 100000000, "ports": [ { "port": 443, "protocol": "UDP", "packetsPeak": 500000 } ], "start": "2024-01-01 00:00:00", "stop": "2024-01-01 00:00:00" } } ``` ## DELETE /api/server/ddos Name: DDoS Regel löschen Group: KVM Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/ddos Live: https://skrime.eu/api/server/ddos Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ruleId": "XXXXXX" } ``` Response example: ```json { "response": "Successfully deleted DDoS rule", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ruleId": "XXXXXX" } } ``` ## GET /api/server/firewall Name: Firewall Regeln abrufen Group: KVM Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/firewall Live: https://skrime.eu/api/server/firewall Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched firewall rules", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "rules": [ { "pos": 0, "type": "in", "action": "ACCEPT", "enabled": true, "macro": "", "protocol": "tcp", "source": "", "sourcePort": "", "destination": "", "destinationPort": "22", "icmpType": "", "isGroup": false, "locked": false, "group": "" } ] } } ``` ## POST /api/server/firewall Name: Firewall Regel verwalten Group: KVM Server Parameter "action" muss einer der folgenden Werte sein: create, edit, move. Bei "action" = "create" ist Parameter "rule" erforderlich. Bei "action" = "edit" sind Parameter "oldPos", "rule" erforderlich. Bei "action" = "move" sind Parameter "oldPos", "pos" erforderlich. Verfügbare "rule.type": in, out. Verfügbare "rule.action": ACCEPT, DROP, REJECT Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/firewall Live: https://skrime.eu/api/server/firewall Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "create", "rule": { "type": "in", "action": "ACCEPT", "enable": 1, "protocol": "tcp", "destinationPort": "22" } } ``` Response example: ```json { "response": "Successfully created firewall rule", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "in", "pos": 0, "action": "ACCEPT", "enabled": true, "macro": "", "protocol": "tcp", "source": "", "sourcePort": "", "destination": "", "destinationPort": "22", "icmpType": "", "positionApplied": true } } ``` ## DELETE /api/server/firewall Name: Firewall Regel löschen Group: KVM Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/firewall Live: https://skrime.eu/api/server/firewall Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pos": 3 } ``` Response example: ```json { "response": "Successfully deleted firewall rule", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/server/rdns Name: rDNS setzen Group: KVM Server Parameter "ipAddress" kann IPv4, IPv6 Adresse oder IPv6 Subnetz (mit /64) sein. Hostname sollte nicht mit einem Punkt enden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/rdns Live: https://skrime.eu/api/server/rdns Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "hostname": "server.domain.tld" } ``` Response example: ```json { "response": "Successfully updated rDNS", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "hostname": "server.domain.tld" } } ``` ## DELETE /api/server/rdns Name: rDNS löschen Group: KVM Server Parameter "ipAddress" kann IPv6 Adresse oder Subnetz (mit /64) sein Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/rdns Live: https://skrime.eu/api/server/rdns Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::" } ``` Response example: ```json { "response": "Successfully deleted rDNS", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::" } } ``` ## POST /api/server/ip Name: IPv4 Adresse hinzufügen Group: KVM Server Kann die Netzwerkkonfiguration nicht sofort angewendet werden, ist "requiresNetworkConfiguration" true und "response" lautet "Successfully added IPv4 address, network configuration pending" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/ip Live: https://skrime.eu/api/server/ip Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully added IPv4 address", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "gateway": "127.0.0.1", "upgradeCost": "0.00", "newPrice": "0.00", "ipv4Count": 2, "requiresNetworkConfiguration": false } } ``` ## GET /api/server/statistic Name: Statistiken abrufen Group: KVM Server Parameter "period" muss einer der folgenden Werte sein: hour, day, week, month Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/statistic Live: https://skrime.eu/api/server/statistic Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "period": "hour" } ``` Response example: ```json { "response": "Successfully fetched server statistics", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "statistics": [ { "time": "2024-01-01 00:00:00", "cpu": 25.5, "memory": 3.87, "netin": 10.52, "netout": 5.24 } ] } } ``` ## GET /api/server/backup Name: Backups abrufen Group: KVM Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/backup Live: https://skrime.eu/api/server/backup Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched backups", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "backups": [ { "volid": "local:vzdump-qemu-100-2026_09_23-14_05_12.vma.zst", "size": "10.50", "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## POST /api/server/backup Name: Backup wiederherstellen Group: KVM Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/backup Live: https://skrime.eu/api/server/backup Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "volid": "local:vzdump-qemu-100-2026_09_23-14_05_12.vma.zst" } ``` Response example: ```json { "response": "Successfully started backup restore", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "volid": "local:vzdump-qemu-100-2026_09_23-14_05_12.vma.zst" } } ``` ## DELETE /api/server/reinstall Name: KVM Server neuinstallieren Group: KVM Server Parameter "password" optional, mindestens 8 Zeichen. Parameter "osName" akzeptiert die Proxmox Kennung, die ID oder den Namen eines Betriebssystems Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/server/reinstall Live: https://skrime.eu/api/server/reinstall Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "osName": "debian-12", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully reinstalled server", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "osName": "debian-12", "password": "Musterpasswort1" } } ``` ## GET /api/dedicated/information Name: Informationen abrufen Group: Dedicated Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dedicated/information Live: https://skrime.eu/api/dedicated/information Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched information", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "status": "online", "cpu": "AMD EPYC 7543", "memory": "1024GB DDR4 ECC", "disk": [ { "type": "SATA SSD", "size": "250GB", "count": 2 }, { "type": "NVMe SSD", "size": "3.84TB", "count": 4 } ], "uplink": "2x 10 Gbit/s LACP" } } ``` ## POST /api/dedicated/action Name: Dedicated Server starten/stoppen Group: Dedicated Server Verfügbare "action": start, stop Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dedicated/action Live: https://skrime.eu/api/dedicated/action Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "start" } ``` Response example: ```json { "response": "Successfully started dedicated server", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "start" } } ``` ## POST /api/dedicated/novnc Name: noVNC URL erzeugen Group: Dedicated Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dedicated/novnc Live: https://skrime.eu/api/dedicated/novnc Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully generated noVNC URL", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "url": "https://dedicated.server.domain.tld/console/?token=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/dedicated/network Name: Netzwerk abrufen Group: Dedicated Server Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dedicated/network Live: https://skrime.eu/api/dedicated/network Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched network", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipv4": [ { "ipAddress": "127.0.0.1/24", "gateway": "127.0.0.1", "hostname": "server01.domain.tld" } ], "ipv6": [ { "zone": "fe80::/48", "ipAddress": "fe80::/48", "gateway": "fe80::", "hostname": "server.domain.tld" }, { "zone": "fe80::/48", "ipAddress": "fe80::", "gateway": "fe80::", "hostname": "mail.domain.tld" } ] } } ``` ## POST /api/dedicated/rdns Name: rDNS setzen Group: Dedicated Server IPv6 Subnetze können in kleinere IP Adressen aufgeteilt werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dedicated/rdns Live: https://skrime.eu/api/dedicated/rdns Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "hostname": "server01.domain.tld" } ``` Response example: ```json { "response": "Successfully updated rDNS", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "hostname": "server01.domain.tld" } } ``` ## DELETE /api/dedicated/rdns Name: rDNS löschen Group: Dedicated Server Unterstützt nur IPv6 Adressen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dedicated/rdns Live: https://skrime.eu/api/dedicated/rdns Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::" } ``` Response example: ```json { "response": "Successfully deleted rDNS", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::" } } ``` ## POST /api/instance/order Name: Instanz bestellen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/order Live: https://skrime.eu/api/instance/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "tos": true, "cancellation": true, "billing": true } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "instance", "state": "active", "userRights": [], "productInfo": { "sub_id": "XXXXXXXXXXXXXXXXXX", "terminate": false, "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "0", "customName": "TeamSpeak Instanz", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/instance/information Name: Informationen abrufen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/information Live: https://skrime.eu/api/instance/information Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched information", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "online", "terminated": false, "ipAddress": "127.0.0.1", "queryPort": "9152", "username": "serveradmin", "password": "Musterpasswort1", "port": { "from": "9001", "to": "9150" } } } ``` ## GET /api/instance/statistic Name: Statistiken abrufen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/statistic Live: https://skrime.eu/api/instance/statistic Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched instance statistics", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "currentSlots": "32", "averageSlots": "16", "reservedAmount": "0.00", "charts": { "slots": [ { "x": "2024-01-01", "y": 32 }, { "x": "2024-01-01", "y": 28 } ], "packetloss": [ { "x": "2024-01-01", "y": 0.02 }, { "x": "2024-01-01", "y": 0.14 } ] }, "period": { "start": "2024-01-01", "end": "2024-01-01" } } } ``` ## POST /api/instance/action Name: Instanz steuern Group: TeamSpeak Instanz Verfügbare "action": start, stop, restart Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/action Live: https://skrime.eu/api/instance/action Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "start" } ``` Response example: ```json { "response": "Successfully started instance", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "start" } } ``` ## POST /api/instance/passwd Name: Passwort zurücksetzen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/passwd Live: https://skrime.eu/api/instance/passwd Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully reset instance password", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } } ``` ## POST /api/instance/terminate Name: Kündigung setzen Group: TeamSpeak Instanz Setzt die Kündigung zum Laufzeitende oder hebt eine bestehende wieder auf Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/terminate Live: https://skrime.eu/api/instance/terminate Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "terminate": true } ``` Response example: ```json { "response": "Successfully updated termination status", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "terminated": true } } ``` ## GET /api/instance/whitelist Name: Whitelist abrufen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/whitelist Live: https://skrime.eu/api/instance/whitelist Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched whitelist", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "whitelist": [ "127.0.0.1", "127.0.0.1" ] } } ``` ## POST /api/instance/whitelist Name: IP zur Whitelist hinzufügen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/whitelist Live: https://skrime.eu/api/instance/whitelist Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1" } ``` Response example: ```json { "response": "Successfully added IP to whitelist", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1" } } ``` ## DELETE /api/instance/whitelist Name: IP aus Whitelist entfernen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/whitelist Live: https://skrime.eu/api/instance/whitelist Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1" } ``` Response example: ```json { "response": "Successfully removed IP from whitelist", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1" } } ``` ## GET /api/instance/virtualserver Name: Virtuelle Server abrufen Group: TeamSpeak Instanz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/instance/virtualserver Live: https://skrime.eu/api/instance/virtualserver Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched virtualservers", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "virtualservers": [ { "virtualserver": "zaWi3hcOPJcQBLZwGFrvOnDmeCY=", "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## GET /api/webspace/pricelist Name: Preisliste abrufen Group: Webspace Die Parameter "productId" und "planId" sind optional. Wenn "productId" angegeben wird, werden Upgrade Preise berechnet Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/pricelist Live: https://skrime.eu/api/webspace/pricelist Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "webspace", "state": "active", "productInfo": { "name": "Webspace S", "disk": 10 }, "price": "0.00", "duration": "1", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## POST /api/webspace/order Name: Webspace bestellen Group: Webspace Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/order Live: https://skrime.eu/api/webspace/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "tos": true, "cancellation": true } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "webspace", "state": "active", "userRights": [], "productInfo": { "username": "webspaceXXXXXX", "password": "Musterpasswort1", "node_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "plan_id": "Webspace S", "upgrade": true, "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Webspace", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/webspace/information Name: Informationen abrufen Group: Webspace Alternativ kann "domain" statt "productId" verwendet werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/information Live: https://skrime.eu/api/webspace/information Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched information", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "domain": "vwebXX.skrime.eu", "ipv4": "127.0.0.1", "ipv6": "fe80::1", "username": "webspaceXXXXXX", "password": "Musterpasswort1", "disk": { "limit": "10240.00", "used": "2048.50", "percentage": "0.00" } } } ``` ## GET /api/webspace/login Name: Login URL erzeugen Group: Webspace Alternativ kann "domain" statt "productId" verwendet werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/login Live: https://skrime.eu/api/webspace/login Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully generated login URL", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "loginUrl": "https://vwebXX.skrime.eu/index.php?sso_request=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } } ``` ## POST /api/webspace/install Name: Webspace installieren Group: Webspace Nur für Domains. Alternativ "productId" statt "domain" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/install Live: https://skrime.eu/api/webspace/install Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully created webspace", "state": "success", "data": { "domain": "domain.tld", "username": "domainXXXXXX", "password": "Musterpasswort1" } } ``` ## DELETE /api/webspace/delete Name: Webspace löschen Group: Webspace Nur für Domains. Alternativ "productId" statt "domain" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/delete Live: https://skrime.eu/api/webspace/delete Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully deleted webspace", "state": "success", "data": { "domain": "domain.tld" } } ``` ## POST /api/webspace/passwd Name: Passwort ändern Group: Webspace Alternativ kann "domain" statt "productId" verwendet werden. Der Parameter "password" ist optional und muss mindestens 8 Zeichen lang sein Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/passwd Live: https://skrime.eu/api/webspace/passwd Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully updated password", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } } ``` ## POST /api/webspace/upgrade Name: Webspace upgraden/downgraden Group: Webspace Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/upgrade Live: https://skrime.eu/api/webspace/upgrade Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully upgraded webspace", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "webspace", "state": "active", "userRights": [], "productInfo": { "username": "webspaceXXXXXX", "password": "Musterpasswort1", "node_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "plan_id": "Webspace M", "upgrade": true, "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Webspace", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## DELETE /api/webspace/reinstall Name: Webspace neuinstallieren Group: Webspace Alternativ kann "domain" statt "productId" verwendet werden. Der Parameter "password" ist optional und muss mindestens 8 Zeichen lang sein Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/webspace/reinstall Live: https://skrime.eu/api/webspace/reinstall Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully reinstalled webspace", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "username": "webspaceXXXXXX", "password": "Musterpasswort1" } } ``` ## POST /api/domain/order Name: Domain bestellen Group: Domain Du musst zwei bis sechs Nameserver angeben. Für eine .eu Domain muss "contact"->"country" ein Land der EU oder des EWR sein, sonst wird die Bestellung mit Statuscode 400 und "Invalid country, .eu domains require a registrant in the EU or EEA" abgelehnt. Für eine .it Domain musst du "contact"->"regCode" angeben, bei einer Firma die Umsatzsteuer-Identifikationsnummer oder Steuernummer, bei einer Privatperson die Steuer- oder Ausweisnummer. Ob die Domain auf eine Firma oder eine Privatperson läuft, ergibt sich aus "contact"->"company". Erlaubt sind 2 bis 32 Zeichen aus Buchstaben, Ziffern, Leerzeichen, Punkt, Bindestrich und Schrägstrich. Fehlt der Wert, wird die Bestellung mit Statuscode 400 und "Invalid request, please provide a regCode" abgelehnt, ist er ungültig, mit Statuscode 400 und "Invalid request, please provide a valid regCode". Nameserver IPv4 IPv6 nameserver01.eu 135.125.183.171 2001:41d0:701:1100::7fdd nameserver02.eu 51.75.23.130 2001:41d0:304:200::604c nameserver03.eu 92.222.9.35 2001:41d0:404:300::6d7 nameserver04.eu 158.69.60.170 2607:5300:201:3100::3115 nameserver05.eu 146.59.92.48 2001:41d0:601:1100::8c0 nameserver06.eu 51.195.136.97 2001:41d0:801:2000::5ba9 Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/order Live: https://skrime.eu/api/domain/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "domain": "domain.tld", "authCode": "XXXXXXXXXXXX", "contact": { "company": "Musterfirma GmbH", "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "state": "Musterstaat", "country": "DE", "email": "max@domain.tld", "phone": "+49.123456789" }, "tos": true, "cancellation": true, "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "domain", "state": "active", "userRights": [], "productInfo": { "domain": "domain.tld", "handle": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "provider": "realtime", "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "12", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "365", "customName": "Domain", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/domain/pricelist Name: Preisliste abrufen Group: Domain Die Preise werden stündlich aktualisiert und in EUR angegeben Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/pricelist Live: https://skrime.eu/api/domain/pricelist Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "tld": "de", "create": "0.00", "renew": "0.00", "transfer": "0.00", "restore": "0.00", "offer": false, "offerTypes": [] } ] } ``` ## POST /api/domain/check Name: Domain Verfügbarkeit prüfen Group: Domain Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/check Live: https://skrime.eu/api/domain/check Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully fetched domain check", "state": "success", "data": { "domain": "domain.tld", "available": false, "premium": false } } ``` ## GET /api/domain/authcode Name: Authcode abrufen Group: Domain Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/authcode Live: https://skrime.eu/api/domain/authcode Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully fetched authcode", "state": "success", "data": { "domain": "domain.tld", "authcode": "XXXXXXXXXXXX" } } ``` ## GET /api/domain/nameserver Name: Nameserver abrufen Group: Domain Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/nameserver Live: https://skrime.eu/api/domain/nameserver Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully fetched nameservers", "state": "success", "data": { "domain": "domain.tld", "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } } ``` ## POST /api/domain/nameserver Name: Nameserver aktualisieren Group: Domain Mindestens 2 und maximal 6 Nameserver müssen angegeben werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/nameserver Live: https://skrime.eu/api/domain/nameserver Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "domain": "domain.tld", "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } ``` Response example: ```json { "response": "Successfully updated nameservers", "state": "success", "data": { "domain": "domain.tld", "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } } ``` ## GET /api/domain/dns Name: DNS Zone abrufen Group: Domain Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/dns Live: https://skrime.eu/api/domain/dns Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully fetched DNS zone", "state": "success", "data": { "domain": "domain.tld", "records": [ { "name": "@", "type": "A", "data": "127.0.0.1" }, { "name": "www", "type": "A", "data": "127.0.0.1" } ] } } ``` ## POST /api/domain/dns Name: DNS Zone aktualisieren Group: Domain Alle Einträge müssen übermittelt werden. Verfügbare "type": A, AAAA, CNAME, ALIAS, MX, SRV, TXT, CAA, PTR, TLSA, DS, DNSKEY. Code Beispiel (https://skri.me/share-0199f94c-14c1-8223-9041-eb1b0ebfcf82) Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/dns Live: https://skrime.eu/api/domain/dns Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "domain": "domain.tld", "records": [ { "name": "@", "type": "A", "data": "127.0.0.1" }, { "name": "www", "type": "A", "data": "127.0.0.1" } ] } ``` Response example: ```json { "response": "Successfully updated DNS records", "state": "success", "data": { "domain": "domain.tld", "records": [ { "name": "@", "type": "A", "data": "127.0.0.1" } ] } } ``` ## GET /api/domain/dnssec Name: DNSSEC abrufen Group: Domain Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/dnssec Live: https://skrime.eu/api/domain/dnssec Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully fetched dnssec", "state": "success", "data": { "domain": "domain.tld", "dnssec": { "flags": "257", "algorithm": "8", "publicKey": "AwEAAcP..." } } } ``` ## POST /api/domain/dnssec Name: DNSSEC aktualisieren Group: Domain Verfügbare "flags": 256, 257. Verfügbare "algorithm": 3, 5, 6, 7, 8, 10, 12, 13, 14, 15, 16, 17, 23 Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/dnssec Live: https://skrime.eu/api/domain/dnssec Request example: ```json { "domain": "domain.tld", "dnssec": { "flags": "257", "algorithm": "8", "publicKey": "AwEAAcP..." } } ``` Response example: ```json { "response": "Successfully updated dnssec", "state": "success", "data": { "domain": "domain.tld", "dnssec": { "flags": "257", "algorithm": "8", "publicKey": "AwEAAcP..." } } } ``` ## DELETE /api/domain/dnssec Name: DNSSEC deaktivieren Group: Domain Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/dnssec Live: https://skrime.eu/api/domain/dnssec Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully deleted dnssec", "state": "success", "data": { "domain": "domain.tld" } } ``` ## GET /api/domain/contact Name: Kontakt abrufen Group: Domain Bei einer .it Domain enthält "contact" zusätzlich "regCode". Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/contact Live: https://skrime.eu/api/domain/contact Request example: ```json { "domain": "domain.tld" } ``` Response example: ```json { "response": "Successfully fetched contact", "state": "success", "data": { "domain": "domain.tld", "contact": { "company": "Musterfirma GmbH", "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "state": "Musterstaat", "country": "DE", "email": "max@domain.tld", "phone": "+49.123456789" }, "privacy": { "organization": false, "name": false, "email": false, "voice": false, "addressLine": false, "city": false, "postalCode": false } } } ``` ## POST /api/domain/contact Name: Kontakt aktualisieren Group: Domain Der Parameter "company" ist optional. Für eine .it Domain musst du "contact"->"regCode" angeben, mit denselben Regeln und Fehlermeldungen wie bei "domain/order". Ändern sich Firma, Name, Land oder "regCode", wird der Inhaber bei der Registry gewechselt. Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/contact Live: https://skrime.eu/api/domain/contact Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "domain": "domain.tld", "contact": { "company": "Musterfirma GmbH", "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "state": "Musterstaat", "country": "DE", "email": "max@domain.tld", "phone": "+49.123456789" } } ``` Response example: ```json { "response": "Successfully updated contact", "state": "success", "data": { "domain": "domain.tld", "contact": { "company": "Musterfirma GmbH", "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "state": "Musterstaat", "country": "DE", "email": "max@domain.tld", "phone": "+49.123456789" } } } ``` ## POST /api/domain/whois Name: Whois Privacy aktualisieren Group: Domain Es wird entweder der Parameter "productId" oder der Parameter "domain" benötigt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/domain/whois Live: https://skrime.eu/api/domain/whois Request example: ```json { "domain": "domain.tld", "privacy": { "organization": false, "name": false, "email": false, "voice": false, "addressLine": false, "city": false, "postalCode": false } } ``` Response example: ```json { "response": "Successfully updated whois settings", "state": "success", "data": { "domain": "domain.tld", "privacy": { "organization": false, "name": false, "email": false, "voice": false, "addressLine": false, "city": false, "postalCode": false } } } ``` ## POST /api/dns/order Name: DNS Zone bestellen Group: DNS Zone Der Parameter "nameserver" ist optional und nimmt 2 bis 6 Nameserver. Der Parameter "soa" ist optional, verlangt dann aber "nameserver" und "email", die weiteren SOA Parameter "serial", "refresh", "retry", "expire", "minimum" sind optional. Als "zone" sind Forward Zones sowie Reverse Zones in-addr.arpa und ip6.arpa zulässig. Ist eine übergeordnete Domain der "zone" als Domain Produkt bei SKRIME vorhanden, muss sie dir gehören oder freigegeben sein, sonst wird die Bestellung mit Statuscode 403 und "Unauthorized access, please check your permissions" abgelehnt. Ist diese Domain gesperrt, wird die Bestellung mit Statuscode 423 und "Access blocked due to product suspension" abgelehnt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/order Live: https://skrime.eu/api/dns/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "zone": "domain.tld", "tos": true, "cancellation": true, "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ], "soa": { "nameserver": "nameserver01.eu", "email": "hostmaster@domain.tld", "serial": 2024010101, "refresh": 10800, "retry": 3600, "expire": 604800, "minimum": 60 } } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "dns", "state": "active", "userRights": [], "productInfo": { "zone": "domain.tld", "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "1196", "customName": "DNS Zone", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/dns/zone Name: DNS Zone abrufen Group: DNS Zone Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/zone Live: https://skrime.eu/api/dns/zone Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched DNS zone", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld", "records": [ { "name": "@", "type": "A", "data": "127.0.0.1" }, { "name": "www", "type": "A", "data": "127.0.0.1" } ] } } ``` ## POST /api/dns/zone Name: DNS Zone aktualisieren Group: DNS Zone Alle Einträge müssen übermittelt werden. Ein leeres "records" Array löscht alle Einträge außer NS und SOA Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/zone Live: https://skrime.eu/api/dns/zone Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "records": [ { "name": "@", "type": "A", "data": "127.0.0.1" }, { "name": "www", "type": "A", "data": "127.0.0.1" } ] } ``` Response example: ```json { "response": "Successfully updated DNS records", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld", "records": [ { "name": "@", "type": "A", "data": "127.0.0.1" }, { "name": "www", "type": "A", "data": "127.0.0.1" } ] } } ``` ## DELETE /api/dns/zone Name: DNS Zone löschen Group: DNS Zone Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/zone Live: https://skrime.eu/api/dns/zone Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted DNS zone", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld" } } ``` ## GET /api/dns/dnssec Name: DNSSEC abrufen Group: DNS Zone Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/dnssec Live: https://skrime.eu/api/dns/dnssec Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched DNSSEC", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld", "dnskey": "257 3 13 mdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ==", "algorithm": "ECDSAP256SHA256", "ds": [ "12345 13 2 3c8e4a0d1b2f5e6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c" ] } } ``` ## POST /api/dns/dnssec Name: DNSSEC aktivieren Group: DNS Zone Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/dnssec Live: https://skrime.eu/api/dns/dnssec Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully enabled DNSSEC", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld" } } ``` ## DELETE /api/dns/dnssec Name: DNSSEC deaktivieren Group: DNS Zone Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/dnssec Live: https://skrime.eu/api/dns/dnssec Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully disabled DNSSEC", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld" } } ``` ## POST /api/dns/nameserver Name: Nameserver aktualisieren Group: DNS Zone Mindestens 2 Nameserver müssen angegeben werden Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/nameserver Live: https://skrime.eu/api/dns/nameserver Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } ``` Response example: ```json { "response": "Successfully updated nameservers", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld", "nameserver": [ "nameserver01.eu", "nameserver02.eu", "nameserver03.eu", "nameserver04.eu", "nameserver05.eu", "nameserver06.eu" ] } } ``` ## POST /api/dns/soa Name: SOA Record aktualisieren Group: DNS Zone Die Parameter "serial", "refresh", "retry", "expire", "minimum" sind optional. Das @ in der E-Mail wird durch einen Punkt ersetzt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/dns/soa Live: https://skrime.eu/api/dns/soa Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nameserver": "nameserver01.eu", "email": "hostmaster@domain.tld", "serial": 2024010101, "refresh": 10800, "retry": 3600, "expire": 604800, "minimum": 60 } ``` Response example: ```json { "response": "Successfully updated SOA record", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zone": "domain.tld", "nameserver": "nameserver01.eu", "email": "hostmaster.domain.tld", "serial": 2024010101, "refresh": "10800", "retry": "3600", "expire": "604800", "minimum": "60" } } ``` ## GET /api/ssl/pricelist Name: Preisliste abrufen Group: SSL Zertifikat Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ssl/pricelist Live: https://skrime.eu/api/ssl/pricelist Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "ssl", "state": "active", "productInfo": { "product": "ssl_perfectssl", "brand": "PerfectSSL", "name": "DV SSL", "validation_type": "DOMAIN_VALIDATION", "certificate_type": "SINGLE_DOMAIN", "warranty": 10000, "issue_time": "Instant", "max_domains": 1, "features": [ "REISSUE", "WWW_INCLUDED", "NON_WWW_INCLUDED" ], "included_domains": 1 }, "price": "0.00", "duration": "12", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## POST /api/ssl/order Name: SSL Zertifikat bestellen Group: SSL Zertifikat Parameter "contact" enthält "firstname", "lastname", "street", "city", "state", "country", "email", "phone". Der Parameter "contact"->"company" ist optional. Die Adresse in "contact"->"email" muss eine gültige DCV Adresse der ersten Domain sein. Das Produkt wird mit "state" = "pending" angelegt, bis die Domain Validierung abgeschlossen ist. Der Parameter "domains" darf höchstens so viele Domains enthalten, wie der Tarif einschließt (kleinerer Wert aus "included_domains" und "max_domains" in "productInfo" von ssl/pricelist). Mehr Domains werden vor der Abbuchung mit Statuscode 400 und "Invalid domains, allowed maximum: " abgelehnt. Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ssl/order Live: https://skrime.eu/api/ssl/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "domains": [ "domain.tld" ], "contact": { "firstname": "Max", "lastname": "Mustermann", "street": "Musterstraße", "city": "Musterort", "state": "Musterstaat", "country": "DE", "email": "admin@domain.tld", "phone": "+49.123456789", "company": "Musterfirma GmbH" }, "tos": true, "cancellation": true } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "ssl", "state": "pending", "userRights": [], "productInfo": { "certificate_id": null, "provider_id": "XXXXXXXXXX#XXXXXXXXXX", "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "12", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "996", "customName": "SSL Zertifikat", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/ssl/information Name: Informationen abrufen Group: SSL Zertifikat Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ssl/information Live: https://skrime.eu/api/ssl/information Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched information", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "domainName": "domain.tld", "publicKeyAlgorithm": "RSA", "publicKeySize": 2048, "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC7VJTUt9Us8cKj\n-----END PRIVATE KEY-----\n", "certificate": "-----BEGIN CERTIFICATE-----\nMIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw\n-----END CERTIFICATE-----\n", "fingerprint": "9A:F1:3C:7B:20:5E:64:D8:11:A0:3F:8C:72:BD:45:E9:06:1C:D3:27" } } ``` ## GET /api/ssl/download Name: Zertifikat herunterladen Group: SSL Zertifikat Der Parameter "format" ist optional, Standard ist "ZIP". Verfügbare "format": ZIP, CRT, CSR, PKCS7, CA, CA_BUNDLE. Die Antwort ist die Zertifikatsdatei selbst und kein JSON. Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ssl/download Live: https://skrime.eu/api/ssl/download Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "format": "ZIP" } ``` Response: not JSON (file or raw output) ## GET /api/proxmox-backup/pricelist Name: Preisliste abrufen Group: Proxmox Backup Der Parameter "voucher" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/proxmox-backup/pricelist Live: https://skrime.eu/api/proxmox-backup/pricelist Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "proxmox-backup", "state": "active", "productInfo": {}, "price": "0.00", "duration": "1", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## POST /api/proxmox-backup/order Name: Proxmox Backup bestellen Group: Proxmox Backup Der Parameter "voucher" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/proxmox-backup/order Live: https://skrime.eu/api/proxmox-backup/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "notice": true, "tos": true, "cancellation": true } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "proxmox-backup", "state": "active", "userRights": [], "productInfo": { "username": "backupXXXXXX", "password": "Musterpasswort1", "datastore": "pbsXXXXXX", "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Proxmox Backup", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/proxmox-backup/information Name: Informationen abrufen Group: Proxmox Backup Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/proxmox-backup/information Live: https://skrime.eu/api/proxmox-backup/information Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched information", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "url": "https://127.0.0.1:8007/", "ipv4": "127.0.0.1", "username": "backupXXXXXX", "password": "Musterpasswort1", "datastore": "pbsXXXXXX", "fingerprint": "7b:2c:1f:9a:44:d8:03:e5:6a:91:b7:2d:58:0c:e3:47:19:af:62:d0:35:8b:c4:7e:1a:96:f2:50:b3:d7:28:6c" } } ``` ## POST /api/proxmox-backup/passwd Name: Passwort ändern Group: Proxmox Backup Der Parameter "password" ist optional und muss mindestens 8 Zeichen lang sein Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/proxmox-backup/passwd Live: https://skrime.eu/api/proxmox-backup/passwd Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully updated password", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } } ``` ## GET /api/ipv4/pricelist Name: Preisliste abrufen Group: IPv4 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv4/pricelist Live: https://skrime.eu/api/ipv4/pricelist Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "ipv4", "state": "active", "productInfo": {}, "price": "0.00", "duration": "1", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## POST /api/ipv4/order Name: IPv4 Netz bestellen Group: IPv4 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv4/order Live: https://skrime.eu/api/ipv4/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "purpose": "Hosting eigener Dienste", "contact": "Musterfirma GmbH\nMax Mustermann\nMusterstraße 1a\n12345 Musterort\nDeutschland\nDE\nmax@domain.tld\n+49123456789", "tos": true, "cancellation": true } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "ipv4", "state": "processing", "userRights": [], "productInfo": { "prefix": "0.0.0.0/24", "asn": "AS64496", "purpose": "Hosting eigener Dienste", "contact": "Musterfirma GmbH\nMax Mustermann\nMusterstraße 1a\n12345 Musterort\nDeutschland\nDE\nmax@domain.tld\n+49123456789", "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "0", "customName": "IPv4 Netz", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/ipv4/network Name: Netzwerk abrufen Group: IPv4 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv4/network Live: https://skrime.eu/api/ipv4/network Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched network", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "prefix": "127.0.0.1/24", "standardRdns": "domain.tld", "addresses": [ { "ipAddress": "127.0.0.1", "hostname": "server.domain.tld" }, { "ipAddress": "127.0.0.1", "hostname": "domain.tld" } ] } } ``` ## POST /api/ipv4/rdns Name: rDNS setzen Group: IPv4 Netz Parameter "ipAddress" kann "*" für den Standard rDNS des gesamten Netzes sein, dann ist Parameter "hostname" erforderlich. Bei einer einzelnen IP Adresse ist "hostname" optional, ohne ihn wird der rDNS Eintrag gelöscht. Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv4/rdns Live: https://skrime.eu/api/ipv4/rdns Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "hostname": "domain.tld" } ``` Response example: ```json { "response": "Successfully updated rDNS", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "127.0.0.1", "hostname": "domain.tld" } } ``` ## GET /api/ipv4/blacklist Name: Blacklist abrufen Group: IPv4 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv4/blacklist Live: https://skrime.eu/api/ipv4/blacklist Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched blacklist information", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "blacklist": [ { "ipAddress": "127.0.0.1", "listed": [ { "rbl": "example.rbl.org", "delist": "https://delist.domain.tld/results/?query=127.0.0.1" } ] } ] } } ``` ## GET /api/ipv6/pricelist Name: Preisliste abrufen Group: IPv6 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/pricelist Live: https://skrime.eu/api/ipv6/pricelist Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "ipv6", "state": "active", "productInfo": { "prefix": "/48", "label": "IPv6 Netz /48" }, "price": "0.00", "duration": "12", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## POST /api/ipv6/order Name: IPv6 Netz bestellen Group: IPv6 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/order Live: https://skrime.eu/api/ipv6/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "mnt": "MNT-DEMO", "purpose": "Hosting eigener Server", "tos": true, "cancellation": true } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "ipv6", "state": "active", "userRights": [], "productInfo": { "prefix": "fe80::/48", "mnt": "MNT-DEMO", "purpose": "Hosting eigener Server", "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "12", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "0", "customName": "IPv6 Netz /48", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/ipv6/network Name: Netzwerk abrufen Group: IPv6 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/network Live: https://skrime.eu/api/ipv6/network Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched network", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "prefix": "fe80::/48", "mnt": "MNT-DEMO", "ripe": { "status": "ASSIGNED", "registered": true }, "reverse": { "delegated": true, "status": "active", "zones": [ "0.0.0.0.0.0.0.0.0.8.e.f.ip6.arpa" ], "ourNs": [ "nameserver01.eu", "nameserver02.eu" ], "currentNs": [ "nameserver01.eu", "nameserver02.eu" ] }, "standardRdns": "domain.tld", "records": [ { "arpa": "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.e.f.ip6.arpa.", "hostname": "server.domain.tld" } ] } } ``` ## POST /api/ipv6/nameserver Name: Reverse Delegation setzen Group: IPv6 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/nameserver Live: https://skrime.eu/api/ipv6/nameserver Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully updated reverse delegation", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/ipv6/rdns Name: rDNS setzen Group: IPv6 Netz Der Parameter "hostname" ist optional, ohne ihn wird der Eintrag entfernt. Mit "ipAddress" = "*" wird der Standard rDNS des gesamten Netzes gesetzt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/rdns Live: https://skrime.eu/api/ipv6/rdns Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::", "hostname": "server.domain.tld" } ``` Response example: ```json { "response": "Successfully updated rDNS", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::", "hostname": "server.domain.tld" } } ``` ## GET /api/ipv6/rpki Name: ROAs abrufen Group: IPv6 Netz Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/rpki Live: https://skrime.eu/api/ipv6/rpki Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched ROAs", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "prefix": "fe80::/48", "roas": [ { "asn": "AS64496", "prefix": "fe80::/48", "maximalLength": "48", "validity": "published" } ] } } ``` ## POST /api/ipv6/rpki Name: ROA erstellen Group: IPv6 Netz Die Parameter "prefix" und "maximalLength" sind optional, ohne sie gelten das Netz des Produktes und dessen Prefixlänge Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/rpki Live: https://skrime.eu/api/ipv6/rpki Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48", "maximalLength": "48" } ``` Response example: ```json { "response": "Successfully created ROA", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48", "maximalLength": "48" } } ``` ## DELETE /api/ipv6/rpki Name: ROA entfernen Group: IPv6 Netz Der Parameter "maximalLength" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/rpki Live: https://skrime.eu/api/ipv6/rpki Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48", "maximalLength": "48" } ``` Response example: ```json { "response": "Successfully removed ROA", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48" } } ``` ## GET /api/ipv6/loa Name: Letter of Authorization abrufen Group: IPv6 Netz Die Antwort ist eine PDF-Datei und kein JSON Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/ipv6/loa Live: https://skrime.eu/api/ipv6/loa Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48" } ``` Response: not JSON (file or raw output) ## POST /api/asn/order Name: ASN bestellen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/order Live: https://skrime.eu/api/asn/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "planId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "tos": true, "cancellation": true, "policy": true } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "asn", "state": "active", "userRights": [], "productInfo": { "prefix": "", "asName": "DEMO-AS", "org": "", "view": { "reason": "" }, "renew": { "reason": "" } }, "price": "0.00", "duration": "12", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "0", "customName": "ASN", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/asn/pricelist Name: Preisliste abrufen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/pricelist Live: https://skrime.eu/api/asn/pricelist Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "asn", "state": "active", "productInfo": { "label": "ASN", "features": [ "Eigene AS Nummer", "RPKI Verwaltung" ] }, "price": "0.00", "duration": "12", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "createdAt": "2024-01-01 00:00:00" } ] } ``` ## GET /api/asn/org-check Name: Organisation prüfen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/org-check Live: https://skrime.eu/api/asn/org-check Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "org": "ORG-DEMO-RIPE" } ``` Response example: ```json { "response": "Successfully fetched organisation check", "state": "success", "data": { "org": "ORG-DEMO-RIPE", "exists": true, "mntSet": true } } ``` ## GET /api/asn/contact-check Name: Kontakt prüfen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/contact-check Live: https://skrime.eu/api/asn/contact-check Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "handle": "DEMO-RIPE" } ``` Response example: ```json { "response": "Successfully fetched contact check", "state": "success", "data": { "handle": "DEMO-RIPE", "type": "person", "exists": true } } ``` ## GET /api/asn/mnt-check Name: Maintainer prüfen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/mnt-check Live: https://skrime.eu/api/asn/mnt-check Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "mnt": "MNT-DEMO" } ``` Response example: ```json { "response": "Successfully fetched maintainer check", "state": "success", "data": { "mnt": "MNT-DEMO", "exists": true } } ``` ## POST /api/asn/setup Name: ASN Setup speichern Group: ASN Verfügbare "setup.holderType": private, sole, company. Verfügbare "setup.registeredFor": self, customer, thirdparty Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/setup Live: https://skrime.eu/api/asn/setup Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "setup": { "holderType": "private", "firstname": "Max", "lastname": "Mustermann", "company": "", "registerNumber": "", "address": { "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "country": "DE" }, "inRegion": true, "regionJustification": "", "registeredFor": "self", "isMinor": false, "asName": "DEMO-AS", "org": "ORG-DEMO-RIPE", "adminC": "DEMO-RIPE", "techC": "DEMO-RIPE", "mnt": "MNT-DEMO", "hasExistingAsn": false, "existingAsn": "", "additionalReason": "", "peering": [ { "asn": "AS64496", "email": "peering@domain.tld" }, { "asn": "AS64496", "email": "noc@domain.tld" } ] } } ``` Response example: ```json { "response": "Successfully updated setup", "state": "success", "data": [] } ``` ## POST /api/asn/upload Name: ASN Dokument hochladen Group: ASN Verfügbare "documentType": id, idParents, commercialRegister, tradeLicense, powerOfAttorney, parentalConsent. Die Dateien werden im Feld "files" als multipart/form-data gesendet, erlaubt sind pdf, jpg, jpeg und png bis 10 MB Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/upload Live: https://skrime.eu/api/asn/upload Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "documentType": "id" } ``` Response example: ```json { "response": "Successfully uploaded document", "state": "success", "data": { "documentType": "id", "files": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "ausweis.pdf", "size": 248312 } ] } } ``` ## GET /api/asn/document Name: Dokument abrufen Group: ASN Die Antwort ist kein JSON, der Endpunkt liefert die hinterlegte Datei zur Anzeige aus Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/document Live: https://skrime.eu/api/asn/document Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "fileId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response: not JSON (file or raw output) ## DELETE /api/asn/upload Name: ASN Dokument entfernen Group: ASN Verfügbare "documentType": id, idParents, commercialRegister, tradeLicense, powerOfAttorney, parentalConsent Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/upload Live: https://skrime.eu/api/asn/upload Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "documentType": "id", "fileId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully removed document", "state": "success", "data": [] } ``` ## POST /api/asn/submit Name: ASN Setup einreichen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/submit Live: https://skrime.eu/api/asn/submit Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully submitted setup", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "submitted" } } ``` ## GET /api/asn/single Name: ASN Anfrage abrufen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/single Live: https://skrime.eu/api/asn/single Request body: none Response example: ```json { "response": "Successfully fetched ASN", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "setup", "asn": "", "productInfo": { "prefix": "fe80::/48", "asName": "DEMO-AS", "org": "ORG-DEMO-RIPE" }, "setup": { "holderType": "private", "firstname": "Max", "lastname": "Mustermann", "company": "", "registerNumber": "", "address": { "street": "Musterstraße", "number": "1a", "postcode": "12345", "city": "Musterort", "country": "DE" }, "inRegion": true, "regionJustification": "", "registeredFor": "self", "isMinor": false, "asName": "DEMO-AS", "org": "ORG-DEMO-RIPE", "adminC": "DEMO-RIPE", "techC": "DEMO-RIPE", "mnt": "MNT-DEMO", "hasExistingAsn": false, "existingAsn": "", "additionalReason": "", "peering": [ { "asn": "AS64496", "email": "peering@domain.tld" }, { "asn": "AS64496", "email": "noc@domain.tld" } ], "documents": { "id": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "ausweis.pdf", "size": 248312 } ], "idParents": [], "commercialRegister": [], "tradeLicense": [], "powerOfAttorney": [], "parentalConsent": [], "contract": [] }, "contract": { "submissionId": "", "status": "none", "sentAt": "", "signedAt": "" }, "correction": { "message": "", "requestedAt": "" } }, "verified": false } } ``` ## GET /api/asn/network Name: Netzwerk abrufen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/network Live: https://skrime.eu/api/asn/network Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched network", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "prefix": "fe80::/48", "mnt": "MNT-DEMO", "ripe": { "status": "ASSIGNED", "registered": true }, "reverse": { "delegated": true, "status": "active", "zones": [ "0.0.0.0.0.0.0.0.0.8.e.f.ip6.arpa" ], "ourNs": [ "nameserver01.eu", "nameserver02.eu" ], "currentNs": [ "nameserver01.eu", "nameserver02.eu" ] }, "standardRdns": "domain.tld", "records": [ { "arpa": "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.e.f.ip6.arpa.", "hostname": "mail.domain.tld" } ] } } ``` ## POST /api/asn/nameserver Name: Reverse Delegation setzen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/nameserver Live: https://skrime.eu/api/asn/nameserver Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully updated reverse delegation", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/asn/rdns Name: rDNS setzen Group: ASN Der Parameter "hostname" ist optional, ein leerer Wert entfernt den Eintrag. Bei "ipAddress" = "*" wird der Standard rDNS aller Zonen gesetzt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/rdns Live: https://skrime.eu/api/asn/rdns Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::", "hostname": "mail.domain.tld" } ``` Response example: ```json { "response": "Successfully updated rDNS", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "ipAddress": "fe80::", "hostname": "mail.domain.tld" } } ``` ## GET /api/asn/rpki Name: ROAs abrufen Group: ASN Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/rpki Live: https://skrime.eu/api/asn/rpki Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched ROAs", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "prefix": "fe80::/48", "roas": [ { "asn": "AS64496", "prefix": "fe80::/48", "maximalLength": "48", "validity": "published" } ] } } ``` ## POST /api/asn/rpki Name: ROA erstellen Group: ASN Die Parameter "prefix" und "maximalLength" sind optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/rpki Live: https://skrime.eu/api/asn/rpki Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496" } ``` Response example: ```json { "response": "Successfully created ROA", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48", "maximalLength": "48" } } ``` ## DELETE /api/asn/rpki Name: ROA entfernen Group: ASN Der Parameter "maximalLength" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/rpki Live: https://skrime.eu/api/asn/rpki Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48" } ``` Response example: ```json { "response": "Successfully removed ROA", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48" } } ``` ## GET /api/asn/loa Name: LOA herunterladen Group: ASN Die Antwort ist kein JSON, der Endpunkt liefert die Letter of Authorization als PDF Datei Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/asn/loa Live: https://skrime.eu/api/asn/loa Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "asn": "AS64496", "prefix": "fe80::/48" } ``` Response: not JSON (file or raw output) ## GET /api/status/pricelist Name: Preisliste abrufen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/pricelist Live: https://skrime.eu/api/status/pricelist Variant: Preisliste abrufen Request body: none Response example: ```json { "response": "Successfully fetched pricelist", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "premium", "name": "Premium", "basePrice": "0.00", "perMonitor": "0.00", "minMonitor": 10, "maxMonitor": 100, "notificationPer": 10, "maxNotification": null, "minInterval": 60, "regionMode": "all", "regions": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Deutschland", "code": "de" } ], "poweredBy": false, "upgrade": true, "price": "0.00", "duration": "1", "sort": 1 } ] } ``` Variant: Konfiguratorpreis abrufen Request example: ```json { "monitor": 25 } ``` Response example: ```json { "response": "Successfully fetched configurator pricing", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "", "type": "status", "state": "active", "productInfo": { "type": "premium", "name": "Premium", "basePrice": 0, "perMonitor": 0, "minMonitor": 10, "maxMonitor": 100, "notificationPer": 10, "maxNotification": null, "minInterval": 60, "regionMode": "all", "regions": [ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ], "poweredBy": false, "upgrade": true, "sort": 1 }, "monitor": 25, "notification": 3, "min": 10, "max": 100, "price": "0.00", "duration": "1", "discountOrder": "0.00", "discountOrderAmount": "0.00", "discountRenew": "0.00", "discountRenewAmount": "0.00", "discountExpire": "2024-01-01 00:00:00", "voucher": "", "voucherOrder": "0", "voucherOrderAmount": "0.00", "voucherRenew": "0", "voucherRenewAmount": "0.00", "finalOrderPrice": "0.00", "finalRenewPrice": "0.00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/status/nodes Name: Überwachungsknoten abrufen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/nodes Live: https://skrime.eu/api/status/nodes Request body: none Response example: ```json { "response": "Successfully fetched monitoring nodes", "state": "success", "data": [ { "continent": "EU", "state": "active", "name": "Frankfurt", "lat": 50.1109, "lon": 8.6821 } ] } ``` ## POST /api/status/order Name: Statusseite bestellen Group: Statusseite Bei "plan" = "free" wird die kostenlose Statusseite bestellt und Parameter "monitor" entfällt. Der Parameter "voucher" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/order Live: https://skrime.eu/api/status/order Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "tos": true, "cancellation": true, "monitor": 25 } ``` Response example: ```json { "response": "Successfully ordered product", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "status", "state": "active", "userRights": [], "productInfo": { "type": "premium", "tariffId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitor": 25, "notification": 5, "minInterval": 30, "regionMode": "all", "regions": [], "poweredBy": false, "upgrade": true, "view": { "reason": "" }, "renew": { "reason": "" } }, "monitor": 25, "notification": 5, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Statusseite", "autoRenew": false, "expireAt": "2024-01-01 00:00:00", "deletedAt": "2024-01-01 00:00:00", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## POST /api/status/upgrade Name: Tarif wechseln Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/upgrade Live: https://skrime.eu/api/status/upgrade Warning: this endpoint costs money (order or renewal). Never call it without explicit confirmation by the user. Test it in the sandbox first. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "tariffId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitor": "25" } ``` Response example: ```json { "response": "Successfully changed tariff", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "status", "state": "active", "userRights": {}, "productInfo": { "type": "premium", "tariffId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitor": 25, "notification": 3, "minInterval": 60, "regionMode": "all", "regions": [ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ], "poweredBy": false }, "price": "0.00", "duration": "1", "discount": "0.00", "priceBeforeDiscount": "0.00", "days": "30", "customName": "Statusseite", "autoRenew": true, "expireAt": "2024-01-01 00:00:00", "deletedAt": "", "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/status/page Name: Statusseiten abrufen Group: Statusseite Verfügbare "scope": single, all. Bei "scope" = "single" ist Parameter "pageId" erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/page Live: https://skrime.eu/api/status/page Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "single", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched pages", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pages": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Statusseite", "website": "https://domain.tld", "imprint": "https://domain.tld/impressum", "privacy": "https://domain.tld/datenschutz", "customUrl": "mustermann", "customDomain": "status.domain.tld", "domainState": "verified", "brandColor": "#0d6efd", "themeColor": "#0d6efd", "backgroundColor": "#ffffff", "textColor": "#212529", "monitorColor": "#f8f9fa", "onlineColor": "#198754", "warningColor": "#ffc107", "offlineColor": "#dc3545", "pausedColor": "#6c757d", "buttonColor": "#0d6efd", "graphColor": "#0d6efd", "logoUrl": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.png", "logoUrlName": "logo.png", "logoOnly": false, "showHero": true, "backgroundUrl": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.jpg", "backgroundUrlName": "hintergrund.jpg", "backgroundGradient": false, "showHistory": true, "font": "Nunito", "groupLayout": "stacked", "groupsCollapsible": true, "groupsDefaultCollapsed": false, "groupPageSize": 15, "showCpu": true, "showRam": true, "showStorage": true, "overlayOpacity": 60, "heroAccent": false, "proxmoxUrl": "proxmox.domain.tld", "proxmoxUsername": "root", "proxmoxRealm": "pam", "hasProxmoxPassword": true, "showAnnouncements": true, "showLangSwitch": true, "seoDescription": "Aktueller Betriebsstatus aller Dienste", "favicon": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.ico", "faviconName": "favicon.ico", "seoImage": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.png", "seoImageName": "vorschau.png", "seoIndex": true, "browserTitle": "Status", "footerName": "Mustermann GmbH", "footerCopyright": "2026 Mustermann GmbH", "showFooter": true, "footerTransparent": false, "footerColor": "#f8f9fa", "ogTitle": "Status", "ogDescription": "Aktueller Betriebsstatus aller Dienste", "ogImage": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.png", "ogImageName": "og.png", "monitorCount": 12, "domainCheckedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } } ``` ## POST /api/status/page Name: Statusseite erstellen Group: Statusseite Ohne "pageId" wird eine Seite angelegt, mit "pageId" wird sie geändert. Verfügbare "font": Nunito, Inter, Poppins, Montserrat, Outfit. Verfügbare "groupLayout": stacked, sidebar. Ein unbekannter Wert wird ohne Fehler durch den Standard ersetzt Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/page Live: https://skrime.eu/api/status/page Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Statusseite", "customUrl": "mustermann" } ``` Response example: ```json { "response": "Successfully created page", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "customUrl": "mustermann" } } ``` ## DELETE /api/status/page Name: Statusseite löschen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/page Live: https://skrime.eu/api/status/page Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted page", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/status/submit-domain Name: Custom Domain verifizieren Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/submit-domain Live: https://skrime.eu/api/status/submit-domain Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "domain": "status.domain.tld" } ``` Response example: ```json { "response": "Successfully verified custom domain", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "domain": "status.domain.tld", "domainState": "verified" } } ``` ## DELETE /api/status/page-domain Name: Custom Domain entfernen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/page-domain Live: https://skrime.eu/api/status/page-domain Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully removed custom domain", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/status/upload Name: Statusseite Bild hochladen Group: Statusseite Verfügbare "type": favicon, seoImage, logo, background, ogImage. Die Bilddatei wird als Multipart Feld "file" gesendet Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/upload Live: https://skrime.eu/api/status/upload Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "logo" } ``` Response example: ```json { "response": "Successfully uploaded image", "state": "success", "data": { "type": "logo", "url": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.png", "name": "logo.png", "virusScanned": true } } ``` ## DELETE /api/status/upload Name: Statusseite Bild entfernen Group: Statusseite Verfügbare "type": favicon, seoImage, logo, background, ogImage Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/upload Live: https://skrime.eu/api/status/upload Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "logo" } ``` Response example: ```json { "response": "Successfully removed image", "state": "success", "data": { "type": "logo" } } ``` ## GET /api/status/group Name: Gruppen abrufen Group: Statusseite Verfügbare "scope": single, all. Bei "scope" = "single" ist Parameter "groupId" erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/group Live: https://skrime.eu/api/status/group Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "all" } ``` Response example: ```json { "response": "Successfully fetched groups", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "groups": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "parentId": null, "name": "Netzwerk", "sortId": 1, "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## POST /api/status/group Name: Gruppe erstellen Group: Statusseite Ohne Parameter "groupId" wird eine Gruppe erstellt, mit "groupId" wird die vorhandene Gruppe aktualisiert. Der Parameter "parentId" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/group Live: https://skrime.eu/api/status/group Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Netzwerk" } ``` Response example: ```json { "response": "Successfully created group", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "groupId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Netzwerk" } } ``` ## DELETE /api/status/group Name: Gruppe löschen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/group Live: https://skrime.eu/api/status/group Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "groupId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted group", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "groupId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/status/monitor Name: Monitore abrufen Group: Statusseite Verfügbare "scope": single, all. Bei "scope" = "single" ist Parameter "monitorId" erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor Live: https://skrime.eu/api/status/monitor Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "all" } ``` Response example: ```json { "response": "Successfully fetched monitors", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitors": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "groupId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "http", "state": "online", "name": "Webserver", "target": { "url": "https://skrime.eu" }, "paused": false, "onlineThreshold": 60, "onlineRatioThreshold": 0.8, "offlineRatioThreshold": 0.5, "repeat": 1, "failStreak": 0, "avgResponseTime": 42.5, "lastSslDays": 78, "sortId": 1, "nodes": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "FRA1", "city": "Frankfurt", "cityEn": "Frankfurt", "regionId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ], "regionIds": [ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ], "notificationIds": [ "1" ], "currentIncident": null, "uptime90d": [ { "day": "2024-01-01", "uptime": 100 } ], "avgUptime90d": 99.9, "lastStateChange": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } ], "nodes": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "FRA1", "city": "Frankfurt", "cityEn": "Frankfurt", "regionId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "active", "online": true } ], "regions": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "code": "eu", "name": "Europa", "sortId": 1 } ] } } ``` ## POST /api/status/monitor Name: Monitor erstellen Group: Statusseite Verfügbare "type": http, tcp, ping, ssl, dns, keyword, json, push, gamedig, grpc, mqtt, mysql, postgres, redis, mongodb, sqlserver, smtp, websocket, rabbitmq, radius, kafka, manual, server. Ist Parameter "monitorId" gesetzt, wird der vorhandene Monitor aktualisiert. Die Pflichtfelder in "target" richten sich nach "type", bei "type" = "http" ist "url" erforderlich. Bei "type" = "server" entfällt Parameter "nodeIds" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor Live: https://skrime.eu/api/status/monitor Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "http", "name": "Webseite Mustermann", "nodeIds": [ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ], "target": { "url": "https://www.domain.tld" } } ``` Response example: ```json { "response": "Successfully created monitor", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "http", "name": "Webseite Mustermann", "target": { "url": "https://www.domain.tld", "ssl_warn_days": 14 }, "onlineThreshold": 4, "onlineRatioThreshold": 80, "offlineRatioThreshold": 50, "repeat": 1 } } ``` ## DELETE /api/status/monitor Name: Monitor löschen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor Live: https://skrime.eu/api/status/monitor Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted monitor", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/status/monitor-config Name: Monitorkonfiguration abrufen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor-config Live: https://skrime.eu/api/status/monitor-config Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched monitor configuration", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "http", "config": { "intervalSec": 60, "retryInterval": 60, "resendInterval": 0, "maxRetries": 0, "timeout": 48, "method": "GET", "acceptedStatus": "200-299", "followRedirects": true, "ignoreTls": false, "sslExpiry": false, "sslWarnDays": 14, "packetCount": 5, "packetLossThreshold": 50, "upsideDown": false, "bodyEncoding": "json", "body": "", "headers": "", "authMethod": "none", "basicAuthUser": "", "basicAuthPass": "", "packetSize": 56, "dnsResolveServer": "1.1.1.1", "givenPortOnly": true } } } ``` ## POST /api/status/monitor-sort Name: Monitorreihenfolge setzen Group: Statusseite Entweder Parameter "order" oder Parameter "layout" ist erforderlich. Mit "layout" lautet die Antwort "Successfully updated layout" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor-sort Live: https://skrime.eu/api/status/monitor-sort Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "order": [ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } ``` Response example: ```json { "response": "Successfully updated sort order", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "count": 2 } } ``` ## POST /api/status/monitor-pause Name: Monitor pausieren Group: Statusseite Bei "paused" = false lautet die Antwort "Successfully resumed monitor" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor-pause Live: https://skrime.eu/api/status/monitor-pause Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "paused": true } ``` Response example: ```json { "response": "Successfully paused monitor", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "paused": true } } ``` ## POST /api/status/monitor-status Name: Monitorstatus setzen Group: Statusseite Verfügbare "state": online, offline. Nur Monitore mit "type" = "manual" lassen sich setzen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor-status Live: https://skrime.eu/api/status/monitor-status Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "offline" } ``` Response example: ```json { "response": "Successfully updated monitor status", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "offline" } } ``` ## DELETE /api/status/monitor-stats Name: Monitorstatistik löschen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/monitor-stats Live: https://skrime.eu/api/status/monitor-stats Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted monitor statistics", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/status/detail Name: Monitor Details abrufen Group: Statusseite Die Parameter "range" und "expand" sind optional. Verfügbare "range": 1h, 3h, 6h, 12h, 24h, 1d, 3d, 7d, 14d, 30d, 60d, 90d Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/detail Live: https://skrime.eu/api/status/detail Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched monitor detail", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitor": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "http", "state": "online", "name": "Webshop Mustermann", "target": { "url": "https://domain.tld", "interval_sec": 60 } }, "stats": { "availability": 100, "avgResponseTime": 142, "onlineNodes": 6, "totalNodes": 6 }, "series": [ { "regionId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "parentId": null, "level": "region", "zoneName": "Europa", "points": [ { "t": "2024-01-01T00:00:00Z", "state": 1, "rt": 142 } ] } ], "incidents": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "source": "auto", "severity": "major", "status": "resolved", "title": "Webshop nicht erreichbar", "message": "Der Webshop war von mehreren Standorten aus nicht erreichbar.", "durationSec": 420, "notified": true, "hidden": false, "regions": [ "Europa", "Nordamerika" ], "regionsDown": 2, "regionsTotal": 6, "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00" } ] } } ``` ## GET /api/status/report Name: Uptime Bericht abrufen Group: Statusseite Der Parameter "months" ist optional und liegt zwischen 1 und 12, ohne Angabe gelten 6 Monate Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/report Live: https://skrime.eu/api/status/report Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched uptime report", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "months": 6, "report": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Webserver", "months": [ { "month": "2024-01", "uptime": 100 }, { "month": "2024-01", "uptime": 100 } ] } ] } } ``` ## GET /api/status/agent Name: Agent Metriken abrufen Group: Statusseite Die Parameter "range" und "withSeries" sind optional. Verfügbare "range": 1h, 3h, 6h, 12h, 24h, 1d, 3d, 7d, 14d, 30d, 60d, 90d Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/agent Live: https://skrime.eu/api/status/agent Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched agent metrics", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "active", "intervalSec": 30, "thresholds": { "cpu": 90, "memory": 90, "storage": 85 }, "publicMetrics": [ "availability", "load" ], "systemInfo": { "hostname": "web01.domain.tld", "os": "Debian GNU/Linux 12", "kernel": "6.1.0-18-amd64", "arch": "x86_64", "cpuCores": 8, "memTotal": 33554432000, "uptime": 1284350, "agentVersion": "1.4.2" }, "snapshot": { "cpu": 12.4, "cpuPerCore": [ 10.2, 14.8, 11.6, 13.1 ], "load": [ 0.42, 0.51, 0.48 ], "mem": { "used": 8589934592, "total": 33554432000 }, "swap": { "used": 0, "total": 4294967296 }, "net": { "in": 184320, "out": 92160 }, "netInterfaces": [ { "name": "eth0", "in": 184320, "out": 92160 } ], "connections": 142, "diskIO": { "read": 524288, "write": 262144 }, "disks": [ { "mount": "/", "used": 42949672960, "total": 214748364800, "percent": 0, "inodesPercent": 0 } ], "processes": { "count": 214, "names": [ "nginx", "mariadbd" ], "top": [ { "name": "nginx", "pid": 1284, "cpu": 4.2, "mem": 1.8 } ] }, "temperatures": [ { "sensor": "Package id 0", "celsius": 41.5 } ], "uptime": 1284350, "at": "2024-01-01 00:00:00" }, "servicesStatus": [ { "name": "nginx", "running": true }, { "name": "mariadbd", "running": true } ], "servicesWatched": true, "bucketSec": 1200, "series": { "cpu": [ { "t": "2024-01-01T00:00:00Z", "v": 12.4 } ], "memPercent": [ { "t": "2024-01-01T00:00:00Z", "v": 25.6 } ], "swapPercent": [], "netIn": [ { "t": "2024-01-01T00:00:00Z", "v": 184320 } ], "netOut": [ { "t": "2024-01-01T00:00:00Z", "v": 92160 } ], "load1": [ { "t": "2024-01-01T00:00:00Z", "v": 0.42 } ], "connections": [ { "t": "2024-01-01T00:00:00Z", "v": 142 } ], "procCount": [ { "t": "2024-01-01T00:00:00Z", "v": 214 } ], "diskRead": [ { "t": "2024-01-01T00:00:00Z", "v": 524288 } ], "diskWrite": [ { "t": "2024-01-01T00:00:00Z", "v": 262144 } ] }, "seriesState": "ok", "lastSeenAt": "2024-01-01 00:00:00" } } ``` ## POST /api/status/agent Name: Agent Metriken melden Group: Statusseite Die Parameter "system" und "agentVersion" sind optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/agent Live: https://skrime.eu/api/status/agent Request example: ```json { "key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "metrics": { "cpu": 12.4, "cpuPerCore": [ 10.2, 14.8, 11.6, 13.1 ], "load": [ 0.42, 0.51, 0.48 ], "mem": { "used": 8589934592, "total": 33554432000 }, "swap": { "used": 0, "total": 4294967296 }, "net": { "in": 184320, "out": 92160 }, "netInterfaces": [ { "name": "eth0", "in": 184320, "out": 92160 } ], "connections": 142, "diskIO": { "read": 524288, "write": 262144 }, "disks": [ { "mount": "/", "used": 42949672960, "total": 214748364800, "inodesUsed": 540672, "inodesTotal": 13107200 } ], "processes": { "count": 214, "names": [ "nginx", "mariadbd" ], "top": [ { "name": "nginx", "pid": 1284, "cpu": 4.2, "mem": 1.8 } ] }, "temperatures": [ { "sensor": "Package id 0", "celsius": 41.5 } ] }, "system": { "hostname": "web01.domain.tld", "os": "Debian GNU/Linux 12", "kernel": "6.1.0-18-amd64", "arch": "x86_64", "cpuCores": 8, "memTotal": 33554432000, "uptime": 1284350 }, "agentVersion": "1.4.2" } ``` Response example: ```json { "response": "Successfully added agent metrics", "state": "success", "data": { "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/status/notification Name: Benachrichtigungen abrufen Group: Statusseite Verfügbare "scope": single, all. Bei "scope" = "single" ist Parameter "notificationId" erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/notification Live: https://skrime.eu/api/status/notification Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "scope": "all" } ``` Response example: ```json { "response": "Successfully fetched notifications", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "notifications": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "email", "data": { "email": "max@domain.tld" }, "configured": false, "monitorCount": 2, "lastSentAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## POST /api/status/notification Name: Benachrichtigung erstellen Group: Statusseite Verfügbare "type": email, webhook, pushover, discord, telegram, ntfy. Ist Parameter "notificationId" gesetzt, wird die vorhandene Benachrichtigung aktualisiert. Bei "type" = "email" ist Parameter "email" erforderlich, bei "webhook" Parameter "webhookUrl", bei "pushover" Parameter "pushoverUser" und "pushoverToken", bei "discord" Parameter "discordWebhook", bei "telegram" Parameter "telegramToken" und "telegramChat", bei "ntfy" Parameter "ntfyServer" und "ntfyTopic" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/notification Live: https://skrime.eu/api/status/notification Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "email", "email": "max@domain.tld" } ``` Response example: ```json { "response": "Successfully created notification", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "notificationId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "email" } } ``` ## DELETE /api/status/notification Name: Benachrichtigung löschen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/notification Live: https://skrime.eu/api/status/notification Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "notificationId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted notification", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "notificationId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/status/notification-test Name: Testbenachrichtigung senden Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/notification-test Live: https://skrime.eu/api/status/notification-test Warning: this endpoint changes access, credentials, targets or routing. Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "notificationId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully sent test notification", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "notificationId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "email" } } ``` ## GET /api/status/maintenance Name: Wartungsfenster abrufen Group: Statusseite Der Parameter "pageId" ist optional Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/maintenance Live: https://skrime.eu/api/status/maintenance Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched maintenance", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "maintenance": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "scheduled", "title": "Wartung am Netzwerk", "message": "Kurze Unterbrechungen sind möglich", "affectedMonitors": [ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ], "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## POST /api/status/maintenance Name: Wartungsfenster anlegen Group: Statusseite Ohne Parameter "maintenanceId" wird ein Wartungsfenster angelegt, mit "maintenanceId" wird es aktualisiert. Verfügbare "state": scheduled, active, completed, cancelled Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/maintenance Live: https://skrime.eu/api/status/maintenance Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "title": "Wartung am Netzwerk" } ``` Response example: ```json { "response": "Successfully created maintenance window", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "maintenanceId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "scheduled", "title": "Wartung am Netzwerk" } } ``` ## DELETE /api/status/maintenance Name: Wartungsfenster löschen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/maintenance Live: https://skrime.eu/api/status/maintenance Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "maintenanceId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted maintenance", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "maintenanceId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/status/incident Name: Vorfälle abrufen Group: Statusseite Verfügbare "scope": all, monitor, page. Bei "scope" = "monitor" ist Parameter "monitorId" erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/incident Live: https://skrime.eu/api/status/incident Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched incidents", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidents": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "source": "manual", "severity": "offline", "status": "resolved", "monitorName": "Webserver", "title": "Störung im Rechenzentrum", "message": "Der Anbieter arbeitet an der Behebung", "durationSec": 1860, "notified": true, "hidden": false, "updates": [ { "status": "resolved", "message": "Die Störung ist behoben", "createdAt": "2024-01-01 00:00:00" } ], "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00" } ], "pagination": { "recordsTotal": 1, "recordsFiltered": 1, "currentPage": 1, "perPage": 25, "totalPages": 1, "hasNext": false, "hasPrev": false } } } ``` ## POST /api/status/incident Name: Vorfall melden Group: Statusseite Ohne Parameter "incidentId" wird ein Vorfall gemeldet, mit "incidentId" wird der Vorfall aktualisiert. Verfügbare "severity": warning, offline. Verfügbare "status": investigating, identified, monitoring, resolved Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/incident Live: https://skrime.eu/api/status/incident Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "title": "Störung im Rechenzentrum" } ``` Response example: ```json { "response": "Successfully created incident", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "status": "investigating" } } ``` ## DELETE /api/status/incident Name: Vorfall löschen Group: Statusseite Statt Parameter "incidentId" kann Parameter "all" gesetzt werden, dann werden alle Vorfälle des Produkts gelöscht Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/incident Live: https://skrime.eu/api/status/incident Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted incident", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/status/incident-update Name: Vorfall Update veröffentlichen Group: Statusseite Der Parameter "status" ist optional. Verfügbare "status": investigating, identified, monitoring, resolved Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/incident-update Live: https://skrime.eu/api/status/incident-update Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "message": "Die Störung ist behoben" } ``` Response example: ```json { "response": "Successfully added incident update", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/status/incident-detail Name: Vorfalldetails abrufen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/incident-detail Live: https://skrime.eu/api/status/incident-detail Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched incident detail", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "severity": "offline", "source": "auto", "durationSec": 1860, "affectedRegions": [ { "nodeName": "Frankfurt", "offlinePercent": 0 } ], "totalNodes": 3, "allAffected": false, "updates": [ { "status": "resolved", "message": "Die Störung ist behoben", "createdAt": "2024-01-01 00:00:00" } ], "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00" } } ``` ## GET /api/status/announcement Name: Neuigkeiten abrufen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/announcement Live: https://skrime.eu/api/status/announcement Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched announcements", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "announcements": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "title": "Wartung am Standort Frankfurt", "message": "Wir tauschen in der Nacht einen Netzwerkverteiler aus.", "createdAt": "2024-01-01 00:00:00", "responses": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "title": "Wartung abgeschlossen", "message": "Der Austausch ist beendet, alle Dienste laufen wieder.", "createdAt": "2024-01-01 00:00:00", "responses": [] } ] } ] } } ``` ## POST /api/status/announcement Name: Neuigkeit erstellen Group: Statusseite Die Parameter "announcementId" und "parentId" sind optional. Bei Angabe von "announcementId" wird die vorhandene Neuigkeit aktualisiert und die Antwort lautet "Successfully updated announcement" Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/announcement Live: https://skrime.eu/api/status/announcement Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "title": "Wartung am Standort Frankfurt", "message": "Wir tauschen in der Nacht einen Netzwerkverteiler aus." } ``` Response example: ```json { "response": "Successfully created announcement", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "announcementId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## DELETE /api/status/announcement Name: Neuigkeit löschen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/announcement Live: https://skrime.eu/api/status/announcement Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "announcementId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted announcement", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "announcementId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/status/allow-domain Name: Domain Freigabe prüfen Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/allow-domain Live: https://skrime.eu/api/status/allow-domain Request example: ```json { "domain": "status.domain.tld" } ``` Response example: ```json { "response": "Successfully verified domain", "state": "success", "data": { "domain": "status.domain.tld" } } ``` ## GET /api/status/badge Name: Uptime Abzeichen abrufen Group: Statusseite Die Antwort ist ein SVG Bild mit Content-Type image/svg+xml und nicht die übliche JSON Antwort Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/badge Live: https://skrime.eu/api/status/badge Request example: ```json { "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response: not JSON (file or raw output) ## GET /api/status/checks Name: Prüfaufträge abrufen Group: Statusseite Der Aufruf ist nur von einem eingetragenen Prüfknoten möglich, dessen Name im Header "X-Hostname" steht und dessen IP Adresse zum Knoten passen muss Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/checks Live: https://skrime.eu/api/status/checks Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request body: none Response example: ```json { "response": "Successfully fetched checks", "state": "success", "data": { "nodeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "region": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitors": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type": "http", "target": { "url": "https://domain.tld", "interval_sec": 60 } } ] } } ``` ## GET /api/status/push Name: Push Heartbeat senden Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/push Live: https://skrime.eu/api/status/push Request example: ```json { "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully received push heartbeat", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/status/push Name: Push Heartbeat senden Group: Statusseite Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/status/push Live: https://skrime.eu/api/status/push Request example: ```json { "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully received push heartbeat", "state": "success", "data": { "productId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/statuspage/overview Name: Statusseitenübersicht abrufen Group: Statusseite (öffentlich) Entweder Parameter "slug" oder Parameter "host" ist erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/statuspage/overview Live: https://skrime.eu/api/statuspage/overview Request example: ```json { "slug": "mustermann" } ``` Response example: ```json { "response": "Successfully fetched status page overview", "state": "success", "data": { "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "page": { "name": "Statusseite", "browserTitle": "Status", "footerName": "Mustermann GmbH", "footerCopyright": "2026 Mustermann GmbH", "showFooter": true, "footerTransparent": false, "footerColor": "#f8f9fa", "website": "https://domain.tld", "imprint": "https://domain.tld/impressum", "privacy": "https://domain.tld/datenschutz", "customUrl": "mustermann", "brandColor": "#0d6efd", "backgroundColor": "#ffffff", "textColor": "#212529", "monitorColor": "#f8f9fa", "onlineColor": "#198754", "warningColor": "#ffc107", "offlineColor": "#dc3545", "pausedColor": "#6c757d", "buttonColor": "#0d6efd", "graphColor": "#0d6efd", "logoUrl": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.png", "logoOnly": false, "showHero": true, "backgroundUrl": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.jpg", "backgroundGradient": false, "showHistory": true, "hasProxmox": true, "showAnnouncements": true, "showLangSwitch": true, "font": "Nunito", "groupLayout": "stacked", "groupsCollapsible": true, "groupsDefaultCollapsed": false, "groupPageSize": 15, "showCpu": true, "showRam": true, "showStorage": true, "overlayOpacity": 60, "heroAccent": false, "seoDescription": "Aktueller Betriebsstatus aller Dienste", "favicon": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.ico", "seoImage": "https://skrime.eu/data/status/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.png", "seoIndex": true }, "overallUptime": 100, "regions": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "code": "eu", "name": "Europa", "sortId": 1 } ], "groups": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Netzwerk", "sortId": 1, "parentId": null } ], "monitors": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Webserver", "type": "http", "state": "online", "paused": false, "onlineRatioThreshold": 0.8, "offlineRatioThreshold": 0.5, "avgResponseTime": 42.5, "lastSslDays": 78, "groupId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nodes": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "FRA1", "regionId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ], "regionIds": [ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ], "uptime90d": [ { "day": "2024-01-01", "uptime": 100 } ], "avgUptime90d": 99.9 } ], "openIncidents": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorName": "Webserver", "source": "auto", "severity": "offline", "status": "investigating", "title": "Störung im Rechenzentrum", "message": "Der Anbieter arbeitet an der Behebung", "startAt": "2024-01-01 00:00:00" } ], "activeMaintenance": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "scheduled", "title": "Wartung am Netzwerk", "message": "Kurze Unterbrechungen sind möglich", "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00", "affectedMonitors": [ "Webserver" ] } ], "announcements": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "title": "Wartung am Standort Frankfurt", "message": "Wir tauschen in der Nacht einen Netzwerkverteiler aus.", "createdAt": "2024-01-01 00:00:00", "responses": [] } ] } } ``` ## GET /api/statuspage/monitor Name: Monitor Details abrufen Group: Statusseite (öffentlich) Entweder Parameter "slug" oder Parameter "host" ist erforderlich. Die Parameter "range" und "expand" sind optional. Verfügbare "range": 6h, 12h, 24h, 3d, 7d Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/statuspage/monitor Live: https://skrime.eu/api/statuspage/monitor Request example: ```json { "slug": "mustermann", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched monitor detail", "state": "success", "data": { "monitor": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "Webserver", "type": "http", "state": "online", "paused": false, "onlineRatioThreshold": 0.8, "offlineRatioThreshold": 0.5 }, "range": "24h", "stats": { "availability": 100, "avgResponseTime": 142, "onlineNodes": 3, "totalNodes": 3 }, "series": [ { "nodeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nodeName": "Europa", "zoneId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "zoneName": "Europa", "level": "region", "parentId": null, "points": [ { "t": "2024-01-01T00:00:00Z", "state": 1, "rt": 142.4 } ] } ], "incidents": [ { "severity": "offline", "status": "resolved", "title": "Störung im Rechenzentrum", "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00", "durationSec": 1860 } ] } } ``` ## GET /api/statuspage/incidents Name: Vorfallverlauf abrufen Group: Statusseite (öffentlich) Entweder Parameter "slug" oder Parameter "host" ist erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/statuspage/incidents Live: https://skrime.eu/api/statuspage/incidents Request example: ```json { "slug": "mustermann" } ``` Response example: ```json { "response": "Successfully fetched incident history", "state": "success", "data": { "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "incidents": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorName": "Webserver", "source": "auto", "severity": "offline", "status": "resolved", "title": "Störung im Rechenzentrum", "message": "Der Anbieter arbeitet an der Behebung", "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00", "durationSec": 1860, "updates": [ { "status": "resolved", "message": "Die Störung ist behoben", "createdAt": "2024-01-01 00:00:00" } ] } ] } } ``` ## GET /api/statuspage/incident Name: Vorfalldetails abrufen Group: Statusseite (öffentlich) Entweder Parameter "slug" oder Parameter "host" ist erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/statuspage/incident Live: https://skrime.eu/api/statuspage/incident Request example: ```json { "slug": "mustermann", "incidentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched incident detail", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "monitorId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "severity": "offline", "source": "auto", "durationSec": 1860, "affectedRegions": [ { "nodeName": "FRA1", "offlinePercent": 0 } ], "totalNodes": 3, "allAffected": false, "updates": [ { "status": "resolved", "message": "Die Störung ist behoben", "createdAt": "2024-01-01 00:00:00" } ], "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00" } } ``` ## GET /api/statuspage/maintenance Name: Wartungsfenster abrufen Group: Statusseite (öffentlich) Entweder Parameter "slug" oder Parameter "host" ist erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/statuspage/maintenance Live: https://skrime.eu/api/statuspage/maintenance Request example: ```json { "slug": "mustermann" } ``` Response example: ```json { "response": "Successfully fetched maintenance windows", "state": "success", "data": { "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "maintenance": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "scheduled", "title": "Wartung am Netzwerk", "message": "Kurze Unterbrechungen sind möglich", "startAt": "2024-01-01 00:00:00", "endAt": "2024-01-01 00:00:00", "affectedMonitors": [ "Webserver" ], "createdAt": "2024-01-01 00:00:00" } ] } } ``` ## GET /api/statuspage/proxmox Name: Proxmox Auslastung abrufen Group: Statusseite (öffentlich) Entweder Parameter "slug" oder Parameter "host" ist erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/statuspage/proxmox Live: https://skrime.eu/api/statuspage/proxmox Request example: ```json { "slug": "mustermann" } ``` Response example: ```json { "response": "Successfully fetched Proxmox cluster resources", "state": "success", "data": { "pageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "cpu": 24, "mem": 61, "storage": 47 } } ``` ## POST /api/paste/create Name: Paste erstellen Group: Paste Der Parameter "password" ist optional, max. 1MB Content Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/paste/create Live: https://skrime.eu/api/paste/create Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "content": "Hello World", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully created paste", "state": "success", "data": { "pasteId": "share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "url": "https://skrime.eu/paste/share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "shortUrl": "https://skri.me/share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "rawUrl": "https://skrime.eu/paste/share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.raw", "hasPassword": true, "createdAt": "2024-01-01 00:00:00" } } ``` ## GET /api/paste/view Name: Paste anzeigen Group: Paste Der Parameter "password" ist nur bei einem passwortgeschützten Paste erforderlich Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/paste/view Live: https://skrime.eu/api/paste/view Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "pasteId": "share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully fetched paste", "state": "success", "data": { "pasteId": "share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "content": "Hello World", "hasPassword": true, "canDelete": true, "createdAt": "2024-01-01 00:00:00" } } ``` ## DELETE /api/paste/delete Name: Paste löschen Group: Paste Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/paste/delete Live: https://skrime.eu/api/paste/delete Warning: this endpoint returns or creates a secret, moves money or depends on the caller's IP address. Do not call it from an AI tool, use the SKRIME interface instead. Request example: ```json { "pasteId": "share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully deleted paste", "state": "success", "data": { "pasteId": "share-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/support/service Name: Servicezeiten abrufen Group: Ticket Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/support/service Live: https://skrime.eu/api/support/service Request body: none Response example: ```json { "response": "Successfully fetched service hours", "state": "success", "data": { "open": false, "nextOpenDay": "mon", "nextOpenToday": false, "nextOpenTime": "09:00" } } ``` ## GET /api/support/tickets Name: Tickets abrufen Group: Ticket Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/support/tickets Live: https://skrime.eu/api/support/tickets Variant: Tickets abrufen Request example: ```json { "scope": "all" } ``` Response example: ```json { "response": "Successfully fetched tickets", "state": "success", "data": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "OPEN", "username": "Max Mustermann", "tags": "Dedicated Server", "assigneeUserId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "assigneeUsername": "Erika Musterfrau", "assigneeAvatarUrl": "https://skrime.eu/data/avatar/XXXXX.svg", "messagePreview": "Mein Server ist nicht erreichbar. Bitte ...", "hasReply": true, "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } ] } ``` Variant: Ticket abrufen Request example: ```json { "scope": "single", "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched ticket", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "OPEN", "username": "Max Mustermann", "tags": "Dedicated Server", "notifyOnSeen": true, "assigneeUserId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "assigneeUsername": "Erika Musterfrau", "assigneeAvatarUrl": "https://skrime.eu/data/avatar/XXXXX.svg", "inactiveOver3Days": false, "messages": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "username": "Max Mustermann", "type": "user", "message": "Mein Server ist nicht erreichbar.
Bitte prüft das.", "fileState": "secure", "files": [ { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name": "screenshot.png", "size": 248310 } ], "createdAt": "2024-01-01 00:00:00" }, { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "username": "Erika Musterfrau", "type": "team", "message": "Wir haben den Server neu gestartet.", "fileState": "pending", "files": [], "createdAt": "2024-01-01 00:00:00" } ], "updatedAt": "2024-01-01 00:00:00", "createdAt": "2024-01-01 00:00:00" } } ``` ## POST /api/support/ticket Name: Ticket erstellen Group: Ticket Der Parameter "files" ist optional. Erlaubte Endungen: jpg, jpeg, png, gif, webp, pdf, txt, log, zip, csv Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/support/ticket Live: https://skrime.eu/api/support/ticket Request example: ```json { "message": "Mein Server ist nicht erreichbar." } ``` Response example: ```json { "response": "Successfully created ticket", "state": "success", "data": { "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "messageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/support/message Name: Nachricht senden Group: Ticket Der Parameter "files" ist optional und wird als Datei hochgeladen, höchstens 10 MB je Datei. Erlaubte Dateitypen: jpg, jpeg, png, gif, webp, pdf, txt, log, zip, csv Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/support/message Live: https://skrime.eu/api/support/message Request example: ```json { "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "message": "Der Server ist wieder erreichbar, vielen Dank." } ``` Response example: ```json { "response": "Successfully sent message", "state": "success", "data": { "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "messageId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## GET /api/support/preview Name: Anhang anzeigen Group: Ticket Nur Bilder, PDF, Video, Audio und Textdateien lassen sich anzeigen. Andere Dateitypen werden mit 400 abgewiesen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/support/preview Live: https://skrime.eu/api/support/preview Request example: ```json { "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "fileId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response: not JSON (file or raw output) ## GET /api/support/download Name: Anhang herunterladen Group: Ticket Die Antwort ist kein JSON, der Endpunkt liefert die Anhangsdatei aus. Kunden erhalten nur freigegebene Dateien Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/support/download Live: https://skrime.eu/api/support/download Request example: ```json { "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "fileId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } ``` Response: not JSON (file or raw output) ## POST /api/support/action Name: Ticket Status ändern Group: Ticket Parameter "action" muss einer der folgenden Werte sein: close, close_system, reopen. Der Wert "close_system" ist Teammitgliedern vorbehalten Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/support/action Live: https://skrime.eu/api/support/action Warning: this endpoint is destructive (deletes, stops or replaces). Only call it after explicit confirmation by the user. Request example: ```json { "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "action": "close" } ``` Response example: ```json { "response": "Successfully closed ticket", "state": "success", "data": { "ticketId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "CLOSED" } } ``` ## GET /api/other/country Name: Länderliste abrufen Group: Tools Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/country Live: https://skrime.eu/api/other/country Request body: none Response example: ```json { "response": "Successfully fetched country list", "state": "success", "data": { "countries": [ { "countryCode": "DE", "countryNameDe": "Deutschland", "countryNameEn": "Germany", "taxClassification": "de" } ] } } ``` ## POST /api/other/captcha Name: Captcha erstellen Group: Tools Das Captcha läuft nach 5 Minuten ab. Die Verifizierung prüft ob IP Adresse und User Agent übereinstimmen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/captcha Live: https://skrime.eu/api/other/captcha Request example: ```json { "userAddr": "127.0.0.1", "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36" } ``` Response example: ```json { "response": "Successfully created captcha", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "image": "iVBORw0KGgoAAAANSUhEUgAAARgAAABQCAYAAADwLLl2AAAgAElEQVR4nO2d" } } ``` ## GET /api/other/captcha Name: Captcha verifizieren Group: Tools Die IP Adresse und der User Agent müssen mit der Erstellung übereinstimmen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/captcha Live: https://skrime.eu/api/other/captcha Request example: ```json { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "code": "XXXXXX", "userAddr": "127.0.0.1", "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36" } ``` Response example: ```json { "response": "Successfully verified captcha", "state": "success", "data": { "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "state": "solved" } } ``` ## GET /api/other/whois Name: Whois Daten abrufen Group: Tools Der Parameter "query" muss eine IP-Adresse oder eine Domain sein, andere Eingaben werden abgewiesen Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/whois Live: https://skrime.eu/api/other/whois Request example: ```json { "query": "domain.tld" } ``` Response example: ```json { "response": "Successfully fetched WHOIS information", "state": "success", "data": { "query": "domain.tld", "whois": "Domain: domain.tld\nRegistrar: Musterregistrar GmbH\nCreated: 2024-01-01 00:00:00" } } ``` ## GET /api/other/network Name: Netzwerkdiagnose abrufen Group: Tools Verfügbare "type": host, ping, mtr, traceroute Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/network Live: https://skrime.eu/api/other/network Request example: ```json { "host": "example.com", "type": "ping" } ``` Response example: ```json { "response": "Successfully fetched network information", "state": "success", "data": { "host": "example.com", "type": "ping", "command": "ping -c 4 'example.com'", "output": "PING example.com (93.184.216.34) 56(84) bytes of data." } } ``` ## GET /api/other/iban Name: IBAN prüfen Group: Tools Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/iban Live: https://skrime.eu/api/other/iban Request example: ```json { "query": "DEXXXXXXXXXXXXXXXXXXXX" } ``` Response example: ```json { "response": "Successfully fetched IBAN information", "state": "success", "data": { "query": "DEXXXXXXXXXXXXXXXXXXXX", "bankData": { "bankCode": "XXXXXXXX", "name": "Musterbank", "zip": "XXXXX", "city": "Musterort", "bic": "XXXXXXXXXXX" }, "valid": true } } ``` ## GET /api/other/uuid Name: UUID erzeugen Group: Tools Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/uuid Live: https://skrime.eu/api/other/uuid Request body: none Response example: ```json { "response": "Successfully generated UUID", "state": "success", "data": { "uuid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } ``` ## POST /api/other/novnc Name: noVNC URL erzeugen (extern) Group: Tools Port und Passwort über "/nodes/{hostname}/qemu/{vmid}/vncproxy" erzeugen. Die IP Adresse darf nicht privat oder reserviert sein. In der Firewall des PVE Hosts "51.89.100.61" und "2001:41d0:700:3604::c0de" freigeben. Code Beispiel (https://skri.me/share-0199fc54-57fa-81a0-9107-59d6a953daf0) Auth: Authorization: Bearer $SKRIME_API_KEY Sandbox: https://skrime.eu/sandbox/other/novnc Live: https://skrime.eu/api/other/novnc Request example: ```json { "ipAddress": "127.0.0.1", "port": "5900", "password": "Musterpasswort1" } ``` Response example: ```json { "response": "Successfully generated noVNC URL", "state": "success", "data": { "url": "https://novnc.eu/vnc.html#host=novnc.eu&port=443&encrypt=1&path=%3Ftoken=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&password=myPassword&autoconnect=1&show_dot=true&scaleViewport=true" } } ```