rds.branches.set-settingsSet the masking rules and pull-request branches (replaces both)
No branch is served unmasked: changed rules make the next branch refresh the pool base first. A rule for a column that does not exist is skipped and reported in the activity log.
Request syntax
PUT /rds/api/instances/{id}/branch-settings
{
"masking": "array of json",
"pullRequests": "object"
}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Request body
maskingOptionalarray of json
Columns rewritten in the pool base before any branch sees it; none when omitted
Default:
[]pullRequestsOptionalobject
A branch per pull request of a Git repository; null or omitted turns it off
Constraints: JSON
Default:
nullMay be null.
Response
200 with the settings now stored: { masking, pullRequests }.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
maskingAlwaysarray of object
Columns rewritten in the pool base before any branch sees itmasking[].databaseAlwaysstring
Database inside the instancemasking[].schemaAlwaysstring
Schema of the tablemasking[].tableAlwaysstring
Tablemasking[].columnAlwaysstring
Column rewrittenmasking[].methodAlwaysone of null, redact, hash, email, phone, name
How the column is rewrittenpullRequestsAlwaysobject, may be null
A branch per pull request; null: offpullRequests.gitRepositoryIdAlwaysstring
Git repository whose pull requests get a branchpullRequests.targetBranchesAlwaysarray of string
Pull requests into these branches; empty: the repository's default branch
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:ModifyDBBranchSettings 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 branches set-settings idcurl -X PUT "https://console.platform-development.deutschecloud.app/rds/api/instances/id/branch-settings" \
-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_branches_set-settings.