deploy.database.rotateNew password for the app role; redeploys by default
Depending on the resource, the call checks rds:ModifyDBInstance, deploy:DeployApp instead; hold all of them to be sure it is allowed.
Request syntax
POST /deploy/api/apps/{id}/database/rotate
{
"envPrefix": "string",
"redeploy": "boolean"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
envPrefixOptionalstring
Which database binding, by its envPrefix; default empty (the unprefixed one)
Constraints: max 32 chars, /^([A-Z][A-Z0-9_]*_)?$/
redeployOptionalboolean
Roll the live deployment onto the new password; default true, since new connections with the old password stop working at once
Response
200 with `data`: { version } — the new version of the password secret. The top-level `redeploy` is null unless redeploy was requested; then { ok: true, deploymentId, generation, reusedDeploymentId } or { ok: false, error }. A master-mode binding is refused (409): rotate the master password on the database.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
versionAlwaysnumber, may be null
The new version of the password secret; null if it could not be read 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 deploy:ManageDatabaseBinding 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 deploy database rotate idcurl -X POST "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/database/rotate" \
-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_deploy_database_rotate.