rds.encryption.startEncrypt a database created before disk encryption: an encrypted copy streams beside it, then a switchover of seconds in its maintenance window (or now)
Single-node databases. Same address, credentials and backup stanza; plaintext backups move to a new encrypted repository with a full backup first. Writes pause only for the switchover (the old machine stops, the address moves, the encrypted machine is promoted). The old disk is kept holdDays, then zero-filled and deleted.
Request syntax
POST /rds/api/instances/{id}/encrypt
{
"schedule": "enum",
"deleteOldAfterHold": "boolean"
}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Request body
scheduleOptionalenum
window: switch over in the maintenance window; now: as soon as the copy is ready
One of:
now,windowDefault:
"window"deleteOldAfterHoldOptionalboolean
Zero-fill and delete the old disk (and plaintext backups) when the hold ends; false keeps them until deleted by hand
Default:
true
Response
202 with the run.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Run idstateAlwaysone 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 cancelledscheduleAlwaysone of now, window
When the switchover may happenrequestedByAlwaysone of owner, operator
Who askeddeleteOldAfterHoldAlwaysboolean
The old disk is deleted when the hold endsbatchIdAlwaysstring, may be null
Shared by the runs of one encrypt-all; null otherwisestepAlwaysstring, may be null
What it is doing nowerrorAlwaysstring, may be null
Why it stopped; null otherwiseswitchStartedAtAlwaysstring, may be null
When writes pausedswitchFinishedAtAlwaysstring, may be null
When writes were accepted on the encrypted diskswitchoverSecondsAlwaysnumber, may be null
Writes paused for this longholdUntilAlwaysstring, may be null
When the old disk may be wipedoldVolumeWipedAtAlwaysstring, may be null
When the old disk was zero-filled and deletedcreatedAtAlwaysstring
When it was asked forfinishedAtAlwaysstring, 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:EncryptDBInstance 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 start idcurl -X POST "https://console.platform.deutschecloud.app/rds/api/instances/id/encrypt" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_encryption_start.