Skip to main content
POST
/
v1
/
instances
/
{instance}
:databases
cURL
curl --request POST \
  --url https://api.example.com/v1/instances/{instance}:databases \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instance": {
    "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>",
        "authenticationPrivateKeyPassphrase": "<string>",
        "obfuscatedAuthenticationPrivateKeyPassphrase": "<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>",
          "obfuscatedVaultSslCa": "<string>",
          "vaultSslCert": "<string>",
          "obfuscatedVaultSslCert": "<string>",
          "vaultSslKey": "<string>",
          "obfuscatedVaultSslKey": "<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>",
        "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": {}
  }
}
'
{
  "databases": [
    "<string>"
  ]
}

Path Parameters

instance
string
required

The instance id.

Body

application/json
name
string
required

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

instance
object
required

The target instance. We need to set this field if the target instance is not created yet.

Response

OK

databases
string[]

All database name list in the instance.