Lock a VDB.

Request

Security

ApiKeyAuth

Path

vdbIdstring, non-emptyrequired

The ID of the VDB.

Bodyapplication/jsonrequired

The parameters to lock a VDB.

account_idinteger, (int64)

Id of the account on whose behalf this request is being made. Only accounts having LOCK_FOR_OTHER_ACCOUNT permission can lock VDBs on behalf of other accounts. If this property is not specified then the account id of the authenticated user making the request is used.

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}/lock' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_id": 0
  }'

Responses

VDB is locked.

Bodyapplication/json

idstring

The VDB object entity ID.

Example:"vdb-123"

database_typestring or null

The database type of this VDB.

Example:"Oracle"

namestring or null

The logical name of this VDB.

Example:"prod01-copy01"

descriptionstring

The container description of this VDB.

database_namestring

The name of the database on the target environment or in the database management system.

Example:"prod01-copy01-dbname"

namespace_idstring

The namespace id of this VDB.

Example:"1-NAMESPACE-1"

namespace_namestring

The namespace name of this VDB.

Example:"test-engine-1"

is_replicaboolean

Is this a replicated object.

Example:true

is_lockedboolean

Is this VDB locked.

Example:true

locked_byinteger, (int64)

The ID of the account that locked this VDB.

Example:1

locked_by_namestring

The name of the account that locked this VDB.

Example:"user-1"

database_versionstring or null

The database version of this VDB.

Example:"10.2.0.5.0"

sizeinteger or null, (int64)

The total size of this VDB, in bytes.

Example:339292672

storage_sizeinteger or null, (int64)

The actual space used by this VDB, in bytes.

Example:12345678

unvirtualized_spaceinteger, (int64)

The disk space, in bytes, that it would take to store the VDB without Delphix.

Example:109242677

engine_idstring

A reference to the Engine that this VDB belongs to.

Example:"engine-123"

statusstring or null

The runtime status of the VDB. 'Unknown' if all attempts to connect to the dataset failed.

Example:"RUNNING"

maskedboolean or null

The VDB is masked or not.

Example:false

content_typestring or null

The content type of the vdb.

Example:"PDB"

parent_timeflow_timestampstring or null, (date-time)

The timestamp for parent timeflow.

Example:"2021-05-01T08:51:34.148Z"

parent_timeflow_timezonestring or null

The timezone for parent timeflow.

Example:"America/Los_Angeles"

environment_idstring or null

A reference to the Environment that hosts this VDB.

Example:"environment-123"

ip_addressstring or null

The IP address of the VDB's host.

Example:"192.0.2.0"

fqdnstring or null

The FQDN of the VDB's host.

Example:"virtual-dbs.myhost.com"

parent_idstring or null

A reference to the parent dataset of this VDB.

Example:"vdb-122"

parent_dsource_idstring or null

A reference to the parent dSource of this VDB.

Example:"dsource-id"

root_parent_idstring or null

A reference to the root parent dataset of this VDB which could be a VDB or a dSource.

Example:"vdb-121"

group_namestring or null

The name of the group containing this VDB.

Example:"VDBs"

engine_namestring or null

Name of the Engine where this VDB is hosted

Example:"engine-123-name"

cdb_idstring or null

A reference to the CDB or VCDB associated with this VDB.

Example:"cdb-123"

tagsArray of objects(Tag)

creation_datestring or null, (date-time)

The date this VDB was created.

Example:"2021-05-01T08:51:34.148Z"

hooksobject(VirtualDatasetHooks)

VDB operation hooks.

appdata_source_paramsobject or null

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

Example:

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

template_idstring or null

A reference to the Database Template.

Example:"DATABASE_TEMPLATE-1"

template_namestring or null

Name of the Database Template.

Example:"template-name"

config_paramsobject or null

Database configuration parameter overrides.

Example:

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

environment_user_refstring

The environment user reference.

additional_mount_pointsArray of objects or null(AdditionalMountPoint)

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

appdata_config_paramsobject or null

The parameters specified by the source config schema in the toolkit

Example:

{
  "foo": "bar"
}

mount_pointstring

Mount point for the VDB (Oracle, ASE, AppData).

Example:"/var/mnt"

current_timeflow_idstring

A reference to the currently active timeflow for this VDB.

Example:"timeflow-456"

previous_timeflow_idstring

A reference to the previous timeflow for this VDB.

Example:"timeflow-123"

last_refreshed_datestring or null, (date-time)

The date this VDB was last refreshed.

Example:"2023-04-15T02:11:14.248Z"

vdb_restartboolean

Indicates whether the Engine should automatically restart this vdb when target host reboot is detected.

Example:true

is_appdataboolean

Indicates whether this VDB has an AppData database.

Example:true

exported_data_directorystring

ZFS exported data directory path.

Example:"domain0/oracle_db_container-30/oracle_timeflow-32/datafile"

vcdb_exported_data_directorystring

ZFS exported data directory path of the virtual CDB container (vCDB).

Example:"domain0/oracle_db_container-29/oracle_timeflow-31/datafile"

toolkit_idstring

The ID of the toolkit associated with this VDB.

Example:"toolkit-1"

plugin_versionstring or null

The version of the plugin associated with this VDB.

Example:"1.0.0"

primary_object_idstring

The ID of the parent object from which replication was done.

Example:"1-CONTAINER-1"

primary_engine_idstring

The ID of the parent engine from which replication was done.

Example:"1"

primary_engine_namestring

The name of the parent engine from which replication was done.

Example:"source-engine"

replicasArray of objects(Replica)

The list of replicas replicated from this object.

invoke_datapatchboolean

Indicates whether datapatch should be invoked.

enabledboolean

True if VDB is enabled false if VDB is disabled.

Example:true

node_listenersArray of strings

The list of node listeners for this VDB.

instance_namestring

The instance name name of this single instance VDB.

Example:"VDBSID"

instance_numberinteger

The instance number of this single instance VDB.

instancesArray of objects(OracleRACDatabaseInstance)

oracle_servicesArray of objects(OracleService)

repository_idstring

The repository id of this VDB.

Example:"1-ORACLE_INSTALL-1"

containerization_statestring(ContainerizationStateEnum)

Indicates the virtual database's containerization state, created for or running inside a containerized environment like Linux containers.

Enum:"NOT_CONTAINERIZED""READY_FOR_CONTAINER""RUNNING_IN_CONTAINER"

parent_tde_keystore_pathstring

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.

Example:"/work/tde/parent_keystore"

target_vcdb_tde_keystore_pathstring

Path to the keystore of the target vCDB.

Example:"/work/tde/target_vcdb_keystore"

tde_key_identifierstring

ID of the key created by Delphix, as recorded in v$encryption_keys.key_id.

Example:"Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"

parent_pdb_tde_keystore_pathstring

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.

Example:"/work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde"

target_pdb_tde_keystore_pathstring

Path of the virtual PDB's Oracle transparent data encryption keystore on the target host.

Example:"/work/TARCDB/3599C5958B31BEF2E063D4DD6E0A2692/tde"

recovery_modelstring

Recovery model of the vdb database.

Example:"FULL"

cdc_on_provisionboolean

Whether to enable CDC on provision for MSSql.

Example:true

data_connection_idstring

The ID of the associated DataConnection.

Example:"data-connection-1"

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

mssql_ag_replicasArray of objects(MssqlAgReplica)

Indicates the mssql replica sources constitutes in MSSQL AG virtual source.

database_unique_namestring

The unique name of the database.

Example:"DBOMSRBBDC6C"

db_usernamestring

The user name of the database.

Example:"oracle"

new_db_idboolean

Indicates whether Delphix will generate a new DBID during VDB provision or refresh.

Example:true

redo_log_groupsinteger, (int32)

Number of Online Redo Log Groups.

Example:3

redo_log_size_in_mbinteger, (int32)

Online Redo Log size in MB.

Example:1024

custom_env_varsArray of objects(OracleCustomEnvVar)

active_instancesArray of objects(OracleActiveInstance)

nfs_versioninteger, (int32)

The NFS version that was last used to mount this source."

Example:3

nfs_version_reasonstring(NfsVersionReasonEnum)

The reason why the source is being mounted with nfsVersion.

Enum:"DEFAULT""OLD_REDHAT""UNSUPPORTED_OS""DNFS""TUNABLE_OVERRIDE""NO_RECOVER_LOST_LOCKS""UNSUPPORTED_DATA_PLATFORM""INCOMPLETE_V4_CONFIG""DNFS_UNSUPPORTED_ORACLE_VERSIONS_1912_1915""DNFS_UNSUPPORTED_ORACLE_VERSIONS_211_216"

nfs_encryption_enabledboolean

Flag indicating whether the data transfer is encrypted or not.

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

Frequency in minutes for incremental export backups for VDBs.

Example:30

recycle_binboolean

Indicates whether the VDB is in recycle bin or not.

Default:false

Example:true

recycle_daysinteger, (int32)

Number of days to retain VDB in the recycle bin before it's permanently deleted.

Example:30

recycle_bin_datestring or null, (date-time)

The date this VDB was moved to recycle bin.

Example:"2023-04-15T02:11:14.248Z"

recycle_bin_account_idinteger or null, (int64)

The ID of the account that moved this VDB to recycle bin.

Example:1

truncate_log_on_checkpointboolean

True if configured to truncate log on checkpoint (ASE only).

Example:true

durability_levelstring

SAP ASE database durability level (ASE only).

Enum:"FULL""AT_SHUTDOWN""NO_RECOVERY"

Example:"FULL"

environment_namestring

The name of the environment associated with this VDB.

Example:"prod-env-01"

parent_namestring

The name of the VDB's parent dataset.

Example:"prod01-main"

parent_dsource_namestring

The name of the dSource that is the root ancestor of this VDB.

Example:"prod01-dsource"

jdbc_connection_stringstringdeprecated

The JDBC connection URL for this VDB.

Example:"jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))"

Response

{
  "id": "vdb-123",
  "database_type": "Oracle",
  "name": "prod01-copy01",
  "description": "string",
  "database_name": "prod01-copy01-dbname",
  "namespace_id": "1-NAMESPACE-1",
  "namespace_name": "test-engine-1",
  "is_replica": true,
  "is_locked": true,
  "locked_by": 1,
  "locked_by_name": "user-1",
  "database_version": "10.2.0.5.0",
  "jdbc_connection_string": "jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))",
  "size": 339292672,
  "storage_size": 12345678,
  "unvirtualized_space": 109242677,
  "engine_id": "engine-123",
  "status": "RUNNING",
  "masked": false,
  "content_type": "PDB",
  "parent_timeflow_timestamp": "2021-05-01T08:51:34.148Z",
  "parent_timeflow_timezone": "America/Los_Angeles",
  "environment_id": "environment-123",
  "ip_address": "192.0.2.0",
  "fqdn": "virtual-dbs.myhost.com",
  "parent_id": "vdb-122",
  "parent_dsource_id": "dsource-id",
  "root_parent_id": "vdb-121",
  "group_name": "VDBs",
  "engine_name": "engine-123-name",
  "cdb_id": "cdb-123",
  "tags": [
    { … }
  ],
  "creation_date": "2021-05-01T08:51:34.148Z",
  "hooks": {
    "pre_refresh": [ … ],
    "post_refresh": [ … ],
    "pre_self_refresh": [ … ],
    "post_self_refresh": [ … ],
    "pre_rollback": [ … ],
    "post_rollback": [ … ],
    "configure_clone": [ … ],
    "pre_snapshot": [ … ],
    "post_snapshot": [ … ],
    "pre_start": [ … ],
    "post_start": [ … ],
    "pre_stop": [ … ],
    "post_stop": [ … ]
  },
  "appdata_source_params": {
    "param": "value",
    "param2": "value2"
  },
  "template_id": "DATABASE_TEMPLATE-1",
  "template_name": "template-name",
  "config_params": {
    "param": "value",
    "param2": "value2"
  },
  "environment_user_ref": "string",
  "additional_mount_points": [
    { … }
  ],
  "appdata_config_params": {
    "foo": "bar"
  },
  "mount_point": "/var/mnt",
  "current_timeflow_id": "timeflow-456",
  "previous_timeflow_id": "timeflow-123",
  "last_refreshed_date": "2023-04-15T02:11:14.248Z",
  "vdb_restart": true,
  "is_appdata": true,
  "exported_data_directory": "domain0/oracle_db_container-30/oracle_timeflow-32/datafile",
  "vcdb_exported_data_directory": "domain0/oracle_db_container-29/oracle_timeflow-31/datafile",
  "toolkit_id": "toolkit-1",
  "plugin_version": "1.0.0",
  "primary_object_id": "1-CONTAINER-1",
  "primary_engine_id": "1",
  "primary_engine_name": "source-engine",
  "replicas": [
    { … }
  ],
  "invoke_datapatch": true,
  "enabled": true,
  "node_listeners": [
    "string"
  ],
  "instance_name": "VDBSID",
  "instance_number": 0,
  "instances": [
    { … }
  ],
  "oracle_services": [
    { … }
  ],
  "repository_id": "1-ORACLE_INSTALL-1",
  "containerization_state": "NOT_CONTAINERIZED",
  "parent_tde_keystore_path": "/work/tde/parent_keystore",
  "target_vcdb_tde_keystore_path": "/work/tde/target_vcdb_keystore",
  "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "parent_pdb_tde_keystore_path": "/work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde",
  "target_pdb_tde_keystore_path": "/work/TARCDB/3599C5958B31BEF2E063D4DD6E0A2692/tde",
  "recovery_model": "FULL",
  "cdc_on_provision": true,
  "data_connection_id": "data-connection-1",
  "mssql_ag_backup_location": "shared_backup_location/location1",
  "mssql_ag_backup_based": true,
  "mssql_ag_replicas": [
    { … }
  ],
  "database_unique_name": "DBOMSRBBDC6C",
  "db_username": "oracle",
  "new_db_id": true,
  "redo_log_groups": 3,
  "redo_log_size_in_mb": 1024,
  "custom_env_vars": [
    { … }
  ],
  "active_instances": [
    { … }
  ],
  "nfs_version": 3,
  "nfs_version_reason": "DEFAULT",
  "nfs_encryption_enabled": true,
  "cache_priority": "HIGH",
  "mssql_incremental_export_backup_frequency_minutes": 30,
  "recycle_bin": true,
  "recycle_days": 30,
  "recycle_bin_date": "2023-04-15T02:11:14.248Z",
  "recycle_bin_account_id": 1,
  "truncate_log_on_checkpoint": true,
  "durability_level": "FULL",
  "environment_name": "prod-env-01",
  "parent_name": "prod01-main",
  "parent_dsource_name": "prod01-dsource"
}

Lock a VDB.

Request

Path

Responses

Was this helpful?