Update a CDB.

Update a CDB.
deprecated

Request

Security

ApiKeyAuth

Path

cdbIdstring, non-emptyrequired

The ID of the CDB.

Bodyapplication/json

The parameters to update a CDB.

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

logsync_modestring(OracleLogsyncModeTypeEnum)

LogSync operation mode for this dSource.

Enum:"ARCHIVE_ONLY_MODE""ARCHIVE_REDO_MODE""UNDEFINED"

tde_keystore_passwordstring, <= 128 characters

For a CDB using software keystore, this is the password of the software keystore used by this database. For a CDB using OKV, this is the password for the endpoint provided during the installation of the Oracle Key Vault client library (i.e., okvclient.jar) on the host where this database runs. For a CDB using HSM, this is the credential of the external key manager which is managing master encryption keys of this database. A blank string will unset the existing tde keystore password.

Example:"password"

tde_keystore_config_typestring(OracleTdeKeystoreConfigTypeEnum)

Oracle TDE keystore configuration type.

Enum:"FILE""OKV""HSM""OKV|FILE""FILE|OKV""HSM|FILE""FILE|HSM""OCI_VAULT""UNSET"

tde_kms_pkcs11_config_pathstring

Path to the PKCS#11 configuration file for TDE KMS. A blank string will unset the existing PKCS#11 config path.

Example:"/etc/oracle/tde/kms_pkcs11.conf"

environment_user_idstring

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

Example:"ENV_USER-1"

db_usernamestring, [ 1 .. 30 ] characters

The name of the database user.

Example:"db-username"

db_passwordstring, non-empty

The password of the database user.

Example:"db-password"

non_sys_usernamestring, [ 1 .. 256 ] characters

The username of a database user that does not have administrative privileges.

non_sys_passwordstring, non-empty

The username of a database user that does not have administrative privileges.

okv_client_idstring

The id of the OKV client used for TDE keystore access. A blank string will unset the existing OKV client id.

Example:"1-ORACLE_OKV_CLIENT-1"

instance_namestring, non-empty.*\S.*

The instance name of this single instance CDB. Must contain at least one non-whitespace character.

Example:"CDBSID"

instance_numberinteger, >= 1

The instance number of this single instance CDB.

Example:1

instancesArray of objects, non-empty(OracleRACDatabaseInstance)

The instances of this RAC database.

Example:

[
  {
    "instance_name": "instance1",
    "instance_number": 1,
    "node_reference": "ORACLE_CLUSTER_NODE-1",
    "okv_client_id": "1-ORACLE_OKV_CLIENT-1"
  }
]

logsync_enabledbooleandeprecated

True if LogSync is enabled for this CDB.

logsync_intervalinteger, (int64)deprecated

Interval between LogSync requests, in seconds.

descriptionstringdeprecated

The container description of this Linked CDB.

Example:"Updated Linked CDB description."

diagnose_no_logging_faultsbooleandeprecated

Example:true

rman_channelsinteger, (int32)deprecated

Number of parallel channels to use.

files_per_setinteger, (int32)deprecated

Number of data files to include in each RMAN backup set.

encrypted_linking_enabledbooleandeprecated

True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data.

compressed_linking_enabledbooleandeprecated

True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network.

bandwidth_limitinteger, (int32)deprecated

Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit.

number_of_connectionsinteger, (int32)deprecated

Total number of transport connections to use during SnapSync.

backup_level_enabledbooleandeprecated

Boolean value indicates whether LEVEL-based incremental backups can be used on the source db.

check_logicalbooleandeprecated

True if extended block checking should be used for this linked 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/cdbs/{cdbId}/update' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "oracle_services": [
      "jdbc:oracle:thin:@hostname:port/service_name",
      "jdbc:oracle:thin:@hostname:port:SID"
    ],
    "logsync_enabled": true,
    "logsync_mode": "ARCHIVE_ONLY_MODE",
    "logsync_interval": 0,
    "tde_keystore_password": "password",
    "tde_keystore_config_type": "FILE",
    "tde_kms_pkcs11_config_path": "/etc/oracle/tde/kms_pkcs11.conf",
    "description": "Updated Linked CDB description.",
    "diagnose_no_logging_faults": true,
    "environment_user_id": "ENV_USER-1",
    "rman_channels": 0,
    "files_per_set": 0,
    "encrypted_linking_enabled": true,
    "compressed_linking_enabled": true,
    "bandwidth_limit": 0,
    "number_of_connections": 0,
    "backup_level_enabled": true,
    "check_logical": true,
    "db_username": "db-username",
    "db_password": "db-password",
    "non_sys_username": "string",
    "non_sys_password": "string",
    "okv_client_id": "1-ORACLE_OKV_CLIENT-1",
    "instance_name": "CDBSID",
    "instance_number": 1,
    "instances": [
      {
        "instance_name": "instance1",
        "instance_number": 1,
        "node_reference": "ORACLE_CLUSTER_NODE-1",
        "okv_client_id": "1-ORACLE_OKV_CLIENT-1"
      }
    ]
  }'

Responses

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

Update a CDB.deprecated

Request

Path

Responses

Was this helpful?

Update a CDB.
deprecated