Skip to content
/
Update values of a VDB

Update values of a VDB

Request

Security
ApiKeyAuth
Path
vdbIdstring, non-emptyrequired

The ID of the VDB.

Bodyapplication/json

The new data to update a VDB.

namestring, [ 1 .. 256 ] characters

The unique name of the VDB within a group.

Example:"my-vdb"
descriptionstring

The container description of this VDB.

Example:"Updated VDB description."
db_usernamestring, [ 1 .. 256 ] characters

The username of the database user (Oracle, ASE Only).

Example:"db-username"
db_passwordstring, [ 1 .. 256 ] characters

The password of the database user (Oracle, ASE Only).

Example:"db-password"
validate_db_credentialsboolean

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

Default:true
Example:true
auto_restartboolean

Whether to enable VDB restart.

environment_user_idstring, [ 1 .. 256 ] characters

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

Example:"environment-user-123"
template_idstring, <= 256 characters

The ID of the target VDB Template (Oracle and MSSql Only).

Example:"template-123"
listener_idsArray of strings

The listener IDs for this provision operation (Oracle Only).

Example:
[
  "listener-123",
  "listener-456"
]
new_dbidboolean

Whether to enable new DBID for Oracle

cdc_on_provisionboolean

Whether to enable CDC on provision for MSSql

pre_scriptstring, [ 1 .. 1024 ] characters

Pre script for MSSql.

post_scriptstring, [ 1 .. 1024 ] characters

Post script for MSSql.

hooksobject(VirtualDatasetHooks)

VDB operation hooks.

custom_env_varsobject

Environment variable to be set when the engine administers a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled.

Example:
{
  "MY_ENV_VAR1": "$ORACLE_HOME",
  "MY_ENV_VAR2": "$CRS_HOME/after"
}
custom_env_filesArray of strings

Environment files to be sourced when the Engine administers a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled.

Example:
[
  "/export/home/env_file_1",
  "/export/home/env_file_2"
]
oracle_rac_custom_env_filesArray of objects(OracleRacCustomEnvFile)

Environment files to be sourced when the Engine administers an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled.

Example:
[
  {
    "node_id": "ORACLE_CLUSTER_NODE-1",
    "path_parameters": "/export/home/env_file_1"
  }
]
oracle_rac_custom_env_varsArray of objects(OracleRacCustomEnvVar)

Environment variable to be set when the engine administers an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled.

Example:
[
  {
    "node_id": "ORACLE_CLUSTER_NODE-1",
    "name": "MY_ENV_VAR1",
    "value": "$CRS_HOME/after"
  }
]
parent_tde_keystore_pathstring, [ 1 .. 1024 ] characters

Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)

Example:"/foo/bar/tde"
parent_tde_keystore_passwordstring, [ 1 .. 1024 ] characters

The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)

Example:"password"
tde_key_identifierstring, [ 1 .. 256 ] characters

ID of the key created by Delphix. (Oracle Multitenant Only)

Example:"tde-indentifier"
target_vcdb_tde_keystore_pathstring, [ 1 .. 1024 ] characters

Path to the keystore of the target vCDB. (Oracle Multitenant Only)

Example:"/foo/cdb/tde"
cdb_tde_keystore_passwordstring, [ 1 .. 1024 ] characters

The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)

Example:"cdb-password"
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 provision from snapshots 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 virtual PDB. (Oracle Multitenant Only)

Example:"password"
appdata_source_paramsobject

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

Example:
{
  "param": "value"
}
additional_mount_pointsArray of objects(AdditionalMountPoint)

Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled.

Example:
[
  {
    "shared_path": "/",
    "mount_path": "/work",
    "environment_id": "environment-123"
  }
]
appdata_config_paramsobject

The parameters specified by the source config schema in the toolkit

Example:
{
  "option": "value"
}
config_paramsobject

Database configuration parameter overrides.

Example:
{
  "processes": 150
}
mount_pointstring

Mount point for the VDB (AppData only), can only be updated while the VDB is disabled.

Example:"/var/mnt"
oracle_servicesArray of strings

List of jdbc connection strings which are used to connect with the database.

Example:
[
  "jdbc:oracle:thin:@hostname:port/service_name",
  "jdbc:oracle:thin:@hostname:port:SID"
]
instancesArray of objects(OracleRACDatabaseInstance)

The instances of this RAC database.

Example:
[
  {
    "instance_name": "instance1",
    "instance_number": 1,
    "node_reference": "ORACLE_CLUSTER_NODE-1"
  }
]
invoke_datapatchboolean

Indicates whether datapatch should be invoked.

mssql_ag_backup_locationstring

Shared backup location to be used for VDB provision on AG Cluster.

Example:"shared_backup_location/location1"
mssql_ag_backup_basedboolean

Indicates whether to do fast operations for VDB on AG which will use a healthy secondary replica to recreate the AG or backup based operations which will use the primary replica to recreate the AG using backup and restore process.

Example:true
cache_prioritystring

When set to a value other than NORMAL (valid only for object storage engines) the engine will aggressively cache required data to ensure improved performance.

Enum:"NORMAL""HIGH"
Example:"HIGH"
mssql_incremental_export_backup_frequency_minutesinteger, >= 10

Frequency in minutes for incremental export backups for VDBs.

Example:30
database_namestring, [ 1 .. 256 ] characters

The name of the database in the target environment (update not applicable for Oracle or AppData VDBs).

Example:"my-test-database"
curl -i -X PATCH \
  '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}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-vdb",
    "description": "Updated VDB description.",
    "db_username": "db-username",
    "db_password": "db-password",
    "validate_db_credentials": true,
    "auto_restart": true,
    "environment_user_id": "environment-user-123",
    "template_id": "template-123",
    "listener_ids": [
      "listener-123",
      "listener-456"
    ],
    "new_dbid": true,
    "cdc_on_provision": true,
    "pre_script": "string",
    "post_script": "string",
    "hooks": {
      "pre_refresh": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "post_refresh": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "pre_self_refresh": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "post_self_refresh": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "pre_rollback": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "post_rollback": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "configure_clone": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "pre_snapshot": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "post_snapshot": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "pre_start": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "post_start": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "pre_stop": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ],
      "post_stop": [
        {
          "name": "Print the current user",
          "command": "whoami",
          "shell": "bash",
          "element_id": "3",
          "has_credentials": false,
          "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": "Hook Template 1"
        }
      ]
    },
    "custom_env_vars": {
      "MY_ENV_VAR1": "$ORACLE_HOME",
      "MY_ENV_VAR2": "$CRS_HOME/after"
    },
    "custom_env_files": [
      "/export/home/env_file_1",
      "/export/home/env_file_2"
    ],
    "oracle_rac_custom_env_files": [
      {
        "node_id": "ORACLE_CLUSTER_NODE-1",
        "path_parameters": "/export/home/env_file_1"
      }
    ],
    "oracle_rac_custom_env_vars": [
      {
        "node_id": "ORACLE_CLUSTER_NODE-1",
        "name": "MY_ENV_VAR1",
        "value": "$CRS_HOME/after"
      }
    ],
    "parent_tde_keystore_path": "/foo/bar/tde",
    "parent_tde_keystore_password": "password",
    "tde_key_identifier": "tde-indentifier",
    "target_vcdb_tde_keystore_path": "/foo/cdb/tde",
    "cdb_tde_keystore_password": "cdb-password",
    "parent_pdb_tde_keystore_path": "/work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde",
    "parent_pdb_tde_keystore_password": "password",
    "target_pdb_tde_keystore_password": "password",
    "appdata_source_params": {
      "param": "value"
    },
    "additional_mount_points": [
      {
        "shared_path": "/",
        "mount_path": "/work",
        "environment_id": "environment-123"
      }
    ],
    "appdata_config_params": {
      "option": "value"
    },
    "config_params": {
      "processes": 150
    },
    "mount_point": "/var/mnt",
    "oracle_services": [
      "jdbc:oracle:thin:@hostname:port/service_name",
      "jdbc:oracle:thin:@hostname:port:SID"
    ],
    "instances": [
      {
        "instance_name": "instance1",
        "instance_number": 1,
        "node_reference": "ORACLE_CLUSTER_NODE-1"
      }
    ],
    "invoke_datapatch": true,
    "mssql_ag_backup_location": "shared_backup_location/location1",
    "mssql_ag_backup_based": true,
    "cache_priority": "HIGH",
    "mssql_incremental_export_backup_frequency_minutes": 30,
    "database_name": "my-test-database"
  }'

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