ProjectService
- GETGet v1* iampolicies:batchget
- GETGet v1projects
- POSTPost v1projects
- GETGet v1projects 1
- DELDelete v1projects
- PATCHPatch v1projects
- POSTPost v1projects webhooks :removewebhook
- PATCHPatch v1projects webhooks :updatewebhook
- POSTPost v1projects :addwebhook
- GETGet v1projects :getiampolicy
- POSTPost v1projects :setiampolicy
- POSTPost v1projects :testwebhook
- POSTPost v1projects :undelete
- POSTPost v1projects:batchdelete
- POSTPost v1projects:search
ActuatorService
AuditLogService
AuthService
OrgPolicyService
- GETGet v1environments policies
- POSTPost v1environments policies
- GETGet v1environments policies 1
- DELDelete v1environments policies
- PATCHPatch v1environments policies
- GETGet v1instances databases policies
- POSTPost v1instances databases policies
- GETGet v1instances databases policies 1
- DELDelete v1instances databases policies
- PATCHPatch v1instances databases policies
- GETGet v1instances policies
- POSTPost v1instances policies
- GETGet v1instances policies 1
- DELDelete v1instances policies
- PATCHPatch v1instances policies
- GETGet v1policies
- POSTPost v1policies
- GETGet v1policies 1
- DELDelete v1policies
- PATCHPatch v1policies
- GETGet v1projects policies
- POSTPost v1projects policies
- GETGet v1projects policies 1
- DELDelete v1projects policies
- PATCHPatch v1projects policies
GroupService
IdentityProviderService
InstanceService
- GETGet v1instances
- POSTPost v1instances
- GETGet v1instances 1
- DELDelete v1instances
- PATCHPatch v1instances
- POSTPost v1instances :adddatasource
- POSTPost v1instances :databases
- POSTPost v1instances :removedatasource
- POSTPost v1instances :sync
- POSTPost v1instances :undelete
- PATCHPatch v1instances :updatedatasource
- POSTPost v1instances:batchsync
- POSTPost v1instances:batchupdate
DatabaseService
- GETGet v1instances databases
- GETGet v1instances databases 1
- PATCHPatch v1instances databases
- GETGet v1instances databases changelogs
- GETGet v1instances databases changelogs 1
- POSTPost v1instances databases changelogs :diffschema
- GETGet v1instances databases metadata
- GETGet v1instances databases schema
- GETGet v1instances databases schemastring
- GETGet v1instances databases sdlschema
- POSTPost v1instances databases :diffschema
- POSTPost v1instances databases :sync
- GETGet v1instances databases:batchget
- POSTPost v1instances databases:batchsync
- POSTPost v1instances databases:batchupdate
- GETGet v1projects databases
- GETGet v1projects databases:batchget
- GETGet v1workspaces databases
DatabaseCatalogService
RevisionService
SQLService
InstanceRoleService
DatabaseGroupService
IssueService
- GETGet v1projects issues
- POSTPost v1projects issues
- GETGet v1projects issues 1
- PATCHPatch v1projects issues
- GETGet v1projects issues issuecomments
- POSTPost v1projects issues :approve
- POSTPost v1projects issues :comment
- PATCHPatch v1projects issues :comment
- POSTPost v1projects issues :reject
- POSTPost v1projects issues :request
- POSTPost v1projects issues:batchupdatestatus
- POSTPost v1projects issues:search
PlanService
ReleaseService
RolloutService
- GETGet v1projects rollouts
- POSTPost v1projects rollouts
- GETGet v1projects rollouts 1
- GETGet v1projects rollouts stages tasks taskruns
- GETGet v1projects rollouts stages tasks taskruns 1
- GETGet v1projects rollouts stages tasks taskruns log
- GETGet v1projects rollouts stages tasks taskruns session
- POSTPost v1projects rollouts stages tasks taskruns :previewrollback
- POSTPost v1projects rollouts stages tasks taskruns:batchcancel
- POSTPost v1projects rollouts stages tasks:batchrun
- POSTPost v1projects rollouts stages tasks:batchskip
- POSTPost v1projects :previewrollout
SheetService
ReviewConfigService
SubscriptionService
UserService
WorksheetService
{
"databases": [
"<string>"
]
}Post v1instances :databases
Lists all databases within an instance without creating them. Permissions required: bb.instances.get
{
"databases": [
"<string>"
]
}Path Parameters
The instance id.
Body
The name of the instance. Format: instances/{instance}
The target instance. We need to set this field if the target instance is not created yet.
Show child attributes
Show child attributes
ENGINE_UNSPECIFIED, CLICKHOUSE, MYSQL, POSTGRES, SNOWFLAKE, SQLITE, TIDB, MONGODB, REDIS, ORACLE, SPANNER, MSSQL, REDSHIFT, MARIADB, OCEANBASE, STARROCKS, DORIS, HIVE, ELASTICSEARCH, BIGQUERY, DYNAMODB, DATABRICKS, COCKROACHDB, COSMOSDB, TRINO, CASSANDRA Show child attributes
Show child attributes
DATA_SOURCE_UNSPECIFIED, ADMIN, READ_ONLY Use SSL to connect to the data source. By default, we use the system's SSL configuration.
verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments).
srv, authentication_database, and replica_set are used for MongoDB. srv is a boolean flag that indicates whether the host is a DNS SRV record.
authentication_database is the database name to authenticate against, which stores the user credentials.
replica_set is used for MongoDB replica set.
sid and service_name are used for Oracle.
SSH related The hostname of the SSH server agent.
The port of the SSH server agent. It's 22 typically.
The user to login the server.
The password to login the server. If it's empty string, no password is required.
The private key to login the server. If it's empty string, we will use the system default private key from os.Getenv("SSH_AUTH_SOCK").
PKCS#8 private key in PEM format. If it's empty string, no private key is required. Used for authentication when connecting to the data source.
Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted.
Show child attributes
Show child attributes
SECRET_TYPE_UNSPECIFIED, VAULT_KV_V2, AWS_SECRETS_MANAGER, GCP_SECRET_MANAGER AUTH_TYPE_UNSPECIFIED, TOKEN, VAULT_APP_ROLE Show child attributes
Show child attributes
The role ID for Vault AppRole authentication.
the secret id for the role without ttl.
The type of secret for AppRole authentication.
SECRET_TYPE_UNSPECIFIED, PLAIN, ENVIRONMENT The path where the approle auth method is mounted.
engine name is the name for secret engine.
the secret name in the engine to store the password.
the key name for the password.
TLS configuration for connecting to Vault server. These fields are separate from the database TLS configuration in DataSource. skip_vault_tls_verification disables TLS certificate verification for Vault connections. Default is false (verification enabled) for security. Only set to true for development or when certificates cannot be properly validated.
CA certificate for Vault server verification.
Client certificate for mutual TLS authentication with Vault.
Client private key for mutual TLS authentication with Vault.
AUTHENTICATION_UNSPECIFIED, PASSWORD, GOOGLE_CLOUD_SQL_IAM, AWS_RDS_IAM, AZURE_IAM Show child attributes
Show child attributes
ARN of IAM role to assume for cross-account access. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
Optional external ID for additional security when assuming role. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
Show child attributes
Show child attributes
Show child attributes
Show child attributes
direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string.
Region is the location of the database, used for AWS RDS. For example, us-east-1.
warehouse_id is used by Databricks.
master_name is the master name used by connecting redis-master via redis sentinel.
master_username and master_obfuscated_password are master credentials used by redis sentinel mode.
REDIS_TYPE_UNSPECIFIED, STANDALONE, SENTINEL, CLUSTER Cluster is the cluster name for the data source. Used by CockroachDB.
The interval between automatic instance synchronizations.
The maximum number of connections. The default is 10 if the value is unset or zero.
Enable sync for the following databases. Default empty, means sync all schemas & databases.
The lower_case_table_names config for MySQL instances. It is used to determine whether the table names and database names are case sensitive.
Show child attributes
Show child attributes
The role name.
The connection count limit for this role.
The expiration for the role's password.
The role attribute. For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it is the global privileges as GRANT statements, which means it only contains "GRANT ... ON . TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html
Response
OK
All database name list in the instance.
Was this page helpful?