curl --request POST \
--url https://api.example.com/v1/instances/{instance}/databases:batchUpdate \
--header 'Content-Type: application/json' \
--data '
{
"requests": [
{
"database": {
"name": "<string>",
"project": "<string>",
"environment": "<string>",
"labels": {}
},
"updateMask": "<string>",
"allowMissing": true
}
],
"parent": "<string>"
}
'{
"databases": [
{
"name": "<string>",
"state": "STATE_UNSPECIFIED",
"successfulSyncTime": "2023-11-07T05:31:56Z",
"project": "<string>",
"schemaVersion": "<string>",
"environment": "<string>",
"effectiveEnvironment": "<string>",
"labels": {},
"instanceResource": {
"title": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"engineVersion": "<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>",
"verifyTlsCertificate": true,
"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>",
"authenticationPrivateKeyPassphrase": "<string>",
"obfuscatedAuthenticationPrivateKeyPassphrase": "<string>",
"externalSecret": {
"secretType": "SECRET_TYPE_UNSPECIFIED",
"url": "<string>",
"authType": "AUTH_TYPE_UNSPECIFIED",
"appRole": {
"type": "SECRET_TYPE_UNSPECIFIED",
"mountPath": "<string>"
},
"token": "<string>",
"engineName": "<string>",
"secretName": "<string>",
"passwordKeyName": "<string>",
"skipVaultTlsVerification": true,
"vaultSslCa": "<string>",
"obfuscatedVaultSslCa": "<string>",
"vaultSslCert": "<string>",
"obfuscatedVaultSslCert": "<string>",
"vaultSslKey": "<string>",
"obfuscatedVaultSslKey": "<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": {}
}
],
"activation": true,
"name": "<string>",
"environment": "<string>"
},
"backupAvailable": true,
"drifted": true
}
]
}Updates multiple databases in a single batch operation. Permissions required: bb.databases.update
curl --request POST \
--url https://api.example.com/v1/instances/{instance}/databases:batchUpdate \
--header 'Content-Type: application/json' \
--data '
{
"requests": [
{
"database": {
"name": "<string>",
"project": "<string>",
"environment": "<string>",
"labels": {}
},
"updateMask": "<string>",
"allowMissing": true
}
],
"parent": "<string>"
}
'{
"databases": [
{
"name": "<string>",
"state": "STATE_UNSPECIFIED",
"successfulSyncTime": "2023-11-07T05:31:56Z",
"project": "<string>",
"schemaVersion": "<string>",
"environment": "<string>",
"effectiveEnvironment": "<string>",
"labels": {},
"instanceResource": {
"title": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"engineVersion": "<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>",
"verifyTlsCertificate": true,
"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>",
"authenticationPrivateKeyPassphrase": "<string>",
"obfuscatedAuthenticationPrivateKeyPassphrase": "<string>",
"externalSecret": {
"secretType": "SECRET_TYPE_UNSPECIFIED",
"url": "<string>",
"authType": "AUTH_TYPE_UNSPECIFIED",
"appRole": {
"type": "SECRET_TYPE_UNSPECIFIED",
"mountPath": "<string>"
},
"token": "<string>",
"engineName": "<string>",
"secretName": "<string>",
"passwordKeyName": "<string>",
"skipVaultTlsVerification": true,
"vaultSslCa": "<string>",
"obfuscatedVaultSslCa": "<string>",
"vaultSslCert": "<string>",
"obfuscatedVaultSslCert": "<string>",
"vaultSslKey": "<string>",
"obfuscatedVaultSslKey": "<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": {}
}
],
"activation": true,
"name": "<string>",
"environment": "<string>"
},
"backupAvailable": true,
"drifted": true
}
]
}The instance id.
The request message specifying the resources to update. A maximum of 1000 databases can be modified in a batch.
Show child attributes
The parent resource shared by all databases being updated. Format: instances/{instance} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the project of databases for now.
OK
Databases updated.
Show child attributes
Was this page helpful?