rds.encryption.getWhat is encrypted at rest, and this database’s encryption runs
Request syntax
GET /rds/api/instances/{id}/encryptionPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with storage (luks2 or none), backups (aes-256-cbc or none), holdDays, legacyBackups (the plaintext backups kept from before, or null) and runs (newest first).
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
storageAlwaysone of luks2, none
Data volumes: LUKS2, or plainbackupsAlwaysone of aes-256-cbc, none
Backup repository cipherholdDaysAlwaysnumber
How long the old disk is kept after a switchover: at least 7, never less than the backup retentionlegacyBackupsAlwaysobject, may be null
Plaintext backups kept from before encryption; null when there are nonelegacyBackups.switchedAtAlwaysstring
When backups moved to the encrypted repositorylegacyBackups.deleteAfterAlwaysstring, may be null
When the plaintext backups are deleted; null: kept until someone decidesrunsAlwaysarray of object
Encryption runs, newest firstruns[].idAlwaysstring
Run idruns[].stateAlwaysone of queued, backups, standby, switching, holding, done, failed, cancelled
queued, backups (moving to an encrypted repository), standby (encrypted copy streaming), switching, holding (encrypted; old disk kept), done, failed or cancelledruns[].scheduleAlwaysone of now, window
When the switchover may happenruns[].requestedByAlwaysone of owner, operator
Who askedruns[].deleteOldAfterHoldAlwaysboolean
The old disk is deleted when the hold endsruns[].batchIdAlwaysstring, may be null
Shared by the runs of one encrypt-all; null otherwiseruns[].stepAlwaysstring, may be null
What it is doing nowruns[].errorAlwaysstring, may be null
Why it stopped; null otherwiseruns[].switchStartedAtAlwaysstring, may be null
When writes pausedruns[].switchFinishedAtAlwaysstring, may be null
When writes were accepted on the encrypted diskruns[].switchoverSecondsAlwaysnumber, may be null
Writes paused for this longruns[].holdUntilAlwaysstring, may be null
When the old disk may be wipedruns[].oldVolumeWipedAtAlwaysstring, may be null
When the old disk was zero-filled and deletedruns[].createdAtAlwaysstring
When it was asked forruns[].finishedAtAlwaysstring, may be null
When it ended
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:DescribeDBInstances 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 encryption get idcurl -X GET "https://console.platform.deutschecloud.app/rds/api/instances/id/encryption" \
-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_encryption_get.