Skip to main content
GET
cURL

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:
MAC,
LINUX,
WINDOWS

Response

A successful response.

connection_string
string
required

connection_string contains the full connection string with parameters formatted inline.

params
object
required

Individual parameters used to create a connection string.