Zum Inhalt springen

netcup Dokumentation

Server

REST-API

Erfahre, wie die Umstellung auf die REST-API abläuft.

Hier findest du die technische Dokumentation zur REST-API: REST-API-Dokumentation

1. Umstellung von SOAP auf REST

Der bisher verwendete SCP-SOAP-Webservice entspricht nicht mehr dem aktuellen Stand der Technik und bietet nicht den vollen Funktionsumfang, den die Benutzeroberfläche bereitstellt. Dadurch ist er für viele Anwendungsfälle unvollständig und nur eingeschränkt nutzbar.

 

Die neue REST-API basiert auf gängigen Webstandards und ermöglicht einen deutlich einfacheren und konsistenten Zugriff auf die verfügbaren Funktionen. Ziel der Umstellung ist es, eine moderne Schnittstelle bereitzustellen, die Automatisierungen rund um VMs einfacher und zuverlässiger macht.

2. Migration zur neuen REST-API

Ab dem 01.10.2025 steht dir im Server Control Panel (SCP) die REST-API zur Verfügung. Sie löst den bestehenden SCP-SOAP-Webservice ab. Um dir eine reibungslose Umstellung zu ermöglichen, stellen wir die neue REST-API in mehreren Phasen bereit.

Zeitplan

Phase

Beschreibung

Zeitraum

Beta-Phase

Die REST-API ist ab dem 
01.10.2025 als 
öffentliche Beta 
verfügbar. In dieser Phase 
kannst du die API nutzen 
und Verbesserungsvorschläge über 
das netcup-Forum
einbringen. Breaking Changes 
sind möglich.

01.10.25-
31.10.25

Migrations-
Phase

Ab dem 01.11.2025 ist die REST-API stabil
Es wird keine Breaking Changes mehr 
geben. Du kannst mit der Migration 
deiner Anwendungen beginnen.

01.11.25-
30.04.26

Abschaltung des 
SCP-Webservice

Der SCP-SOAP-Webservice wird zum 
01.05.2026 endgültig abgeschaltet.
Spätestens zu diesem Zeitpunkt musst 
du deine bestehenden Anwendungen auf 
die REST-API migriert haben.

01.05.26

3. Wie nutze ich die neue REST-API?

Mit der REST-API im Server Control Panel (SCP) kannst du programmatische Änderungen vornehmen. Die verfügbaren Endpunkte sowie eine Anleitung zur Authentifizierung findest du direkt im SCP. 

 

Um die API-Dokumentation zu öffnen, klicke im Menü oben rechts auf REST-API Doku. Alternativ kannst du sie auch über folgenden Link öffnen: REST-API-Dokumentation

Hervorgehobene Schaltfläche im SCP, die zur REST-API-Dokumentation führt.

Die REST-API ist case-sensitive – verwende also ausschließlich Kleinbuchstaben, da Großbuchstaben zu Fehlern führen können.

4. Häufig gestellte Fragen (FAQ)

Zuletzt aktualisiert: 2. März 2026

War dieser Artikel hilfreich?