Skip to main content
GET
cURL
This endpoint is in Preview and subject to change. Refer to the API support policy for more details.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string
required

Query Parameters

database
string
default:defaultdb
sql_user
string
os
enum<string>

os indicates the target operating system, used with formatting the default SSL certificate path. Required only for dedicated clusters.

Available options:
OS_MAC,
OS_LINUX,
OS_WINDOWS

Response

A successful response.

connection_string
string

connection_string contains the full connection string with parameters formatted inline.

params
object

params contains a list of individual key parameters for generating nonstandard connection strings.