rds.branches.getOne branch: status, data as of, masking, connection, create time
Request syntax
GET /rds/api/branches/{branchId}Path parameters
branchIdRequiredstring
Constraints: /^ewbr-[0-9a-f]{12}$/
Response
200 with the branch: id, parentDbInstanceId, name, status, origin, recoveryTargetTime, dataAsOf, masked, maskRuleCount, expiresAt, source, pullRequest, connection, usedBytes, error, requestedAt, availableAt, createTookMs, agentTookMs.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Branch id (ewbr-…)parentDbInstanceIdAlwaysstring
Database the branch is ofnameAlwaysstring
Branch namestatusAlwaysone of queued, creating, available, deleting, deleted, failed
State of the branchoriginAlwaysone of base, time
base: a clone of the pool's base; time: restored to recoveryTargetTimerecoveryTargetTimeAlwaysstring, may be null
The moment asked for, for origin timedataAsOfAlwaysstring, may be null
The moment the branch's data is frommaskedAlwaysboolean
Whether masking rules were applied to its datamaskRuleCountAlwaysnumber
Masking rules appliedexpiresAtAlwaysstring, may be null
When the branch is deleted; null for a pull-request branch, which lives with its pull requestsourceAlwaysone of api, pull_request
Asked for through the API or console, or made for a pull requestpullRequestAlwaysobject, may be null
The pull request it was made for; null otherwisepullRequest.gitRepositoryIdAlwaysstring
Git repositorypullRequest.numberAlwaysnumber
Pull request numberconnectionAlwaysobject
Where to connectconnection.hostAlwaysstring, may be null
Host to connect to; null until the branch pool has oneconnection.portAlwaysnumber, may be null
Port of the branch; null until it is assignedconnection.databaseAlwaysstring
Database to connect toconnection.userAlwaysstring
The master user of the parent databaseconnection.secretNameAlwaysstring
Secrets entry holding every login role's password on the branchconnection.urlAlwaysstring, may be null
postgres:// URL without the password; null while host or port is unknownusedBytesAlwaysnumber, may be null
Bytes written to the branch since it was cut, as last reportederrorAlwaysstring, may be null
Why it failed; null otherwiserequestedAtAlwaysstring
When it was asked foravailableAtAlwaysstring, may be null
When it became availablecreateTookMsAlwaysnumber, may be null
Request to available, millisecondsagentTookMsAlwaysnumber, 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 get branchIdcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/branches/branchId" \
-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_get.