# Export a dSource using timestamp to a physical file system.

Endpoint: POST /dsources/{dsourceId}/export-by-timestamp
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Path parameters:

  - `dsourceId` (string, required)
    The ID of the dSource.

## Request body:

  - `application/json` (unknown)
    The parameters to export a dSource.

## Request fields (application/json):

  - `unique_name` (string)
    The unique name of the database.
    Example: DBOMSRBBDC6C

  - `database_name` (string)
    The name of the database.
    Example: DBOMSRBB

  - `repository_id` (string)
    The repository_id to use for this operation.
    Example: 1-ORACLE_INSTALL-1

  - `environment_user_ref` (string)
    The environment user reference.
    Example: HOST_USER-10

  - `tde_keystore_password` (string)
    The password for the Transparent Data Encryption keystore associated with this database.
    Example: password

  - `tde_keystore_config_type` (string)
    Oracle TDE keystore configuration type.
    Enum: "FILE", "OKV", "HSM", "OKV|FILE", "FILE|OKV", "HSM|FILE", "FILE|HSM", "OCI_VAULT", "UNSET"

  - `oracle_instance_name` (string)
    SID of the exported database
    Example: DBOMSRBBDC6C

  - `instance_number` (integer)
    The number of the instance.
    Example: 1

  - `instances` (array)

  - `instances.instance_name` (string, required)
    The name of this instance. Must contain at least one non-whitespace character.

  - `instances.instance_number` (integer, required)
    The number of this instance.

  - `instances.node_reference` (string, required)
    The reference to the cluster node which the instance is running on. Must contain at least one non-whitespace character.

  - `instances.okv_client_id` (string)
    The id of the OKV client used for TDE keystore access. If provided, it must include at least one non-whitespace character; if omitted, the existing OKV client will be cleared.
    Example: 1-ORACLE_OKV_CLIENT-1

  - `mount_base` (string)
    The base mount point to use for the NFS mounts for the temporary VDB.
    Example: /tmp/provision

  - `config_params` (object)
    Database configuration parameter overrides.
    Example: {"param":"value","param2":"value2"}

  - `cdb_id` (string)
    ID of an Oracle multitenant database this pluggable database belongs to.
    Example: CDOMLOSRB5A3

  - `parent_tde_keystore_path` (string)
    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_password` (string)
    The password of the keystore specified in parentTdeKeystorePath.
    Example: password

  - `tde_exported_keyfile_secret` (string)
    Secret to be used while exporting and importing vPDB encryption keys.
    Example: secret

  - `tde_key_identifier` (string)
    PDB database master encryption key id, as recorded in v$encryption_keys.key_id.
    Example: Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

  - `parent_pdb_tde_keystore_path` (string)
    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_password` (string)
    The password of the parent PDB keystore. (Oracle Multitenant Only)
    Example: password

  - `target_pdb_tde_keystore_password` (string)
    The password for the isolated mode TDE keystore of the target PDB. (Oracle Multitenant Only)
    Example: password

  - `crs_database_name` (string)
    The Oracle Clusterware database name.
    Example: DBOMSR9051BF

  - `recover_database` (boolean)
    If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point.
    Example: true

  - `file_mapping_rules` (string)
    Database file mapping rules.

  - `enable_cdc` (boolean)
    Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only).
    Example: false

  - `recovery_model` (string)
    Recovery model of the database (MSSql Only).
    Enum: "FULL", "SIMPLE", "BULK_LOGGED"

  - `mirroring_state` (string)
    Recovery model of the database (MSSql Only).
    Enum: "SUSPENDED", "DISCONNECTED", "SYNCHRONIZING", "PENDING_FAILOVER", "SYNCHRONIZED", "NOT_SYNCHRONIZED", "FAILOVER_POSSIBLE", "NONE"

  - `is_incremental_v2p` (boolean)
    Whether to enable incremental V2P (Virtual to Physical) export. When enabled, the export will be configured for incremental backups.
    Example: false

  - `backup_frequency_minutes` (integer)
    The frequency with which the incremental backup will be taken in minutes.
    Example: 30

  - `rman_channels_for_incremental_backup` (integer)
    Number of data streams to connect to the database for incremental backup.
    Example: 4

  - `rman_files_per_set_for_incremental_backup` (integer)
    Number of data files to include in each RMAN backup set for incremental backup.
    Example: 8

  - `rman_file_section_size_in_gb_for_incremental_backup` (integer)
    Number of GigaBytes in which RMAN will break large files to back them up in parallel for incremental backup.
    Example: 0

  - `invoke_datapatch` (boolean)
    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.
    Example: false

  - `appdata_v2p_params` (object)
    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_params` (object)
    The parameters specified by the source config schema in the toolkit. Maps to AppDataSourceConfig.parameters on the Delphix engine.
    Example: {"dbName":"mydb","port":5432}

  - `targetDirectory` (string)
    The base directory to use for the exported database.
    Example: /work/v2pdb

  - `dataDirectory` (string)
    The directory for data files.
    Example: /work/v2pdb/data

  - `archiveDirectory` (string)
    The directory for archive files.
    Example: /work/v2pdb/archive

  - `externalDirectory` (string)
    The directory for external files.
    Example: /work/v2pdb/external

  - `tempDirectory` (string)
    The directory for temporary files.
    Example: /work/v2pdb/temp

  - `scriptDirectory` (string)
    The directory for script files.
    Example: /work/v2pdb/script

  - `useAbsolutePathForDataFiles` (boolean)
    Whether to use absolute path for data files (Oracle only).
    Example: false

  - `rman_channels` (integer)
    Number of data streams to connect to the database.

  - `rman_file_section_size_in_gb` (integer)
    Number of GigaBytes in which RMAN will break large files to back them in parallel.

  - `timeflow_id` (string, required)
    The Timeflow ID.
    Example: 1-ORACLE_TIMEFLOW-2

  - `timestamp` (string, required)
    The timestamp at which to execute the operation.
    Example: 2025-01-31T08:51:34.148Z

## Response 200:

  - `200` (unknown)
    DSource export using timestamp to a physical file system initiated.

## Response 200 fields (application/json):

  - `job` (object)
    An asynchronous task.

  - `job.id` (string)
    The Job entity ID.
    Example: job-123

  - `job.status` (string)
    The status of the job.
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.is_waiting_for_telemetry` (boolean)
    Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.

  - `job.type` (string)
    The type of job being done.
    Example: DB_REFRESH

  - `job.localized_type` (string)
    The i18n translated type of job being done.
    Example: DB Refresh

  - `job.error_details` (string)
    Details about the failure for FAILED jobs.
    Example: Unable to connect to the engine.

  - `job.warning_message` (string)
    Warnings for the job.
    Example: Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.

  - `job.target_id` (string)
    A reference to the job's target.
    Example: vdb-123

  - `job.target_name` (string)
    A reference to the job's target name.
    Example: vdb

  - `job.work_source_id` (string)
    The ID of the entity that initiated this job (e.g. a policy ID), if applicable.

  - `job.work_source_name` (string)
    The name of the entity that initiated this job, if applicable.

  - `job.work_source_type` (string)
    The origin of the operation that created this job. Null for DCT-initiated operations (attributed via account_id). DIRECT means the action was performed directly on the engine, bypassing DCT; POLICY means an automated policy triggered it; SYSTEM means it was engine-internal.
    Enum: "DIRECT", "POLICY", "SYSTEM"

  - `job.start_time` (string)
    The time the job started executing.
    Example: 2022-01-02T05:11:24.148Z

  - `job.update_time` (string)
    The time the job was last updated.
    Example: 2022-01-02T06:11:24.148Z

  - `job.trace_id` (string)
    traceId of the request which created this Job

  - `job.engine_ids` (array)
    IDs of the engines this Job is executing on.

  - `job.tags` (array)

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

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

  - `job.engines` (array)

  - `job.engines.engine_id` (string)

  - `job.engines.engine_name` (string)

  - `job.account_id` (integer)
    The ID of the account who initiated this job.
    Example: 1

  - `job.account_name` (string)
    The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-.
    Example: User 1

  - `job.compliance_node_id` (string)
    The ID of the associated compliance node, if applicable.

  - `job.compliance_node_name` (string)
    The name of the associated compliance node, if applicable.

  - `job.percent_complete` (integer)
    Completion percentage of the Job.
    Example: 50

  - `job.virtualization_tasks` (array)

  - `job.virtualization_tasks.id` (string)

  - `job.virtualization_tasks.parent_job_id` (string)

  - `job.virtualization_tasks.start_time` (string)

  - `job.virtualization_tasks.end_time` (string)

  - `job.virtualization_tasks.title` (string)

  - `job.virtualization_tasks.percent_complete` (integer)

  - `job.virtualization_tasks.events` (array)

  - `job.virtualization_tasks.events.message_details` (string)

  - `job.virtualization_tasks.events.message_action` (string)

  - `job.virtualization_tasks.events.message_command_output` (string)

  - `job.virtualization_tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.tasks` (array)

  - `job.tasks.id` (string)

  - `job.tasks.parent_job_id` (string)

  - `job.tasks.start_time` (string)

  - `job.tasks.end_time` (string)

  - `job.tasks.title` (string)

  - `job.tasks.percent_complete` (integer)

  - `job.tasks.events` (array)

  - `job.tasks.events.message_details` (string)

  - `job.tasks.events.message_action` (string)

  - `job.tasks.events.message_command_output` (string)

  - `job.tasks.events.timestamp` (string)
    When this specific event occurred. Absent/null for events persisted before this field was added (no backfill) and for any producer not yet updated to set it.

  - `job.tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.execution_id` (string)
    The ID of the associated masking execution, if any.

  - `job.result_type` (string)
    The type of the job result. This is the type of the object present in the result.

  - `job.result` (object)
    The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.

  - `job.parent_job_id` (string)
    The ID of the parent job, if this job was triggered by another job.