rds.backups.restoreRestore to latest, to a timestamp, or to a labelled backup
Request syntax
POST /rds/api/instances/{id}/restore
{
"recoveryTarget": "enum",
"targetIdentifier": "string",
"instanceClass": "string",
"topology": "enum",
"kmsKeyId": "string",
"publiclyAccessible": "boolean",
"tags": "map of string",
"recoveryTargetTime": "string",
"recoveryTargetLabel": "string"
}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Request body
The body takes one of several shapes (latest, time, label); the server decides which combination of fields is valid.
recoveryTargetRequiredenum
Selects which of the other fields apply
One of:
latest,time,labeltargetIdentifierOptionalstring
Name of the new database the restore creates; a restore never overwrites its source
Constraints: 1-63 chars
instanceClassOptionalstring
Instance type of the new database, e.g. performance-2 (provider names deprecated); omitted: the source's
Constraints: min 1 chars
topologyOptionalenum
single (the default) or cluster: three nodes, the class needs 8 GiB of memory or more
One of:
single,clusterkmsKeyIdOptionalstring
KMS key for the new database's disks; null: the platform key; omitted: the source's
Constraints: uuid
May be null.
publiclyAccessibleOptionalboolean
Whether the new database answers on the internet; omitted: the source's choice
tagsOptionalmap of string
Tags for the new resource, e.g. {"env": "prod", "project": "shop"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).
Constraints: key=value
recoveryTargetTimeOptionalstring
ISO time to restore to; must lie inside the recoverable window of backups list
Constraints: datetime
recoveryTargetLabelOptionalstring
Label of the backup to restore, as backups list shows it (e.g. 20260826-030000F)
Constraints: 1-128 chars, /^[A-Za-z0-9_-]+$/
Response
202 with { job, target }: the restore job (status queued, as `list-restore-jobs` shows it) and the new database it builds, as `get` describes it without `placement`.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
jobAlwaysobject
The restore jobjob.idAlwaysstring
Restore job idjob.orgIdAlwaysstring
Organization that owns the databasesjob.sourceDbInstanceIdAlwaysstring
Database whose backups are restoredjob.targetDbInstanceIdAlwaysstring, may be null
New database the restore builds; null once that database is deletedjob.recoveryTargetAlwaysone of latest, time, label
latest, a point in time, or a labelled backupjob.recoveryTargetTimeAlwaysstring, may be null
The point in time, for timejob.recoveryTargetLabelAlwaysstring, may be null
The backup label, for labeljob.baseBackupLabelAlwaysstring, may be null
Backup the restore starts from; set when it startsjob.statusAlwaysone of queued, restoring, completed, cancelled, failed
cancelled: withdrawn before it startedjob.errorAlwaysstring, may be null
Why it failed or who cancelled it; null otherwisejob.requestedByIamUserIdAlwaysstring, may be null
IAM user who asked; null once that user is deletedjob.startedAtAlwaysstring, may be null
When the restore startedjob.finishedAtAlwaysstring, may be null
When it finished or was cancelledjob.createdAtAlwaysstring
When it was requestedtargetAlwaysobject
The new database the restore buildstarget.idAlwaysstring
Database id (ewdb-…)target.orgIdAlwaysstring
Organization that owns the databasetarget.identifierAlwaysstring
Name of the database, unique within the organizationtarget.engineAlwaysone of postgres, docdb
Database engine; postgres for every managed PostgreSQL databasetarget.engineVersionAlwaysstring
PostgreSQL version the database is on, a pinned minor such as 17.11target.instanceClassAlwaysstring
Instance type of every node, e.g. performance-2target.regionIdAlwaysstring
Region the database is in, e.g. de1target.availabilityZoneIdAlwaysstring, may be null
Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a clustertarget.vpcIdAlwaysstring, may be null
VPC the database joins; null: nonetarget.subnetIdAlwaysstring, may be null
Subnet of that VPC its addresses come from; null: the VPC's whole rangetarget.dbNameAlwaysstring, may be null
Database created inside the server at launchtarget.masterUsernameAlwaysstring
Name of the master role, whose password is filed in Secretstarget.allocatedStorageGibAlwaysnumber
Size of each node's data volume, GiBtarget.maxAllocatedStorageGibAlwaysnumber, may be null
Autoscaling ceiling, GiB; null: automatic growth is offtarget.storageTypeAlwaysstring
Storage class label; informationaltarget.iopsAlwaysnumber, may be null
Provisioned IOPS; not offered, so nulltarget.multiAzAlwaysboolean
Not used: zonePlacement says how a cluster is spread over zonestarget.publiclyAccessibleAlwaysboolean
Whether the database answers on the internet; false: only from its VPCtarget.topologyAlwaysone of single, cluster
single: one node; cluster: three nodes with automatic failovertarget.nodeCountAlwaysnumber
Core nodes: 1 for single, 3 for a cluster (readers not counted)target.masterSecretIdAlwaysstring, may be null
Secret holding the master password; null until it is filedtarget.loadBalancerIdAlwaysstring, may be null
Load balancer in front of a cluster, on the platform's own fleet; null otherwisetarget.endpointKindAlwaysone of hetzner-lb, fleet, may be null
What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single nodetarget.hetznerLoadBalancerIdAlwaysnumber, may be null
The provider's id of a cluster's load balancer; null when there is nonetarget.hetznerNetworkIdAlwaysnumber, may be null
The provider's id of the private network a cluster's members talk over; null on a single nodetarget.hetznerFirewallIdAlwaysnumber, may be null
The provider's id of the database's firewall; null before it existstarget.reconcileErrorAlwaysstring, may be null
Why the last provisioning or teardown step failed; null when nothing failedtarget.capacityFallbackAlwaysobject
What the create could fall back to when its type was sold outtarget.capacityFallback.otherZonesAlwaysboolean
A sold-out zone may be replaced by another zone of the regiontarget.capacityFallback.equivalentTypesAlwaysboolean
A sold-out instance type may be replaced by an equivalent onetarget.onStockOutAlwaysone of fail, wait
Sold out with no fallback: fail the create, or wait for stocktarget.capacityWaitUntilAlwaysstring, may be null
While waiting for stock: when the create gives up; null otherwisetarget.requestedInstanceClassAlwaysstring, may be null
The instance type asked for, when a stock fallback bought another; null otherwisetarget.statusAlwaysone of available, creating, modifying, backing-up, deleting, failed, stopped, starting, stopping, rebooting, maintenance, waiting-for-capacity, retained
State of the databasetarget.retainedUntilAlwaysstring, may be null
For a retained database: when its backups are removed; null otherwisetarget.endpointAddressAlwaysstring, may be null
Address clients connect to; null until the database is reachabletarget.endpointPortAlwaysnumber, may be null
Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432target.privateEndpointAddressAlwaysstring, may be null
The database's address inside its VPC, named in its certificate; null: use endpointAddresstarget.parameterGroupIdAlwaysstring, may be null
Not used; parameters holds your valuestarget.backupRetentionDaysAlwaysnumber
Days backups are kept; 0: scheduled backups are offtarget.backupsEnabledAlwaysboolean
Whether scheduled backups are takentarget.storageEncryptedAlwaysboolean
Whether every node's data volume is encrypted at resttarget.storageKmsKeyIdAlwaysstring, may be null
KMS key that wraps every node volume's key; null: the platform keytarget.backupAgentSeenAtAlwaysstring, may be null
When a node last asked for backup work; null: nevertarget.backupPollerVersionAlwaysnumber, may be null
Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reportedtarget.lastBackupAtAlwaysstring, may be null
When the newest backup finished; null: nevertarget.backupWindowAlwaysstring, may be null
When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)target.maintenanceWindowAlwaysstring, may be null
Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mitarget.deletionProtectionAlwaysboolean
While true, delete is refusedtarget.performanceInsightsEnabledAlwaysboolean
Not used; query insights are always ontarget.autoMinorVersionUpgradeAlwaysboolean
Whether new minor versions are applied in the maintenance windowtarget.parametersAlwaysmap
Your PostgreSQL parameter values by name; parameters not named keep their defaulttarget.caCertIdentifierAlwaysstring, may be null
Name of the CA that signs the server certificatetarget.tlsSerialAlwaysstring, may be null
Serial of the server certificate; null: the database has no certificatetarget.tlsNotAfterAlwaysstring, may be null
When the server certificate expirestarget.tlsNamesInCertAlwaysboolean
Whether the certificate names the database's DNS endpoint namestarget.tlsRequiredAlwaysboolean
Whether clients that do not use TLS are refusedtarget.replicationModeAlwaysone of async, sync, may be null
sync: a commit waits for one standby; async: it does not; null on a single nodetarget.zonePlacementAlwaysone of spread, single, may be null
spread: members over the zones; single: all in one zone; null on a single nodetarget.logicalReplicationAlwaysboolean
Whether wal_level is logical, for CDC and publicationstarget.branchPoolOfAlwaysstring, may be null
Set on the machine that serves the branches of another database: that database; null otherwisetarget.branchSettingsAlwaysunknown
Branch settings as stored (branch-settings reads them); null: the defaultstarget.launchedAtAlwaysstring, may be null
When the database first became availabletarget.tagsAlwaysstring, may be null
Kept for compatibility; the tags API holds the tags of the databasetarget.createdAtAlwaysstring
When the database was createdtarget.updatedAtAlwaysstring
When the database record last changedtarget.encryptionAlwaysobject
What is encrypted at resttarget.encryption.storageAlwaysone of luks2, none
luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryptiontarget.encryption.backupsAlwaysone of aes-256-cbc, none
aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryption
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 restore id --recovery-target latestcurl -X POST "https://console.platform-development.deutschecloud.app/rds/api/instances/id/restore" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"recoveryTarget":"latest"}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_backups_restore.