Managed Databases

Get connection details

Connection details for the database: host, port, username, database name, and a ready-to-use connection URI.

The password field is empty unless you pass reveal=true. TLS is always required.

get/api/v1/databases/{database_id}/connection

Path parameters

database_idstring required

Database ID (UUID) or short id (the database_id field, e.g. a1b2c3d4)

Query parameters

revealboolean

Set to true to include the password in the response and connection URI

Response

Connection details

successboolean
hoststring

Endpoint hostname

portinteger

Endpoint port

usernamestring

Database user

passwordstring

Password — empty unless the request was made with reveal=true

database_namestring

Default database name

connection_uristring

Ready-to-use connection URI (includes the password only when revealed)

ca_certstring

PEM CA bundle your client must trust, for engines whose certificates come from a private CA (currently Kafka). Empty for other engines.

Example response

{
  "host": "a1b2c3d4.db.raffusercloud.com",
  "port": 6432
}

Changes