This web service allows to cancel an ongoing (remote or local) configuration restore operation.
This web service requires the ADMIN role.
| Method | Endpoint |
|---|---|
DELETE |
|
| Path parameter | Type | Required? | Description |
|---|---|---|---|
orderId |
String | Yes | Unique identifier of the restore order to be stopped. Get the ID from the response of the Restore a configuration backup or Restore a configuration backup from a remote portal web service. |
| Return code | Description |
|---|---|
204 NO CONTENT |
The order was successfully stopped. |
401 UNAUTHORIZED |
You are not authenticated when authentication is required. |
403 FORBIDDEN |
You do not have the specific rights required by the web service. |
404 NOT FOUND |
There is no such order in progress (the backup might have already been restored). |
409 CONFLICT |
The status of the restore operation does not allow the user to stop it. |
For a comprehensive list of all possible return codes, see Return codes.