Path Parameters
The project id.
Query Parameters
The list of database names to retrieve.
Response
OK
The databases from the specified request.
{ "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>", "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": {} } ], "activation": true, "name": "<string>", "environment": "<string>" }, "backupAvailable": true, "drifted": true } ] }
Permissions required: bb.databases.get
{ "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>", "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": {} } ], "activation": true, "name": "<string>", "environment": "<string>" }, "backupAvailable": true, "drifted": true } ] }
The project id.
The list of database names to retrieve.
OK
The databases from the specified request.
Show child attributes
Was this page helpful?