Connection details and credentials

An owner/admin can read a database’s connection details while it is active or paused. The response contains privileged credentials; treat the entire body as secret.

Field	How to use it
host, port	Public database destination; do not substitute the API hostname
database	Native database name; Redis URIs use database 0
username, password	Privileged engine credentials
connection_string	Engine URI; preserve query options and check for masking
engine	postgres, redis, or mongodb
ssl_mode	Deployment-specific TLS setting; interpret with the engine URI
key_prefix	Redis namespace prefix; add it to every native-client key

For normal application traffic, create an application user and combine its returned username/password with these public destination settings. PostgreSQL user-creation responses can contain masked URIs, and other user URI destinations may differ from the connection panel. The connection-details endpoint is the destination reference.

A URI containing **** is display text, not a usable credential. If a custom password contains URI-reserved characters, use driver parameters or encode the username/password components when constructing a URI. Do not blindly encode the whole URI.

TLS availability and mode depend on deployment. A PostgreSQL prefer value can allow a non-TLS connection; redis:// is different from rediss://; MongoDB TLS is controlled by its options. Confirm required encryption and certificate verification before production use. See network and TLS.

Choose a working example: PostgreSQL, Redis, MongoDB. API contract: connection details.