deploy.docdb.bindBind a Document Database cluster (MongoDB-compatible) as one of its users
Generates {prefix}MONGODB_URL (mongodb://user:password@<host>:27017/?tls=true&authMechanism=SCRAM-SHA-256&authSource=admin&directConnection=true&tlsCAFile=<the platform CA in the container>) at every rollout, and on a 3-node cluster {prefix}MONGODB_READER_URL (the same on port 27018: the replicas, reads only, may lag). A private cluster needs the app’s machines in its VPC; a public one is reachable from anywhere. Needs secrets:GetSecretValue on that user’s password. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.
Depending on the resource, the call checks secrets:GetSecretValue, deploy:DeployApp instead; hold all of them to be sure it is allowed.
Request syntax
PUT /deploy/api/apps/{id}/docdb
{
"clusterId": "string",
"userName": "string",
"envPrefix": "string",
"redeploy": "boolean"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
clusterIdRequiredstring
The Document Database cluster to bind
Constraints: /^ewdoc-[0-9a-f]{12}$/
userNameRequiredstring
The user the app signs in as: the cluster’s master user (masterUsername) or one of its users
envPrefixOptionalstring
Put in front of every generated variable name (e.g. CACHE_ gives CACHE_REDIS_URL), so one app can hold several bindings of a kind; default empty
Constraints: max 32 chars, /^([A-Z][A-Z0-9_]*_)?$/
redeployOptionalboolean
Also roll the live deployment onto the new configuration; default false
Response
201 with `data`: the binding — id, engine, resourceId, userName, envPrefix and generatedKeys (the variable names it generates). The top-level `redeploy` is null unless redeploy was requested; then { ok: true, deploymentId, generation, reusedDeploymentId } or { ok: false, error }.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Binding idengineAlwaysone of kafka, rabbitmq, docdb
kafka, rabbitmq or docdbresourceIdAlwaysstring
The bound cluster or brokeruserNameAlwaysstring
User the app signs in asenvPrefixAlwaysstring
Prefix of the generated variable names; empty for nonegeneratedKeysAlwaysarray of string
Variable names the binding generates
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 deploy:ManageBrokerBinding 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 deploy docdb bind id --cluster-id example --user-name examplecurl -X PUT "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/docdb" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"clusterId":"example","userName":"example"}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_docdb_bind.