Skip to content
/
Migrate a VDB.

Migrate a VDB.

Request

Security
ApiKeyAuth
Path
vdbIdstring, non-emptyrequired

The ID of the VDB.

Bodyapplication/json

The parameters to migrate a VDB.

environment_idstring

Id of the environment.

Example:"1-UNIX_HOST_ENVIRONMENT-2"
environment_user_refstring

Reference of the environment user.

Example:"HOST_USER-10"
repository_idstring

Id of the environment repository.

Example:"1-ORACLE_INSTALL-10"
cdb_idstring

Id of the container database.

Example:"1-ORACLE_SINGLE_CONFIG-12"
cluster_node_idsArray of strings, non-empty

The cluster node ids, name or addresses for this migrate operation (Oracle RAC Only).

Example:
[
  "ORACLE_CLUSTER_NODE-1"
]
cluster_node_instancesArray of objects, non-empty(ClusterNodeInstance)

The cluster node instances details for this migrate operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids.

Example:
[
  {
    "node_reference": "ORACLE_CLUSTER_NODE-1",
    "instance_number": 1,
    "instance_name": "cluster_instance1"
  }
]
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}/migrate' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "environment_id": "1-UNIX_HOST_ENVIRONMENT-2",
    "environment_user_ref": "HOST_USER-10",
    "repository_id": "1-ORACLE_INSTALL-10",
    "cdb_id": "1-ORACLE_SINGLE_CONFIG-12",
    "cluster_node_ids": [
      "ORACLE_CLUSTER_NODE-1"
    ],
    "cluster_node_instances": [
      {
        "node_reference": "ORACLE_CLUSTER_NODE-1",
        "instance_number": 1,
        "instance_name": "cluster_instance1"
      }
    ]
  }'

Responses

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