# Get defaults for an ASE dSource linking.

Endpoint: POST /dsources/ase/defaults
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Request body:

  - `application/json` (unknown)
    The parameters to get defaults for linking an ASE dSource.

## Request fields (application/json):

  - `source_id` (string, required)
    The ID of the source to be linked.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `name` (string)
    Name of the dSource to be created.

  - `source_id` (string)
    Id of the source to link.

  - `group_id` (string)
    Id of the dataset group where this dSource should belong to.

  - `description` (string)
    The notes/description for the dSource.

  - `log_sync_enabled` (boolean)
    True if LogSync should run for this database.

  - `sync_policy_id` (string)
    The ID of the SnapSync policy for the dSource.
    Example: snapshot-123

  - `retention_policy_id` (string)
    The ID of the Retention policy for the dSource.
    Example: retention-policy-123

  - `make_current_account_owner` (boolean)
    Whether the account creating this reporting schedule must be configured as owner of the reporting schedule.

  - `tags` (array)
    The tags to be created for dSource.

  - `tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `ops_pre_sync` (array)
    Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing.

  - `ops_pre_sync.name` (string)

  - `ops_pre_sync.command` (string)

  - `ops_pre_sync.shell` (string)
    Enum: "bash", "shell", "expect", "ps", "psd"

  - `ops_pre_sync.credentials_env_vars` (array)
    List of environment variables that will contain credentials for this operation.

  - `ops_pre_sync.credentials_env_vars.base_var_name` (string, required)
    Base name of the environment variables. Variables are named by appending '_USER', '_PASSWORD', '_PUBKEY' and '_PRIVKEY' to this base name, respectively. Variables whose values are not entered or are not present in the type of credential or vault selected, will not be set.

  - `ops_pre_sync.credentials_env_vars.password` (string)
    Password to assign to the environment variables.
    Example: password

  - `ops_pre_sync.credentials_env_vars.vault_username` (string)
    Delphix display name for the vault user.
    Example: my-vault

  - `ops_pre_sync.credentials_env_vars.vault` (string)
    The name or reference of the vault to assign to the environment variables.
    Example: 1-VAULT-1

  - `ops_pre_sync.credentials_env_vars.hashicorp_vault_engine` (string)
    Vault engine name where the credential is stored.
    Example: kv

  - `ops_pre_sync.credentials_env_vars.hashicorp_vault_secret_path` (string)
    Path in the vault engine where the credential is stored.
    Example: oracle-env

  - `ops_pre_sync.credentials_env_vars.hashicorp_vault_username_key` (string)
    Hashicorp vault key for the username in the key-value store.
    Example: username

  - `ops_pre_sync.credentials_env_vars.hashicorp_vault_secret_key` (string)
    Hashicorp vault key for the password in the key-value store.
    Example: secret

  - `ops_pre_sync.credentials_env_vars.azure_vault_name` (string)
    Azure key vault name.
    Example: azure_vault

  - `ops_pre_sync.credentials_env_vars.azure_vault_username_key` (string)
    Azure vault key in the key-value store.
    Example: username

  - `ops_pre_sync.credentials_env_vars.azure_vault_secret_key` (string)
    Azure vault key in the key-value store.
    Example: secret

  - `ops_pre_sync.credentials_env_vars.cyberark_vault_query_string` (string)
    Query to find a credential in the CyberArk vault.
    Example: Safe=Test;Folder=Test;Object=Test

  - `ops_pre_sync.credentials_env_vars.credential_type` (string)
    Credential type of the credential environment variable
    Example: PasswordCredential

  - `ops_pre_sync.credentials_env_vars.element_id` (string)
    Element ID of the credential environment variable. Omit to create a new credential. Include an existing element_id to update that credential. Any existing credential whose element_id is omitted from the request will be deleted. An element_id that does not match any existing credential is silently ignored.
    Example: 35

  - `ops_pre_sync.credentials_env_vars.type` (string)
    Type of the credential environment variable
    Example: CredentialsEnvVars

  - `ops_pre_sync.hook_template_id` (string)
    ID of the hook template

  - `ops_post_sync` (array)
    Operations to perform after syncing a created dSource.

  - `db_vault_username` (string)
    Delphix display name for the vault user.
    Example: my-vault

  - `db_vault` (string)
    The name or reference of the vault from which to read the database credentials.
    Example: vault1

  - `db_hashicorp_vault_engine` (string)
    Vault engine name where the credential is stored.
    Example: key-vault/vault-secrets

  - `db_hashicorp_vault_secret_path` (string)
    Path in the vault engine where the credential is stored.
    Example: ase-db-cred

  - `db_hashicorp_vault_username_key` (string)
    Hashicorp vault key for the username in the key-value store.
    Example: user

  - `db_hashicorp_vault_secret_key` (string)
    Hashicorp vault key for the password in the key-value store.
    Example: upword

  - `db_azure_vault_name` (string)
    Azure key vault name.
    Example: azure-keyvault

  - `db_azure_vault_username_key` (string)
    Azure vault key for the username in the key-value store.
    Example: ase-db-cred-sa-user

  - `db_azure_vault_secret_key` (string)
    Azure vault key for the password in the key-value store.
    Example: ase-db-cred-sa-password

  - `db_cyberark_vault_query_string` (string)
    Query to find a credential in the CyberArk vault.
    Example: Safe=Test;Object=ase-db-cred

  - `external_file_path` (string)
    External file path.

  - `mount_base` (string)
    The base mount point to use for the NFS mounts.

  - `load_backup_path` (string)
    Source database backup location.

  - `backup_server_name` (string)
    Name of the backup server instance.

  - `backup_host_user` (string)
    OS user for the host where the backup server is located.

  - `backup_host` (string)
    Host environment where the backup server is located.

  - `dump_credentials` (string)
    The password credential for the source DB user.

  - `source_host_user` (string)
    ID or user reference of the host OS user to use for linking.

  - `db_user` (string)
    The user name for the source DB user.

  - `db_password` (string)
    Password for the database user.

  - `db_use_kerberos_authentication` (boolean)
    Whether to use kerberos authentication.
    Example: true

  - `staging_repository` (string)
    The SAP ASE instance on the staging environment that we want to use for validated sync.

  - `staging_host_user` (string)
    Information about the host OS user on the staging environment to use for linking.

  - `validated_sync_mode` (string)
    Information about the host OS user on the staging environment to use for linking.
    Enum: "ENABLED", "DISABLED"

  - `dump_history_file_enabled` (boolean)
    Specifies if Dump History File is enabled for backup history detection.

  - `drop_and_recreate_devices` (boolean)
    If this parameter is set to true, it will drop the older devices and create new devices during manual sync operations instead of trying to remap the devices. This might increase the space utilization on Delphix Engine.

  - `sync_strategy` (string)
    Determines how the Delphix Engine will take a backup:
* `latest_backup` - Use the most recent backup.
* `new_backup` - Delphix will take a new backup of your source database.
* `specific_backup` - Use a specific backup. Using this option requires setting `ase_backup_files`.
Default is `new_backup`.
    Enum: "latest_backup", "new_backup", "specific_backup"

  - `ase_backup_files` (array)
    The location of the full backup of the source database to restore from. The backup should be present in the shared backup location for the source database.

  - `pre_validated_sync` (array)
    Operations to perform on the staging source before performing a validated sync.

  - `post_validated_sync` (array)
    Operations to perform on the staging source after performing a validated sync.

