rds.branches.listA database's branches with where to connect, and its branch pool: machine, base age, masking, operation, space per branch
Request syntax
GET /rds/api/instances/{id}/branchesPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Query parameters
includeDeletedOptionalenum
Include deleted branches
One of:
true,false
Response
200 with pool (null before the first branch: status, host, baseRestoredAt, maskedAt, staleAfterHours, refreshDue, operation, usage, …) and branches, each as `get` describes it.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
poolAlwaysobject, may be null
The branch pool; null before the first branchpool.idAlwaysstring
Branch pool idpool.statusAlwaysone of building, preparing, available, refreshing, deleting, failed
State of the poolpool.hostAlwaysobject, may be null
The machine the branches run on; null before it existspool.host.dbInstanceIdAlwaysstring
Database id of the pool machinepool.host.identifierAlwaysstring
Its namepool.host.instanceClassAlwaysstring
Its instance typepool.host.allocatedStorageGibAlwaysnumber
Its storage, GiBpool.host.statusAlwaysstring
Its statepool.baseRestoredAtAlwaysstring, may be null
The moment the base's data is frompool.maskedAtAlwaysstring, may be null
When the base was maskedpool.maskRulesCurrentAlwaysboolean
False when the masking rules changed since: the next branch refreshes the basepool.staleAfterHoursAlwaysnumber
A branch asked for on an older base refreshes it first; 0: alwayspool.refreshDueAlwaysstring, may be null
Why the next branch will refresh the base first; null when it will notpool.operationAlwaysobject, may be null
The pool's operation in progress; null: nonepool.operation.idAlwaysstring
Operation idpool.operation.kindAlwaysone of prepare-base, refresh-base
What is being donepool.operation.statusAlwaysone of pending, running
Waiting or runningpool.operation.requestedAtAlwaysstring
When it was asked forpool.operation.claimedAtWhen presentstring
When the pool machine took it uppool.operation.attemptsAlwaysnumber
Tries so farpool.operation.rulesHashWhen presentstring, may be null
Fingerprint of the masking rules the base is masked withpool.usageAlwaysobject, may be null
Space, as the pool machine last reported; null: not reportedpool.usage.poolSizeBytesAlwaysnumber
Size of the pool storage, bytespool.usage.poolFreeBytesAlwaysnumber
Free, bytespool.usage.baseUsedBytesAlwaysnumber
Taken by the base, bytespool.usage.branchesAlwaysarray of object
Each branchpool.usage.branches[].idAlwaysstring
Branch idpool.usage.branches[].usedBytesAlwaysnumber
Bytes written since the clonepool.usage.branches[].runningAlwaysboolean
Whether its server runspool.usageReportedAtAlwaysstring, may be null
When usage was reportedpool.lastErrorAlwaysstring, may be null
Why the pool last failed; null otherwisepool.emptySinceAlwaysstring, may be null
Since when the pool holds no branch; null while it holds somebranchesAlwaysarray of object
The branches of the databasebranches[].idAlwaysstring
Branch id (ewbr-…)branches[].parentDbInstanceIdAlwaysstring
Database the branch is ofbranches[].nameAlwaysstring
Branch namebranches[].statusAlwaysone of queued, creating, available, deleting, deleted, failed
State of the branchbranches[].originAlwaysone of base, time
base: a clone of the pool's base; time: restored to recoveryTargetTimebranches[].recoveryTargetTimeAlwaysstring, may be null
The moment asked for, for origin timebranches[].dataAsOfAlwaysstring, may be null
The moment the branch's data is frombranches[].maskedAlwaysboolean
Whether masking rules were applied to its databranches[].maskRuleCountAlwaysnumber
Masking rules appliedbranches[].expiresAtAlwaysstring, may be null
When the branch is deleted; null for a pull-request branch, which lives with its pull requestbranches[].sourceAlwaysone of api, pull_request
Asked for through the API or console, or made for a pull requestbranches[].pullRequestAlwaysobject, may be null
The pull request it was made for; null otherwisebranches[].pullRequest.gitRepositoryIdAlwaysstring
Git repositorybranches[].pullRequest.numberAlwaysnumber
Pull request numberbranches[].connectionAlwaysobject
Where to connectbranches[].connection.hostAlwaysstring, may be null
Host to connect to; null until the branch pool has onebranches[].connection.portAlwaysnumber, may be null
Port of the branch; null until it is assignedbranches[].connection.databaseAlwaysstring
Database to connect tobranches[].connection.userAlwaysstring
The master user of the parent databasebranches[].connection.secretNameAlwaysstring
Secrets entry holding every login role's password on the branchbranches[].connection.urlAlwaysstring, may be null
postgres:// URL without the password; null while host or port is unknownbranches[].usedBytesAlwaysnumber, may be null
Bytes written to the branch since it was cut, as last reportedbranches[].errorAlwaysstring, may be null
Why it failed; null otherwisebranches[].requestedAtAlwaysstring
When it was asked forbranches[].availableAtAlwaysstring, may be null
When it became availablebranches[].createTookMsAlwaysnumber, may be null
Request to available, millisecondsbranches[].agentTookMsAlwaysnumber, may be null
Time the branch machine spent creating it, milliseconds
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:DescribeDBBranches 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 list idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/branches" \
-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_branches_list.