deploy.connections.get

Host (private or public, as the binding resolves it), port, database, role and the secret holding the password

GET /deploy/api/apps/{id}/connectionsIAM deploy:DescribeAppRead

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}/connections

Path parameters

  • idRequired

    string

    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

  • databasesAlways

    array of object

    Managed Postgres bindings
  • databases[].​envPrefixAlways

    string

    Prefix of the generated variable names; empty for none
  • databases[].​errorAlways

    string, may be null

    Why the next rollout would fail for this binding; null when it resolves
  • databases[].​connectionAlways

    object, may be null

    How the app connects; null when error is set
  • databases[].​connection.​hostAlways

    string

    Host the app connects to
  • databases[].​connection.​networkAlways

    one of private, public

    private: inside the app’s network; public: over the internet
  • databases[].​connection.​portAlways

    number

    Port
  • databases[].​connection.​databaseAlways

    string

    Database
  • databases[].​connection.​userAlways

    string

    User (role)
  • databases[].​connection.​passwordAlways

    object

    Where the password is; never the password itself
  • databases[].​connection.​password.​secretIdAlways

    string

    The Secret holding the password
  • databases[].​connection.​password.​secretNameAlways

    string, may be null

    Its name; null if it is gone
  • databases[].​connection.​password.​canRevealAlways

    boolean

    Whether you may read its value
  • cachesAlways

    array of object

    Managed cache bindings
  • caches[].​envPrefixAlways

    string

    Prefix of the generated variable names; empty for none
  • caches[].​errorAlways

    string, may be null

    Why the next rollout would fail for this binding; null when it resolves
  • caches[].​connectionAlways

    object, may be null

    How the app connects; null when error is set
  • caches[].​connection.​hostAlways

    string

    Host the app connects to
  • caches[].​connection.​portAlways

    number

    Port
  • caches[].​connection.​tlsAlways

    boolean

    Whether the connection uses TLS (rediss://)
  • caches[].​connection.​userAlways

    "default"

    User, always default
  • caches[].​connection.​passwordAlways

    object

    Where the password is; never the password itself
  • caches[].​connection.​password.​secretIdAlways

    string

    The Secret holding the password
  • caches[].​connection.​password.​secretNameAlways

    string, may be null

    Its name; null if it is gone
  • caches[].​connection.​password.​canRevealAlways

    boolean

    Whether you may read its value
  • brokersAlways

    array of object

    Kafka, RabbitMQ and Document Database bindings
  • brokers[].​engineAlways

    one of kafka, rabbitmq, docdb

    kafka, rabbitmq or docdb
  • brokers[].​envPrefixAlways

    string

    Prefix of the generated variable names; empty for none
  • brokers[].​errorAlways

    string, may be null

    Why the next rollout would fail for this binding; null when it resolves
  • brokers[].​connectionAlways

    object, may be null

    How the app connects; null when error is set
  • brokers[].​connection.​identifierAlways

    string

    Name of the cluster or broker
  • brokers[].​connection.​hostAlways

    string

    Kafka: the bootstrap list; otherwise the address to connect to
  • brokers[].​connection.​portAlways

    number

    Port
  • brokers[].​connection.​nodesAlways

    array of string

    Every node as address:port
  • brokers[].​connection.​userAlways

    string

    User the app signs in as
  • brokers[].​connection.​passwordAlways

    object

    Where the password is; never the password itself
  • brokers[].​connection.​password.​secretIdAlways

    string

    The Secret holding the password
  • brokers[].​connection.​password.​secretNameAlways

    string, may be null

    Its name; null if it is gone
  • brokers[].​connection.​password.​canRevealAlways

    boolean

    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 id

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.