rds.branches.get-credentialsThe branch's passwords (every login role) and a DATABASE_URL for its master user
Request syntax
GET /rds/api/branches/{branchId}/credentialsPath parameters
branchIdRequiredstring
Constraints: /^ewbr-[0-9a-f]{12}$/
Response
200 with the connection (host, port, database, user, secretName, url), passwords (role → password) and databaseUrl for the master user (null while host or port is unknown).
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
hostAlwaysstring, may be null
Host to connect to; null until the branch pool has oneportAlwaysnumber, may be null
Port of the branch; null until it is assigneddatabaseAlwaysstring
Database to connect touserAlwaysstring
The master user of the parent databasesecretNameAlwaysstring
Secrets entry holding every login role's password on the branchurlAlwaysstring, may be null
postgres:// URL without the password; null while host or port is unknownpasswordsAlwaysmap
Every login role's password on the branch, by role namedatabaseUrlAlwaysstring, may be null
postgres:// URL with the master password; null while host or port is unknown
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:GetDBBranchCredentials 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-credentials branchIdcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/branches/branchId/credentials" \
-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-credentials.