rds.backups.createTake a backup now
On a database whose nodes run backup poller 3 (`keepsByHand` in the list), the backup is kept until you delete it, at most 20 per database; otherwise it follows the retention window.
Request syntax
POST /rds/api/instances/{id}/backupsPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
202 with { backup, state: "requested" }: the backup (a full backup, status running, as `list` shows it) that the database node fills in when it reports.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
backupAlwaysobject
The backup requestedbackup.idAlwaysstring
Backup idbackup.dbInstanceIdAlwaysstring
Database the backup is ofbackup.orgIdAlwaysstring
Organization that owns the databasebackup.typeAlwaysone of full, differential, incremental
full copies every file; the others what changed since an earlier backupbackup.statusAlwaysone of running, completed, failed, expired
expired: aged out of the retention window and no longer in the repositorybackup.labelAlwaysstring, may be null
Name of the backup, e.g. 20260826-030000F; null until it has finishedbackup.startedAtAlwaysstring
When the backup started (or was requested)backup.finishedAtAlwaysstring, may be null
When it finished; null while runningbackup.sizeBytesAlwaysnumber, may be null
Size of the database as backed up, bytesbackup.repoSizeBytesAlwaysnumber, may be null
Space it takes in the backup repository, bytes: what is billedbackup.walStartAlwaysstring, may be null
First WAL segment the backup needsbackup.walStopAlwaysstring, may be null
Last WAL segment the backup needsbackup.errorAlwaysstring, may be null
Why it failed; null otherwisebackup.keptUntilDeletedAlwaysboolean
Taken by hand and kept until deleted, not expired with the retention windowbackup.createdAtAlwaysstring
When the record was createdstateAlways"requested"
Recorded; a database node picks the request up and reports back
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:CreateBackup 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 create idcurl -X POST "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_create.