Connection Manager API, REST: Connection.Create

Статья создана

Обновлена 30 октября 2025 г.

HTTP request
Body parameters
ConnectionParams
PostgreSQLConnection
PostgreSQLCluster
Host
TLSParams
TLSConfig
PostgreSQLAuth
UserPasswordAuth
Password
PasswordGenerationOptions
LockboxPasswordGenerationOptions
MySQLConnection
MySQLCluster
Host
MySQLAuth
MongoDBConnection
MongoDBCluster
Host
MongoDBAuth
ClickHouseConnection
ClickHouseCluster
Host
ShardGroup
ClickHouseAuth
KafkaConnection
KafkaCluster
Host
KafkaAuth
KafkaSaslSecurity
RedisConnection
RedisCluster
Host
RedisAuth
UserPasswordAuth
OpenSearchConnection
OpenSearchCluster
Host
OpenSearchAuth
TrinoConnection
TrinoCluster
Coordinator
TrinoAuth
ValkeyConnection
ValkeyCluster
Host
ValkeyAuth
UserPasswordAuth
GreenplumConnection
GreenplumCluster
Host
GreenplumAuth
StoreDocConnection
StoreDocCluster
Host
StoreDocAuth
Response
CreateConnectionMetadata
Status
Connection
ConnectionParams
PostgreSQLConnection
PostgreSQLCluster
Host
TLSParams
TLSConfig
PostgreSQLAuth
UserPasswordAuth
Password
PasswordGenerationOptions
LockboxPasswordGenerationOptions
MySQLConnection
MySQLCluster
Host
MySQLAuth
MongoDBConnection
MongoDBCluster
Host
MongoDBAuth
ClickHouseConnection
ClickHouseCluster
Host
ShardGroup
ClickHouseAuth
KafkaConnection
KafkaCluster
Host
KafkaAuth
KafkaSaslSecurity
RedisConnection
RedisCluster
Host
RedisAuth
UserPasswordAuth
OpenSearchConnection
OpenSearchCluster
Host
OpenSearchAuth
TrinoConnection
TrinoCluster
Coordinator
TrinoAuth
ValkeyConnection
ValkeyCluster
Host
ValkeyAuth
UserPasswordAuth
GreenplumConnection
GreenplumCluster
Host
GreenplumAuth
StoreDocConnection
StoreDocCluster
Host
StoreDocAuth
LockboxSecret

Creates connection.

HTTP request

POST https://connman.api.cloud.yandex.net/v1/connection

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "params": {
    // Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`
    "postgresql": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "role": "string",
            "replicaType": "string",
            "health": "string"
          }
        ],
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "mysql": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "role": "string",
            "health": "string"
          }
        ],
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "mongodb": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "role": "string",
            "health": "string",
            "type": "string"
          }
        ],
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        },
        // end of the list of possible fields
        "authSource": "string"
      },
      "databases": [
        "string"
      ]
    },
    "clickhouse": {
      "cluster": {
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        },
        "hosts": [
          {
            "host": "string",
            "httpPort": "string",
            "tcpPort": "string",
            "shardName": "string",
            "health": "string"
          }
        ],
        "shardGroups": [
          {
            "name": "string",
            "shardNames": [
              "string"
            ]
          }
        ]
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "kafka": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "health": "string"
          }
        ],
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `sasl`
        "sasl": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          },
          "supportedMechanisms": [
            "string"
          ]
        }
        // end of the list of possible fields
      }
    },
    "redis": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "role": "string",
            "health": "string",
            "shardName": "string"
          }
        ],
        "sentinelPort": "string",
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "opensearch": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "health": "string",
            "roles": [
              "string"
            ]
          }
        ],
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      }
    },
    "trino": {
      "cluster": {
        "coordinator": {
          "host": "string",
          "port": "string"
        },
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      }
    },
    "valkey": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "role": "string",
            "health": "string",
            "shardName": "string"
          }
        ],
        "sentinelPort": "string",
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "greenplum": {
      "cluster": {
        "coordinatorHosts": [
          {
            "host": "string",
            "port": "string",
            "role": "string",
            "health": "string"
          }
        ],
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        }
        // end of the list of possible fields
      },
      "databases": [
        "string"
      ]
    },
    "storedoc": {
      "cluster": {
        "hosts": [
          {
            "host": "string",
            "port": "string",
            "role": "string",
            "health": "string",
            "type": "string"
          }
        ],
        "tlsParams": {
          // Includes only one of the fields `tls`
          "tls": {
            "caCertificate": "string"
          }
          // end of the list of possible fields
        }
      },
      "managedClusterId": "string",
      "auth": {
        // Includes only one of the fields `userPassword`
        "userPassword": {
          "user": "string",
          "password": {
            "raw": "string",
            "passwordGenerationOptions": {
              "cookie": "string",
              // Includes only one of the fields `lockboxPasswordGenerationOptions`
              "lockboxPasswordGenerationOptions": {
                "length": "string",
                "includeUppercase": "boolean",
                "includeLowercase": "boolean",
                "includeDigits": "boolean",
                "includePunctuation": "boolean",
                "includedPunctuation": "string",
                "excludedPunctuation": "string"
              }
              // end of the list of possible fields
            },
            // Includes only one of the fields `lockboxSecretKey`
            "lockboxSecretKey": "string"
            // end of the list of possible fields
          }
        },
        // end of the list of possible fields
        "authSource": "string"
      },
      "databases": [
        "string"
      ]
    }
    // end of the list of possible fields
  }
}

Field	Description
folderId	string
name	string
description	string
labels	object (map<string, string>)
params	ConnectionParams

ConnectionParams

Field	Description
postgresql	PostgreSQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mysql	MySQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mongodb	MongoDBConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
clickhouse	ClickHouseConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
kafka	KafkaConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
redis	RedisConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
opensearch	OpenSearchConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
trino	TrinoConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
valkey	ValkeyConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
greenplum	GreenplumConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
storedoc	StoreDocConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.

PostgreSQLConnection

Field	Description
cluster	PostgreSQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	PostgreSQLAuth
databases[]	string

PostgreSQLCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
replicaType	enum (ReplicaType) `REPLICA_TYPE_UNSPECIFIED` `ASYNC` `SYNC` `QUORUM`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

TLSParams

Field

Description

tls

TLSConfig

Includes only one of the fields tls.

TLSConfig

Field	Description
caCertificate	string

PostgreSQLAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

UserPasswordAuth

Field	Description
user	string
password	Password

Password

Field	Description
raw	string When creating/updating Password, the field "raw" is mutually exclusive with "password_generation_options". In order to switch to the "raw" password you have to explicitly clear the "password_generation_options" field.
passwordGenerationOptions	PasswordGenerationOptions When creating/updating Password, the field "password_generation_options" is mutually exclusive with "raw". In order to switch to the "password_generation_options" you have to explicitly clear the "raw" field.
lockboxSecretKey	string Read-only. Do not fill this field in create/update requests. Includes only one of the fields `lockboxSecretKey`.

Cookie is an arbitrary non-sensitive string that is saved with the
password. When updating PasswordGenerationOptions, if the cookie passed
in the update request differs from the cookie in the current
PasswordGenerationOptions, the password will be re-generated. If the
same cookie is passed, the password will not change.

lockboxPasswordGenerationOptions

LockboxPasswordGenerationOptions

Includes only one of the fields lockboxPasswordGenerationOptions.

LockboxPasswordGenerationOptions

Field	Description
length	string (int64) password length; by default, a reasonable length will be decided
includeUppercase	boolean whether at least one A..Z character is included in the password, true by default
includeLowercase	boolean whether at least one a..z character is included in the password, true by default
includeDigits	boolean whether at least one 0..9 character is included in the password, true by default
includePunctuation	boolean whether at least one punctuation character is included in the password, true by default punctuation characters by default: !"#$%&'()*+,-./:;<=>?@[]^_`{\|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below
includedPunctuation	string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use
excludedPunctuation	string a string of punctuation characters to exclude from the default

MySQLConnection

Field	Description
cluster	MySQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MySQLAuth
databases[]	string

MySQLCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

MySQLAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

MongoDBConnection

Field	Description
cluster	MongoDBCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MongoDBAuth
databases[]	string

MongoDBCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum (Type) `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

MongoDBAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

authSource

string

ClickHouseConnection

Field	Description
cluster	ClickHouseCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ClickHouseAuth
databases[]	string

ClickHouseCluster

Field	Description
tlsParams	TLSParams
hosts[]	Host
shardGroups[]	ShardGroup

Host

Field	Description
host	string
httpPort	string (int64) depends on tls params may vary as http or https
tcpPort	string (int64)
shardName	string
health	enum (Health) `HEALTH_UNKNOWN` `ALIVE` `DEAD` `DEGRADED`

ShardGroup

Field	Description
name	string
shardNames[]	string

ClickHouseAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

KafkaConnection

Field	Description
cluster	KafkaCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	KafkaAuth

KafkaCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
health	enum (Health) `HEALTH_UNSPECIFIED`: Host is in unknown state (we have no data) `ALIVE`: Host is alive and well (all services are alive) `DEAD`: Host is inoperable (it cannot perform any of its essential functions) `DEGRADED`: Host is partially alive (it can perform some of its essential functions)

KafkaAuth

Field

Description

sasl

KafkaSaslSecurity

Includes only one of the fields sasl.

KafkaSaslSecurity

Field	Description
user	string
password	Password
supportedMechanisms[]	enum (Mechanism) `MECHANISM_UNSPECIFIED` `PLAIN` `SCRAM_SHA256` `SCRAM_SHA512`

RedisConnection

Field	Description
cluster	RedisCluster
auth	RedisAuth
databases[]	string (int64)

RedisCluster

Field	Description
hosts[]	Host
sentinelPort	string (int64)
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shardName	string

RedisAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

UserPasswordAuth

Field	Description
user	string
password	Password

OpenSearchConnection

Field	Description
cluster	OpenSearchCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	OpenSearchAuth

OpenSearchCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`
roles[]	enum (GroupRole) `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`

OpenSearchAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

TrinoConnection

Field	Description
cluster	TrinoCluster
auth	TrinoAuth

TrinoCluster

Field	Description
coordinator	Coordinator
tlsParams	TLSParams

Coordinator

Field	Description
host	string
port	string (int64)

TrinoAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

ValkeyConnection

Field	Description
cluster	ValkeyCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ValkeyAuth
databases[]	string (int64)

ValkeyCluster

Field	Description
hosts[]	Host
sentinelPort	string (int64)
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shardName	string

ValkeyAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

UserPasswordAuth

Field	Description
user	string
password	Password

GreenplumConnection

Field	Description
cluster	GreenplumCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	GreenplumAuth
databases[]	string

GreenplumCluster

Field	Description
coordinatorHosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `UNBALANCED`

GreenplumAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

StoreDocConnection

Field	Description
cluster	StoreDocCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	StoreDocAuth
databases[]	string

StoreDocCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum (Type) `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

StoreDocAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

authSource

string

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "connectionId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "createdBy": "string",
    "params": {
      // Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`
      "postgresql": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "role": "string",
              "replicaType": "string",
              "health": "string"
            }
          ],
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "mysql": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "role": "string",
              "health": "string"
            }
          ],
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "mongodb": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "role": "string",
              "health": "string",
              "type": "string"
            }
          ],
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          },
          // end of the list of possible fields
          "authSource": "string"
        },
        "databases": [
          "string"
        ]
      },
      "clickhouse": {
        "cluster": {
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          },
          "hosts": [
            {
              "host": "string",
              "httpPort": "string",
              "tcpPort": "string",
              "shardName": "string",
              "health": "string"
            }
          ],
          "shardGroups": [
            {
              "name": "string",
              "shardNames": [
                "string"
              ]
            }
          ]
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "kafka": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "health": "string"
            }
          ],
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `sasl`
          "sasl": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            },
            "supportedMechanisms": [
              "string"
            ]
          }
          // end of the list of possible fields
        }
      },
      "redis": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "role": "string",
              "health": "string",
              "shardName": "string"
            }
          ],
          "sentinelPort": "string",
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "opensearch": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "health": "string",
              "roles": [
                "string"
              ]
            }
          ],
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        }
      },
      "trino": {
        "cluster": {
          "coordinator": {
            "host": "string",
            "port": "string"
          },
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        }
      },
      "valkey": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "role": "string",
              "health": "string",
              "shardName": "string"
            }
          ],
          "sentinelPort": "string",
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "greenplum": {
        "cluster": {
          "coordinatorHosts": [
            {
              "host": "string",
              "port": "string",
              "role": "string",
              "health": "string"
            }
          ],
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          }
          // end of the list of possible fields
        },
        "databases": [
          "string"
        ]
      },
      "storedoc": {
        "cluster": {
          "hosts": [
            {
              "host": "string",
              "port": "string",
              "role": "string",
              "health": "string",
              "type": "string"
            }
          ],
          "tlsParams": {
            // Includes only one of the fields `tls`
            "tls": {
              "caCertificate": "string"
            }
            // end of the list of possible fields
          }
        },
        "managedClusterId": "string",
        "auth": {
          // Includes only one of the fields `userPassword`
          "userPassword": {
            "user": "string",
            "password": {
              "raw": "string",
              "passwordGenerationOptions": {
                "cookie": "string",
                // Includes only one of the fields `lockboxPasswordGenerationOptions`
                "lockboxPasswordGenerationOptions": {
                  "length": "string",
                  "includeUppercase": "boolean",
                  "includeLowercase": "boolean",
                  "includeDigits": "boolean",
                  "includePunctuation": "boolean",
                  "includedPunctuation": "string",
                  "excludedPunctuation": "string"
                }
                // end of the list of possible fields
              },
              // Includes only one of the fields `lockboxSecretKey`
              "lockboxSecretKey": "string"
              // end of the list of possible fields
            }
          },
          // end of the list of possible fields
          "authSource": "string"
        },
        "databases": [
          "string"
        ]
      }
      // end of the list of possible fields
    },
    // Includes only one of the fields `lockboxSecret`
    "lockboxSecret": {
      "id": "string",
      "version": "string",
      "newestVersion": "string"
    },
    // end of the list of possible fields
    "isManaged": "boolean",
    "canUse": "boolean"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CreateConnectionMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Connection The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CreateConnectionMetadata

Field	Description
connectionId	string

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Connection

Field	Description
id	string
folderId	string
createdAt	string (date-time) String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
updatedAt	string (date-time) String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string
description	string
labels	object (map<string, string>)
createdBy	string
params	ConnectionParams
lockboxSecret	LockboxSecret Includes only one of the fields `lockboxSecret`.
isManaged	boolean
canUse	boolean

ConnectionParams

Field	Description
postgresql	PostgreSQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mysql	MySQLConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
mongodb	MongoDBConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
clickhouse	ClickHouseConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
kafka	KafkaConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
redis	RedisConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
opensearch	OpenSearchConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
trino	TrinoConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
valkey	ValkeyConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
greenplum	GreenplumConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.
storedoc	StoreDocConnection Includes only one of the fields `postgresql`, `mysql`, `mongodb`, `clickhouse`, `kafka`, `redis`, `opensearch`, `trino`, `valkey`, `greenplum`, `storedoc`.

PostgreSQLConnection

Field	Description
cluster	PostgreSQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	PostgreSQLAuth
databases[]	string

PostgreSQLCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
replicaType	enum (ReplicaType) `REPLICA_TYPE_UNSPECIFIED` `ASYNC` `SYNC` `QUORUM`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

TLSParams

Field

Description

tls

TLSConfig

Includes only one of the fields tls.

TLSConfig

Field	Description
caCertificate	string

PostgreSQLAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

UserPasswordAuth

Field	Description
user	string
password	Password

Password

Field	Description
raw	string When creating/updating Password, the field "raw" is mutually exclusive with "password_generation_options". In order to switch to the "raw" password you have to explicitly clear the "password_generation_options" field.
passwordGenerationOptions	PasswordGenerationOptions When creating/updating Password, the field "password_generation_options" is mutually exclusive with "raw". In order to switch to the "password_generation_options" you have to explicitly clear the "raw" field.
lockboxSecretKey	string Read-only. Do not fill this field in create/update requests. Includes only one of the fields `lockboxSecretKey`.

PasswordGenerationOptions

Field

Description

string

lockboxPasswordGenerationOptions

LockboxPasswordGenerationOptions

Includes only one of the fields lockboxPasswordGenerationOptions.

LockboxPasswordGenerationOptions

Field	Description
length	string (int64) password length; by default, a reasonable length will be decided
includeUppercase	boolean whether at least one A..Z character is included in the password, true by default
includeLowercase	boolean whether at least one a..z character is included in the password, true by default
includeDigits	boolean whether at least one 0..9 character is included in the password, true by default
includePunctuation	boolean whether at least one punctuation character is included in the password, true by default punctuation characters by default: !"#$%&'()*+,-./:;<=>?@[]^_`{\|}~ to customize the punctuation characters, see included_punctuation and excluded_punctuation below
includedPunctuation	string If include_punctuation is true, one of these two fields (not both) may be used optionally to customize the punctuation: a string of specific punctuation characters to use
excludedPunctuation	string a string of punctuation characters to exclude from the default

MySQLConnection

Field	Description
cluster	MySQLCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MySQLAuth
databases[]	string

MySQLCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`

MySQLAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

MongoDBConnection

Field	Description
cluster	MongoDBCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	MongoDBAuth
databases[]	string

MongoDBCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum (Type) `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

MongoDBAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

authSource

string

ClickHouseConnection

Field	Description
cluster	ClickHouseCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ClickHouseAuth
databases[]	string

ClickHouseCluster

Field	Description
tlsParams	TLSParams
hosts[]	Host
shardGroups[]	ShardGroup

Host

Field	Description
host	string
httpPort	string (int64) depends on tls params may vary as http or https
tcpPort	string (int64)
shardName	string
health	enum (Health) `HEALTH_UNKNOWN` `ALIVE` `DEAD` `DEGRADED`

ShardGroup

Field	Description
name	string
shardNames[]	string

ClickHouseAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

KafkaConnection

Field	Description
cluster	KafkaCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	KafkaAuth

KafkaCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
health	enum (Health) `HEALTH_UNSPECIFIED`: Host is in unknown state (we have no data) `ALIVE`: Host is alive and well (all services are alive) `DEAD`: Host is inoperable (it cannot perform any of its essential functions) `DEGRADED`: Host is partially alive (it can perform some of its essential functions)

KafkaAuth

Field

Description

sasl

KafkaSaslSecurity

Includes only one of the fields sasl.

KafkaSaslSecurity

Field	Description
user	string
password	Password
supportedMechanisms[]	enum (Mechanism) `MECHANISM_UNSPECIFIED` `PLAIN` `SCRAM_SHA256` `SCRAM_SHA512`

RedisConnection

Field	Description
cluster	RedisCluster
auth	RedisAuth
databases[]	string (int64)

RedisCluster

Field	Description
hosts[]	Host
sentinelPort	string (int64)
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shardName	string

RedisAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

UserPasswordAuth

Field	Description
user	string
password	Password

OpenSearchConnection

Field	Description
cluster	OpenSearchCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	OpenSearchAuth

OpenSearchCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `READONLY`
roles[]	enum (GroupRole) `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`

OpenSearchAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

TrinoConnection

Field	Description
cluster	TrinoCluster
auth	TrinoAuth

TrinoCluster

Field	Description
coordinator	Coordinator
tlsParams	TLSParams

Coordinator

Field	Description
host	string
port	string (int64)

TrinoAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

ValkeyConnection

Field	Description
cluster	ValkeyCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	ValkeyAuth
databases[]	string (int64)

ValkeyCluster

Field	Description
hosts[]	Host
sentinelPort	string (int64)
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
shardName	string

ValkeyAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

UserPasswordAuth

Field	Description
user	string
password	Password

GreenplumConnection

Field	Description
cluster	GreenplumCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	GreenplumAuth
databases[]	string

GreenplumCluster

Field	Description
coordinatorHosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `MASTER` `REPLICA`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED` `UNBALANCED`

GreenplumAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

StoreDocConnection

Field	Description
cluster	StoreDocCluster When creating/updating Connection, the field "cluster" is mutually exclusive with "managed_cluster_id".
managedClusterId	string When creating/updating Connection, the field "managed_cluster_id" is mutually exclusive with "cluster".
auth	StoreDocAuth
databases[]	string

StoreDocCluster

Field	Description
hosts[]	Host
tlsParams	TLSParams

Host

Field	Description
host	string
port	string (int64)
role	enum (Role) `ROLE_UNSPECIFIED` `PRIMARY` `SECONDARY`
health	enum (Health) `HEALTH_UNSPECIFIED` `ALIVE` `DEAD` `DEGRADED`
type	enum (Type) `TYPE_UNSPECIFIED` `MONGOD` `MONGOS` `MONGOINFRA`

StoreDocAuth

Field

Description

userPassword

UserPasswordAuth

Includes only one of the fields userPassword.

authSource

string

LockboxSecret

Field	Description
id	string
version	string
newestVersion	string

Connection Manager API, REST: Connection.Create

HTTP requestHTTP request

Body parametersBody parameters

ConnectionParamsConnectionParams

PostgreSQLConnectionPostgreSQLConnection

PostgreSQLClusterPostgreSQLCluster

HostHost

TLSParamsTLSParams

TLSConfigTLSConfig

PostgreSQLAuthPostgreSQLAuth

UserPasswordAuthUserPasswordAuth

PasswordPassword

PasswordGenerationOptionsPasswordGenerationOptions

LockboxPasswordGenerationOptionsLockboxPasswordGenerationOptions

MySQLConnectionMySQLConnection

MySQLClusterMySQLCluster

HostHost

MySQLAuthMySQLAuth

MongoDBConnectionMongoDBConnection

MongoDBClusterMongoDBCluster

HostHost

MongoDBAuthMongoDBAuth

ClickHouseConnectionClickHouseConnection

ClickHouseClusterClickHouseCluster

HostHost

ShardGroupShardGroup

ClickHouseAuthClickHouseAuth

KafkaConnectionKafkaConnection

KafkaClusterKafkaCluster

HostHost

KafkaAuthKafkaAuth

KafkaSaslSecurityKafkaSaslSecurity

RedisConnectionRedisConnection

RedisClusterRedisCluster

HostHost

RedisAuthRedisAuth

UserPasswordAuthUserPasswordAuth

OpenSearchConnectionOpenSearchConnection

OpenSearchClusterOpenSearchCluster

HostHost

OpenSearchAuthOpenSearchAuth

TrinoConnectionTrinoConnection

TrinoClusterTrinoCluster

CoordinatorCoordinator

TrinoAuthTrinoAuth

ValkeyConnectionValkeyConnection

ValkeyClusterValkeyCluster

HostHost

ValkeyAuthValkeyAuth

UserPasswordAuthUserPasswordAuth

GreenplumConnectionGreenplumConnection

GreenplumClusterGreenplumCluster

HostHost

GreenplumAuthGreenplumAuth

StoreDocConnectionStoreDocConnection

StoreDocClusterStoreDocCluster

HostHost

StoreDocAuthStoreDocAuth

ResponseResponse

CreateConnectionMetadataCreateConnectionMetadata

StatusStatus

ConnectionConnection

ConnectionParamsConnectionParams

PostgreSQLConnectionPostgreSQLConnection

PostgreSQLClusterPostgreSQLCluster

HostHost

TLSParamsTLSParams

TLSConfigTLSConfig

PostgreSQLAuthPostgreSQLAuth

UserPasswordAuthUserPasswordAuth

PasswordPassword

PasswordGenerationOptionsPasswordGenerationOptions

LockboxPasswordGenerationOptionsLockboxPasswordGenerationOptions

MySQLConnectionMySQLConnection

MySQLClusterMySQLCluster

HostHost

MySQLAuthMySQLAuth

MongoDBConnectionMongoDBConnection

MongoDBClusterMongoDBCluster

HostHost

HTTP request

Body parameters

ConnectionParams

PostgreSQLConnection

PostgreSQLCluster

Host

TLSParams

TLSConfig

PostgreSQLAuth

UserPasswordAuth

Password

PasswordGenerationOptions

LockboxPasswordGenerationOptions

MySQLConnection

MySQLCluster

Host

MySQLAuth

MongoDBConnection

MongoDBCluster

Host

MongoDBAuth

ClickHouseConnection

ClickHouseCluster

Host

ShardGroup

ClickHouseAuth

KafkaConnection

KafkaCluster

Host

KafkaAuth

KafkaSaslSecurity

RedisConnection

RedisCluster

Host

RedisAuth

UserPasswordAuth

OpenSearchConnection

OpenSearchCluster

Host

OpenSearchAuth

TrinoConnection

TrinoCluster

Coordinator

TrinoAuth

ValkeyConnection

ValkeyCluster

Host

ValkeyAuth

UserPasswordAuth

GreenplumConnection

GreenplumCluster

Host

GreenplumAuth

StoreDocConnection

StoreDocCluster

Host

StoreDocAuth

Response

CreateConnectionMetadata

Status

Connection

ConnectionParams

PostgreSQLConnection

PostgreSQLCluster

Host

TLSParams

TLSConfig

PostgreSQLAuth

UserPasswordAuth

Password

PasswordGenerationOptions

LockboxPasswordGenerationOptions

MySQLConnection

MySQLCluster

Host

MySQLAuth

MongoDBConnection

MongoDBCluster

Host

MongoDBAuth