Skip to content
/
Attach an Oracle CDB to a...

Attach an Oracle CDB to an Oracle database.
deprecated

Request

Security
ApiKeyAuth
Path
cdbIdstring, non-emptyrequired

The ID of the CDB.

Bodyapplication/jsonrequired

The parameters to attach an Oracle CDB.

backup_level_enabledboolean

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

bandwidth_limitinteger

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

Default:0
check_logicalboolean

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

Default:false
compressed_linking_enabledboolean

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.

Default:true
double_syncboolean

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.

Default:false
encrypted_linking_enabledboolean

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.

Default:false
environment_userstring

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

external_file_pathstring, <= 1024 characters

External file path.

files_per_setinteger, [ 1 .. 64 ]

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

Default:5
forceboolean

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

Default:false
number_of_connectionsinteger

Total number of transport connections to use during SnapSync.

Default:1
operationsArray of objects(SourceOperation)

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

oracle_fallback_userstring, [ 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.

Example:"oracle"
oracle_fallback_credentialsstring, [ 1 .. 256 ] characters

Password for fallback username.

Example:"oracle"
rman_channelsinteger, [ 1 .. 32 ]

Number of parallel channels to use.

Default:2
dsource_idstring, [ 1 .. 256 ] charactersrequired

Id of the dsource to attach.

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/cdbs/{cdbId}/attachSource' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
      {
        "name": "string",
        "command": "string",
        "shell": "bash",
        "credentials_env_vars": [
          {
            "base_var_name": "string",
            "password": "password",
            "vault_username": "my-vault",
            "vault": "1-VAULT-1",
            "hashicorp_vault_engine": "kv",
            "hashicorp_vault_secret_path": "oracle-env",
            "hashicorp_vault_username_key": "username",
            "hashicorp_vault_secret_key": "secret",
            "azure_vault_name": "azure_vault",
            "azure_vault_username_key": "username",
            "azure_vault_secret_key": "secret",
            "cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
            "credential_type": "PasswordCredential",
            "element_id": "35",
            "type": "CredentialsEnvVars"
          }
        ],
        "hook_template_id": "string"
      }
    ],
    "oracle_fallback_user": "oracle",
    "oracle_fallback_credentials": "oracle",
    "rman_channels": 2,
    "dsource_id": "string"
  }'

Responses

OK

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"
  }
}