The CDBs API from Delphix — 14 operation(s) for cdbs.
openapi: 3.0.0
info:
title: Delphix DCT Algorithms CDBs API
version: 3.28.0
description: Delphix DCT API
contact:
name: Delphix Support
url: https://portal.perforce.com/s/
email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: CDBs
paths:
/cdbs:
get:
summary: List all CDBs (Oracle only).
operationId: get_cdbs
tags:
- CDBs
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/cdbsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListCDBsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/CDB'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/cdbs/search:
post:
summary: Search for CDBs (Oracle only).
operationId: search_cdbs
tags:
- CDBs
x-filterable:
fields:
id:
type: string
name:
type: string
description:
type: string
diagnose_no_logging_faults:
type: boolean
database_version:
type: string
environment_id:
type: string
size:
type: integer
jdbc_connection_string:
type: string
engine_id:
type: string
namespace_id:
type: string
namespace_name:
type: string
is_replica:
type: boolean
is_linked:
type: boolean
group_name:
type: string
status:
type: string
enabled:
type: boolean
instance_name:
type: string
instance_number:
type: integer
repository_id:
type: string
tde_keystore_config_type:
type: string
database_name:
type: string
database_unique_name:
type: string
tde_kms_pkcs11_config_path:
type: string
is_tde_keystore_password_set:
type: boolean
environment_user_ref:
type: string
rman_channels:
type: integer
files_per_set:
type: integer
encrypted_linking_enabled:
type: boolean
compressed_linking_enabled:
type: boolean
bandwidth_limit:
type: integer
number_of_connections:
type: integer
backup_level_enabled:
type: boolean
check_logical:
type: boolean
logsync_enabled:
type: boolean
logsync_mode:
type: string
db_username:
type: string
non_sys_username:
type: string
okv_client_id:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/cdbsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchCDBsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/CDB'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/cdbs/{cdbId}:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
get:
summary: Get a CDB by ID (Oracle only).
operationId: get_cdb_by_id
tags:
- CDBs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CDB'
patch:
summary: Update a CDB.
tags:
- CDBs
operationId: update_cdb
requestBody:
content:
application/json:
schema:
x-body-name: update_cdb_parameter
$ref: '#/components/schemas/UpdateCDBParameters'
description: The parameters to update a CDB.
responses:
'200':
description: CDB update initiated.
content:
application/json:
schema:
type: object
title: UpdateCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/cdbs/{cdbId}/update:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
patch:
deprecated: true
summary: Update a CDB.
tags:
- CDBs
operationId: update_cdb_by_id
requestBody:
content:
application/json:
schema:
x-body-name: update_cdb_parameter
$ref: '#/components/schemas/UpdateCDBParameters'
description: The parameters to update a CDB.
responses:
'200':
description: CDB update initiated.
content:
application/json:
schema:
type: object
title: UpdateCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/cdbs/{cdbId}/tags:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
tags:
- CDBs
summary: Create tags for a CDB.
operationId: create_cdb_tags
requestBody:
content:
application/json:
schema:
x-body-name: cdb_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for CDB.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- CDBs
summary: Get tags for a CDB.
operationId: get_tags_cdb
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/cdbs/{cdbId}/tags/delete:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
tags:
- CDBs
summary: Delete tags for a CDB.
operationId: delete_cdb_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
required: false
responses:
'204':
description: No Content
/cdbs/{cdbId}/enable:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
deprecated: true
summary: Enable a CDB.
tags:
- CDBs
operationId: enable_cdb
requestBody:
content:
application/json:
schema:
x-body-name: enable_cdb_parameter
$ref: '#/components/schemas/EnableCDBParameters'
description: The parameters to enable a CDB.
responses:
'200':
description: CDB enable initiated.
content:
application/json:
schema:
type: object
title: EnableCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/cdbs/{cdbId}/disable:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
deprecated: true
summary: Disable a CDB.
tags:
- CDBs
operationId: disable_cdb
requestBody:
content:
application/json:
schema:
x-body-name: disable_cdb_parameter
$ref: '#/components/schemas/DisableCDBParameters'
description: The parameters to disable a CDB.
responses:
'200':
description: CDB disable initiated.
content:
application/json:
schema:
type: object
title: DisableCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/cdbs/{cdbId}/deletion-dependencies:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
get:
summary: Get deletion dependencies of a CDB.
operationId: get_cdb_deletion_dependencies
tags:
- CDBs
responses:
'200':
description: Deletion dependencies of a CDB.
content:
application/json:
schema:
$ref: '#/components/schemas/DeletionDependenciesResponse'
/cdbs/{cdbId}/delete:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
deprecated: true
summary: Delete a CDB.
tags:
- CDBs
operationId: delete_cdb
requestBody:
content:
application/json:
schema:
x-body-name: delete_cdb_parameter
$ref: '#/components/schemas/DeleteCDBParameters'
description: The parameters to delete a CDB.
responses:
'200':
description: CDB delete initiated.
content:
application/json:
schema:
type: object
title: DeleteCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/cdbs/{cdbId}/upgrade:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
deprecated: true
summary: Upgrade Oracle CDB
tags:
- CDBs
operationId: upgrade_cdb
requestBody:
content:
application/json:
schema:
x-body-name: upgrade_oracle_cdb_parameter
$ref: '#/components/schemas/UpgradeOracleContainerDatabaseParameters'
description: The new data to upgrade an Oracle CDB.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: UpgradeCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/cdbs/{cdbId}/detachSource:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
deprecated: true
summary: Detaches an Oracle CDB from an Oracle database.
operationId: detach_cdb
tags:
- CDBs
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DetachCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
dsource_id:
type: string
description: The dsource id of the detached dSource.
example: 1-ORACLE_DB_CONTAINER-32
/cdbs/{cdbId}/attachSource:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
deprecated: true
summary: Attach an Oracle CDB to an Oracle database.
operationId: attach_cdb
tags:
- CDBs
requestBody:
x-body-name: attachOracleCdbBody
$ref: '#/components/requestBodies/OracleAttachCdbBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: attachCDBResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/cdbs/{cdbId}/jdbc-check:
parameters:
- $ref: '#/components/parameters/cdbIdParam'
post:
tags:
- CDBs
summary: Verify JDBC connection string for a CDB.
operationId: verify_cdb_jdbc_connection_string
requestBody:
$ref: '#/components/requestBodies/OracleVerifyJdbcConnectionStringBody'
responses:
'200':
description: Success or Failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectivityCheckResponse'
components:
schemas:
DeletionDependenciesResponse:
description: The deletion dependencies of a dataset.
type: object
properties:
items:
description: The deletion dependencies of a dataset. These are presented in reverse order of deletion meaning that the last item in the list is the first item that needs to be deleted.
type: array
items:
$ref: '#/components/schemas/EngineStorageCapacityDependencyData'
Tag:
type: object
required:
- key
- value
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
OracleLogsyncModeTypeEnum:
type: string
description: LogSync operation mode for this dSource.
enum:
- ARCHIVE_ONLY_MODE
- ARCHIVE_REDO_MODE
- UNDEFINED
DeleteCDBParameters:
type: object
description: Parameters to delete a CDB.
properties:
force:
type: boolean
description: Whether to continue the operation upon failures.
default: false
delete_all_dependent_datasets:
type: boolean
description: Whether to delete all dependent datasets of the CDB.
default: false
EngineStorageDatasetType:
type: string
description: Type of the dataset.
enum:
- VDB
- DSOURCE
- CDB
- VCDB
- HELDSPACE
VirtualizationTaskEvent:
deprecated: true
properties:
message_details:
type: string
Engine:
properties:
engine_id:
type: string
minLength: 1
maxLength: 4000
engine_name:
type: string
minLength: 1
maxLength: 4000
PaginatedResponseMetadata:
type: object
properties:
prev_cursor:
description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
next_cursor:
description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
total:
description: The total number of results. This value may not be provided.
type: integer
format: int_64
JobTaskEvent:
properties:
message_details:
type: string
DeleteTag:
type: object
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
tags:
description: List of tags to be deleted
type: array
minItems: 1
maxItems: 1000
uniqueItems: true
items:
$ref: '#/components/schemas/Tag'
JobTask:
properties:
id:
type: string
parent_job_id:
type: string
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
title:
type: string
percent_complete:
type: integer
minimum: 0
maximum: 100
events:
type: array
items:
$ref: '#/components/schemas/JobTaskEvent'
status:
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
TagsRequest:
type: object
required:
- tags
properties:
tags:
description: Array of tags with key value pairs
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 1000
uniqueItems: true
OracleRACDatabaseInstance:
type: object
required:
- instance_name
- instance_number
- node_reference
properties:
instance_name:
type: string
description: The name of this instance. Must contain at least one non-whitespace character.
minLength: 1
pattern: .*\S.*
instance_number:
type: integer
description: The number of this instance.
minimum: 1
node_reference:
type: string
description: The reference to the cluster node which the instance is running on. Must contain at least one non-whitespace character.
minLength: 1
pattern: .*\S.*
okv_client_id:
description: 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.
type: string
minLength: 1
pattern: .*\S.*
example: 1-ORACLE_OKV_CLIENT-1
ConnectivityCheckResponse:
title: ConnectivityResponse
type: object
description: The result of the connectivity check.
required:
- message
properties:
message:
description: A message describing the result of the connectivity check.
type: string
example: Success!
status:
description: A status describing the status of the connectivity check.
type: string
enum:
- SUCCESS
- FAILED
example: SUCCESS
OracleService:
properties:
discovered:
description: Represents whether this jdbc connection string is auto discovered or not.
type: boolean
jdbc_connection_string:
description: The jdbc connection string used to connect with the database.
type: string
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)))
SourceOperation:
properties:
name:
type: string
minLength: 1
maxLength: 256
command:
type: string
minLength: 1
maxLength: 131072
shell:
type: string
enum:
- bash
- shell
- expect
- ps
- psd
default: bash
credentials_env_vars:
description: List of environment variables that will contain credentials for this operation.
type: array
items:
$ref: '#/components/schemas/CredentialsEnvVariable'
hook_template_id:
description: ID of the hook template
type: string
CDB:
description: The Delphix representation of an Oracle Container Database.
type: object
properties:
id:
description: The CDB object entity ID.
type: string
example: 1-CDB-1
name:
description: The name of this CDB.
type: string
nullable: true
example: Oracle CDB
description:
description: The container description of this Linked CDB.
type: string
example: This is Oracle linked CDB.
diagnose_no_logging_faults:
description: If true, NOLOGGING operations on this container are treated as faults and cannot be resolved manually. Otherwise, these operations are ignored.
type: boolean
example: true
namespace_id:
description: The namespace id of this CDB.
type: string
example: 1-NAMESPACE-1
namespace_name:
description: The namespace name of this CDB.
type: string
example: test-engine-1
is_replica:
description: Is this a replicated object.
type: boolean
example: true
database_version:
description: The version of this CDB.
type: string
nullable: true
example: 10.2.0.5.0
environment_id:
description: A reference to the Environment that hosts this CDB.
type: string
nullable: true
example: 1-ENVIRONMENT-1
size:
description: The total size of the data files used by this CDB, in bytes.
type: integer
format: int64
nullable: true
example: 339292672
rman_channels:
type: integer
format: int32
description: Number of parallel channels to use.
files_per_set:
type: integer
format: int32
description: Number of data files to include in each RMAN backup set.
encrypted_linking_enabled:
type: boolean
description: 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_enabled:
type: boolean
description: 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_limit:
type: integer
format: int32
description: Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit.
number_of_connections:
type: integer
format: int32
description: Total number of transport connections to use during SnapSync.
backup_level_enabled:
type: boolean
description: Boolean value indicates whether LEVEL-based incremental backups can be used on the source db.
check_logical:
type: boolean
description: True if extended block checking should be used for this linked database.
jdbc_connection_string:
description: The JDBC connection URL for this CDB.
type: string
nullable: true
example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.43.47.94)(PORT=1521))(CONNECT_DATA=(UR=A)(SID=production01)))
deprecated: true
engine_id:
description: A reference to the Engine that this CDB belongs to.
type: string
example: engine-12
is_linked:
description: Whether this CDB is linked or not.
type: boolean
example: false
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
group_name:
description: The name of the group containing this CDB.
type: string
nullable: true
example: Untitled
status:
description: The runtime status of the vCDB.
type: string
nullable: true
example: RUNNING
enabled:
description: Whether the CDB is enabled or not.
type: boolean
example: true
instance_name:
description: The instance name of this single instance CDB.
type: string
example: CDBSID
instance_number:
description: The instance number of this single instance CDB.
type: integer
instances:
type: array
items:
$ref: '#/components/schemas/OracleRACDatabaseInstance'
oracle_services:
type: array
items:
$ref: '#/components/schemas/OracleService'
repository_id:
description: The repository id of this CDB.
type: string
example: 1-ORACLE_INSTALL-1
logsync_enabled:
description: True if LogSync is enabled for this dSource.
type: boolean
logsync_mode:
description: LogSync operation mode for this dSource.
$ref: '#/components/schemas/OracleLogsyncModeTypeEnum'
logsync_interval:
description: Interval between LogSync requests, in seconds.
type: integer
format: int64
tde_keystore_config_type:
description: The TDE keystore configuration type of this database.
$ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum'
example: OKV
database_name:
description: The database name of this container database.
type: string
example: production01
database_unique_name:
type: string
description: The unique name of the container database.
example: DBOMSRBBDC6C
tde_kms_pkcs11_config_path:
description: The path to the TDE KMS PKC11 configuration file.
type: string
example: /etc/oracle/tde/kms_pkcs11.conf
is_tde_keystore_password_set:
description: True if TDE keystore password is set for this container database.
type: boolean
environment_user_ref:
description: The environment user reference.
type: string
db_username:
description: The name of the database user.
type: string
non_sys_username:
description: The username of a database user that does not have administrative privileges.
type: string
okv_client_id:
description: The id of the OKV client used for TDE keystore access.
type: string
example: 1-ORACLE_OKV_CLIENT-1
SearchBody:
description: Search body.
type: object
properties:
filter_expression:
type: string
minLength: 5
maxLength: 50000
example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"
OracleAttachCdbParameters:
allOf:
- $ref: '#/components/schemas/OracleAttachParameters'
- type: object
required:
- dsource_id
properties:
dsource_id:
description: Id of the dsource to attach.
type: string
minLength: 1
maxLength: 256
UpdateCDBParameters:
type: object
description: Parameters to update a CDB.
properties:
oracle_services:
type: array
items:
type: string
description: 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_enabled:
deprecated: true
description: True if LogSync is enabled for this CDB.
type: boolean
logsync_mode:
deprecated: true
description: LogSync operation mode for this CDB.
$ref: '#/components/schemas/OracleLogsyncModeTypeEnum'
logsync_interval:
deprecated: true
description: Interval between LogSync requests, in seconds.
type: integer
format: int64
tde_keystore_password:
x-dct-toolkit-credential-field: true
description: 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.
type: string
maxLength: 128
example: password
tde_keystore_config_type:
description: The TDE keystore configuration type of this database.
$ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum'
example: OKV
tde_kms_pkcs11_config_path:
description: Path to the PKCS#11 configuration file for TDE KMS. A blank string will unset the existing PKCS#11 config path.
type: string
example: /etc/oracle/tde/kms_pkcs11.conf
description:
deprecated: true
description: The container description of this Linked CDB.
type: string
example: Updated Linked CDB description.
diagnose_no_logging_faults:
deprecated: true
type: boolean
example: true
environment_user_id:
description: The environment user ID to use to connect to the environment.
type: string
example: ENV_USER-1
rman_channels:
deprecated: true
type: integer
format: int32
description: Number of parallel channels to use.
files_per_set:
deprecated: true
type: integer
format: int32
description: Number of data files to include in each RMAN backup set.
encrypted_linking_enabled:
deprecated: true
type: boolean
description: 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_enabled:
deprecated: true
type: boolean
description: 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_limit:
deprecated: true
type: integer
format: int32
description: Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit.
number_of_connections:
deprecated: true
type: integer
format: int32
description: Total number of transport connections to use during SnapSync.
backup_level_enabled:
deprecated: true
type: boolean
description: Boolean value indicates whether LEVEL-based incremental backups can be used on the source db.
check_logical:
deprecated: true
type: boolean
description: True if extended block checking should be used for this linked database.
db_username:
type: string
description: The name of the database user.
minLength: 1
maxLength: 30
example: db-username
db_password:
x-dct-toolkit-credential-field: true
type: string
description: The password of the database user.
minLength: 1
example: db-password
non_sys_username:
description: The username of a database user that does not have administrative privileges.
type: string
minLength: 1
maxLength: 256
non_sys_password:
x-dct-toolkit-credential-field: true
type: string
description: The username of a database user that does not have administrative privileges.
minLength: 1
okv_client_id:
desc
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-cdbs-api-openapi.yml