# Get a VDB by ID.

Endpoint: GET /vdbs/{vdbId}
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Path parameters:

  - `vdbId` (string, required)
    The ID of the VDB.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `id` (string)
    The VDB object entity ID.
    Example: vdb-123

  - `database_type` (string)
    The database type of this VDB.
    Example: Oracle

  - `name` (string)
    The logical name of this VDB.
    Example: prod01-copy01

  - `description` (string)
    The container description of this VDB.

  - `database_name` (string)
    The name of the database on the target environment or in the database management system.
    Example: prod01-copy01-dbname

  - `namespace_id` (string)
    The namespace id of this VDB.
    Example: 1-NAMESPACE-1

  - `namespace_name` (string)
    The namespace name of this VDB.
    Example: test-engine-1

  - `is_replica` (boolean)
    Is this a replicated object.
    Example: true

  - `is_locked` (boolean)
    Is this VDB locked.
    Example: true

  - `locked_by` (integer)
    The ID of the account that locked this VDB.
    Example: 1

  - `locked_by_name` (string)
    The name of the account that locked this VDB.
    Example: user-1

  - `database_version` (string)
    The database version of this VDB.
    Example: 10.2.0.5.0

  - `jdbc_connection_string` (string)
    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)))

  - `size` (integer)
    The total size of this VDB, in bytes.
    Example: 339292672

  - `storage_size` (integer)
    The actual space used by this VDB, in bytes.
    Example: 12345678

  - `unvirtualized_space` (integer)
    The disk space, in bytes, that it would take to store the VDB without Delphix.
    Example: 109242677

  - `engine_id` (string)
    A reference to the Engine that this VDB belongs to.
    Example: engine-123

  - `status` (string)
    The runtime status of the VDB. 'Unknown' if all attempts to connect to the dataset failed.
    Example: RUNNING

  - `masked` (boolean)
    The VDB is masked or not.
    Example: false

  - `content_type` (string)
    The content type of the vdb.
    Example: PDB

  - `parent_timeflow_timestamp` (string)
    The timestamp for parent timeflow.
    Example: 2021-05-01T08:51:34.148Z

  - `parent_timeflow_timezone` (string)
    The timezone for parent timeflow.
    Example: America/Los_Angeles

  - `environment_id` (string)
    A reference to the Environment that hosts this VDB.
    Example: environment-123

  - `ip_address` (string)
    The IP address of the VDB's host.
    Example: 192.0.2.0

  - `fqdn` (string)
    The FQDN of the VDB's host.
    Example: virtual-dbs.myhost.com

  - `parent_id` (string)
    A reference to the parent dataset of this VDB.
    Example: vdb-122

  - `parent_dsource_id` (string)
    A reference to the parent dSource of this VDB.
    Example: dsource-id

  - `root_parent_id` (string)
    A reference to the root parent dataset of this VDB which could be a VDB or a dSource.
    Example: vdb-121

  - `group_name` (string)
    The name of the group containing this VDB.
    Example: VDBs

  - `engine_name` (string)
    Name of the Engine where this VDB is hosted
    Example: engine-123-name

  - `cdb_id` (string)
    A reference to the CDB or VCDB associated with this VDB.
    Example: cdb-123

  - `tags` (array)

  - `tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `creation_date` (string)
    The date this VDB was created.
    Example: 2021-05-01T08:51:34.148Z

  - `hooks` (object)
    VDB operation hooks.

  - `hooks.pre_refresh` (array)
    The commands to execute on the target environment before refreshing the VDB.

  - `hooks.pre_refresh.name` (string)
    Example: Print the current user

  - `hooks.pre_refresh.command` (string)
    Example: whoami

  - `hooks.pre_refresh.shell` (string)
    Enum: "bash", "shell", "expect", "ps", "psd"

  - `hooks.pre_refresh.element_id` (string)
    Pass the element_id only when updating an existing hook, omit to create a new one.
    Example: 3

  - `hooks.pre_refresh.has_credentials` (boolean)
    Example: false

  - `hooks.pre_refresh.credentials_env_vars` (array)

  - `hooks.pre_refresh.credentials_env_vars.base_var_name` (string, required)
    Base name of the environment variables. Variables are named by appending '_USER', '_PASSWORD', '_PUBKEY' and '_PRIVKEY' to this base name, respectively. Variables whose values are not entered or are not present in the type of credential or vault selected, will not be set.

  - `hooks.pre_refresh.credentials_env_vars.password` (string)
    Password to assign to the environment variables.
    Example: password

  - `hooks.pre_refresh.credentials_env_vars.vault_username` (string)
    Delphix display name for the vault user.
    Example: my-vault

  - `hooks.pre_refresh.credentials_env_vars.vault` (string)
    The name or reference of the vault to assign to the environment variables.
    Example: 1-VAULT-1

  - `hooks.pre_refresh.credentials_env_vars.hashicorp_vault_engine` (string)
    Vault engine name where the credential is stored.
    Example: kv

  - `hooks.pre_refresh.credentials_env_vars.hashicorp_vault_secret_path` (string)
    Path in the vault engine where the credential is stored.
    Example: oracle-env

  - `hooks.pre_refresh.credentials_env_vars.hashicorp_vault_username_key` (string)
    Hashicorp vault key for the username in the key-value store.
    Example: username

  - `hooks.pre_refresh.credentials_env_vars.hashicorp_vault_secret_key` (string)
    Hashicorp vault key for the password in the key-value store.
    Example: secret

  - `hooks.pre_refresh.credentials_env_vars.azure_vault_name` (string)
    Azure key vault name.
    Example: azure_vault

  - `hooks.pre_refresh.credentials_env_vars.azure_vault_username_key` (string)
    Azure vault key in the key-value store.
    Example: username

  - `hooks.pre_refresh.credentials_env_vars.azure_vault_secret_key` (string)
    Azure vault key in the key-value store.
    Example: secret

  - `hooks.pre_refresh.credentials_env_vars.cyberark_vault_query_string` (string)
    Query to find a credential in the CyberArk vault.
    Example: Safe=Test;Folder=Test;Object=Test

  - `hooks.pre_refresh.credentials_env_vars.credential_type` (string)
    Credential type of the credential environment variable
    Example: PasswordCredential

  - `hooks.pre_refresh.credentials_env_vars.element_id` (string)
    Element ID of the credential environment variable. Omit to create a new credential. Include an existing element_id to update that credential. Any existing credential whose element_id is omitted from the request will be deleted. An element_id that does not match any existing credential is silently ignored.
    Example: 35

  - `hooks.pre_refresh.credentials_env_vars.type` (string)
    Type of the credential environment variable
    Example: CredentialsEnvVars

  - `hooks.pre_refresh.hook_template_id` (string)
    Example: Hook Template 1

  - `hooks.post_refresh` (array)
    The commands to execute on the target environment after refreshing the VDB.

  - `hooks.pre_self_refresh` (array)
    The commands to execute on the target environment before refreshing the VDB with data from itself.

  - `hooks.post_self_refresh` (array)
    The commands to execute on the target environment after refreshing the VDB with data from itself.

  - `hooks.pre_rollback` (array)
    The commands to execute on the target environment before rewinding the VDB.

  - `hooks.post_rollback` (array)
    The commands to execute on the target environment after rewinding the VDB.

  - `hooks.configure_clone` (array)
    The commands to execute on the target environment when the VDB is created or refreshed.

  - `hooks.pre_snapshot` (array)
    The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting.

  - `hooks.post_snapshot` (array)
    The commands to execute on the target environment after snapshotting a virtual source.

  - `hooks.pre_start` (array)
    The commands to execute on the target environment before starting a virtual source.

  - `hooks.post_start` (array)
    The commands to execute on the target environment after starting a virtual source.

  - `hooks.pre_stop` (array)
    The commands to execute on the target environment before stopping a virtual source.

  - `hooks.post_stop` (array)
    The commands to execute on the target environment after stopping a virtual source.

  - `appdata_source_params` (object)
    The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
    Example: {"param":"value","param2":"value2"}

  - `template_id` (string)
    A reference to the Database Template.
    Example: DATABASE_TEMPLATE-1

  - `template_name` (string)
    Name of the Database Template.
    Example: template-name

  - `config_params` (object)
    Database configuration parameter overrides.
    Example: {"param":"value","param2":"value2"}

  - `environment_user_ref` (string)
    The environment user reference.

  - `additional_mount_points` (array)
    Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled.

  - `additional_mount_points.shared_path` (string)
    Relative path within the container of the directory that should be mounted.
    Example: /

  - `additional_mount_points.mount_path` (string)
    Absolute path on the target environment were the filesystem should be mounted
    Example: /work/ws1

  - `additional_mount_points.environment_id` (string)
    The entity ID of the environment on which the file system will be mounted.
    Example: environment-123

  - `appdata_config_params` (object)
    The parameters specified by the source config schema in the toolkit
    Example: {"foo":"bar"}

  - `mount_point` (string)
    Mount point for the VDB (Oracle, ASE, AppData).
    Example: /var/mnt

  - `current_timeflow_id` (string)
    A reference to the currently active timeflow for this VDB.
    Example: timeflow-456

  - `previous_timeflow_id` (string)
    A reference to the previous timeflow for this VDB.
    Example: timeflow-123

  - `last_refreshed_date` (string)
    The date this VDB was last refreshed.
    Example: 2023-04-15T02:11:14.248Z

  - `vdb_restart` (boolean)
    Indicates whether the Engine should automatically restart this vdb when target host reboot is detected.
    Example: true

  - `is_appdata` (boolean)
    Indicates whether this VDB has an AppData database.
    Example: true

  - `exported_data_directory` (string)
    ZFS exported data directory path.
    Example: domain0/oracle_db_container-30/oracle_timeflow-32/datafile

  - `vcdb_exported_data_directory` (string)
    ZFS exported data directory path of the virtual CDB container (vCDB).
    Example: domain0/oracle_db_container-29/oracle_timeflow-31/datafile

  - `toolkit_id` (string)
    The ID of the toolkit associated with this VDB.
    Example: toolkit-1

  - `plugin_version` (string)
    The version of the plugin associated with this VDB.
    Example: 1.0.0

  - `primary_object_id` (string)
    The ID of the parent object from which replication was done.
    Example: 1-CONTAINER-1

  - `primary_engine_id` (string)
    The ID of the parent engine from which replication was done.
    Example: 1

  - `primary_engine_name` (string)
    The name of the parent engine from which replication was done.
    Example: source-engine

  - `replicas` (array)
    The list of replicas replicated from this object.

  - `replicas.replica_id` (string)
    The ID of the replicated object.
    Example: replica-1

  - `replicas.replica_engine_id` (string)
    The ID of the replicated object's engine.
    Example: 1

  - `replicas.replica_engine_name` (string)
    The name of the replicated object's engine.
    Example: replica-e1

  - `replicas.replica_namespace_id` (string)
    The namespace id of the replicated object.
    Example: namespace-1

  - `invoke_datapatch` (boolean)
    Indicates whether datapatch should be invoked.

  - `enabled` (boolean)
    True if VDB is enabled false if VDB is disabled.
    Example: true

  - `node_listeners` (array)
    The list of node listeners for this VDB.

  - `instance_name` (string)
    The instance name name of this single instance VDB.
    Example: VDBSID

  - `instance_number` (integer)
    The instance number of this single instance VDB.

  - `instances` (array)

  - `instances.instance_name` (string, required)
    The name of this instance. Must contain at least one non-whitespace character.

  - `instances.instance_number` (integer, required)
    The number of this instance.

  - `instances.node_reference` (string, required)
    The reference to the cluster node which the instance is running on. Must contain at least one non-whitespace character.

  - `instances.okv_client_id` (string)
    The id of the OKV client used for TDE keystore access. If provided, it must include at least one non-whitespace character; if omitted, the existing OKV client will be cleared.
    Example: 1-ORACLE_OKV_CLIENT-1

  - `oracle_services` (array)

  - `oracle_services.discovered` (boolean)
    Represents whether this jdbc connection string is auto discovered or not.

  - `oracle_services.jdbc_connection_string` (string)
    The jdbc connection string used to connect with the database.
    Example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.110.230.197)(PORT=1521))(CONNECT_DATA=(UR=A)(SERVICE_NAME=VDBOMSRBBDC6C_UJG)))

  - `repository_id` (string)
    The repository id of this VDB.
    Example: 1-ORACLE_INSTALL-1

  - `containerization_state` (string)
    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_path` (string)
    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_path` (string)
    Path to the keystore of the target vCDB.
    Example: /work/tde/target_vcdb_keystore

  - `tde_key_identifier` (string)
    ID of the key created by Delphix, as recorded in v$encryption_keys.key_id.
    Example: Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

  - `parent_pdb_tde_keystore_path` (string)
    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_path` (string)
    Path of the virtual PDB's Oracle transparent data encryption keystore on the target host.
    Example: /work/TARCDB/3599C5958B31BEF2E063D4DD6E0A2692/tde

  - `recovery_model` (string)
    Recovery model of the vdb database.
    Example: FULL

  - `cdc_on_provision` (boolean)
    Whether to enable CDC on provision for MSSql.
    Example: true

  - `data_connection_id` (string)
    The ID of the associated DataConnection.
    Example: data-connection-1

  - `mssql_ag_backup_location` (string)
    Shared backup location to be used for VDB provision on AG Cluster.
    Example: shared_backup_location/location1

  - `mssql_ag_backup_based` (boolean)
    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_replicas` (array)
    Indicates the mssql replica sources constitutes in MSSQL AG virtual source.

  - `mssql_ag_replicas.name` (string)
    The logical name of the replica source.
    Example: Rag1_FJ1

  - `mssql_ag_replicas.ag_replica_id` (string)
    The AG Replica object entity ID.
    Example: 1-MSSQL_DB_CONTAINER-104

  - `mssql_ag_replicas.vdb_id` (string)
    Reference to the AG virtual source.
    Example: 1-MSSQL_DB_CONTAINER-102

  - `mssql_ag_replicas.current_timeflow_id` (string)
    A reference to the currently active timeflow for this AG Replica.
    Example: 1-MSSQL_TIMEFLOW-111

  - `mssql_ag_replicas.mount_point` (string)
    The base mount point for the replica source iSCSI LUN mounts.
    Example: C:\Program Files\Delphix\DelphixConnector\ec2f5d5f-a2e0-3902-5097-62d348ae63a8-replica-30

  - `mssql_ag_replicas.exported_data_directory` (string)
    ZFS exported data directory path.
    Example: domain0/mssql_db_container-358/mssql_timeflow-361/datafile

  - `mssql_ag_replicas.repository_id` (string)
    The repository id of this AG Replica.
    Example: 1-MSSQL_INSTANCE-116

  - `mssql_ag_replicas.environment_id` (string)
    A reference to the Environment that hosts this AG Replica.
    Example: 1-WINDOWS_HOST_ENVIRONMENT-43

  - `mssql_ag_replicas.curr_timeflow_support_provision_without_backup` (boolean)
    Indicates whether the database file can be used to provision without taking backups for current (active) timeflow of ths AG Replica.
    Example: false

  - `mssql_ag_replicas.curr_timeflow_ag_replica_sync_status` (string)
    Indicates the data-movement state for current (active) timeflow of ths AG Replica.
    Example: SYNCHRONIZED

  - `mssql_ag_replicas.curr_timeflow_ag_replica_role_primary` (boolean)
    Whether this AG replica is currently the primary. Null when the role is unknown (for example, during a failover).
    Example: true

  - `mssql_ag_replicas.curr_timeflow_last_hardened_lsn` (string)
    For current (active) timeflow of ths AG Replica, indicates the start of the next block past the blocks that are already on disk. So any LSN less than the value of last_hardened_lsn is on disk.
    Example: 34000000294400001

  - `database_unique_name` (string)
    The unique name of the database.
    Example: DBOMSRBBDC6C

  - `db_username` (string)
    The user name of the database.
    Example: oracle

  - `new_db_id` (boolean)
    Indicates whether Delphix will generate a new DBID during VDB provision or refresh.
    Example: true

  - `redo_log_groups` (integer)
    Number of Online Redo Log Groups.
    Example: 3

  - `redo_log_size_in_mb` (integer)
    Online Redo Log size in MB.
    Example: 1024

  - `custom_env_vars` (array)

  - `custom_env_vars.cluster_node` (string)
    The cluster node on which the environment variable is relevant.

  - `custom_env_vars.path_parameters` (string)
    A string of whitespace-separated parameters to be passed to the source command. The first parameter must be an absolute path to a file that exists on the target environment. Every subsequent parameter will be treated as an argument interpreted by the environment file.

  - `custom_env_vars.var_name` (string)
    The name of the environment variable.

  - `custom_env_vars.var_value` (string)
    The value of the environment variable.

  - `active_instances` (array)

  - `active_instances.instance_number` (integer)
    The number of this instance.

  - `active_instances.instance_name` (string)
    The name of this instance.

  - `active_instances.host_name` (string)
    The reference to the cluster node which the instance is running on.

  - `nfs_version` (integer)
    The NFS version that was last used to mount this source."
    Example: 3

  - `nfs_version_reason` (string)
    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", "DNFS_UNSUPPORTED_ORACLE_VERSIONS_LESS_THAN_12C"

  - `nfs_encryption_enabled` (boolean)
    Flag indicating whether the data transfer is encrypted or not.
    Example: true

  - `cache_priority` (string)
    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"

  - `mssql_incremental_export_backup_frequency_minutes` (integer)
    Frequency in minutes for incremental export backups for VDBs.
    Example: 30

  - `recycle_bin` (boolean)
    Indicates whether the VDB is in recycle bin or not.
    Example: true

  - `recycle_days` (integer)
    Number of days to retain VDB in the recycle bin before it's permanently deleted.
    Example: 30

  - `recycle_bin_date` (string)
    The date this VDB was moved to recycle bin.
    Example: 2023-04-15T02:11:14.248Z

  - `recycle_bin_account_id` (integer)
    The ID of the account that moved this VDB to recycle bin.
    Example: 1

  - `truncate_log_on_checkpoint` (boolean)
    True if configured to truncate log on checkpoint (ASE only).
    Example: true

  - `durability_level` (string)
    SAP ASE database durability level (ASE only).
    Enum: "FULL", "AT_SHUTDOWN", "NO_RECOVERY"

  - `environment_name` (string)
    The name of the environment associated with this VDB.
    Example: prod-env-01

  - `parent_name` (string)
    The name of the VDB's parent dataset.
    Example: prod01-main

  - `parent_dsource_name` (string)
    The name of the dSource that is the root ancestor of this VDB.
    Example: prod01-dsource