rds.backups.listList backups and the recoverable window
Request syntax
GET /rds/api/instances/{id}/backupsPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with backups (id, type, status, label, startedAt, finishedAt, sizeBytes, keptUntilDeleted, …), recoveryWindow ({ earliest, latest } or null), backupsEnabled, retentionDays, backupWindow, lastBackupAt, agentSeenAt and keepsByHand.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
backupsAlwaysarray of object
The newest backups, newest firstbackups[].idAlwaysstring
Backup idbackups[].dbInstanceIdAlwaysstring
Database the backup is ofbackups[].orgIdAlwaysstring
Organization that owns the databasebackups[].typeAlwaysone of full, differential, incremental
full copies every file; the others what changed since an earlier backupbackups[].statusAlwaysone of running, completed, failed, expired
expired: aged out of the retention window and no longer in the repositorybackups[].labelAlwaysstring, may be null
Name of the backup, e.g. 20260826-030000F; null until it has finishedbackups[].startedAtAlwaysstring
When the backup started (or was requested)backups[].finishedAtAlwaysstring, may be null
When it finished; null while runningbackups[].sizeBytesAlwaysnumber, may be null
Size of the database as backed up, bytesbackups[].repoSizeBytesAlwaysnumber, may be null
Space it takes in the backup repository, bytes: what is billedbackups[].walStartAlwaysstring, may be null
First WAL segment the backup needsbackups[].walStopAlwaysstring, may be null
Last WAL segment the backup needsbackups[].errorAlwaysstring, may be null
Why it failed; null otherwisebackups[].keptUntilDeletedAlwaysboolean
Taken by hand and kept until deleted, not expired with the retention windowbackups[].createdAtAlwaysstring
When the record was createdrecoveryWindowAlwaysobject, may be null
The moments a point-in-time restore can name; null: none yetrecoveryWindow.earliestAlwaysstring
Earliest moment a restore can namerecoveryWindow.latestAlwaysstring
Latest moment a restore can namebackupsEnabledAlwaysboolean
Whether scheduled backups are takenagentSeenAtAlwaysstring, may be null
When the database's machines last asked for backup work; null: neverretentionDaysAlwaysnumber
Days backups are keptbackupWindowAlwaysstring, may be null
When the daily backup runs, UTC HH:MM-HH:MMlastBackupAtAlwaysstring, may be null
When the newest backup finishedkeepsByHandAlwaysboolean
A backup taken by hand is kept until it is deleted (at most 20)
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:ListBackups 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 list idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/backups" \
-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_list.