deploy.connections.getHost (private or public, as the binding resolves it), port, database, role and the secret holding the password
Resolved exactly as the next rollout resolves it; a binding that would fail the rollout carries `error` instead of `connection`. No password is returned: read it with `dcloud secrets secrets get-value <password.secretId>` (needs secrets:GetSecretValue on that secret, audited). DATABASE_URL is postgresql://<user>:<password>@<host>:<port>/<database>?sslmode=require.
Request syntax
GET /deploy/api/apps/{id}/connectionsPath parameters
idRequiredstring
Constraints: uuid
Response
200 with `data`: `databases`, `caches` and `brokers`, one entry per binding with its envPrefix (brokers also engine) and either `connection` (host, port, user, database or nodes as they apply, and `password` — secretId, secretName and canReveal) or `error`.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
databasesAlwaysarray of object
Managed Postgres bindingsdatabases[].envPrefixAlwaysstring
Prefix of the generated variable names; empty for nonedatabases[].errorAlwaysstring, may be null
Why the next rollout would fail for this binding; null when it resolvesdatabases[].connectionAlwaysobject, may be null
How the app connects; null when error is setdatabases[].connection.hostAlwaysstring
Host the app connects todatabases[].connection.networkAlwaysone of private, public
private: inside the app’s network; public: over the internetdatabases[].connection.portAlwaysnumber
Portdatabases[].connection.databaseAlwaysstring
Databasedatabases[].connection.userAlwaysstring
User (role)databases[].connection.passwordAlwaysobject
Where the password is; never the password itselfdatabases[].connection.password.secretIdAlwaysstring
The Secret holding the passworddatabases[].connection.password.secretNameAlwaysstring, may be null
Its name; null if it is gonedatabases[].connection.password.canRevealAlwaysboolean
Whether you may read its valuecachesAlwaysarray of object
Managed cache bindingscaches[].envPrefixAlwaysstring
Prefix of the generated variable names; empty for nonecaches[].errorAlwaysstring, may be null
Why the next rollout would fail for this binding; null when it resolvescaches[].connectionAlwaysobject, may be null
How the app connects; null when error is setcaches[].connection.hostAlwaysstring
Host the app connects tocaches[].connection.portAlwaysnumber
Portcaches[].connection.tlsAlwaysboolean
Whether the connection uses TLS (rediss://)caches[].connection.userAlways"default"
User, always defaultcaches[].connection.passwordAlwaysobject
Where the password is; never the password itselfcaches[].connection.password.secretIdAlwaysstring
The Secret holding the passwordcaches[].connection.password.secretNameAlwaysstring, may be null
Its name; null if it is gonecaches[].connection.password.canRevealAlwaysboolean
Whether you may read its valuebrokersAlwaysarray of object
Kafka, RabbitMQ and Document Database bindingsbrokers[].engineAlwaysone of kafka, rabbitmq, docdb
kafka, rabbitmq or docdbbrokers[].envPrefixAlwaysstring
Prefix of the generated variable names; empty for nonebrokers[].errorAlwaysstring, may be null
Why the next rollout would fail for this binding; null when it resolvesbrokers[].connectionAlwaysobject, may be null
How the app connects; null when error is setbrokers[].connection.identifierAlwaysstring
Name of the cluster or brokerbrokers[].connection.hostAlwaysstring
Kafka: the bootstrap list; otherwise the address to connect tobrokers[].connection.portAlwaysnumber
Portbrokers[].connection.nodesAlwaysarray of string
Every node as address:portbrokers[].connection.userAlwaysstring
User the app signs in asbrokers[].connection.passwordAlwaysobject
Where the password is; never the password itselfbrokers[].connection.password.secretIdAlwaysstring
The Secret holding the passwordbrokers[].connection.password.secretNameAlwaysstring, may be null
Its name; null if it is gonebrokers[].connection.password.canRevealAlwaysboolean
Whether you may read its value
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:DescribeApp 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 connections get idcurl -X GET "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/connections" \
-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_deploy_connections_get.