menu
small_header_rootserver.svg

netcup wiki

Server

REST API

Learn how the transition to the REST API works.
1. Transition from SOAP to REST2. Migration to the new REST API3. How do I use the new REST API?4. Frequently Asked Questions (FAQ)

1. Transition from SOAP to REST

The SCP SOAP web service used to date is no longer state of the art and does not offer the full range of functions provided by the user interface. This means that it is incomplete for many use cases and can only be used to a limited extent.

The new REST API is based on common web standards, enabling significantly easier and more consistent access to the available functions. The aim of the transition is to provide a modern interface that makes automation around VMs easier and more reliable.

2. Migration to the new REST API

Starting October 1, 2025, the REST API will be available in the Server Control Panel (SCP). It will replace the existing SCP SOAP web service. To ensure a smooth transition, the new REST API will be rolled out in several phases.

Schedule

PhaseDescriptionPeriod
Beta phaseThe REST API will be available as a public beta starting October 1, 2025. During this phase, you can use the API and submit suggestions for improvement in the
netcup forum. Breaking changes are possible.		October 1, 2025–October 31, 2025
Migration phaseThe REST API will be stable as of November 1, 2025. There will be no more breaking changes.
You can begin migrating your applications.		November 1, 2025–April 30, 2026
Shutdown of SCP web serviceThe SCP SOAP web service will be permanently deactivated on May 1, 2026.
You must have migrated your existing applications to the REST API by this date at the latest.		May 1, 2026

3. How do I use the new REST API?

You can make programmatic changes using the REST API in the Server Control Panel (SCP). The available endpoints and instructions for authentication can be found directly in the SCP. To open the API documentation, click REST API Docs in the menu at the top right.

Open API documentation in the SCP

The REST API is case-sensitive, so use lowercase letters only, as uppercase letters can lead to errors.

4. Frequently Asked Questions (FAQ)

Does netcup offer to postpone the date for shutting down the SCP web service? This is a global function and the shutdown date cannot therefore be extended on an individual basis.
Last update: 01/10/2025
server rest api