Skip to content

Get a CDB by ID (Oracle only).

Request

Security
ApiKeyAuth
Path
vcdbIdstring, non-emptyrequired

The ID of the vCDB.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2025.2.0.0/continuous-data-apis-dct-2025.2.0.0/vcdbs/{vcdbId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

The vCDB object entity ID.

Example:"1-CDB-1"
namestring or null

The name of this vCDB.

Example:"Oracle CDB"
database_namestring

The name of the container database in the Oracle DBMS.

Example:"VPDBSBBVK4"
namespace_idstring or null

The namespace id of this vCDB.

namespace_namestring or null

The namespace name of this vCDB.

is_replicaboolean or null

Is this a replicated object.

database_versionstring or null

The version of this vCDB.

Example:"10.2.0.5.0"
environment_idstring or null

A reference to the Environment that hosts this vCDB.

Example:"1-ENVIRONMENT-1"
sizeinteger or null, (int64)

The total size of the data files used by this vCDB, in bytes.

Example:339292672
engine_idstring

A reference to the Engine that this vCDB belongs to.

Example:"engine-12"
statusstring or null

The runtime status of the vCDB.

Example:"RUNNING"
parent_idstring

A reference to the parent CDB of this vCDB.

Example:"1-CDB-1"
creation_datestring or null, (date-time)

The date this vCDB was created.

Example:"2022-10-15T08:51:34.148Z"
group_namestring or null

The name of the group containing this vCDB.

Example:"Untitled"
enabledboolean

Whether the vCDB is enabled or not.

Example:true
content_typestring or null

The content type of the vcdb.

vcdb_restartboolean

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

Example:true
tagsArray of objects(Tag)
invoke_datapatchboolean

Indicates whether datapatch should be invoked.

node_listenersArray of strings

The list of node listeners for this VCDB.

instance_namestring

The instance name of this single instance VCDB.

Example:"VCDSID"
instance_numberinteger

The instance number of this single instance VCDB.

instancesArray of objects(OracleRACDatabaseInstance)
oracle_servicesArray of objects(OracleService)
repository_idstring

The repository id of this Virtual CDB.

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

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

Example:"Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
tde_keystore_config_typestring(OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum:"FILE""OKV""HSM""OKV|FILE""FILE|OKV""HSM|FILE""FILE|HSM"
Response
{ "id": "1-CDB-1", "name": "Oracle CDB", "database_name": "VPDBSBBVK4", "namespace_id": "string", "namespace_name": "string", "is_replica": true, "database_version": "10.2.0.5.0", "environment_id": "1-ENVIRONMENT-1", "size": 339292672, "engine_id": "engine-12", "status": "RUNNING", "parent_id": "1-CDB-1", "creation_date": "2022-10-15T08:51:34.148Z", "group_name": "Untitled", "enabled": true, "content_type": "string", "vcdb_restart": true, "tags": [ { … } ], "invoke_datapatch": true, "node_listeners": [ "string" ], "instance_name": "VCDSID", "instance_number": 0, "instances": [ { … } ], "oracle_services": [ { … } ], "repository_id": "1-ORACLE_INSTALL-1", "containerization_state": "NOT_CONTAINERIZED", "tde_key_identifier": "Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "tde_keystore_config_type": "FILE" }