/target-create-db

post

https://api.akeyless.io/target-create-db

Body Params

azure-client-id

string

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

azure-client-secret

string

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

azure-tenant-id

string

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

cloud-service-provider

string

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

cluster-mode

boolean

Cluster Mode

comment

string

Deprecated - use description

connection-type

string

required

Defaults to credentials

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

db-name

string

db-server-certificates

string

(Optional) DB server certificates

db-server-name

string

(Optional) Server name for certificate verification

db-type

string

required

description

string

Description of the object

host

string

json

boolean

Defaults to false

Set output format to JSON

key

string

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

max-versions

string

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

mongodb-atlas

boolean

mongodb-atlas-api-private-key

string

MongoDB Atlas private key

mongodb-atlas-api-public-key

string

MongoDB Atlas public key

mongodb-atlas-project-id

string

MongoDB Atlas project ID

mongodb-default-auth-db

string

MongoDB server default authentication database

mongodb-uri-options

string

MongoDB server URI options

name

string

required

Target name

oracle-service-name

string

Oracle db service name

oracle-wallet-login-type

string

oracle-wallet-p12-file-data

string

Oracle wallet p12 file data in base64

oracle-wallet-sso-file-data

string

Oracle wallet sso file data in base64

parent-target-name

string

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

port

string

pwd

string

snowflake-account

string

snowflake-api-private-key

string

RSA Private key (base64 encoded)

snowflake-api-private-key-password

string

The Private key passphrase

ssl

boolean

Defaults to false

Enable/Disable SSL [true/false]

ssl-certificate

string

SSL connection certificate

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

user-name

string

Responses

201targetCreateDBResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.