rds.backups.cancel-restoreWithdraw a restore request that has not started
Refused with 409 once the restore is past `queued`: delete the database it is building instead. Cancelling also removes the placeholder target database, provided nothing has been provisioned for it yet.
Request syntax
DELETE /rds/api/restore-jobs/{jobId}Path parameters
jobIdRequiredstring
Constraints: uuid
Response
200 with the cancelled restore job (status cancelled), as `list-restore-jobs` shows it.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Restore job idorgIdAlwaysstring
Organization that owns the databasessourceDbInstanceIdAlwaysstring
Database whose backups are restoredtargetDbInstanceIdAlwaysstring, may be null
New database the restore builds; null once that database is deletedrecoveryTargetAlwaysone of latest, time, label
latest, a point in time, or a labelled backuprecoveryTargetTimeAlwaysstring, may be null
The point in time, for timerecoveryTargetLabelAlwaysstring, may be null
The backup label, for labelbaseBackupLabelAlwaysstring, may be null
Backup the restore starts from; set when it startsstatusAlwaysone of queued, restoring, completed, cancelled, failed
cancelled: withdrawn before it startederrorAlwaysstring, may be null
Why it failed or who cancelled it; null otherwiserequestedByIamUserIdAlwaysstring, may be null
IAM user who asked; null once that user is deletedstartedAtAlwaysstring, may be null
When the restore startedfinishedAtAlwaysstring, may be null
When it finished or was cancelledcreatedAtAlwaysstring
When it was requested
Checked against the handlers: every route test validates their answers against this schema.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow rds:RestoreDBInstance on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud rds backups cancel-restore jobIdcurl -X DELETE "https://console.platform-development.deutschecloud.app/rds/api/restore-jobs/jobId" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_backups_cancel-restore.