RArafftechnologies
Managed Databases

Get connection details

Changed on

Connection details for the database: username, database name, and two endpoints.

  • Private (host, port, connection_uri): reachable from inside the database's VPC. For PostgreSQL, port is the direct port 5432; the pooler is on 6432 of the same host. Use these only when the database has a vpc_id; without a VPC there is no private endpoint you can reach.
  • Public (public_host, public_port, public_connection_uri): filled while public access is on.

The password field is empty unless you pass reveal=true. TLS is always required: ca_cert is the database's certificate authority, for clients that verify the server certificate (the public hostname is in the certificate).

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

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/databases/{database_id}/connection
  • Auth
    API key in header X-API-Key

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 (PostgreSQL 5432 direct; its pooler is on 6432)

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 that signs the database's certificate. Kafka clients must trust it; for PostgreSQL, use it with sslmode=verify-full.

public_hoststring

Public hostname. Empty while public access is off.

public_portinteger

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.

public_connection_uristring

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

Example response

{
  "host": "a1b2c3d4.db.raffusercloud.com",
  "port": 5432,
  "public_host": "a1b2c3d4.public.db.raffusercloud.com",
  "public_port": 5432
}

Changes

  • 26292956c4b3Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • efd3c11c5c92Revision changes
    • info

      endpoint added