Skip to main content
GET
Get connection details

Authorizations

X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Path Parameters

database_id
string
required

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

Query Parameters

reveal
boolean
default:false

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

Response

Connection details

success
boolean
host
string

Endpoint hostname

Example:

"a1b2c3d4.db.raffusercloud.com"

port
integer

Endpoint port

Example:

6432

username
string

Database user

password
string

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

database_name
string

Default database name

connection_uri
string

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

ca_cert
string

PEM CA that signs the database's certificate. Kafka clients must trust it; for PostgreSQL, use it with sslmode=verify-full.

public_host
string

Public hostname. Empty while public access is off.

Example:

"a1b2c3d4.public.db.raffusercloud.com"

public_port
integer

Public port. PostgreSQL uses the standard direct port 5432 (routed by the hostname your client sends in TLS); ClickHouse uses its native TLS port; other engines use public_port of the database.

Example:

5432

public_connection_uri
string

Ready-to-use URI for the public endpoint (includes the password only when revealed). Empty while public access is off.

Last modified on October 5, 2026