Permissions required: bb.instances.update
{
"instances": [
{
"title": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"activation": true,
"version": "<string>",
"externalLink": "<string>",
"dataSources": [
{
"id": "<string>",
"type": "DATA_SOURCE_UNSPECIFIED",
"username": "<string>",
"password": "<string>",
"obfuscatedPassword": "<string>",
"useSsl": true,
"sslCa": "<string>",
"obfuscatedSslCa": "<string>",
"sslCert": "<string>",
"obfuscatedSslCert": "<string>",
"sslKey": "<string>",
"obfuscatedSslKey": "<string>",
"host": "<string>",
"port": "<string>",
"database": "<string>",
"srv": true,
"authenticationDatabase": "<string>",
"replicaSet": "<string>",
"sid": "<string>",
"serviceName": "<string>",
"sshHost": "<string>",
"sshPort": "<string>",
"sshUser": "<string>",
"sshPassword": "<string>",
"obfuscatedSshPassword": "<string>",
"sshPrivateKey": "<string>",
"obfuscatedSshPrivateKey": "<string>",
"authenticationPrivateKey": "<string>",
"obfuscatedAuthenticationPrivateKey": "<string>",
"externalSecret": {
"secretType": "SAECRET_TYPE_UNSPECIFIED",
"url": "<string>",
"authType": "AUTH_TYPE_UNSPECIFIED",
"appRole": {
"type": "SECRET_TYPE_UNSPECIFIED",
"mountPath": "<string>"
},
"token": "<string>",
"engineName": "<string>",
"secretName": "<string>",
"passwordKeyName": "<string>"
},
"authenticationType": "AUTHENTICATION_UNSPECIFIED",
"azureCredential": {
"tenantId": "<string>",
"clientId": "<string>"
},
"awsCredential": {},
"gcpCredential": {},
"saslConfig": {
"krbConfig": {
"primary": "<string>",
"instance": "<string>",
"realm": "<string>",
"keytab": "<string>",
"kdcHost": "<string>",
"kdcPort": "<string>",
"kdcTransportProtocol": "<string>"
}
},
"additionalAddresses": [
{
"host": "<string>",
"port": "<string>"
}
],
"directConnection": true,
"region": "<string>",
"warehouseId": "<string>",
"masterName": "<string>",
"masterUsername": "<string>",
"masterPassword": "<string>",
"obfuscatedMasterPassword": "<string>",
"redisType": "REDIS_TYPE_UNSPECIFIED",
"cluster": "<string>",
"extraConnectionParameters": {}
}
],
"syncInterval": "<string>",
"maximumConnections": 123,
"syncDatabases": [
"<string>"
],
"mysqlLowerCaseTableNames": 123,
"lastSyncTime": "2023-11-07T05:31:56Z",
"roles": [
{
"name": "<string>",
"connectionLimit": 123,
"validUntil": "<string>",
"attribute": "<string>"
}
]
}
]
}
OK
The response is of type object
.
Was this page helpful?
{
"instances": [
{
"title": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"activation": true,
"version": "<string>",
"externalLink": "<string>",
"dataSources": [
{
"id": "<string>",
"type": "DATA_SOURCE_UNSPECIFIED",
"username": "<string>",
"password": "<string>",
"obfuscatedPassword": "<string>",
"useSsl": true,
"sslCa": "<string>",
"obfuscatedSslCa": "<string>",
"sslCert": "<string>",
"obfuscatedSslCert": "<string>",
"sslKey": "<string>",
"obfuscatedSslKey": "<string>",
"host": "<string>",
"port": "<string>",
"database": "<string>",
"srv": true,
"authenticationDatabase": "<string>",
"replicaSet": "<string>",
"sid": "<string>",
"serviceName": "<string>",
"sshHost": "<string>",
"sshPort": "<string>",
"sshUser": "<string>",
"sshPassword": "<string>",
"obfuscatedSshPassword": "<string>",
"sshPrivateKey": "<string>",
"obfuscatedSshPrivateKey": "<string>",
"authenticationPrivateKey": "<string>",
"obfuscatedAuthenticationPrivateKey": "<string>",
"externalSecret": {
"secretType": "SAECRET_TYPE_UNSPECIFIED",
"url": "<string>",
"authType": "AUTH_TYPE_UNSPECIFIED",
"appRole": {
"type": "SECRET_TYPE_UNSPECIFIED",
"mountPath": "<string>"
},
"token": "<string>",
"engineName": "<string>",
"secretName": "<string>",
"passwordKeyName": "<string>"
},
"authenticationType": "AUTHENTICATION_UNSPECIFIED",
"azureCredential": {
"tenantId": "<string>",
"clientId": "<string>"
},
"awsCredential": {},
"gcpCredential": {},
"saslConfig": {
"krbConfig": {
"primary": "<string>",
"instance": "<string>",
"realm": "<string>",
"keytab": "<string>",
"kdcHost": "<string>",
"kdcPort": "<string>",
"kdcTransportProtocol": "<string>"
}
},
"additionalAddresses": [
{
"host": "<string>",
"port": "<string>"
}
],
"directConnection": true,
"region": "<string>",
"warehouseId": "<string>",
"masterName": "<string>",
"masterUsername": "<string>",
"masterPassword": "<string>",
"obfuscatedMasterPassword": "<string>",
"redisType": "REDIS_TYPE_UNSPECIFIED",
"cluster": "<string>",
"extraConnectionParameters": {}
}
],
"syncInterval": "<string>",
"maximumConnections": 123,
"syncDatabases": [
"<string>"
],
"mysqlLowerCaseTableNames": 123,
"lastSyncTime": "2023-11-07T05:31:56Z",
"roles": [
{
"name": "<string>",
"connectionLimit": 123,
"validUntil": "<string>",
"attribute": "<string>"
}
]
}
]
}
Permissions required: bb.instances.update
{
"instances": [
{
"title": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"activation": true,
"version": "<string>",
"externalLink": "<string>",
"dataSources": [
{
"id": "<string>",
"type": "DATA_SOURCE_UNSPECIFIED",
"username": "<string>",
"password": "<string>",
"obfuscatedPassword": "<string>",
"useSsl": true,
"sslCa": "<string>",
"obfuscatedSslCa": "<string>",
"sslCert": "<string>",
"obfuscatedSslCert": "<string>",
"sslKey": "<string>",
"obfuscatedSslKey": "<string>",
"host": "<string>",
"port": "<string>",
"database": "<string>",
"srv": true,
"authenticationDatabase": "<string>",
"replicaSet": "<string>",
"sid": "<string>",
"serviceName": "<string>",
"sshHost": "<string>",
"sshPort": "<string>",
"sshUser": "<string>",
"sshPassword": "<string>",
"obfuscatedSshPassword": "<string>",
"sshPrivateKey": "<string>",
"obfuscatedSshPrivateKey": "<string>",
"authenticationPrivateKey": "<string>",
"obfuscatedAuthenticationPrivateKey": "<string>",
"externalSecret": {
"secretType": "SAECRET_TYPE_UNSPECIFIED",
"url": "<string>",
"authType": "AUTH_TYPE_UNSPECIFIED",
"appRole": {
"type": "SECRET_TYPE_UNSPECIFIED",
"mountPath": "<string>"
},
"token": "<string>",
"engineName": "<string>",
"secretName": "<string>",
"passwordKeyName": "<string>"
},
"authenticationType": "AUTHENTICATION_UNSPECIFIED",
"azureCredential": {
"tenantId": "<string>",
"clientId": "<string>"
},
"awsCredential": {},
"gcpCredential": {},
"saslConfig": {
"krbConfig": {
"primary": "<string>",
"instance": "<string>",
"realm": "<string>",
"keytab": "<string>",
"kdcHost": "<string>",
"kdcPort": "<string>",
"kdcTransportProtocol": "<string>"
}
},
"additionalAddresses": [
{
"host": "<string>",
"port": "<string>"
}
],
"directConnection": true,
"region": "<string>",
"warehouseId": "<string>",
"masterName": "<string>",
"masterUsername": "<string>",
"masterPassword": "<string>",
"obfuscatedMasterPassword": "<string>",
"redisType": "REDIS_TYPE_UNSPECIFIED",
"cluster": "<string>",
"extraConnectionParameters": {}
}
],
"syncInterval": "<string>",
"maximumConnections": 123,
"syncDatabases": [
"<string>"
],
"mysqlLowerCaseTableNames": 123,
"lastSyncTime": "2023-11-07T05:31:56Z",
"roles": [
{
"name": "<string>",
"connectionLimit": 123,
"validUntil": "<string>",
"attribute": "<string>"
}
]
}
]
}
OK
The response is of type object
.
Was this page helpful?
{
"instances": [
{
"title": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"activation": true,
"version": "<string>",
"externalLink": "<string>",
"dataSources": [
{
"id": "<string>",
"type": "DATA_SOURCE_UNSPECIFIED",
"username": "<string>",
"password": "<string>",
"obfuscatedPassword": "<string>",
"useSsl": true,
"sslCa": "<string>",
"obfuscatedSslCa": "<string>",
"sslCert": "<string>",
"obfuscatedSslCert": "<string>",
"sslKey": "<string>",
"obfuscatedSslKey": "<string>",
"host": "<string>",
"port": "<string>",
"database": "<string>",
"srv": true,
"authenticationDatabase": "<string>",
"replicaSet": "<string>",
"sid": "<string>",
"serviceName": "<string>",
"sshHost": "<string>",
"sshPort": "<string>",
"sshUser": "<string>",
"sshPassword": "<string>",
"obfuscatedSshPassword": "<string>",
"sshPrivateKey": "<string>",
"obfuscatedSshPrivateKey": "<string>",
"authenticationPrivateKey": "<string>",
"obfuscatedAuthenticationPrivateKey": "<string>",
"externalSecret": {
"secretType": "SAECRET_TYPE_UNSPECIFIED",
"url": "<string>",
"authType": "AUTH_TYPE_UNSPECIFIED",
"appRole": {
"type": "SECRET_TYPE_UNSPECIFIED",
"mountPath": "<string>"
},
"token": "<string>",
"engineName": "<string>",
"secretName": "<string>",
"passwordKeyName": "<string>"
},
"authenticationType": "AUTHENTICATION_UNSPECIFIED",
"azureCredential": {
"tenantId": "<string>",
"clientId": "<string>"
},
"awsCredential": {},
"gcpCredential": {},
"saslConfig": {
"krbConfig": {
"primary": "<string>",
"instance": "<string>",
"realm": "<string>",
"keytab": "<string>",
"kdcHost": "<string>",
"kdcPort": "<string>",
"kdcTransportProtocol": "<string>"
}
},
"additionalAddresses": [
{
"host": "<string>",
"port": "<string>"
}
],
"directConnection": true,
"region": "<string>",
"warehouseId": "<string>",
"masterName": "<string>",
"masterUsername": "<string>",
"masterPassword": "<string>",
"obfuscatedMasterPassword": "<string>",
"redisType": "REDIS_TYPE_UNSPECIFIED",
"cluster": "<string>",
"extraConnectionParameters": {}
}
],
"syncInterval": "<string>",
"maximumConnections": 123,
"syncDatabases": [
"<string>"
],
"mysqlLowerCaseTableNames": 123,
"lastSyncTime": "2023-11-07T05:31:56Z",
"roles": [
{
"name": "<string>",
"connectionLimit": 123,
"validUntil": "<string>",
"attribute": "<string>"
}
]
}
]
}