DSources

List all dSources.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "content_type" "-content_type" "database_type" "-database_type" "name" "-name" "database_version" "-database_version" "data_uuid" "-data_uuid" "storage_size" "-storage_size" "plugin_version" "-plugin_version" "creation_date" "-creation_date" "group_name" "-group_name" "enabled" "-enabled" "engine_id" "-engine_id" "source_id" "-source_id" "status" "-status" "engine_name" "-engine_name" "primary_object_id" "-primary_object_id" "primary_engine_id" "-primary_engine_id" "primary_engine_name" "-primary_engine_name" "sync_policy_id" "-sync_policy_id" "retention_policy_id" "-retention_policy_id" "replica_retention_policy_id" "-replica_retention_policy_id" "quota_policy_id" "-quota_policy_id" "logsync_enabled" "-logsync_enabled" "logsync_mode" "-logsync_mode" "logsync_interval" "-logsync_interval" "exported_data_directory" "-exported_data_directory" "template_id" "-template_id" "allow_auto_staging_restart_on_host_reboot" "-allow_auto_staging_restart_on_host_reboot" "physical_standby" "-physical_standby" "validate_by_opening_db_in_read_only_mode" "-validate_by_opening_db_in_read_only_mode" "mssql_sync_strategy_managed_type" "-mssql_sync_strategy_managed_type" "validated_sync_mode" "-validated_sync_mode" "backup_policy" "-backup_policy" "compression_enabled" "-compression_enabled" "staging_database_name" "-staging_database_name" "db_state" "-db_state" "external_netbackup_config_master_name" "-external_netbackup_config_master_name" "external_netbackup_config_source_client_name" "-external_netbackup_config_source_client_name" "external_netbackup_config_templates" "-external_netbackup_config_templates" "external_commserve_host_name" "-external_commserve_host_name" "external_commvault_config_source_client_name" "-external_commvault_config_source_client_name" "external_commvault_config_staging_client_name" "-external_commvault_config_staging_client_name" "external_commvault_config_templates" "-external_commvault_config_templates" "mssql_user_type" "-mssql_user_type" "domain_user_credential_type" "-domain_user_credential_type" "mssql_database_username" "-mssql_database_username" "mssql_user_environment_reference" "-mssql_user_environment_reference" "mssql_user_domain_username" "-mssql_user_domain_username" "mssql_user_domain_vault_username" "-mssql_user_domain_vault_username" "mssql_user_domain_vault" "-mssql_user_domain_vault" "mssql_user_domain_hashicorp_vault_engine" "-mssql_user_domain_hashicorp_vault_engine" "mssql_user_domain_hashicorp_vault_secret_path" "-mssql_user_domain_hashicorp_vault_secret_path" "mssql_user_domain_hashicorp_vault_username_key" "-mssql_user_domain_hashicorp_vault_username_key" "mssql_user_domain_hashicorp_vault_secret_key" "-mssql_user_domain_hashicorp_vault_secret_key" "mssql_user_domain_azure_vault_name" "-mssql_user_domain_azure_vault_name" "mssql_user_domain_azure_vault_username_key" "-mssql_user_domain_azure_vault_username_key" "mssql_user_domain_azure_vault_secret_key" "-mssql_user_domain_azure_vault_secret_key" "mssql_user_domain_cyberark_vault_query_string" "-mssql_user_domain_cyberark_vault_query_string"
Example: sort=id
permission
string (PermissionEnum)

Restrict the objects, which are allowed.

Enum: "READ" "UPDATE" "DELETE" "EXECUTE" "CANCEL" "MIGRATE" "REFRESH" "DISABLE" "ENABLE" "ABANDON" "VALIDATE" "START" "STOP" "SNAPSHOT" "COPY" "REMOVE_JOB" "PASSWORD_RESET" "UNDO_IMPORT" "IMPORT" "PROVISION_FROM_BOOKMARK" "PROVISION" "REFRESH_FROM_BOOKMARK" "REFRESH_FROM_SNAPSHOT" "REFRESH_FROM_TIMESTAMP" "REFRESH_FROM_LOCATION" "CREATE_ENVIRONMENT" "CREATE_BOOKMARK" "CREATE_VDBGROUP" "MANAGE_TAGS" "LINK" "REPLICATE" "REPLICATE_TO" "CONVERT_AND_DROP" "IMPORT_BOOKMARKS" "FAILOVER" "COMMIT_FAILOVER" "FAILBACK" "DISCARD" "LOCK" "UNLOCK" "FORCE_UNLOCK" "LOCK_FOR_OTHER_ACCOUNT" "UPDATE_TIMEFLOW" "SNAPSHOT_DELETE" "SWITCH_TIMEFLOW" "DELETE_TIMEFLOW" "SNAPSHOT_UPDATE" "IMPORT_ACCOUNTS" "DETACH_SOURCE" "ATTACH_SOURCE" "RESOLVE" "RESOLVE_ALL" "RESOLVE_OR_IGNORE" "API_KEY_RESET" "API_KEY_DELETE" "READ_STORAGE_CAPACITY_DATA" "DELETE_BOOKMARK" "UPDATE_BOOKMARK" "READ_BOOKMARK" "UPLOAD_MASKING_FILE" "GLOBAL_SYNC_ENGINES" "ADD_ENGINE_TO_HYPERSCALE" "CONFIGURE_CUSTOM_AUTO_TAGGING" "CONFIGURE_PREDEFINED_AUTO_TAGGING" "APPLY" "UNAPPLY" "UNDO_REFRESH" "CONVERT" "DELETE_HELDSPACE" "REPAIR_TIMEFLOW" "EXPORT"
Example: permission=READ
Responses
200

OK

get/dsources
Response samples
application/json
{
  • "items": [
    ],
  • "errors": [
    ],
  • "response_metadata": {
    }
}

Get defaults for dSource linking.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
source_id
required
string

The ID of the source to be linked.

Responses
200

OK

post/dsources/oracle/defaults
Request samples
application/json
{
  • "source_id": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "source_id": "string",
  • "group_id": "string",
  • "description": "string",
  • "log_sync_enabled": false,
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "make_current_account_owner": true,
  • "tags": [
    ],
  • "ops_pre_sync": [
    ],
  • "ops_post_sync": [
    ],
  • "external_file_path": "string",
  • "environment_user_id": "string",
  • "backup_level_enabled": true,
  • "rman_channels": 2,
  • "files_per_set": 5,
  • "check_logical": false,
  • "encrypted_linking_enabled": false,
  • "compressed_linking_enabled": true,
  • "bandwidth_limit": 0,
  • "number_of_connections": 1,
  • "diagnose_no_logging_faults": true,
  • "pre_provisioning_enabled": false,
  • "link_now": false,
  • "force_full_backup": false,
  • "double_sync": false,
  • "skip_space_check": false,
  • "do_not_resume": false,
  • "files_for_full_backup": [
    ],
  • "log_sync_mode": "ARCHIVE_ONLY_MODE",
  • "log_sync_interval": 5,
  • "non_sys_username": "oracle",
  • "non_sys_password": "oracle",
  • "non_sys_vault_username": "my-vault",
  • "non_sys_vault": "my-vault",
  • "non_sys_hashicorp_vault_engine": "kv",
  • "non_sys_hashicorp_vault_secret_path": "oracle-env",
  • "non_sys_hashicorp_vault_username_key": "username",
  • "non_sys_hashicorp_vault_secret_key": "secret",
  • "non_sys_azure_vault_name": "azure_vault",
  • "non_sys_azure_vault_username_key": "username",
  • "non_sys_azure_vault_secret_key": "secret",
  • "non_sys_cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
  • "fallback_username": "oracle",
  • "fallback_password": "oracle",
  • "fallback_vault_username": "my-vault",
  • "fallback_vault": "my-vault",
  • "fallback_hashicorp_vault_engine": "kv",
  • "fallback_hashicorp_vault_secret_path": "oracle-env",
  • "fallback_hashicorp_vault_username_key": "username",
  • "fallback_hashicorp_vault_secret_key": "secret",
  • "fallback_azure_vault_name": "azure_vault",
  • "fallback_azure_vault_username_key": "username",
  • "fallback_azure_vault_secret_key": "secret",
  • "fallback_cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
  • "ops_pre_log_sync": [
    ]
}

Detaches an Oracle source from an Oracle database.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Responses
200

OK

post/dsources/oracle/{dsourceId}/detachSource
Response samples
application/json
{
  • "job": {
    }
}

Attach an Oracle dSource to an Oracle database.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to attach an Oracle dSource.

source_id
required
string [ 1 .. 256 ] characters

Id of the source to attach.

backup_level_enabled
boolean

Boolean value indicates whether LEVEL-based incremental backups can be used on the source database.

bandwidth_limit
integer
Default: 0

Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit.

check_logical
boolean
Default: false

True if extended block checking should be used for this linked database.

compressed_linking_enabled
boolean
Default: true

True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network.

double_sync
boolean
Default: false

True if two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot.

encrypted_linking_enabled
boolean
Default: false

True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data.

environment_user
string

Reference to the user that should be used in the host.

external_file_path
string [ 1 .. 1024 ] characters

External file path.

files_per_set
integer [ 1 .. 64 ]
Default: 5

Number of data files to include in each RMAN backup set.

force
boolean
Default: false

If true, attach will succeed even if the resetlogs of the new database does not match the resetlogs information of the original database.

link_now
boolean
Default: false

True if initial load should be done immediately.

number_of_connections
integer
Default: 1

Total number of transport connections to use during SnapSync.

Array of objects (SourceOperation)

Operations to perform after syncing a created dSource and before running the LogSync.

oracle_fallback_user
string [ 1 .. 256 ] characters

The database fallback username. Optional if bequeath connections are enabled (to be used in case of bequeath connection failures). Only required for username-password auth.

oracle_fallback_credentials
string [ 1 .. 256 ] characters

Password for fallback username.

rman_channels
integer [ 1 .. 32 ]
Default: 2

Number of parallel channels to use.

Responses
200

OK

post/dsources/oracle/{dsourceId}/attachSource
Request samples
application/json
{
  • "source_id": "string",
  • "backup_level_enabled": true,
  • "bandwidth_limit": 0,
  • "check_logical": false,
  • "compressed_linking_enabled": true,
  • "double_sync": false,
  • "encrypted_linking_enabled": false,
  • "environment_user": "string",
  • "external_file_path": "string",
  • "files_per_set": 5,
  • "force": false,
  • "link_now": false,
  • "number_of_connections": 1,
  • "operations": [
    ],
  • "oracle_fallback_user": "oracle",
  • "oracle_fallback_credentials": "oracle",
  • "rman_channels": 2
}
Response samples
application/json
{
  • "job": {
    }
}

Get defaults for a Oracle staging push dSource linking.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
environment_id
required
string

The ID of the environment to be linked.

container_type
string

The container type of this database.If not provided the request would be considered for a PDB database.

Enum: "ROOT_CDB" "NON_CDB"
Responses
200

OK

post/dsources/oracle/staging-push/defaults
Request samples
application/json
{
  • "environment_id": "string",
  • "container_type": "ROOT_CDB"
}
Response samples
application/json
{
  • "name": "string",
  • "source_id": "string",
  • "group_id": "string",
  • "description": "string",
  • "log_sync_enabled": false,
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "make_current_account_owner": true,
  • "tags": [
    ],
  • "ops_pre_sync": [
    ],
  • "ops_post_sync": [
    ],
  • "engine_id": "string",
  • "container_type": "ROOT_CDB",
  • "environment_user_id": "string",
  • "repository": "string",
  • "database_name": "string",
  • "database_unique_name": "string",
  • "sid": "string",
  • "mount_base": "string",
  • "custom_env_variables_pairs": [
    ],
  • "custom_env_variables_paths": [
    ],
  • "auto_staging_restart": false,
  • "allow_auto_staging_restart_on_host_reboot": true,
  • "physical_standby": false,
  • "validate_snapshot_in_readonly": false,
  • "validate_by_opening_db_in_read_only_mode": true,
  • "staging_database_templates": [
    ],
  • "staging_database_config_params": {
    },
  • "staging_container_database_reference": "string",
  • "ops_pre_log_sync": [
    ],
  • "tde_keystore_config_type": "FILE",
  • "template_id": "70096a7-6655-4973-8464-682c41c932da"
}

Update values of an Oracle dSource

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The new data to update an Oracle dSource.

name
string [ 1 .. 256 ] characters

The unique name of the dSource within a group.

db_username
string [ 1 .. 256 ] characters

The username of the database user.

db_password
string [ 1 .. 256 ] characters

The password of the database user.

validate_db_credentials
boolean
Default: true

Whether db_username and db_password must be validated, if present, against the dSource. This must be set to false when credentials validation is not possible, for instance if the dSource is known to be disabled.

environment_user_id
string [ 1 .. 256 ] characters

The environment user ID to use to connect to the target environment.

backup_level_enabled
boolean

Boolean value indicates whether LEVEL-based incremental backups can be used on the source database.

rman_channels
integer [ 1 .. 32 ]

Number of parallel channels to use.

files_per_set
integer [ 1 .. 64 ]

Number of data files to include in each RMAN backup set.

check_logical
boolean

True if extended block checking should be used for this dSource.

encrypted_linking_enabled
boolean

True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data.

compressed_linking_enabled
boolean

True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network.

bandwidth_limit
integer

Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit.

number_of_connections
integer

Total number of transport connections to use during SnapSync.

validate_by_opening_db_in_read_only_mode
boolean

Whether the snaphots of this dSource's staging database will be validated by opening it in read-only mode.

pre_provisioning_enabled
boolean

Boolean flag indicating whether or not pre-provisioning is turned on for this dSource.

diagnose_no_logging_faults
boolean

If true, NOLOGGING operations on this dSource are treated as faults and cannot be resolved manually.

rac_max_instance_lag
integer

Maximum number of log sequences to allow a RAC instance to lag before considering the instance offline.

allow_auto_staging_restart_on_host_reboot
boolean

Allow auto restart of staging source on host reboot.

physical_standby
boolean

If true, convert this dSource's staging database to a physical standby.

external_file_path
string [ 1 .. 1024 ] characters

External file path.

object (DSourceHooks)

DSource operation hooks.

Array of objects (NameValuePair)

An array of name value pair of environment variables.

custom_env_variables_paths
Array of strings

An array of strings of whitespace-separated parameters to be passed to the source command. The first parameter must be an absolute path to a file that exists on the target environment. Every subsequent parameter will be treated as an argument interpreted by the environment file.

object or null

Database configuration parameter overrides.

template_id
string [ 1 .. 256 ] characters

The template ID of the target Oracle Staging Push dSource.

logsync_enabled
boolean

True if LogSync is enabled for this dSource.

logsync_mode
string (OracleLogsyncModeTypeEnum)

LogSync operation mode for this dSource.

Enum: "ARCHIVE_ONLY_MODE" "ARCHIVE_REDO_MODE" "UNDEFINED"
logsync_interval
integer >= 5

Interval between LogSync requests, in seconds.

Responses
200

OK

patch/dsources/oracle/{dsourceId}
Request samples
application/json
{
  • "name": "my-dsource",
  • "db_username": "db-username",
  • "db_password": "db-password",
  • "validate_db_credentials": true,
  • "environment_user_id": "environment-user-123",
  • "backup_level_enabled": true,
  • "rman_channels": 1,
  • "files_per_set": 1,
  • "check_logical": true,
  • "encrypted_linking_enabled": true,
  • "compressed_linking_enabled": true,
  • "bandwidth_limit": 0,
  • "number_of_connections": 0,
  • "validate_by_opening_db_in_read_only_mode": true,
  • "pre_provisioning_enabled": true,
  • "diagnose_no_logging_faults": true,
  • "rac_max_instance_lag": 0,
  • "allow_auto_staging_restart_on_host_reboot": true,
  • "physical_standby": true,
  • "external_file_path": "string",
  • "hooks": {
    },
  • "custom_env_variables_pairs": [
    ],
  • "custom_env_variables_paths": [
    ],
  • "staging_database_config_params": { },
  • "template_id": "70096a7-6655-4973-8464-682c41c932da",
  • "logsync_enabled": true,
  • "logsync_mode": "ARCHIVE_ONLY_MODE",
  • "logsync_interval": 5
}
Response samples
application/json
{
  • "job": {
    }
}

Upgrade the requested Oracle dSource installation and user.Deprecated

This API is marked as deprecated in favour of generalized API '/dsources/{dsourceId}/upgrade'

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The new data to upgrade an Oracle dSource.

repository_id
required
string

The id of the dSource/VDB repository to upgrade to.

environment_user_id
required
string

Reference of the environment user to use for dSource/VDB upgrade.

Responses
200

OK

post/dsources/oracle/{dsourceId}/upgrade
Request samples
application/json
{
  • "repository_id": "1-ORACLE_INSTALL-4",
  • "environment_user_id": "HOST_USER-4"
}
Response samples
application/json
{
  • "job": {
    }
}

Upgrade dSource

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The new API to upgrade dSource

repository_id
required
string

The id of the dSource/VDB repository to upgrade to.

environment_user_id
string

Reference of the environment user to use for dSource/VDB upgrade.

ppt_repository
string

The id of the SQL instance on the PPT environment that we want to use for pre-provisioning (MSSQL only).

Responses
200

OK

post/dsources/{dsourceId}/upgrade
Request samples
application/json
{
  • "repository_id": "1-ORACLE_INSTALL-4",
  • "environment_user_id": "HOST_USER-4",
  • "ppt_repository": "1-MSSQL_INSTANCE-11"
}
Response samples
application/json
{
  • "job": {
    }
}

Get defaults for an ASE dSource linking.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
source_id
required
string

The ID of the source to be linked.

Responses
200

OK

post/dsources/ase/defaults
Request samples
application/json
{
  • "source_id": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "source_id": "string",
  • "group_id": "string",
  • "description": "string",
  • "log_sync_enabled": false,
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "make_current_account_owner": true,
  • "tags": [
    ],
  • "ops_pre_sync": [
    ],
  • "ops_post_sync": [
    ],
  • "external_file_path": "string",
  • "mount_base": "string",
  • "load_backup_path": "string",
  • "backup_server_name": "string",
  • "backup_host_user": "string",
  • "backup_host": "string",
  • "dump_credentials": "string",
  • "source_host_user": "string",
  • "db_user": "string",
  • "db_password": "string",
  • "db_vault_username": "my-vault",
  • "db_vault": "string",
  • "db_hashicorp_vault_engine": "string",
  • "db_hashicorp_vault_secret_path": "string",
  • "db_hashicorp_vault_username_key": "string",
  • "db_hashicorp_vault_secret_key": "string",
  • "db_azure_vault_name": "string",
  • "db_azure_vault_username_key": "string",
  • "db_azure_vault_secret_key": "string",
  • "db_cyberark_vault_query_string": "string",
  • "staging_repository": "string",
  • "staging_host_user": "string",
  • "validated_sync_mode": "ENABLED",
  • "dump_history_file_enabled": false,
  • "drop_and_recreate_devices": false,
  • "sync_strategy": "latest_backup",
  • "ase_backup_files": [
    ],
  • "pre_validated_sync": [
    ],
  • "post_validated_sync": [
    ]
}

Update values of an ASE dSource

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The new data to update an ASE dSource.

name
string [ 1 .. 256 ] characters

Name of the dSource and container to be updated.

description
string [ 1 .. 1024 ] characters

The notes/description for the dSource.

sync_policy_id
string [ 1 .. 256 ] characters

The ID of the SnapSync policy for the dSource.

retention_policy_id
string [ 1 .. 256 ] characters

The ID of the Retention policy for the dSource.

Responses
200

OK

patch/dsources/ase/{dsourceId}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123"
}
Response samples
application/json
{
  • "job": {
    }
}

Get defaults for an AppData dSource linking.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
source_id
required
string

The ID of the source to be linked.

Responses
200

OK

post/dsources/appdata/defaults
Request samples
application/json
{
  • "source_id": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "source_id": "string",
  • "group_id": "string",
  • "description": "string",
  • "log_sync_enabled": false,
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "make_current_account_owner": true,
  • "tags": [
    ],
  • "ops_pre_sync": [
    ],
  • "ops_post_sync": [
    ],
  • "link_type": "AppDataDirect",
  • "staging_mount_base": "string",
  • "staging_environment": "string",
  • "staging_environment_user": "string",
  • "environment_user": "string",
  • "excludes": [
    ],
  • "follow_symlinks": [
    ],
  • "parameters": { },
  • "sync_parameters": { }
}

Update values of an AppData dSource

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The new data to update an AppData dSource.

name
string [ 1 .. 256 ] characters

Name of the dSource and container to be updated.

description
string [ 1 .. 1024 ] characters

The notes/description for the dSource.

staging_environment
string

The environment used as an intermediate stage to pull data into Delphix [AppDataStaged only].

staging_environment_user
string

The environment user used to access the staging environment [AppDataStaged only].

environment_user
string [ 1 .. 256 ] characters

The OS user to use for linking.

object

The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.

sync_policy_id
string [ 1 .. 256 ] characters

The ID of the SnapSync policy for the dSource.

retention_policy_id
string [ 1 .. 256 ] characters

The ID of the Retention policy for the dSource.

Array of objects (SourceOperation)

Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing.

Array of objects (SourceOperation)

Operations to perform after syncing a created dSource.

Responses
200

OK

patch/dsources/appdata/{dsourceId}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "staging_environment": "3-UNIX_HOST_ENVIRONMENT-7",
  • "staging_environment_user": "HOST_USER-11",
  • "environment_user": "HOST_USER-11",
  • "parameters": { },
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "ops_pre_sync": [
    ],
  • "ops_post_sync": [
    ]
}
Response samples
application/json
{
  • "job": {
    }
}

Detaches a linked source from a MSSql database.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Responses
200

OK

post/dsources/mssql/{dsourceId}/detachSource
Response samples
application/json
{
  • "job": {
    }
}

Attaches a MSSql source to a previously detached dsource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The parameters to attach a MSSql dSource.

source_id
required
string [ 1 .. 256 ] characters

Id of the source to link.

ppt_repository
required
string [ 1 .. 1024 ] characters

Id of the SQL instance on the PPT environment that we want to use for pre-provisioning.

sync_strategy_managed_type
string
Default: "external"

MSSQL specific parameters for source based sync strategy.:

  • external - MSSQL specific parameters for externally managed source based sync strategy.
  • delphix - MSSQL specific parameters for delphix managed source based sync strategy.
Enum: "external" "delphix"
mssql_user_environment_reference
string [ 1 .. 1024 ] characters

Reference to the source environment user to use for linking.

mssql_user_domain_username
string [ 1 .. 1024 ] characters

The username for the source DB user.

mssql_user_domain_password
string [ 1 .. 256 ] characters

Password for the database user.

mssql_user_domain_vault_username
string [ 1 .. 256 ] characters

Delphix display name for the vault user.

mssql_user_domain_vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the database credentials.

mssql_user_domain_hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

mssql_user_domain_hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

mssql_user_domain_hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Hashicorp vault key for the username in the key-value store.

mssql_user_domain_hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Hashicorp vault key for the password in the key-value store.

mssql_user_domain_azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name.

mssql_user_domain_azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

mssql_user_domain_azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

mssql_user_domain_cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

mssql_database_username
string [ 1 .. 1024 ] characters

The username for the source DB user.

mssql_database_password
string [ 1 .. 256 ] characters

Password for the database user.

delphix_managed_backup_compression_enabled
boolean
Default: false

Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected.

delphix_managed_backup_policy
string
Default: "primary"

Specify which node of an availability group to run the copy-only full backup on:

  • primary - Backups only go to the primary node.
  • secondary_only - Backups only go to secondary nodes. If secondary nodes are down, backups will fail.
  • prefer_secondary - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node.
Enum: "primary" "secondary_only" "prefer_secondary"
external_managed_validate_sync_mode
string
Default: "TRANSACTION_LOG"

Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database

Enum: "TRANSACTION_LOG" "FULL_OR_DIFFERENTIAL" "FULL" "NONE"
external_managed_shared_backup_locations
Array of strings <= 260 items

Shared source database backup locations.

external_netbackup_config_master_name
string [ 1 .. 256 ] characters

The master server name of this NetBackup configuration.

external_netbackup_config_source_client_name
string [ 1 .. 256 ] characters

The source's client server name of this NetBackup configuration.

object

NetBackup configuration parameter overrides.

external_netbackup_config_templates
string

Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored.

external_commserve_host_name
string [ 1 .. 256 ] characters

The commserve host name of this Commvault configuration.

external_commvault_config_source_client_name
string [ 1 .. 256 ] characters

The source client name of this Commvault configuration.

external_commvault_config_staging_client_name
string [ 1 .. 256 ] characters

The staging client name of this Commvault configuration.

object

Commvault configuration parameter overrides.

external_commvault_config_templates
string

Optional config template selection for Commvault configurations. If set, configParams will be ignored.

encryption_key
string

The encryption key to use when restoring encrypted backups.

source_host_user
string [ 1 .. 1024 ] characters

ID or user reference of the host OS user to use for linking.

ppt_host_user
string [ 1 .. 1024 ] characters

Reference of the host OS user on the PPT host to use for linking.

staging_pre_script
string [ 1 .. 1024 ] characters

A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning.

staging_post_script
string [ 1 .. 1024 ] characters

A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning.

Array of objects (SourceOperation)

Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing.

Array of objects (SourceOperation)

Operations to perform after syncing a created dSource.

Responses
200

OK

post/dsources/mssql/{dsourceId}/attachSource
Request samples
application/json

The above request example is intended for an MSSql Database attach operation without including optional properties

{
  • "source_id": "SOURCE_CONFIG-1",
  • "ppt_repository": "MSSQL_INSTANCE-1",
  • "mssql_user_environment_reference": "HOST_USER-1"
}
Response samples
application/json
{
  • "job": {
    }
}

Attaches a MSSql staging push database to a previously detached dsource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to attach an MSSql dSource.

encryption_key
string

The encryption key to use when restoring encrypted backups.

ppt_repository
required
string [ 1 .. 1024 ] characters

Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning.

ppt_host_user
string [ 1 .. 1024 ] characters

Reference of the host OS user on the PPT host to use for linking.

staging_pre_script
string [ 1 .. 1024 ] characters

A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning.

staging_post_script
string [ 1 .. 1024 ] characters

A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning.

staging_database_name
required
string [ 1 .. 1024 ] characters

The name of the database to create on the staging environment. This property is mutually exclusive to sync_strategy_managed_type

db_state
string
Default: "RESTORING"

User provided db state that will be used to create staging push db. Default is RESTORING

Enum: "RESTORING" "ONLINE"
Array of objects (SourceOperation)

Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing.

Array of objects (SourceOperation)

Operations to perform after syncing a created dSource.

Responses
200

OK

post/dsources/mssql/staging-push/{dsourceId}/attachSource
Request samples
application/json

The above request example is intended for an MSSql staging push Database attach operation without including optional properties

{
  • "ppt_repository": "PPT_REPOSITORY-1",
  • "staging_database_name": "staging_database-1"
}
Response samples
application/json
{
  • "job": {
    }
}

Get defaults for a MSSql dSource linking.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
source_id
required
string

The ID of the source to be linked.

Responses
200

OK

post/dsources/mssql/defaults
Request samples
application/json
{
  • "source_id": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "source_id": "string",
  • "group_id": "string",
  • "description": "string",
  • "log_sync_enabled": false,
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "make_current_account_owner": true,
  • "tags": [
    ],
  • "ops_pre_sync": [
    ],
  • "ops_post_sync": [
    ],
  • "encryption_key": "string",
  • "sync_strategy": "latest_backup",
  • "mssql_backup_uuid": "string",
  • "compression_enabled": false,
  • "availability_group_backup_policy": "primary",
  • "source_host_user": "string",
  • "ppt_repository": "string",
  • "ppt_host_user": "string",
  • "staging_pre_script": "string",
  • "staging_post_script": "string",
  • "sync_strategy_managed_type": "external",
  • "mssql_user_environment_reference": "string",
  • "mssql_user_domain_username": "string",
  • "mssql_user_domain_password": "string",
  • "mssql_user_domain_vault_username": "my-vault",
  • "mssql_user_domain_vault": "string",
  • "mssql_user_domain_hashicorp_vault_engine": "string",
  • "mssql_user_domain_hashicorp_vault_secret_path": "string",
  • "mssql_user_domain_hashicorp_vault_username_key": "string",
  • "mssql_user_domain_hashicorp_vault_secret_key": "string",
  • "mssql_user_domain_azure_vault_name": "string",
  • "mssql_user_domain_azure_vault_username_key": "string",
  • "mssql_user_domain_azure_vault_secret_key": "string",
  • "mssql_user_domain_cyberark_vault_query_string": "string",
  • "mssql_database_username": "string",
  • "mssql_database_password": "string",
  • "delphix_managed_backup_compression_enabled": false,
  • "delphix_managed_backup_policy": "primary",
  • "external_managed_validate_sync_mode": "TRANSACTION_LOG",
  • "external_managed_shared_backup_locations": [
    ],
  • "external_netbackup_config_master_name": "string",
  • "external_netbackup_config_source_client_name": "string",
  • "external_netbackup_config_params": { },
  • "external_netbackup_config_templates": "string",
  • "external_commserve_host_name": "string",
  • "external_commvault_config_source_client_name": "string",
  • "external_commvault_config_staging_client_name": "string",
  • "external_commvault_config_params": { },
  • "external_commvault_config_templates": "string"
}

Get defaults for a MSSql staging push dSource linking.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
environment_id
required
string

The ID of the environment to be linked.

Responses
200

OK

post/dsources/mssql/staging-push/defaults
Request samples
application/json
{
  • "environment_id": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "source_id": "string",
  • "group_id": "string",
  • "description": "string",
  • "log_sync_enabled": false,
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123",
  • "make_current_account_owner": true,
  • "tags": [
    ],
  • "ops_pre_sync": [
    ],
  • "ops_post_sync": [
    ],
  • "engine_id": "string",
  • "encryption_key": "string",
  • "ppt_repository": "string",
  • "ppt_host_user": "string",
  • "staging_pre_script": "string",
  • "staging_post_script": "string",
  • "staging_database_name": "string",
  • "db_state": "RESTORING"
}

Delete the specified dSource.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
dsource_id
required
string [ 1 .. 256 ] characters

Id of the dSource to delete.

force
boolean
Default: false

Flag indicating whether to continue the operation upon failures.

oracle_username
string [ 1 .. 256 ] characters

The name of the privileged user to run the delete operation as (Oracle only).

oracle_password
string [ 1 .. 256 ] characters

Password for privileged user (Oracle only).

delete_all_dependent_vdbs
boolean
Default: false

Flag indicating whether to delete all dependent VDBs before deleting the dSource.

Responses
200

OK

post/dsources/delete
Request samples
application/json
{
  • "dsource_id": "string",
  • "force": false,
  • "oracle_username": "oracle-username",
  • "oracle_password": "oracle-password",
  • "delete_all_dependent_vdbs": false
}
Response samples
application/json
{
  • "id": "job-123",
  • "status": "RUNNING",
  • "is_waiting_for_telemetry": true,
  • "type": "DB_REFRESH",
  • "localized_type": "DB Refresh",
  • "error_details": "Unable to connect to the engine.",
  • "warning_message": "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.",
  • "target_id": "vdb-123",
  • "target_name": "vdb",
  • "start_time": "2022-01-02T05:11:24.148Z",
  • "update_time": "2022-01-02T06:11:24.148Z",
  • "trace_id": "string",
  • "engine_ids": [
    ],
  • "tags": [
    ],
  • "engines": [
    ],
  • "account_id": 1,
  • "account_name": "User 1",
  • "percent_complete": 50,
  • "virtualization_tasks": [
    ],
  • "tasks": [
    ],
  • "execution_id": "string",
  • "result_type": "string",
  • "result": { },
  • "job": {
    }
}

Search for dSources.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "content_type" "-content_type" "database_type" "-database_type" "name" "-name" "database_version" "-database_version" "data_uuid" "-data_uuid" "storage_size" "-storage_size" "plugin_version" "-plugin_version" "creation_date" "-creation_date" "group_name" "-group_name" "enabled" "-enabled" "engine_id" "-engine_id" "source_id" "-source_id" "status" "-status" "engine_name" "-engine_name" "primary_object_id" "-primary_object_id" "primary_engine_id" "-primary_engine_id" "primary_engine_name" "-primary_engine_name" "sync_policy_id" "-sync_policy_id" "retention_policy_id" "-retention_policy_id" "replica_retention_policy_id" "-replica_retention_policy_id" "quota_policy_id" "-quota_policy_id" "logsync_enabled" "-logsync_enabled" "logsync_mode" "-logsync_mode" "logsync_interval" "-logsync_interval" "exported_data_directory" "-exported_data_directory" "template_id" "-template_id" "allow_auto_staging_restart_on_host_reboot" "-allow_auto_staging_restart_on_host_reboot" "physical_standby" "-physical_standby" "validate_by_opening_db_in_read_only_mode" "-validate_by_opening_db_in_read_only_mode" "mssql_sync_strategy_managed_type" "-mssql_sync_strategy_managed_type" "validated_sync_mode" "-validated_sync_mode" "backup_policy" "-backup_policy" "compression_enabled" "-compression_enabled" "staging_database_name" "-staging_database_name" "db_state" "-db_state" "external_netbackup_config_master_name" "-external_netbackup_config_master_name" "external_netbackup_config_source_client_name" "-external_netbackup_config_source_client_name" "external_netbackup_config_templates" "-external_netbackup_config_templates" "external_commserve_host_name" "-external_commserve_host_name" "external_commvault_config_source_client_name" "-external_commvault_config_source_client_name" "external_commvault_config_staging_client_name" "-external_commvault_config_staging_client_name" "external_commvault_config_templates" "-external_commvault_config_templates" "mssql_user_type" "-mssql_user_type" "domain_user_credential_type" "-domain_user_credential_type" "mssql_database_username" "-mssql_database_username" "mssql_user_environment_reference" "-mssql_user_environment_reference" "mssql_user_domain_username" "-mssql_user_domain_username" "mssql_user_domain_vault_username" "-mssql_user_domain_vault_username" "mssql_user_domain_vault" "-mssql_user_domain_vault" "mssql_user_domain_hashicorp_vault_engine" "-mssql_user_domain_hashicorp_vault_engine" "mssql_user_domain_hashicorp_vault_secret_path" "-mssql_user_domain_hashicorp_vault_secret_path" "mssql_user_domain_hashicorp_vault_username_key" "-mssql_user_domain_hashicorp_vault_username_key" "mssql_user_domain_hashicorp_vault_secret_key" "-mssql_user_domain_hashicorp_vault_secret_key" "mssql_user_domain_azure_vault_name" "-mssql_user_domain_azure_vault_name" "mssql_user_domain_azure_vault_username_key" "-mssql_user_domain_azure_vault_username_key" "mssql_user_domain_azure_vault_secret_key" "-mssql_user_domain_azure_vault_secret_key" "mssql_user_domain_cyberark_vault_query_string" "-mssql_user_domain_cyberark_vault_query_string"
Example: sort=id
permission
string (PermissionEnum)

Restrict the objects, which are allowed.

Enum: "READ" "UPDATE" "DELETE" "EXECUTE" "CANCEL" "MIGRATE" "REFRESH" "DISABLE" "ENABLE" "ABANDON" "VALIDATE" "START" "STOP" "SNAPSHOT" "COPY" "REMOVE_JOB" "PASSWORD_RESET" "UNDO_IMPORT" "IMPORT" "PROVISION_FROM_BOOKMARK" "PROVISION" "REFRESH_FROM_BOOKMARK" "REFRESH_FROM_SNAPSHOT" "REFRESH_FROM_TIMESTAMP" "REFRESH_FROM_LOCATION" "CREATE_ENVIRONMENT" "CREATE_BOOKMARK" "CREATE_VDBGROUP" "MANAGE_TAGS" "LINK" "REPLICATE" "REPLICATE_TO" "CONVERT_AND_DROP" "IMPORT_BOOKMARKS" "FAILOVER" "COMMIT_FAILOVER" "FAILBACK" "DISCARD" "LOCK" "UNLOCK" "FORCE_UNLOCK" "LOCK_FOR_OTHER_ACCOUNT" "UPDATE_TIMEFLOW" "SNAPSHOT_DELETE" "SWITCH_TIMEFLOW" "DELETE_TIMEFLOW" "SNAPSHOT_UPDATE" "IMPORT_ACCOUNTS" "DETACH_SOURCE" "ATTACH_SOURCE" "RESOLVE" "RESOLVE_ALL" "RESOLVE_OR_IGNORE" "API_KEY_RESET" "API_KEY_DELETE" "READ_STORAGE_CAPACITY_DATA" "DELETE_BOOKMARK" "UPDATE_BOOKMARK" "READ_BOOKMARK" "UPLOAD_MASKING_FILE" "GLOBAL_SYNC_ENGINES" "ADD_ENGINE_TO_HYPERSCALE" "CONFIGURE_CUSTOM_AUTO_TAGGING" "CONFIGURE_PREDEFINED_AUTO_TAGGING" "APPLY" "UNAPPLY" "UNDO_REFRESH" "CONVERT" "DELETE_HELDSPACE" "REPAIR_TIMEFLOW" "EXPORT"
Example: permission=READ
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 50000 ] characters
Responses
200

OK

post/dsources/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Get a dSource by ID.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Responses
200

OK

get/dsources/{dsourceId}
Response samples
application/json
{
  • "id": "dsource-123",
  • "database_type": "Oracle",
  • "name": "prod01-main",
  • "database_version": "10.2.0.5.0",
  • "data_uuid": "1734315df891991101eb96963535afa0",
  • "storage_size": 339292672,
  • "plugin_version": "1.0",
  • "creation_date": "2021-05-01T08:51:34.148Z",
  • "group_name": "DSources",
  • "enabled": true,
  • "is_detached": false,
  • "engine_id": "engine-123",
  • "source_id": "source-123",
  • "status": "RUNNING",
  • "engine_name": "engine-123-name",
  • "cdb_id": "cdb-123",
  • "is_appdata": true,
  • "tags": [
    ],
  • "primary_object_id": "1-CONTAINER-1",
  • "primary_engine_id": "1",
  • "primary_engine_name": "source-engine",
  • "replicas": [
    ],
  • "hooks": {
    },
  • "sync_policy_id": "1-POLICY_SNAPSHOT-1",
  • "retention_policy_id": "1-POLICY_RETENTION-1",
  • "replica_retention_policy_id": "1-POLICY_REPLICA_RETENTION-1",
  • "quota_policy_id": "1-POLICY_QUOTA-1",
  • "logsync_enabled": true,
  • "exported_data_directory": "domain0/oracle_db_container-30/oracle_timeflow-32/datafile",
  • "template_id": "DATABASE_TEMPLATE-1",
  • "mssql_user_type": "DATABASE_USER",
  • "domain_user_credential_type": "PASSWORD",
  • "mssql_database_username": "mssql-user",
  • "mssql_user_environment_reference": "HOST-USER_1",
  • "mssql_user_domain_username": "domain/user",
  • "mssql_user_domain_vault_username": "my-vault",
  • "mssql_user_domain_vault": "my-vault-1",
  • "mssql_user_domain_hashicorp_vault_engine": "key_vault",
  • "mssql_user_domain_hashicorp_vault_secret_path": "mssql-env",
  • "mssql_user_domain_hashicorp_vault_username_key": "username",
  • "mssql_user_domain_hashicorp_vault_secret_key": "secret",
  • "mssql_user_domain_azure_vault_name": "azure_vault",
  • "mssql_user_domain_azure_vault_username_key": "username",
  • "mssql_user_domain_azure_vault_secret_key": "secret",
  • "mssql_user_domain_cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test"
}

Enable a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The parameters to enable a dSource.

attempt_start
boolean
Default: true

Whether to attempt a startup of the source after the enable.

Responses
200

OK

post/dsources/{dsourceId}/enable
Request samples
application/json
{
  • "attempt_start": true
}
Response samples
application/json
{
  • "job": {
    }
}

Disable a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The parameters to disable a dSource.

attempt_cleanup
boolean
Default: true

Whether to attempt a cleanup of the database from the environment before the disable.

Responses
200

OK

post/dsources/{dsourceId}/disable
Request samples
application/json
{
  • "attempt_cleanup": true
}
Response samples
application/json
{
  • "job": {
    }
}

Returns a list of compatible repositories for dSource upgrade.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Responses
200

OK

get/dsources/{dsourceId}/upgrade_compatible_repositories
Response samples
application/json
{
  • "items": [
    ]
}

Update values of an MSSql dSource

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The new data to update an MSSql dSource.

name
string [ 1 .. 256 ] characters

The unique name of the dSource within a group.

logsync_enabled
boolean

Enabled LogSync for this dSource.

encryption_key
string

The encryption key to use when restoring encrypted backups.

ppt_repository
string [ 1 .. 1024 ] characters

Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning.

ppt_host_user
string [ 1 .. 1024 ] characters

Reference of the host OS user on the PPT host to use for linking.

sync_strategy_managed_type
string

MSSQL specific parameters for source based sync strategy.:

  • external - MSSQL specific parameters for externally managed source based sync strategy.
  • delphix - MSSQL specific parameters for delphix managed source based sync strategy.
  • staging_push - MSSQL specific parameters for staging push based sync strategy.
Enum: "external" "delphix" "staging_push"
source_host_user
string [ 1 .. 1024 ] characters

ID or user reference of the host OS user to use for linking.

mssql_user_environment_reference
string [ 1 .. 1024 ] characters

Reference to the source environment user to use for linking.

mssql_user_domain_username
string [ 1 .. 1024 ] characters

The username for the source DB user.

mssql_user_domain_password
string [ 1 .. 256 ] characters

Password for the database user.

mssql_user_domain_vault_username
string [ 1 .. 256 ] characters

Delphix display name for the vault user.

mssql_user_domain_vault
string [ 1 .. 256 ] characters

The name or reference of the vault from which to read the database credentials.

mssql_user_domain_hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

mssql_user_domain_hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

mssql_user_domain_hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Hashicorp vault key for the username in the key-value store.

mssql_user_domain_hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Hashicorp vault key for the password in the key-value store.

mssql_user_domain_azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name.

mssql_user_domain_azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

mssql_user_domain_azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

mssql_user_domain_cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

mssql_database_username
string [ 1 .. 1024 ] characters

The username for the source DB user.

mssql_database_password
string [ 1 .. 256 ] characters

Password for the database user.

delphix_managed_backup_compression_enabled
boolean

Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected.

delphix_managed_backup_policy
string

Specify which node of an availability group to run the copy-only full backup on:

  • primary - Backups only go to the primary node.
  • secondary_only - Backups only go to secondary nodes. If secondary nodes are down, backups will fail.
  • prefer_secondary - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node.
Enum: "primary" "secondary_only" "prefer_secondary"
external_managed_validate_sync_mode
string

Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database

Enum: "TRANSACTION_LOG" "FULL_OR_DIFFERENTIAL" "FULL" "NONE"
external_managed_shared_backup_locations
Array of strings <= 260 items

Shared source database backup locations.

disable_netbackup_config
boolean

Disable NetBackup configuration.

external_netbackup_config_master_name
string [ 1 .. 256 ] characters

The master server name of this NetBackup configuration.

external_netbackup_config_source_client_name
string [ 1 .. 256 ] characters

The source's client server name of this NetBackup configuration.

object

NetBackup configuration parameter overrides.

external_netbackup_config_templates
string

Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored.

disable_commvault_config
boolean

Disable Commvault configuration.

external_commserve_host_name
string [ 1 .. 256 ] characters

The commserve host name of this Commvault configuration.

external_commvault_config_source_client_name
string [ 1 .. 256 ] characters

The source client name of this Commvault configuration.

external_commvault_config_staging_client_name
string [ 1 .. 256 ] characters

The staging client name of this Commvault configuration.

object

Commvault configuration parameter overrides.

external_commvault_config_templates
string

Optional config template selection for Commvault configurations. If set, configParams will be ignored.

object (DSourceHooks)

DSource operation hooks.

sync_policy_id
string [ 1 .. 256 ] characters

The ID of the SnapSync policy for the dSource.

retention_policy_id
string [ 1 .. 256 ] characters

The ID of the Retention policy for the dSource.

Responses
200

OK

patch/dsources/mssql/{dsourceId}
Request samples
application/json
{
  • "name": "string",
  • "logsync_enabled": true,
  • "encryption_key": "string",
  • "ppt_repository": "string",
  • "ppt_host_user": "string",
  • "sync_strategy_managed_type": "external",
  • "source_host_user": "string",
  • "mssql_user_environment_reference": "string",
  • "mssql_user_domain_username": "string",
  • "mssql_user_domain_password": "string",
  • "mssql_user_domain_vault_username": "my-vault",
  • "mssql_user_domain_vault": "string",
  • "mssql_user_domain_hashicorp_vault_engine": "string",
  • "mssql_user_domain_hashicorp_vault_secret_path": "string",
  • "mssql_user_domain_hashicorp_vault_username_key": "string",
  • "mssql_user_domain_hashicorp_vault_secret_key": "string",
  • "mssql_user_domain_azure_vault_name": "string",
  • "mssql_user_domain_azure_vault_username_key": "string",
  • "mssql_user_domain_azure_vault_secret_key": "string",
  • "mssql_user_domain_cyberark_vault_query_string": "string",
  • "mssql_database_username": "string",
  • "mssql_database_password": "string",
  • "delphix_managed_backup_compression_enabled": true,
  • "delphix_managed_backup_policy": "primary",
  • "external_managed_validate_sync_mode": "TRANSACTION_LOG",
  • "external_managed_shared_backup_locations": [
    ],
  • "disable_netbackup_config": true,
  • "external_netbackup_config_master_name": "string",
  • "external_netbackup_config_source_client_name": "string",
  • "external_netbackup_config_params": { },
  • "external_netbackup_config_templates": "string",
  • "disable_commvault_config": true,
  • "external_commserve_host_name": "string",
  • "external_commvault_config_source_client_name": "string",
  • "external_commvault_config_staging_client_name": "string",
  • "external_commvault_config_params": { },
  • "external_commvault_config_templates": "string",
  • "hooks": {
    },
  • "sync_policy_id": "snapshot-123",
  • "retention_policy_id": "retention-policy-123"
}
Response samples
application/json
{
  • "job": {
    }
}

List Snapshots for a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

Responses
200

OK

get/dsources/{dsourceId}/snapshots
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Snapshot a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
optional

Optional parameters to snapshot a DSource.

drop_and_recreate_devices
boolean

If this parameter is set to true, older devices will be dropped and new devices created instead of trying to remap the devices. This might increase the space utilization on Delphix Engine. (ASE only)

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 for ASE dSources or mssql_backup_uuid for MSSql dSources. Default is new_backup. (ASE, MSSql only)
Enum: "latest_backup" "new_backup" "specific_backup"
ase_backup_files
Array of strings

When using the specific_backup sync_strategy, determines the backup files. (ASE Only)

mssql_backup_uuid
string [ 1 .. 4096 ] characters

When using the specific_backup sync_strategy, determines the Backup Set UUID. (MSSql only)

compression_enabled
boolean

When using the new_backup sync_strategy, determines if compression must be enabled. Defaults to the configuration of the ingestion strategy configured on the Delphix Engine for this dSource. (MSSql only)

availability_group_backup_policy
string

When using the new_backup sync_strategy for an MSSql Availability Group, determines the backup policy:

  • primary - Backups only go to the primary node.
  • secondary_only - Backups only go to secondary nodes. If secondary nodes are down, backups will fail.
  • prefer_secondary - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. (MSSql only)
Enum: "primary" "secondary_only" "prefer_secondary"
do_not_resume
boolean

Indicates whether a fresh SnapSync must be started regardless if it was possible to resume the current SnapSync. If true, we will not resume but instead ignore previous progress and backup all datafiles even if already completed from previous failed SnapSync. This does not force a full backup, if an incremental was in progress this will start a new incremental snapshot. (Oracle only)

double_sync
boolean

Indicates whether two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. (Oracle only).

force_full_backup
boolean

Whether or not to take another full backup of the source database. (Oracle only)

skip_space_check
boolean

Skip check that tests if there is enough space available to store the database in the Delphix Engine. The Delphix Engine estimates how much space a database will occupy after compression and prevents SnapSync if insufficient space is available. This safeguard can be overridden using this option. This may be useful when linking highly compressible databases. (Oracle only)

files_for_partial_full_backup
Array of integers <int64> [ 1 .. 10000 ] items

List of datafiles to take a full backup of. This would be useful in situations where certain datafiles could not be backed up during previous SnapSync due to corruption or because they went offline. (Oracle only)

object or null

The list of parameters specified by the snapshotParametersDefinition schema in the toolkit (AppData only).

Responses
200

dSource snapshot initiated.

post/dsources/{dsourceId}/snapshots
Request samples
application/json

This request example does not set any property and will thus use the default behavior.

{ }
Response samples
application/json
{
  • "job": {
    }
}

Get deletion dependencies for a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Responses
200

Deletion dependencies of a dSource.

get/dsources/{dsourceId}/deletion-dependencies
Response samples
application/json
{
  • "items": [
    ]
}

Get tags for a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Responses
200

Created

get/dsources/{dsourceId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

Tags information for DSource.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Ok

post/dsources/{dsourceId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a dSource.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/dsources/{dsourceId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Export a dSource by a snapshot to an ASM file system

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

default_data_diskgroup
required
string

Default diskgroup for datafiles.

redo_diskgroup
string

Diskgroup for archive logs. Optional as it is not required for PDB databases.

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

snapshot_id
string

The ID of the snapshot from which to execute the operation. If snapshot_id is not provided, the latest snapshot will be selected.

Responses
200

DSource export using snapshot to Oracle ASM initiated.

post/dsources/{dsourceId}/asm-export-by-snapshot
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "default_data_diskgroup": "+DATA",
  • "redo_diskgroup": "+REDO",
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "snapshot_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Export a dSource using snapshot to a physical file system

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

targetDirectory
string

The base directory to use for the exported database.

dataDirectory
string

The directory for data files.

archiveDirectory
string

The directory for archive files.

externalDirectory
string

The directory for external files.

tempDirectory
string

The directory for temporary files.

scriptDirectory
string

The directory for script files.

useAbsolutePathForDataFiles
boolean

Whether to use absolute path for data files (Oracle only).

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

snapshot_id
string

The ID of the snapshot from which to execute the operation. If snapshot_id is not provided, the latest snapshot will be selected.

Responses
200

dSource export using snapshot to a physical file system initiated.

post/dsources/{dsourceId}/export-by-snapshot
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "targetDirectory": "/work/v2pdb",
  • "dataDirectory": "/work/v2pdb/data",
  • "archiveDirectory": "/work/v2pdb/archive",
  • "externalDirectory": "/work/v2pdb/external",
  • "tempDirectory": "/work/v2pdb/temp",
  • "scriptDirectory": "/work/v2pdb/script",
  • "useAbsolutePathForDataFiles": false,
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "snapshot_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Export a dSource using SCN to an ASM file system

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

default_data_diskgroup
required
string

Default diskgroup for datafiles.

redo_diskgroup
string

Diskgroup for archive logs. Optional as it is not required for PDB databases.

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

location
required
string [ 1 .. 256 ] characters

The SCN value in the snapshot to perform the export from this SCN location.

Responses
200

DSource export using SCN to Oracle ASM initiated.

post/dsources/{dsourceId}/asm-export-by-location
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "default_data_diskgroup": "+DATA",
  • "redo_diskgroup": "+REDO",
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "location": "112233"
}
Response samples
application/json
{
  • "job": {
    }
}

Export a dSource using bookmark to an ASM file system

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

default_data_diskgroup
required
string

Default diskgroup for datafiles.

redo_diskgroup
string

Diskgroup for archive logs. Optional as it is not required for PDB databases.

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

bookmark_id
required
string [ 1 .. 256 ] characters

The ID of the bookmark from which to execute the operation.

Responses
200

DSource export using bookmark to Oracle ASM initiated.

post/dsources/{dsourceId}/asm-export-from-bookmark
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "default_data_diskgroup": "+DATA",
  • "redo_diskgroup": "+REDO",
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "bookmark_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Export a dSource using bookmark to physical file system

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

targetDirectory
string

The base directory to use for the exported database.

dataDirectory
string

The directory for data files.

archiveDirectory
string

The directory for archive files.

externalDirectory
string

The directory for external files.

tempDirectory
string

The directory for temporary files.

scriptDirectory
string

The directory for script files.

useAbsolutePathForDataFiles
boolean

Whether to use absolute path for data files (Oracle only).

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

bookmark_id
required
string [ 1 .. 256 ] characters

The ID of the bookmark from which to execute the operation.

Responses
200

DSource export using bookmark to physical file system initiated.

post/dsources/{dsourceId}/export-from-bookmark
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "targetDirectory": "/work/v2pdb",
  • "dataDirectory": "/work/v2pdb/data",
  • "archiveDirectory": "/work/v2pdb/archive",
  • "externalDirectory": "/work/v2pdb/external",
  • "tempDirectory": "/work/v2pdb/temp",
  • "scriptDirectory": "/work/v2pdb/script",
  • "useAbsolutePathForDataFiles": false,
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "bookmark_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Export a dSource using timestamp to an ASM file system

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

default_data_diskgroup
required
string

Default diskgroup for datafiles.

redo_diskgroup
string

Diskgroup for archive logs. Optional as it is not required for PDB databases.

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

timeflow_id
required
string

The Timeflow ID.

timestamp
required
string <date-time>

The timestamp at which to execute the operation.

Responses
200

DSource export using timestamp to Oracle ASM initiated.

post/dsources/{dsourceId}/asm-export-by-timestamp
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "default_data_diskgroup": "+DATA",
  • "redo_diskgroup": "+REDO",
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "timeflow_id": "1-ORACLE_TIMEFLOW-2",
  • "timestamp": "2025-01-31T08:51:34.148Z"
}
Response samples
application/json
{
  • "job": {
    }
}

Export a dSource using timestamp to a physical file system.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

targetDirectory
string

The base directory to use for the exported database.

dataDirectory
string

The directory for data files.

archiveDirectory
string

The directory for archive files.

externalDirectory
string

The directory for external files.

tempDirectory
string

The directory for temporary files.

scriptDirectory
string

The directory for script files.

useAbsolutePathForDataFiles
boolean

Whether to use absolute path for data files (Oracle only).

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

timeflow_id
required
string

The Timeflow ID.

timestamp
required
string <date-time>

The timestamp at which to execute the operation.

Responses
200

DSource export using timestamp to a physical file system initiated.

post/dsources/{dsourceId}/export-by-timestamp
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "targetDirectory": "/work/v2pdb",
  • "dataDirectory": "/work/v2pdb/data",
  • "archiveDirectory": "/work/v2pdb/archive",
  • "externalDirectory": "/work/v2pdb/external",
  • "tempDirectory": "/work/v2pdb/temp",
  • "scriptDirectory": "/work/v2pdb/script",
  • "useAbsolutePathForDataFiles": false,
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "timeflow_id": "1-ORACLE_TIMEFLOW-2",
  • "timestamp": "2025-01-31T08:51:34.148Z"
}
Response samples
application/json
{
  • "job": {
    }
}

Export a dSource using timeflow location to a physical file system.

SecurityApiKeyAuth
Request
path Parameters
dsourceId
required
string non-empty

The ID of the dSource.

Request Body schema: application/json
required

The parameters to export a dSource.

unique_name
string

The unique name of the database.

database_name
string

The name of the database.

repository_id
string

The repository_id to use for this operation.

environment_user_ref
string

The environment user reference.

tde_keystore_password
string

The password for the Transparent Data Encryption keystore associated with this database.

tde_keystore_config_type
string (OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum: "FILE" "OKV" "HSM" "OKV|FILE" "FILE|OKV" "HSM|FILE" "FILE|HSM"
oracle_instance_name
string [ 1 .. 15 ] characters ^[a-zA-Z0-9_]+$

SID of the exported database

instance_number
integer <int32>

The number of the instance.

Array of objects (OracleRACDatabaseInstance)
mount_base
string

The base mount point to use for the NFS mounts for the temporary VDB.

object or null

Database configuration parameter overrides.

cdb_id
string

ID of an Oracle multitenant database this pluggable database belongs to.

parent_tde_keystore_path
string

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host.

parent_tde_keystore_password
string

The password of the keystore specified in parentTdeKeystorePath.

tde_exported_keyfile_secret
string

Secret to be used while exporting and importing vPDB encryption keys.

tde_key_identifier
string

Virtual database master encryption key id, as recorded in v$encryption_keys.key_id.

crs_database_name
string

The Oracle Clusterware database name.

targetDirectory
string

The base directory to use for the exported database.

dataDirectory
string

The directory for data files.

archiveDirectory
string

The directory for archive files.

externalDirectory
string

The directory for external files.

tempDirectory
string

The directory for temporary files.

scriptDirectory
string

The directory for script files.

useAbsolutePathForDataFiles
boolean

Whether to use absolute path for data files (Oracle only).

rman_channels
integer [ 1 .. 32 ]
Default: 8

Number of data streams to connect to the database.

rman_file_section_size_in_gb
integer
Default: 0

Number of GigaBytes in which RMAN will break large files to back them in parallel.

location
required
string [ 1 .. 256 ] characters

The timeflow point location to execute the operation.

Responses
200

DSource export using timeflow location to a physical file system initiated.

post/dsources/{dsourceId}/export-by-location
Request samples
application/json
{
  • "unique_name": "DBOMSRBBDC6C",
  • "database_name": "DBOMSRBB",
  • "repository_id": "1-ORACLE_INSTALL-1",
  • "environment_user_ref": "HOST_USER-10",
  • "tde_keystore_password": "password",
  • "tde_keystore_config_type": "FILE",
  • "oracle_instance_name": "DBOMSRBBDC6C",
  • "instance_number": 1,
  • "instances": [
    ],
  • "mount_base": "/tmp/provision",
  • "config_params": {
    },
  • "cdb_id": "CDOMLOSRB5A3",
  • "parent_tde_keystore_path": "/work/tde/parent_keystore",
  • "parent_tde_keystore_password": "password",
  • "tde_exported_keyfile_secret": "secret",
  • "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  • "crs_database_name": "DBOMSR9051BF",
  • "targetDirectory": "/work/v2pdb",
  • "dataDirectory": "/work/v2pdb/data",
  • "archiveDirectory": "/work/v2pdb/archive",
  • "externalDirectory": "/work/v2pdb/external",
  • "tempDirectory": "/work/v2pdb/temp",
  • "scriptDirectory": "/work/v2pdb/script",
  • "useAbsolutePathForDataFiles": false,
  • "rman_channels": 8,
  • "rman_file_section_size_in_gb": 0,
  • "location": "112233"
}
Response samples
application/json
{
  • "job": {
    }
}
➔ Next to KerberosConfig