Skip to main content
POST
/
v1
/
instances
/
{instance}
:removeDataSource
{  "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>",  "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": {}  }  ],  "syncInterval": "<string>",  "maximumConnections": 123,  "syncDatabases": [  "<string>"  ],  "mysqlLowerCaseTableNames": 123,  "lastSyncTime": "2023-11-07T05:31:56Z",  "roles": [  {  "name": "<string>",  "connectionLimit": 123,  "validUntil": "<string>",  "attribute": "<string>"  }  ],  "labels": {} }

Path Parameters

​
instance
string
required

The instance id.

Body

application/json
​
name
string
required

The name of the instance to remove a data source from. Format: instances/{instance}

​
dataSource
object
required

Identified by data source ID. Only READ_ONLY data source can be removed.

Response

OK

Instance is the proto for instances.

​
title
string
​
engine
enum<string>
Available options:
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
​
activation
boolean
​
version
string
​
externalLink
string
​
dataSources
object[]
​
syncInterval
string

How often the instance is synced.

​
maximumConnections
integer

The maximum number of connections. The default is 10 if the value is unset or zero.

​
syncDatabases
string[]

Enable sync for following databases. Default empty, means sync all schemas & databases.

​
mysqlLowerCaseTableNames
integer

The lower_case_table_names config for MySQL instances. It is used to determine whether the table names and database names are case sensitive.

​
lastSyncTime
string<date-time>
​
roles
object[]
​
labels
object

Labels are key-value pairs that can be attached to the instance. For example, { "org_group": "infrastructure", "environment": "production" }