Skip to content
/
Export a vdb using timest...

Export a vdb using timestamp to a physical file system

Request

Security
ApiKeyAuth
Path
vdbIdstring, non-emptyrequired

The ID of the VDB.

Bodyapplication/jsonrequired

The parameters to export a vdb.

unique_namestring

The unique name of the database.

Example:"DBOMSRBBDC6C"
database_namestring

The name of the database.

Example:"DBOMSRBB"
repository_idstring

The repository_id to use for this operation.

Example:"1-ORACLE_INSTALL-1"
environment_user_refstring

The environment user reference.

Example:"HOST_USER-10"
tde_keystore_config_typestring(OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum:"FILE""OKV""HSM""OKV|FILE""FILE|OKV""HSM|FILE""FILE|HSM""OCI_VAULT""UNSET"
oracle_instance_namestring, [ 1 .. 15 ] characters^[a-zA-Z0-9_]+$

SID of the exported database

Example:"DBOMSRBBDC6C"
instance_numberinteger, (int32)

The number of the instance.

Example:1
instancesArray of objects(OracleRACDatabaseInstance)
mount_basestring

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

Example:"/tmp/provision"
config_paramsobject or null

Database configuration parameter overrides.

Example:
{
  "param": "value",
  "param2": "value2"
}
cdb_idstring

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

Example:"CDOMLOSRB5A3"
parent_tde_keystore_pathstring

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

Example:"/work/tde/parent_keystore"
parent_tde_keystore_passwordstring

The password of the keystore specified in parentTdeKeystorePath.

Example:"password"
tde_exported_keyfile_secretstring

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

Example:"secret"
tde_key_identifierstring

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

Example:"Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
parent_pdb_tde_keystore_pathstring, [ 1 .. 512 ] characters

Path to a copy of the parent PDB's Oracle transparent data encryption keystore on the target host. Required to export of PDB containing encrypted database files with isolated mode keystore.(Oracle Multitenant Only)

Example:"/work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde"
parent_pdb_tde_keystore_passwordstring, [ 1 .. 128 ] characters

The password of the parent PDB keystore. (Oracle Multitenant Only)

Example:"password"
target_pdb_tde_keystore_passwordstring, [ 1 .. 128 ] characters

The password for the isolated mode TDE keystore of the target PDB. (Oracle Multitenant Only)

Example:"password"
crs_database_namestring

The Oracle Clusterware database name.

Example:"DBOMSR9051BF"
recover_databaseboolean

If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point.

Default:true
Example:true
file_mapping_rulesstring

Database file mapping rules.

enable_cdcboolean

Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only).

Default:false
Example:false
recovery_modelstring

Recovery model of the database (MSSql Only).

Default:"FULL"
Enum:"FULL""SIMPLE""BULK_LOGGED"
Example:"FULL"
mirroring_statestring

Recovery model of the database (MSSql Only).

Default:"NONE"
Enum:"SUSPENDED""DISCONNECTED""SYNCHRONIZING""PENDING_FAILOVER""SYNCHRONIZED""NOT_SYNCHRONIZED""FAILOVER_POSSIBLE""NONE"
Example:"SUSPENDED"
is_incremental_v2pboolean

Whether to enable incremental V2P (Virtual to Physical) export. When enabled, the export will be configured for incremental backups.

Example:false
backup_frequency_minutesinteger, (int32), >= 10

The frequency with which the incremental backup will be taken in minutes.

Default:30
Example:30
rman_channels_for_incremental_backupinteger, (int32), [ 1 .. 255 ]

Number of data streams to connect to the database for incremental backup.

Default:8
Example:4
rman_files_per_set_for_incremental_backupinteger, (int32), [ 1 .. 64 ]

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

Default:5
Example:8
rman_file_section_size_in_gb_for_incremental_backupinteger, (int32), >= 0

Number of GigaBytes in which RMAN will break large files to back them up in parallel for incremental backup.

Default:0
Example:0
invoke_datapatchboolean

Indicates whether to invoke Oracle's datapatch utility during post recovery step of exportFinalize. Requires Delphix engine version 2025.6.0.0 (API version 1.11.46) or later.

Default:false
Example:false
appdata_v2p_paramsobject or null

The JSON payload conforming to the DraftV4 schema defined in the toolkit's virtualToPhysicalDefinition. Maps to AppDataExportParameters.parameters on the Delphix engine.

Example:
{
  "targetDir": "/mnt/physical",
  "option": "value"
}
appdata_config_paramsobject or null

The parameters specified by the source config schema in the toolkit. Maps to AppDataSourceConfig.parameters on the Delphix engine.

Example:
{
  "dbName": "mydb",
  "port": 5432
}
targetDirectorystring

The base directory to use for the exported database.

Example:"/work/v2pdb"
dataDirectorystring

The directory for data files.

Example:"/work/v2pdb/data"
archiveDirectorystring

The directory for archive files.

Example:"/work/v2pdb/archive"
externalDirectorystring

The directory for external files.

Example:"/work/v2pdb/external"
tempDirectorystring

The directory for temporary files.

Example:"/work/v2pdb/temp"
scriptDirectorystring

The directory for script files.

Example:"/work/v2pdb/script"
useAbsolutePathForDataFilesboolean

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

Example:false
rman_channelsinteger, [ 1 .. 32 ]

Number of data streams to connect to the database.

Default:8
rman_file_section_size_in_gbinteger

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

Default:0
timeflow_idstringrequired

The Timeflow ID.

Example:"1-ORACLE_TIMEFLOW-2"
timestampstring, (date-time)required

The timestamp at which to execute the operation.

Example:"2025-01-31T08:51:34.148Z"
tde_keystore_passwordstringdeprecated

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

Example:"password"
curl -i -X POST \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2026.5.0.0/continuous-data-apis-dct-2026.5.0.0/vdbs/{vdbId}/export-by-timestamp' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
      {
        "instance_name": "string",
        "instance_number": 1,
        "node_reference": "string",
        "okv_client_id": "1-ORACLE_OKV_CLIENT-1"
      }
    ],
    "mount_base": "/tmp/provision",
    "config_params": {
      "param": "value",
      "param2": "value2"
    },
    "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",
    "parent_pdb_tde_keystore_path": "/work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde",
    "parent_pdb_tde_keystore_password": "password",
    "target_pdb_tde_keystore_password": "password",
    "crs_database_name": "DBOMSR9051BF",
    "recover_database": true,
    "file_mapping_rules": "string",
    "enable_cdc": false,
    "recovery_model": "FULL",
    "mirroring_state": "SUSPENDED",
    "is_incremental_v2p": false,
    "backup_frequency_minutes": 30,
    "rman_channels_for_incremental_backup": 4,
    "rman_files_per_set_for_incremental_backup": 8,
    "rman_file_section_size_in_gb_for_incremental_backup": 0,
    "invoke_datapatch": false,
    "appdata_v2p_params": {
      "targetDir": "/mnt/physical",
      "option": "value"
    },
    "appdata_config_params": {
      "dbName": "mydb",
      "port": 5432
    },
    "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"
  }'

Responses

VDB export using timestamp to a physical file system initiated.

Bodyapplication/json
jobobject(Job)

An asynchronous task.

Response
{
  "job": {
    "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",
    "work_source_id": "string",
    "work_source_name": "string",
    "work_source_type": "DIRECT",
    "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",
    "compliance_node_id": "string",
    "compliance_node_name": "string",
    "percent_complete": 50,
    "virtualization_tasks": [ … ],
    "tasks": [ … ],
    "execution_id": "string",
    "result_type": "string",
    "result": {},
    "parent_job_id": "string"
  }
}