v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/create-db-target

Request body

azure-client-idstring

(Optional) Client id (relevant for "cloud-service-provider" only)

azure-client-secretstring

(Optional) Client secret (relevant for "cloud-service-provider" only)

azure-tenant-idstring

(Optional) Tenant id (relevant for "cloud-service-provider" only)

client-certificatestring

Client certificate for mutual TLS

client-key-passphrasestring

Client private key passphrase for mutual TLS

client-private-keystring

Client private key for mutual TLS

cloud-service-providerstring

(Optional) Cloud service provider (currently only supports Azure)

cluster-modeboolean

Cluster Mode

commentstring

Deprecated - use description

connection-typestring required

Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]

db-namestring
db-server-certificatesstring

(Optional) DB server certificates

db-server-namestring

(Optional) Server name for certificate verification

db-typestring required
descriptionstring

Description of the object

enable-mtlsboolean

Enable mutual TLS

hoststring
jsonboolean

Set output format to JSON

keystring

The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)

max-versionsstring

Set the maximum number of versions, limited by the account settings defaults.

mongodb-atlasboolean
mongodb-atlas-api-private-keystring

MongoDB Atlas private key

mongodb-atlas-api-public-keystring

MongoDB Atlas public key

mongodb-atlas-project-idstring

MongoDB Atlas project ID

mongodb-default-auth-dbstring

MongoDB server default authentication database

mongodb-uri-optionsstring

MongoDB server URI options

namestring required

Target name

oracle-service-namestring

Oracle db service name

oracle-wallet-login-typestring

Oracle Wallet login type (password/mtls)

oracle-wallet-p12-file-datastring

Oracle wallet p12 file data in base64

oracle-wallet-sso-file-datastring

Oracle wallet sso file data in base64

parent-target-namestring

Name of the parent target, relevant only when connection-type is parent-target

portstring
pwdstring
snowflake-accountstring
snowflake-api-private-keystring

RSA Private key (base64 encoded)

snowflake-api-private-key-passwordstring

The Private key passphrase

sslboolean

Enable/Disable SSL [true/false]

ssl-certificatestring

SSL connection certificate

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

user-namestring

Response

createDBTargetResponse wraps response body.

target_idinteger