API Spec ohne Auth

    Ich würde gerne die API Specs und den entsprechenden Endpunkt https://www.servercontrolpanel.de/scp-core/api/v1/openapi ohne Auth abrufen können.


    Ich erhalte nur die Fehlermeldung {"message":"Authorization header missing."}

    Hallo H6G

    wir freuen uns über dein Interesse :)


    Die OpenAPI Doku wird nicht ohne Authentifizierung zur Verfügung gestellt, da sie individuell pro User ausgeliefert wird.
    Nicht jeder hat die gleichen Rollen und somit die gleichen Endpoints.


    Um die OpenAPI Spec herunterzuladen, kann einfach in der WebUI beim Endpoint der "Try it out" Button verwendet werden. Danach auf "Execute" klicken und man bekommt das json ausgeliefert.

    Wir hoffen, das klärt deine Frage!

    Liebe Grüße
    Sarah & das netcup-Team

    Quote from [netcup] Sarah G.

    Die OpenAPI Doku wird nicht ohne Authentifizierung zur Verfügung gestellt, da sie individuell pro User ausgeliefert wird.
    Nicht jeder hat die gleichen Rollen und somit die gleichen Endpoints.

    Macht es Sinn hier ein Henne - Ei Problem zu erzeugen?

    Wenn es unterschiedliche Versionen für unterschiedliche Rollen gibt, warum stellt ihr diese Versionen nicht als Auswahl zur Verfügung?

    Oder zumindest die Basisversion, falls ihr die Whitelabel API geheim halten wollt.


    Letztenendes führt das dazu, dass jeder sich seinen eigenen API Explorer hostet und bei Infos zu eurer API dann Drittseiten verlinkt werden.

    U.A. auch für Neukunden, die noch kein SCP Konto haben, aber sich vorher über die Möglichkeiten der API informieren wollen.


    Hallo H6G,
    danke für dein Feedback! :)


    Wir hosten für jeden Kunden bereits einen API Explorer in der SCP UI.
    Für uns hat sich da die Frage gestellt, welchen Mehrwert es ergeben würde, wenn man den API Explorer selbst hostet.

    Sollten Neukunden vermehrt Interesse an der API Spec haben, so werden wir diese ggf. im netcup Helpcenter zur Verfügung stellen.

    Liebe Grüße
    Sarah & das netcup-Team

    Quote from Borgqueen

    Hallo zusammen,

    mir ist bis dato nicht verständlich für was die Api ist und was man damit machen kann.

    Hi Borgqueen

    ich hatte zwar gesehen, dass im Längsten Thema auch schon drauf geantwortet wurde, aber dennoch hier kurz für dich zur Info. :)


    Sämtliche Operationen welche über die UI auf einem Server möglich sind, können so in z.B. Scripts automatisiert werden.


    Beispiele hierfür wären:

    • Automatisieren einer Wartung (Routen einer Failover IP von Server A auf B)
    • Automatisches Provisionieren eines Servers (Image-Setup inkl. Konfiguration SSH-Zugriff und danach Provisionierung mit z.B. Ansible)

    Wir hoffen, das hilft weiter!

    Liebe Grüße
    Sarah & das netcup-Team

    Quote from [netcup] Sarah G.

    Für uns hat sich da die Frage gestellt, welchen Mehrwert es ergeben würde, wenn man den API Explorer selbst hostet.

    Ich möchte schnell etwas nachsehen oder ein neues Feature entwickeln. Folgenden Ablauf muss ich bei euch durchführen:

    1. Gehe auf netcup.de

    2. Klicke auf CCP Login

    3. Gebe Kundennummer & Passwort ein

    4. Hole Handy raus

    5. Öffne TOTP App

    6. Suche Netcup 2FA Token

    7. Tippe 2FA Token im CCP ein

    8. Klicke auf SCP Autologin

    9. Klicke auf REST-API Doku


    Da bin ich wesentlich schneller, wenn ich das selber hoste oder fix eine URL example.net/scp-doc eintippe.

    Zusätzlich bin ich nicht auf SwaggerUI limitiert.


    Um ehrlich zu sein habe ich bei Punkt 5 bereits vergessen, was ich überhaupt im SCP will.


    Währenddessen gebe ich bei der Konkurrenz bei Google einfach Anbieter Cloud API ein, und ich hab alles, was ich brauche.

    Am Ende sind das Quality of Life Improvements, in denen ich zumindest einen Mehrwert sehe.


    Ich habe sogar eine altmodische Excel-Liste mit allen Servern, ihren IP Adressen und Specs, damit ich sowas schnell nachgucken kann.

    Ggf. frage ich einen DNS Server nach den Adressen. (Um mich für solche Infos nicht direkt einloggen zu müssen)


    Ich würde mich darüber freuen, wenn das Spec nach der Beta Phase schnell & einfach abrufbar ist.

    Ich kann am Ende nicht mal auf eine Datenstruktur verlinken oder im Forum auf entsprechende Fragen antworten.

    Der "Link" https://www.servercontrolpanel.de/SCP/Home;jsessionid={sessionId}?#/default/delete_api_v1_rdns_ipv4__ip_  führt ins Leere.


    Ich könnte solche Sachen nicht mit einem externen Entwickler besprechen.

    Hallo Sarah,


    Danke für die Antwort.

    Ich bin der Anfang, das Ende, die Eine, die Viele ist.

    Ich bin die Borg.

    Happy Duck 1

    Hi H6G,

    danke für die ausführliche Beschreibung deines Use Cases!
    Wir haben deine Anregungen entsprechend aufgenommen und werden die Upvotes/Reaktionen in diesem Thread weiter beobachten.

    Liebe Grüße
    Sarah & das netcup-Team

    Zusätzlich zu einer kompletten, öffentlichen API Dokumentation, wäre es auch sehr praktisch, wenn man die OpenAPI Specs direkt sehen könnte, nicht nur via dieser eingebauten Swagger-Web-UI.

    Damit meine ich die pure OpenAPI .yaml Datei selbst.


    Ich hoffe ja, dass es bald ein Terraform/OpenTofu Plugin gibt (und wenn ich es selber schreiben muss...), das die API abbildet, und spätestens dann wäre dieses Plugin eine vollständigere Dokumentation der Netcup SCP API als die auf der Netcup-Seite selbst. Das kann ja auch nicht im Sinne von Netcup sein.


    Eine öffentliche API sollte ja kein Geheimnis sein, oder?


    EDIT: Ich habe gesehen, dass man die OpenAPI Specs mittels API bekommt, aber das ist einfach nur umständlich mit der Authentifikation und so wie ich das verstanden habe, ist das auch nur eine User-angepasste Untermenge.

    Hallo Johi

    entschuldige bitte die etwas verspätete Antwort, der Endspurt des netcup Community Events hat mich da leider sehr in Beschlag genommen.
    Nichtsdestotrotz möchten wir dir dennoch eine Antwort geben. :)

    In einem ersten Schritt haben wir die API Spec öffentlich zur Verfügung gestellt, siehe hier.

    Liebe Grüße
    Sarah & das netcup-Team