rds.logins.rotate-passwordNew password for a login, filed as a new version of the same secret (grants carry over)
Request syntax
POST /rds/api/instances/{id}/logins/{loginId}/rotate
{
"endSessions": "boolean"
}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
loginIdRequiredstring
Constraints: uuid
Request body
endSessionsOptionalboolean
Also end the open sessions, which the old password opened
Default:
false
Response
200 with { id, secretId, version, terminated }: the secret version holding the new password and how many sessions were ended.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Login idsecretIdAlwaysstring
Secret holding the passwordversionAlwaysnumber
Its new version, holding the new passwordterminatedAlwaysnumber
Open sessions that were ended (0 unless endSessions was asked)
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:RotateDBLoginPassword 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 logins rotate-password id loginIdcurl -X POST "https://console.platform-development.deutschecloud.app/rds/api/instances/id/logins/loginId/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_rds_logins_rotate-password.