Skip to main content
PATCH
/
v1
/
instances
/
{instance}
cURL
curl --request PATCH \
  --url https://api.example.com/v1/instances/{instance} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "state": "STATE_UNSPECIFIED",
  "title": "<string>",
  "engine": "ENGINE_UNSPECIFIED",
  "externalLink": "<string>",
  "dataSources": [
    {
      "id": "<string>",
      "type": "DATA_SOURCE_UNSPECIFIED",
      "username": "<string>",
      "password": "<string>",
      "useSsl": true,
      "sslCa": "<string>",
      "sslCert": "<string>",
      "sslKey": "<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>",
      "sshPrivateKey": "<string>",
      "authenticationPrivateKey": "<string>",
      "authenticationPrivateKeyPassphrase": "<string>",
      "externalSecret": {
        "secretType": "SECRET_TYPE_UNSPECIFIED",
        "url": "<string>",
        "authType": "AUTH_TYPE_UNSPECIFIED",
        "appRole": {
          "roleId": "<string>",
          "secretId": "<string>",
          "type": "SECRET_TYPE_UNSPECIFIED",
          "mountPath": "<string>"
        },
        "token": "<string>",
        "engineName": "<string>",
        "secretName": "<string>",
        "passwordKeyName": "<string>",
        "skipVaultTlsVerification": true,
        "vaultSslCa": "<string>",
        "vaultSslCert": "<string>",
        "vaultSslKey": "<string>"
      },
      "authenticationType": "AUTHENTICATION_UNSPECIFIED",
      "azureCredential": {
        "tenantId": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>"
      },
      "awsCredential": {
        "accessKeyId": "<string>",
        "secretAccessKey": "<string>",
        "sessionToken": "<string>",
        "roleArn": "<string>",
        "externalId": "<string>"
      },
      "gcpCredential": {
        "content": "<string>"
      },
      "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>",
      "redisType": "REDIS_TYPE_UNSPECIFIED",
      "cluster": "<string>",
      "extraConnectionParameters": {}
    }
  ],
  "environment": "<string>",
  "activation": true,
  "syncInterval": "<string>",
  "maximumConnections": 123,
  "syncDatabases": [
    "<string>"
  ],
  "labels": {}
}
'
{
  "name": "<string>",
  "state": "STATE_UNSPECIFIED",
  "title": "<string>",
  "engine": "ENGINE_UNSPECIFIED",
  "engineVersion": "<string>",
  "externalLink": "<string>",
  "dataSources": [
    {
      "id": "<string>",
      "type": "DATA_SOURCE_UNSPECIFIED",
      "username": "<string>",
      "useSsl": true,
      "verifyTlsCertificate": true,
      "host": "<string>",
      "port": "<string>",
      "database": "<string>",
      "srv": true,
      "authenticationDatabase": "<string>",
      "replicaSet": "<string>",
      "sid": "<string>",
      "serviceName": "<string>",
      "sshHost": "<string>",
      "sshPort": "<string>",
      "sshUser": "<string>",
      "externalSecret": {
        "secretType": "SECRET_TYPE_UNSPECIFIED",
        "url": "<string>",
        "authType": "AUTH_TYPE_UNSPECIFIED",
        "appRole": {
          "type": "SECRET_TYPE_UNSPECIFIED",
          "mountPath": "<string>"
        },
        "engineName": "<string>",
        "secretName": "<string>",
        "passwordKeyName": "<string>",
        "skipVaultTlsVerification": true
      },
      "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>",
      "redisType": "REDIS_TYPE_UNSPECIFIED",
      "cluster": "<string>",
      "extraConnectionParameters": {}
    }
  ],
  "environment": "<string>",
  "activation": true,
  "roles": [
    {
      "name": "<string>",
      "roleName": "<string>",
      "connectionLimit": 123,
      "validUntil": "<string>",
      "attribute": "<string>"
    }
  ],
  "syncInterval": "<string>",
  "maximumConnections": 123,
  "syncDatabases": [
    "<string>"
  ],
  "lastSyncTime": "2023-11-07T05:31:56Z",
  "labels": {}
}

Path Parameters

​
instance
string
required

The instance id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to update.

​
allowMissing
boolean

If set to true, and the instance is not found, a new instance will be created. In this situation, update_mask is ignored.

Body

application/json
​
name
string

The name of the instance. Format: instances/{instance}

​
state
enum<string>

The lifecycle state of the instance.

Available options:
STATE_UNSPECIFIED,
ACTIVE,
DELETED
​
title
string

The display title of the instance.

​
engine
enum<string>

The database engine type.

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
​
externalLink
string

External URL to the database instance console.

​
dataSources
object[]

Data source configurations for connecting to the instance.

​
environment
string

The environment resource. Format: environments/prod where prod is the environment resource ID.

​
activation
boolean

Whether the instance is activated for use.

​
syncInterval
string

How often the instance is synced.

​
maximumConnections
integer<int32>

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.

​
labels
object

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

Response

OK

​
name
string

The name of the instance. Format: instances/{instance}

​
state
enum<string>

The lifecycle state of the instance.

Available options:
STATE_UNSPECIFIED,
ACTIVE,
DELETED
​
title
string

The display title of the instance.

​
engine
enum<string>

The database engine type.

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
​
engineVersion
string

The version of the database engine.

​
externalLink
string

External URL to the database instance console.

​
dataSources
object[]

Data source configurations for connecting to the instance.

​
environment
string

The environment resource. Format: environments/prod where prod is the environment resource ID.

​
activation
boolean

Whether the instance is activated for use.

​
roles
object[]

Database roles available in this instance.

​
syncInterval
string

How often the instance is synced.

​
maximumConnections
integer<int32>

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.

​
lastSyncTime
string<date-time>

The last time the instance was synced.

​
labels
object

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