openapi: 3.0.0 info: title: Delphix DCT Algorithms VDBs 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: VDBs paths: /vdbs: get: summary: List all vdbs. operationId: get_vdbs tags: - VDBs parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/vdbsSortParam' - $ref: '#/components/parameters/permission' responses: '200': description: OK content: application/json: schema: type: object title: ListVDBsResponse properties: items: type: array items: $ref: '#/components/schemas/VDB' errors: $ref: '#/components/schemas/Errors' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /vdbs/empty-recycle-bin: x-internal: true post: summary: Empty VDB recycle bin. operationId: empty_recycle_bin tags: - VDBs responses: '200': description: OK content: application/json: schema: type: object title: EmptyRecycleBinResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/search: post: summary: Search for VDBs. operationId: search_vdbs tags: - VDBs x-filterable: fields: id: type: string database_type: type: string name: type: string description: type: string database_name: type: string database_version: type: string jdbc_connection_string: type: string size: type: integer storage_size: type: integer unvirtualized_space: type: integer engine_id: type: string status: type: string environment_id: type: string ip_address: type: string fqdn: type: string parent_id: type: string parent_dsource_id: type: string group_name: type: string creation_date: type: string last_refreshed_date: type: string current_timeflow_id: type: string previous_timeflow_id: type: string masked: type: boolean namespace_id: type: string namespace_name: type: string is_replica: type: boolean is_locked: type: boolean logsync_enabled: x-internal: true type: boolean exported_data_directory: type: string vcdb_exported_data_directory: type: string locked_by: type: integer format: int64 locked_by_name: type: string content_type: type: string template_id: type: string template_name: type: string tags: type: array[object] fields: key: type: string value: type: string hooks: type: array[object] fields: name: type: string command: type: string shell: type: string element_id: type: string has_credentials: type: string hook_point: type: string engine_name: type: string cdb_id: type: string appdata_source_params: type: string config_params: type: string primary_object_id: type: string primary_engine_id: type: string primary_engine_name: type: string replicas: type: array[object] fields: replica_id: type: string replica_engine_id: type: string replica_engine_name: type: string invoke_datapatch: type: boolean node_listeners: type: array[string] instance_name: type: string instance_number: type: integer repository_id: type: string containerization_state: type: string parent_tde_keystore_path: type: string target_vcdb_tde_keystore_path: type: string tde_key_identifier: type: string parent_pdb_tde_keystore_path: type: string target_pdb_tde_keystore_path: type: string environment_user_ref: type: string recovery_model: type: string cdc_on_provision: type: boolean data_connection_id: type: string mssql_ag_backup_location: type: string mssql_ag_backup_based: type: boolean mssql_ag_replicas: type: array[object] fields: name: type: string ag_replica_id: type: string vdb_id: type: string current_timeflow_id: type: string mount_point: type: string exported_data_directory: type: string repository_id: type: string environment_id: type: string curr_timeflow_support_provision_without_backup: type: boolean curr_timeflow_ag_replica_sync_status: type: string curr_timeflow_last_hardened_lsn: type: string database_unique_name: type: string db_username: type: string new_db_id: type: boolean redo_log_groups: type: integer format: int32 redo_log_size_in_mb: type: integer format: int32 toolkit_id: type: string nfs_version: type: integer format: int32 nfs_version_reason: type: string nfs_encryption_enabled: type: boolean mssql_incremental_export_backup_frequency_minutes: type: integer format: int32 truncate_log_on_checkpoint: type: boolean durability_level: type: string parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/vdbsSortParam' - $ref: '#/components/parameters/permission' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchVDBsResponse properties: items: type: array items: $ref: '#/components/schemas/VDB' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /vdbs/{vdbId}: parameters: - $ref: '#/components/parameters/vdbIdParam' get: summary: Get a VDB by ID. operationId: get_vdb_by_id tags: - VDBs responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VDB' patch: tags: - VDBs summary: Update values of a VDB operationId: update_vdb_by_id requestBody: content: application/json: schema: x-body-name: update_vdb_parameter $ref: '#/components/schemas/UpdateVDBParameters' description: The new data to update a VDB. responses: '200': description: OK content: application/json: schema: type: object title: UpdateVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/snapshots: parameters: - $ref: '#/components/parameters/vdbIdParam' get: summary: List Snapshots for a VDB. operationId: get_vdb_snapshots parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' tags: - VDBs responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListSnapshotsResponse' post: summary: Snapshot a VDB. operationId: snapshot_vdb tags: - VDBs responses: '200': description: VDB snapshot initiated. content: application/json: schema: type: object title: SnapshotVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/bookmarks: parameters: - $ref: '#/components/parameters/vdbIdParam' get: summary: List Bookmarks compatible with this VDB. operationId: get_bookmarks_by_vdb parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/bookmarksSortParam' tags: - VDBs responses: '200': description: OK content: application/json: schema: type: object title: ListBookmarksByVDBResponse properties: items: type: array items: $ref: '#/components/schemas/Bookmark' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /vdbs/{vdbId}/bookmarks/search: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Search Bookmarks compatible with this VDB. operationId: search_bookmarks_by_vdb parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/bookmarksSortParam' tags: - VDBs x-filterable: fields: id: type: string name: type: string creation_date: type: date-time vdb_ids: type: array[string] retention: type: integer expiration: type: date ss_data_layout_id: type: string ss_bookmark_reference: type: string ss_bookmark_errors: type: array[string] vdbs: type: array[object] fields: vdb_id: type: string vdb_name: type: string tags: type: array[object] fields: key: type: string value: type: string requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchBookmarksByVDBResponse properties: items: type: array items: $ref: '#/components/schemas/Bookmark' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /vdbs/{vdbId}/deletion-dependencies: parameters: - $ref: '#/components/parameters/vdbIdParam' get: summary: Get deletion dependencies of a VDB. operationId: get_vdb_deletion_dependencies tags: - VDBs responses: '200': description: Deletion dependencies of a VDB. content: application/json: schema: $ref: '#/components/schemas/DeletionDependenciesResponse' /vdbs/{vdbId}/tags: parameters: - $ref: '#/components/parameters/vdbIdParam' post: tags: - VDBs summary: Create tags for a VDB. operationId: create_vdb_tags requestBody: content: application/json: schema: x-body-name: vdb_tags $ref: '#/components/schemas/TagsRequest' description: Tags information for VDB. required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/TagsResponse' get: tags: - VDBs summary: Get tags for a VDB. operationId: get_tags_vdb responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/TagsResponse' /vdbs/{vdbId}/tags/delete: parameters: - $ref: '#/components/parameters/vdbIdParam' post: tags: - VDBs summary: Delete tags for a VDB. operationId: delete_vdb_tags requestBody: $ref: '#/components/requestBodies/DeleteTags' responses: '204': description: No Content /vdbs/{vdbId}/start: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Start a VDB. tags: - VDBs operationId: start_vdb requestBody: content: application/json: schema: x-body-name: StartVdbParameters $ref: '#/components/schemas/StartVDBParameters' required: false responses: '200': description: VDB start initiated. content: application/json: schema: type: object title: StartVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/stop: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Stop a VDB. tags: - VDBs operationId: stop_vdb requestBody: content: application/json: schema: x-body-name: StopVdbParameters $ref: '#/components/schemas/StopVDBParameters' required: false responses: '200': description: VDB stop initiated. content: application/json: schema: type: object title: StopVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/enable: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Enable a VDB. tags: - VDBs operationId: enable_vdb requestBody: content: application/json: schema: x-body-name: enable_vdb_parameter $ref: '#/components/schemas/EnableVDBParameters' description: The parameters to enable a VDB. responses: '200': description: VDB enable initiated. content: application/json: schema: type: object title: EnableVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/disable: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Disable a VDB. tags: - VDBs operationId: disable_vdb requestBody: content: application/json: schema: x-body-name: disable_vdb_parameter $ref: '#/components/schemas/DisableVDBParameters' description: The parameters to disable a VDB. responses: '200': description: VDB disable initiated. content: application/json: schema: type: object title: DisableVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/migrate: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Migrate a VDB. tags: - VDBs operationId: migrate_vdb requestBody: content: application/json: schema: x-body-name: migrate_vdb_parameter $ref: '#/components/schemas/MigrateVDBParameters' description: The parameters to migrate a VDB. responses: '200': description: VDB migrate initiated. content: application/json: schema: type: object title: MigrateVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/migrate_compatible_repositories: parameters: - $ref: '#/components/parameters/vdbIdParam' get: tags: - VDBs summary: Returns a list of compatible repositories for vdb migration. operationId: get_migrate_compatible_repo responses: '200': description: OK content: application/json: schema: type: object title: MigrateCompatibleEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' /vdbs/{vdbId}/restore-from-recycle-bin: x-internal: true parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Restore a VDB from recycle bin. tags: - VDBs operationId: restore_vdb_from_recycle_bin responses: '200': description: VDB is restored. content: application/json: schema: $ref: '#/components/schemas/VDB' /vdbs/{vdbId}/lock: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Lock a VDB. tags: - VDBs operationId: lock_vdb requestBody: content: application/json: schema: type: object title: LockVDBParameters properties: account_id: description: 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. type: integer format: int64 description: The parameters to lock a VDB. required: true responses: '200': description: VDB is locked. content: application/json: schema: $ref: '#/components/schemas/VDB' /vdbs/{vdbId}/unlock: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Unlock a VDB. tags: - VDBs operationId: unlock_vdb responses: '200': description: VDB is unlocked. content: application/json: schema: $ref: '#/components/schemas/VDB' /vdbs/{vdbId}/delete: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Delete a VDB. tags: - VDBs operationId: delete_vdb requestBody: content: application/json: schema: x-body-name: delete_vdb_parameter $ref: '#/components/schemas/DeleteVDBParameters' description: The parameters to delete a VDB. responses: '200': description: VDB delete initiated. content: application/json: schema: type: object title: DeleteVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/rollback_by_timestamp: parameters: - $ref: '#/components/parameters/vdbIdParam' post: deprecated: true summary: Rollback a VDB by timestamp. tags: - VDBs operationId: rollback_vdb_by_timestamp requestBody: content: application/json: schema: x-body-name: rollback_vdb_parameter $ref: '#/components/schemas/RollbackVDBByTimestampParameters' description: The parameters to rollback a VDB. responses: '200': description: VDB rollback initiated. content: application/json: schema: type: object title: RollbackVDBByTimestampResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/rollback_by_snapshot: parameters: - $ref: '#/components/parameters/vdbIdParam' post: deprecated: true summary: Rollback a VDB by snapshot. tags: - VDBs operationId: rollback_vdb_by_snapshot requestBody: content: application/json: schema: x-body-name: rollback_vdb_parameter $ref: '#/components/schemas/RollbackVDBBySnapshotParameters' description: The parameters to rollback a VDB. responses: '200': description: VDB rollback initiated. content: application/json: schema: type: object title: RollbackVDBBySnapshotResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/rollback_from_bookmark: parameters: - $ref: '#/components/parameters/vdbIdParam' post: deprecated: true summary: Rollback a VDB from a bookmark with only the same VDB. tags: - VDBs operationId: rollback_vdb_from_bookmark requestBody: content: application/json: schema: x-body-name: rollback_vdb_parameter $ref: '#/components/schemas/RollbackVDBFromBookmarkParameters' description: The parameters to rollback a VDB. responses: '200': description: VDB rollback initiated. content: application/json: schema: type: object title: RollbackVDBFromBookmarkResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/refresh_by_timestamp: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Refresh a VDB by timestamp. tags: - VDBs operationId: refresh_vdb_by_timestamp requestBody: content: application/json: schema: x-body-name: refresh_vdb_parameter $ref: '#/components/schemas/RefreshVDBByTimestampParameters' description: The parameters to refresh a VDB. responses: '200': description: VDB refresh initiated. content: application/json: schema: type: object title: RefreshVDBByTimestampResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/refresh_by_snapshot: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Refresh a VDB by snapshot. tags: - VDBs operationId: refresh_vdb_by_snapshot requestBody: content: application/json: schema: x-body-name: refresh_vdb_parameter $ref: '#/components/schemas/RefreshVDBBySnapshotParameters' description: The parameters to refresh a VDB. responses: '200': description: VDB refresh initiated. content: application/json: schema: type: object title: RefreshVDBBySnapshotResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/refresh_from_bookmark: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Refresh a VDB from bookmark with a single VDB. tags: - VDBs operationId: refresh_vdb_from_bookmark requestBody: content: application/json: schema: x-body-name: refresh_vdb_parameter $ref: '#/components/schemas/RefreshVDBFromBookmarkParameters' description: The parameters to refresh a VDB. responses: '200': description: VDB refresh initiated. content: application/json: schema: type: object title: RefreshVDBFromBookmarkResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/refresh_by_location: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Refresh a VDB by location. tags: - VDBs operationId: refresh_vdb_by_location requestBody: content: application/json: schema: x-body-name: refresh_vdb_parameter $ref: '#/components/schemas/RefreshVDBByLocationParameters' description: The parameters to refresh a VDB. responses: '200': description: VDB refresh initiated. content: application/json: schema: type: object title: RefreshVDBByLocationResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/undo_refresh: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Undo the last refresh operation. tags: - VDBs operationId: undo_refresh responses: '200': description: VDB undo refresh initiated. content: application/json: schema: type: object title: UndoRefreshVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/export_cleanup: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export cleanup for incremental V2P operation tags: - VDBs operationId: export_cleanup requestBody: content: application/json: schema: x-body-name: export_cleanup $ref: '#/components/schemas/ExportCleanupParameters' description: Parameters to cleanup VDB created as part of the Incremental V2P required: true responses: '202': description: Cleanup VDB created as part of the Incremental V2P. content: application/json: schema: type: object title: ExportCleanupResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/switch_timeflow: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Switches the current timeflow of a VDB. tags: - VDBs operationId: switch_timeflow requestBody: content: application/json: schema: x-body-name: switch_timeflow_parameter $ref: '#/components/schemas/SwitchTimeflowParameters' description: The parameters to switch the timeflow of a VDB. responses: '200': description: Switch timeflow initiated. content: application/json: schema: type: object title: SwitchTimeflowResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/oracle/{vdbId}/upgrade: parameters: - $ref: '#/components/parameters/vdbIdParam' post: deprecated: true summary: Upgrade Oracle VDB description: This API is marked as deprecated in favour of generalized API '/vdbs/{vdbId}/upgrade' tags: - VDBs operationId: upgrade_oracle_vdb requestBody: content: application/json: schema: x-body-name: upgrade_oracle_vdb_parameters $ref: '#/components/schemas/UpgradeOracleDatabaseParameters' description: The new API to upgrade Oracle VDB responses: '200': description: OK content: application/json: schema: type: object title: UpgradeVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/upgrade: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Upgrade VDB tags: - VDBs operationId: upgrade_vdb requestBody: content: application/json: schema: x-body-name: upgrade_vdb_parameters $ref: '#/components/schemas/UpgradeDatabaseParameters' description: The new API to upgrade VDB responses: '200': description: OK content: application/json: schema: type: object title: UpgradeVDBResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/upgrade_compatible_repositories: parameters: - $ref: '#/components/parameters/vdbIdParam' get: tags: - VDBs summary: Returns a list of compatible repositories for vdb upgrade. operationId: get_upgrade_compatible_repo_for_vdb responses: '200': description: OK content: application/json: schema: type: object title: UpgradeCompatibleEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' /vdbs/{vdbId}/jdbc-check: parameters: - $ref: '#/components/parameters/vdbIdParam' post: tags: - VDBs summary: Verify JDBC connection string for VDB. operationId: verify_vdb_jdbc_connection_string requestBody: $ref: '#/components/requestBodies/OracleVerifyJdbcConnectionStringBody' responses: '200': description: Success or Failure. content: application/json: schema: $ref: '#/components/schemas/ConnectivityCheckResponse' /vdbs/provision_by_timestamp: post: summary: Provision a new VDB by timestamp. tags: - VDBs operationId: provision_vdb_by_timestamp requestBody: content: application/json: schema: x-body-name: provision_vdb_parameter $ref: '#/components/schemas/ProvisionVDBByTimestampParameters' description: The parameters to provision a VDB. required: true responses: '200': description: VDB provisioning initiated. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBResponse' /vdbs/provision_by_timestamp/defaults: post: summary: Get default provision parameters for provisioning a new VDB by timestamp. tags: - VDBs operationId: provision_vdb_by_timestamp_defaults requestBody: content: application/json: schema: x-body-name: provision_vdb_parameter_defaults $ref: '#/components/schemas/ProvisionVDBByTimestampDefaultsRequest' description: The request to get default VDB provision parameters for provisioning a new VDB by timestamp. required: true responses: '200': description: Default VDB provisioning parameters. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBByTimestampParameters' /vdbs/provision_by_location: post: summary: Provision a new VDB by location. tags: - VDBs operationId: provision_vdb_by_location requestBody: content: application/json: schema: x-body-name: provision_vdb_parameter $ref: '#/components/schemas/ProvisionVDBByLocationParameters' description: The parameters to provision a VDB. required: true responses: '200': description: VDB provisioning initiated. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBResponse' /vdbs/provision_by_location/defaults: post: summary: Get default provision parameters for provisioning a new VDB by location. tags: - VDBs operationId: provision_vdb_by_location_defaults requestBody: content: application/json: schema: x-body-name: provision_vdb_parameter_defaults $ref: '#/components/schemas/ProvisionVDBByLocationDefaultsRequest' description: The request to get default VDB provision parameters for provisioning a new VDB by location. required: true responses: '200': description: Default VDB provisioning parameters. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBByLocationParameters' /vdbs/provision_by_snapshot: post: summary: Provision a new VDB by snapshot. tags: - VDBs operationId: provision_vdb_by_snapshot requestBody: $ref: '#/components/requestBodies/ProvisionBySnapshot' responses: '200': description: VDB provisioning initiated. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBResponse' /vdbs/provision_by_snapshot/defaults: post: summary: Get default provision parameters for provisioning a new VDB by snapshot. tags: - VDBs operationId: provision_vdb_by_snapshot_defaults requestBody: content: application/json: schema: x-body-name: provision_vdb_parameter_defaults $ref: '#/components/schemas/ProvisionVDBBySnapshotDefaultsRequest' description: The request to get default VDB provision parameters for provisioning a new VDB by snapshot. required: true responses: '200': description: Default VDB provisioning parameters. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBBySnapshotParameters' /vdbs/provision_from_bookmark: post: summary: Provision a new VDB from a bookmark with a single VDB. tags: - VDBs operationId: provision_vdb_from_bookmark requestBody: content: application/json: schema: x-body-name: provision_vdb_parameter $ref: '#/components/schemas/ProvisionVDBFromBookmarkParameters' description: The parameters to provision a VDB. required: true responses: '200': description: VDB provisioning initiated. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBResponse' /vdbs/provision_from_bookmark/defaults: post: summary: Get default provision parameters for provisioning a new VDB from a bookmark. tags: - VDBs operationId: provision_vdb_from_bookmark_defaults requestBody: content: application/json: schema: x-body-name: provision_vdb_parameter_defaults $ref: '#/components/schemas/ProvisionVDBFromBookmarkDefaultsRequest' description: The request to get default VDB provision parameters for provisioning a new VDB from a bookmark. required: true responses: '200': description: Default VDB provisioning parameters. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBFromBookmarkParameters' /vdbs/empty_vdb: post: summary: Provision an empty VDB. tags: - VDBs operationId: empty_vdb requestBody: $ref: '#/components/requestBodies/ProvisionEmptyVDB' responses: '200': description: Empty VDB provisioning initiated. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBResponse' /vdbs/{vdbId}/asm-in-place-export: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Convert a virtual database to a physical database on Oracle ASM file system. tags: - VDBs operationId: oracle_asm_in_place_vdb_export requestBody: content: application/json: schema: x-body-name: asm_in_place_vdb_export_parameter $ref: '#/components/schemas/OracleAsmInPlaceExportParameters' description: The parameters to perform Oracle ASM inplace VDB/VPDB export. required: true responses: '200': description: Oracle VDB/vPDB In-Place export to ASM initiated. content: application/json: schema: type: object title: OracleAsmInPlaceVDBExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/in-place-export: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Convert a virtual database to a physical database on physical file system. tags: - VDBs operationId: export_vdb_in_place requestBody: content: application/json: schema: x-body-name: in_place_vpdb_export_parameter $ref: '#/components/schemas/InPlaceExportParameters' description: The parameters to perform an in-place export of a virtual database to a physical file system. required: true responses: '200': description: VDB in-place export to physical file system initiated. content: application/json: schema: type: object title: ExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/asm-export-by-snapshot: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using snapshot to an ASM file system tags: - VDBs operationId: export_vdb_to_asm_by_snapshot requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportBySnapshotParameters' description: The parameters to export a vdb. required: true responses: '200': description: VDB export using snapshot to Oracle ASM initiated. content: application/json: schema: type: object title: OracleAsmExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/asm-export-by-location: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using SCN to an ASM file system tags: - VDBs operationId: export_vdb_to_asm_by_location requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportByLocationParameters' description: The parameters to export a vdb. required: true responses: '200': description: VDB export using SCN to Oracle ASM initiated. content: application/json: schema: type: object title: OracleAsmExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/asm-export-by-timestamp: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using timestamp to an ASM file system tags: - VDBs operationId: export_vdb_to_asm_by_timestamp requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportByTimestampParameters' description: The parameters to export a vdb. required: true responses: '200': description: VDB export using timestamp to Oracle ASM initiated. content: application/json: schema: type: object title: OracleAsmExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/export-from-bookmark: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using bookmark to physical file system tags: - VDBs operationId: export_vdb_from_bookmark requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportFromBookmarkParameters' description: The parameters to export a VDB. required: true responses: '200': description: VDB export using bookmark to physical file system initiated. content: application/json: schema: type: object title: ExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/asm-export-from-bookmark: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using bookmark to an ASM file system tags: - VDBs operationId: export_vdb_to_asm_by_bookmark requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportFromBookmarkParameters' description: The parameters to export a vdb. required: true responses: '200': description: VDB export using bookmark to Oracle ASM initiated. content: application/json: schema: type: object title: OracleAsmExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/export-by-timestamp: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using timestamp to a physical file system tags: - VDBs operationId: export_vdb_by_timestamp requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportByTimestampParameters' description: The parameters to export a vdb. required: true responses: '200': description: VDB export using timestamp to a physical file system initiated. content: application/json: schema: type: object title: ExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/export-by-snapshot: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using snapshot to a physical file system tags: - VDBs operationId: export_vdb_by_snapshot requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportBySnapshotParameters' description: The parameters to export a vdb. required: true responses: '200': description: VDB export using snapshot to a physical file system initiated. content: application/json: schema: type: object title: ExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/export-by-location: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Export a vdb using timeflow location to a physical file system tags: - VDBs operationId: export_vdb_by_location requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportByLocationParameters' description: The parameters to export a vdb. required: true responses: '200': description: VDB export using timeflow location to a physical file system initiated. content: application/json: schema: type: object title: ExportResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /vdbs/{vdbId}/export_finalize: parameters: - $ref: '#/components/parameters/vdbIdParam' post: summary: Finalize operation on incremental V2P export tags: - VDBs operationId: export_finalize requestBody: content: application/json: schema: x-body-name: export_finalize $ref: '#/components/schemas/ExportFinalizeParameters' description: Parameters to finalize export (V2P) from the VDB created as part of the Incremental V2P required: false responses: '202': description: VDB export finalize initiated. content: application/json: schema: type: object title: ExportFinalizeResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. 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' ProvisionVDBBySnapshotDefaultsRequest: type: object properties: snapshot_id: type: string description: The ID of the snapshot from which to execute the operation. minLength: 1 maxLength: 256 example: snapshot-123 engine_id: type: string description: The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. minLength: 1 maxLength: 256 example: engine-123 source_data_id: type: string description: The ID of the source object (dSource or VDB) to provision from. If this property is not set, the data_source of the snapshot_id will be used. minLength: 1 maxLength: 256 example: source-123 RollbackVDBBySnapshotParameters: deprecated: true allOf: - $ref: '#/components/schemas/DataPointBySnapshotParameters' BookmarkVDBs: description: VDB id and name associated with bookmark. type: object properties: vdb_id: description: The VDB id. type: string example: vdb-id-1 vdb_name: description: The VDB name. type: string example: vdb-name snapshot_id: description: The snapshot id. type: string example: 1-SNAP-1 source_data_timestamp: description: The timestamp of origin timeline location. type: string format: date-time example: '2021-05-01T08:51:34.148000+00:00' root_parent_id: description: The root of the VDB. type: string example: 1-DBCONTAINER-1 timeflow_id: description: The timeflow id of the snapshot. type: string data_timestamp: description: The bookmark timestamp of the VDB. type: string format: date-time SwitchTimeflowParameters: type: object description: Parameters to switch the timeflow of a VDB. properties: timeflow_id: type: string description: The ID of the timeflow to switch to. example: timeflow-123 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 VirtualDatasetHooks: description: VDB operation hooks. type: object properties: pre_refresh: type: array maxItems: 100 description: The commands to execute on the target environment before refreshing the VDB. items: $ref: '#/components/schemas/Hook' post_refresh: type: array maxItems: 100 description: The commands to execute on the target environment after refreshing the VDB. items: $ref: '#/components/schemas/Hook' deprecated: true pre_self_refresh: type: array maxItems: 100 description: The commands to execute on the target environment before refreshing the VDB with data from itself. items: $ref: '#/components/schemas/Hook' post_self_refresh: type: array maxItems: 100 description: The commands to execute on the target environment after refreshing the VDB with data from itself. items: $ref: '#/components/schemas/Hook' pre_rollback: deprecated: true type: array maxItems: 100 description: The commands to execute on the target environment before rewinding the VDB. items: $ref: '#/components/schemas/Hook' post_rollback: deprecated: true type: array maxItems: 100 description: The commands to execute on the target environment after rewinding the VDB. items: $ref: '#/components/schemas/Hook' configure_clone: type: array maxItems: 100 description: The commands to execute on the target environment when the VDB is created or refreshed. items: $ref: '#/components/schemas/Hook' pre_snapshot: type: array maxItems: 100 description: The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting. items: $ref: '#/components/schemas/Hook' post_snapshot: type: array maxItems: 100 description: The commands to execute on the target environment after snapshotting a virtual source. items: $ref: '#/components/schemas/Hook' pre_start: type: array maxItems: 100 description: The commands to execute on the target environment before starting a virtual source. items: $ref: '#/components/schemas/Hook' post_start: type: array maxItems: 100 description: The commands to execute on the target environment after starting a virtual source. items: $ref: '#/components/schemas/Hook' pre_stop: type: array maxItems: 100 description: The commands to execute on the target environment before stopping a virtual source. items: $ref: '#/components/schemas/Hook' post_stop: type: array maxItems: 100 description: The commands to execute on the target environment after stopping a virtual source. items: $ref: '#/components/schemas/Hook' discriminator: propertyName: class_type 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 OracleCustomEnvVar: type: object properties: cluster_node: type: string description: The cluster node on which the environment variable is relevant. path_parameters: type: string description: 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. var_name: type: string description: The name of the environment variable. var_value: description: The value of the environment variable. type: string StopVDBParameters: type: object description: Parameters to stop a VDB. properties: instances: type: array items: type: integer description: List of specific Oracle Virtual Database Instances to stop. abort: type: boolean description: Whether to issue 'shutdown abort' to shutdown Oracle Virtual DB instances. default: false discriminator: propertyName: class_type 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))) OracleRacCustomEnvFile: type: object properties: node_id: type: string minLength: 1 maxLength: 256 path_parameters: type: string OracleAsmExportByTimestampParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/OracleAsmLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object required: - timeflow_id - timestamp properties: timeflow_id: description: The Timeflow ID. type: string example: 1-ORACLE_TIMEFLOW-2 timestamp: type: string format: date-time description: The timestamp at which to execute the operation. example: '2025-01-31T08:51:34.148000+00:00' AdditionalMountPoint: description: Specifies an additional location on which to mount a subdirectory of an AppData container. type: object properties: shared_path: description: Relative path within the container of the directory that should be mounted. type: string minLength: 1 maxLength: 2048 example: / mount_path: description: Absolute path on the target environment were the filesystem should be mounted type: string minLength: 1 maxLength: 2048 example: /work/ws1 environment_id: description: The entity ID of the environment on which the file system will be mounted. type: string minLength: 1 maxLength: 256 example: environment-123 VirtualizationTask: deprecated: true 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/VirtualizationTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED OracleRacCustomEnvVar: type: object properties: node_id: type: string minLength: 1 maxLength: 256 name: type: string minLength: 1 maxLength: 4096 value: type: string minLength: 1 maxLength: 4096 UpgradeDatabaseParameters: type: object required: - repository_id description: Parameters to upgrade a dSource/VDB. properties: repository_id: type: string description: The id of the dSource/VDB repository to upgrade to. example: 1-ORACLE_INSTALL-4 environment_user_id: type: string description: Reference of the environment user to use for dSource/VDB upgrade. example: HOST_USER-4 ppt_repository: type: string description: The id of the SQL instance on the PPT environment that we want to use for pre-provisioning (MSSQL only). example: 1-MSSQL_INSTANCE-11 OracleAsmInPlaceExportParameters: allOf: - $ref: '#/components/schemas/OracleAsmLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object properties: db_unique_name: type: string description: Unique name to be given to the database after it is converted to physical. maxLength: 30 example: DBOMSR9051BF pdb_name: type: string description: The name to be given to the PDB after it is exported in-place. maxLength: 30 example: CDOMLOTGACDBPDB operations_postV2P: type: boolean description: Indicates operations allowed on virtual source post V2P. default: false ProvisionVDBByLocationParameters: allOf: - $ref: '#/components/schemas/BaseProvisionVDBParameters' - $ref: '#/components/schemas/DataPointByLocationParameters' - type: object properties: engine_id: type: string description: The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. minLength: 1 maxLength: 256 example: engine-123 source_data_id: type: string description: The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. minLength: 1 maxLength: 256 example: source-123 make_current_account_owner: type: boolean default: true description: Whether the account provisioning this VDB must be configured as owner of the VDB. DataPointByLocationParameters: type: object properties: location: type: string description: The location to provision from. minLength: 1 maxLength: 256 example: 112233 timeflow_id: type: string description: ID of the timeflow to provision from. minLength: 1 maxLength: 256 example: timeflow_123 discriminator: propertyName: class_type CredentialsEnvVariable: required: - base_var_name properties: base_var_name: type: string description: 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. minLength: 1 maxLength: 256 password: x-dct-toolkit-credential-field: true type: string description: Password to assign to the environment variables. minLength: 1 maxLength: 256 example: password vault_username: type: string description: Delphix display name for the vault user. minLength: 1 maxLength: 256 example: my-vault vault: type: string description: The name or reference of the vault to assign to the environment variables. minLength: 1 maxLength: 256 example: 1-VAULT-1 hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault azure_vault_username_key: type: string description: Azure vault key in the key-value store. minLength: 1 maxLength: 256 example: username azure_vault_secret_key: type: string description: Azure vault key in the key-value store. minLength: 1 maxLength: 256 example: secret cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test credential_type: type: string description: Credential type of the credential environment variable minLength: 1 maxLength: 256 example: PasswordCredential element_id: type: string description: 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. minLength: 1 maxLength: 256 example: 35 type: type: string description: Type of the credential environment variable minLength: 1 maxLength: 256 example: CredentialsEnvVars RollbackVDBFromBookmarkParameters: deprecated: true allOf: - $ref: '#/components/schemas/DataPointFromBookmarkParameters' 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 StartVDBParameters: type: object description: Parameters to start a VDB. properties: instances: type: array items: type: integer description: List of specific Oracle Virtual Database Instances to start. discriminator: propertyName: class_type VirtualizationTaskEvent: deprecated: true properties: message_details: type: string DataPointByTimestampParameters: type: object properties: timestamp: type: string format: date-time description: The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. example: '2021-05-01T08:51:34.148000+00:00' timestamp_in_database_timezone: description: The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp. type: string pattern: '[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{0,3})?' example: '2021-08-14T14:55:20.507' timeflow_id: description: The Timeflow ID. type: string example: timeflow-123 discriminator: propertyName: class_type Environment: description: A grouping of a single host or a cluster of hosts. type: object properties: id: description: The Environment object entity ID. type: string example: environment-123 name: description: The name of this environment. type: string example: Linux Test Host namespace_id: description: The namespace id of this environment. type: string example: 1-NAMESPACE-1 namespace_name: description: The namespace name of this environment. type: string example: test-engine-1 is_replica: description: Is this a replicated object. type: boolean example: true namespace: description: The namespace of this environment for replicated and restored objects. type: string nullable: true example: NAMESPACE-1 engine_id: description: A reference to the Engine that this Environment connection is associated with. type: string example: engine-123 engine_name: description: A reference to the Engine that this Environment connection is associated with. type: string example: engine-123 address: description: The address of this environment. For a standalone environment, this is the address of the host itself; for a clustered environment, it is the address used to perform cluster discovery. type: string example: winsrc1201.dlpxdc.co enabled: description: True if this environment is enabled. type: boolean example: true encryption_enabled: type: boolean description: Flag indicating whether the data transfer is encrypted or not. example: false description: type: string description: The environment description. example: Windows source host is_cluster: description: True if this environment is a cluster of hosts. type: boolean example: false cluster_home: description: Cluster home for RAC environment. type: string example: /u01/app/12.2.0.1/grid cluster_name: description: Cluster name for Oracle RAC environment. type: string example: abc-19990src cluster_user: description: Cluster user for Oracle RAC environment. type: string example: HOST_USER-4 scan: description: The Single Client Access Name of the cluster (11.2 and greater clusters only). type: string example: abc-scan.xyz.com remote_listener: description: The default remote_listener parameter to be used for databases on the cluster. type: string example: remote-listener.xyz.com is_windows_target: description: True if this windows environment is a target environment. type: boolean example: false staging_environment: description: ID of the staging environment. type: string example: 1-WINDOWS_HOST-8 hosts: description: The hosts that are part of this environment. type: array items: $ref: '#/components/schemas/Host' tags: description: The tags to be created for this environment. type: array items: $ref: '#/components/schemas/Tag' repositories: description: Repositories associated with this environment. A Repository typically corresponds to a database installation. type: array items: $ref: '#/components/schemas/Repository' listeners: description: Oracle listeners associated with this environment. type: array items: $ref: '#/components/schemas/OracleListener' os_type: description: The operating system type of this environment. type: string enum: - UNIX - WINDOWS env_users: description: Environment users associated with this environment. type: array items: $ref: '#/components/schemas/EnvironmentUser' ase_db_user_name: description: The username of the SAP ASE database user. type: string ase_db_credential_type: description: The credential type used for the SAP ASE database user. type: string enum: - PasswordCredential - SystemKeyCredential - KeyPairCredential - KerberosCredential - CyberArkVaultCredential - HashiCorpVaultCredential - AzureVaultCredential ase_enable_tls: description: True if SAP ASE environment configured with TLS/SSL to discover the SAP ASE instances. type: boolean example: false ase_skip_server_certificate_validation: description: If True, ASE database connection will skip the server certificate validation during the TLS/SSL handshake. type: boolean Engine: properties: engine_id: type: string minLength: 1 maxLength: 4000 engine_name: type: string minLength: 1 maxLength: 4000 MigrateVDBParameters: type: object description: Parameters to migrate a VDB. properties: environment_id: type: string description: Id of the environment. example: 1-UNIX_HOST_ENVIRONMENT-2 environment_user_ref: type: string description: Reference of the environment user. example: HOST_USER-10 repository_id: type: string description: Id of the environment repository. example: 1-ORACLE_INSTALL-10 cdb_id: type: string description: Id of the container database. example: 1-ORACLE_SINGLE_CONFIG-12 cluster_node_ids: type: array items: type: string minLength: 1 maxLength: 256 minItems: 1 description: The cluster node ids, name or addresses for this migrate operation (Oracle RAC Only). example: - ORACLE_CLUSTER_NODE-1 cluster_node_instances: type: array items: $ref: '#/components/schemas/ClusterNodeInstance' minItems: 1 description: The cluster node instances details for this migrate operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids. example: - node_reference: ORACLE_CLUSTER_NODE-1 instance_number: 1 instance_name: cluster_instance1 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 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 BookmarkPaaSInstances: description: PaaS Instance id and name associated with bookmark. type: object properties: paas_instance_id: description: The PaaS Instance id. type: string example: paas-instance-id-1 paas_instance_name: description: The PaaS Instance name. type: string example: paas-instance-name root_parent_id: description: The root of the PaaS Instance. type: string example: paas-instance-root-id-1 paas_snapshot_id: description: The PaaS Instance snapshot id. type: string example: 1-SNAP-1 data_timestamp: description: The timestamp of the PaaS Instance snapshot. type: string format: date-time example: '2021-05-01T08:51:34.148000+00:00' ProvisionVDBFromBookmarkDefaultsRequest: type: object required: - bookmark_id properties: bookmark_id: type: string description: The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB. minLength: 1 maxLength: 256 ProvisionVDBByTimestampDefaultsRequest: type: object required: - source_data_id properties: timestamp: type: string format: date-time description: The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. example: '2021-05-01T08:51:34.148000+00:00' timestamp_in_database_timezone: description: The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp. type: string pattern: '[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{0,3})?' example: '2021-08-14T14:55:20.507' engine_id: type: string description: The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. minLength: 1 maxLength: 256 example: engine-123 source_data_id: type: string description: The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. minLength: 1 maxLength: 256 example: source-123 timeflow_id: description: The Timeflow ID. type: string example: timeflow-123 Replica: properties: replica_id: description: The ID of the replicated object. type: string example: replica-1 replica_engine_id: description: The ID of the replicated object's engine. type: string example: '1' replica_engine_name: description: The name of the replicated object's engine. type: string example: replica-e1 replica_namespace_id: description: The namespace id of the replicated object. type: string example: namespace-1 ListSnapshotsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Snapshot' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' BaseExportTransferStrategyParameters: type: object properties: rman_channels: description: Number of data streams to connect to the database. type: integer minimum: 1 maximum: 32 default: 8 rman_file_section_size_in_gb: type: integer description: Number of GigaBytes in which RMAN will break large files to back them in parallel. default: 0 discriminator: propertyName: class_type OracleAsmExportBySnapshotParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/OracleAsmLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object properties: snapshot_id: type: string description: The ID of the snapshot from which to execute the operation. If snapshot_id is not provided, the latest snapshot will be selected. UpgradeOracleDatabaseParameters: deprecated: true type: object required: - repository_id - environment_user_id description: Parameters to upgrade an Oracle dataset. properties: repository_id: type: string description: The id of the dSource/VDB repository to upgrade to. example: 1-ORACLE_INSTALL-4 environment_user_id: type: string description: Reference of the environment user to use for dSource/VDB upgrade. example: HOST_USER-4 Hook: properties: name: type: string minLength: 1 maxLength: 256 example: Print the current user command: type: string minLength: 1 example: whoami shell: type: string enum: - bash - shell - expect - ps - psd example: bash element_id: type: string minLength: 1 maxLength: 256 example: '3' description: Pass the element_id only when updating an existing hook, omit to create a new one. has_credentials: type: boolean example: false credentials_env_vars: type: array items: $ref: '#/components/schemas/CredentialsEnvVariable' hook_template_id: type: string example: Hook Template 1 ProvisionVDBResponse: properties: job: $ref: '#/components/schemas/Job' description: The initiated job. vdb_id: type: string description: The ID of the provisioned vdb. ProvisionVDBByTimestampParameters: allOf: - $ref: '#/components/schemas/BaseProvisionVDBParameters' - $ref: '#/components/schemas/DataPointByTimestampParameters' - type: object required: - source_data_id properties: engine_id: type: string description: The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. minLength: 1 maxLength: 256 example: engine-123 source_data_id: type: string description: The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. minLength: 1 maxLength: 256 example: source-123 make_current_account_owner: type: boolean default: true description: Whether the account provisioning this VDB must be configured as owner of the VDB. EngineStorageCapacityDependencyData: description: Engine storage capacity dependency data. allOf: - $ref: '#/components/schemas/EngineStorageCapacityData' - type: object properties: parent_id: type: string description: ID of the parent dataset. OracleAsmExportFromBookmarkParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/OracleAsmLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object required: - bookmark_id properties: bookmark_id: type: string description: The ID of the bookmark from which to execute the operation. minLength: 1 maxLength: 256 Host: description: A physical/virtual server. type: object properties: id: description: The entity ID of this Host. type: string minLength: 1 maxLength: 256 example: 3-UNIX_HOST-5 reference: description: Delphix engine equivalent constant type: string example: UNIX_HOST-5 hostname: description: The hostname or IP address of this host. type: string example: linux.dev.delphix.com os_name: description: The name of the OS on this host. type: string example: Linux os_version: description: The version of the OS on this host. type: string example: Red Hat Enterprise Linux Server release 7.3 (Maipo) distribution: description: The name of the OS distribution on this host. type: string example: RedHat memory_size: description: The total amount of memory on this host in bytes. type: integer format: int64 example: 8382160896 available: description: True if the host is up and a connection can be established from the engine. type: boolean example: false available_timestamp: description: The last time the available property was updated. type: string format: date-time example: '2022-06-02T17:49:11.457Z' not_available_reason: description: The reason why the host is not available. type: string example: Failed to connect to host oracle_cluster_node_reference: description: The reference to the associated OracleClusterNode. type: string example: ORACLE_CLUSTER_NODE-1 oracle_cluster_node_name: description: The name of the associated OracleClusterNode. type: string example: my-favorite-cluster-node oracle_cluster_node_enabled: description: Whether the associated OracleClusterNode is enabled. type: boolean example: true oracle_cluster_node_discovered: description: Whether the associated OracleClusterNode was discovered. type: boolean example: true oracle_cluster_node_virtual_ips: description: The Virtual IP addresses associated with the OracleClusterNode. type: array items: $ref: '#/components/schemas/OracleVirtualIP' oracle_cluster_node_instances: description: The instances associated with the OracleClusterNode. type: array items: $ref: '#/components/schemas/OracleClusterNodeInstance' windows_cluster_node_reference: description: The reference to the associated WindowsClusterNode. type: string example: WINDOWS_CLUSTER_NODE-1 windows_cluster_node_name: description: The name of the associated WindowsClusterNode. type: string example: my-favorite-cluster-node windows_cluster_node_discovered: description: Whether the associated Windows cluster node was discovered. type: boolean example: true nfs_addresses: description: The list of host/IP addresses to use for NFS export. type: array items: type: string uniqueItems: true example: - 192.168.10.2 dsp_keystore_alias: description: The lowercase alias to use inside the user managed DSP keystore. type: string minLength: 1 example: oracle-env dsp_keystore_path: description: The path to the user managed DSP keystore. type: string minLength: 1 example: /tmp/keystore.keystore dsp_truststore_path: description: The path to the user managed DSP truststore. type: string minLength: 1 example: /tmp/truststore.keystore java_home: description: The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. type: string minLength: 1 example: /Library/Java/JavaVirtualMachines/jdk/Contents/Home ssh_port: description: The port number used to connect to the host via SSH. type: integer example: 22 toolkit_path: description: The path for the toolkit that resides on the host. type: string minLength: 1 example: /work connector_port: description: The port that the Windows Connector connects on. type: integer example: 9100 connector_version: description: The Windows Connector version that is installed on the provided host. type: string example: 1.17.0 connector_dot_net_framework_version: description: The .NET Framework version used for Windows Connector Service. type: string example: '3.5' oracle_tde_keystores_root_path: description: The path to the root of the Oracle TDE keystores artifact directories. type: string minLength: 1 example: /keystore/root/path oracle_tde_okv_home_path: description: The path to the Oracle Key Vault library installation on the database node. type: string minLength: 1 example: /work/okv processor_type: description: The platform for the host machine. type: string example: x86_64 timezone: description: The OS timezone. type: string example: America/New_York,EST-0500 powershell_version: description: The PowerShell version installed on the windows target host. type: string example: 5.1.17763.134 release: description: The OS release. type: string example: '6.3' trace_route_info: description: Traceroute network hops from host to Delphix Engine. type: string example: 1 <1 ms <1 ms <1 ms 10.110.232.122 is_tde_external_key_manager_password_set: description: True if Oracle TDE External key Manager password is set. type: boolean example: true BookmarkPaaSDatabases: description: PaaS Database id and name associated with bookmark. type: object properties: paas_database_id: description: The PaaS Database id. type: string example: paas-database-id-1 paas_database_name: description: The PaaS Database name. type: string example: paas-database-name root_parent_id: description: The root of the PaaS Database. type: string example: paas-instance-id-1 paas_snapshot_id: description: The PaaS Snapshot id. type: string example: 1-SNAP-1 data_timestamp: description: The timestamp of the PaaS Snapshot. type: string format: date-time example: '2021-05-01T08:51:34.148000+00:00' EnvironmentUser: type: object properties: user_ref: description: Environment user reference type: string minLength: 1 maxLength: 4000 example: user-ref-1 username: description: Username of environment user. type: string minLength: 1 maxLength: 4000 example: username-1 primary_user: description: This indicates if this user is primary or not type: boolean example: false auth_type: description: Authentication type of this user. PasswordCredential indicates username and password are used, SystemKeyCredential indicates public key based security credential, KeyPairCredential indicates public key based security credential consisting of a user specified key pair, KerberosCredential indicates Kerberos authentication, CyberArkVaultCredential indicates CyberArk Vault is used and HashiCorpVaultCredential indicates that Hashicorp vault is used for authentication type: string enum: - PasswordCredential - SystemKeyCredential - KeyPairCredential - KerberosCredential - CyberArkVaultCredential - HashiCorpVaultCredential - AzureVaultCredential vault: type: string description: The name or reference of the vault from which to read the host credentials. minLength: 1 maxLength: 256 example: my-vault hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env hashicorp_vault_username_key: type: string description: Key for the username in the key-value store. minLength: 1 maxLength: 256 example: username-key hashicorp_vault_secret_key: type: string description: Key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret-key cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username-key azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret-key custom_public_key: type: string description: Public key to be used for authentication minLength: 1 maxLength: 6000 RefreshVDBByTimestampParameters: allOf: - $ref: '#/components/schemas/DataPointByTimestampParameters' - type: object properties: dataset_id: type: string description: ID of the dataset to refresh to, mutually exclusive with timeflow_id. minLength: 1 maxLength: 256 example: 123-CONTAINER_1 timeflow_id: type: string description: ID of the timeflow to refresh to, mutually exclusive with dataset_id. minLength: 1 maxLength: 256 example: timeflow_123 EngineStorageDatasetType: type: string description: Type of the dataset. enum: - VDB - DSOURCE - CDB - VCDB - HELDSPACE ExportByLocationParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/FilesystemLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object required: - location properties: location: type: string description: The timeflow point location to execute the operation. minLength: 1 maxLength: 256 example: 112233 ExportBySnapshotParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/FilesystemLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object properties: snapshot_id: type: string description: The ID of the snapshot from which to execute the operation. If snapshot_id is not provided, the latest snapshot will be selected. MSSQLClusterListener: properties: type: description: Type of this listener. $ref: '#/components/schemas/MSSQLListenerTypeEnum' example: MSSqlAvailabilityGroupListener address: description: The address of the listener. type: string example: ag-w16-tgt-agl.qa-ad.delphix.com name: description: The name of the listener. type: string example: ag-w16-tgt-agl port: description: The port for the listener. type: integer example: 1433 DeleteVDBParameters: type: object description: Parameters to delete a VDB. properties: force: type: boolean description: Whether to continue the operation upon failures. default: false delete_all_dependent_vdbs: type: boolean description: Flag indicating whether to delete all dependent VDBs before deleting the VDB. default: false move_to_recycle_bin: x-internal: true type: boolean description: Flag indicating that VDB needs to be marked for deletion and sent to recycle bin instead of permanent deletion. default: false ProvisionVDBBySnapshotParameters: allOf: - $ref: '#/components/schemas/BaseProvisionVDBParameters' - $ref: '#/components/schemas/DataPointBySnapshotParameters' - type: object properties: engine_id: type: string description: The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. minLength: 1 maxLength: 256 example: engine-123 source_data_id: type: string description: The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. If this property is not set, the data_source of the snapshot_id will be used. minLength: 1 maxLength: 256 example: source-123 make_current_account_owner: type: boolean default: true description: Whether the account provisioning this VDB must be configured as owner of the VDB. FilesystemLayoutParameters: type: object properties: type: x-internal: true type: string description: The type of the filesystem layout. example: OracleFilesystemLayout targetDirectory: type: string description: The base directory to use for the exported database. example: /work/v2pdb dataDirectory: type: string description: The directory for data files. example: /work/v2pdb/data archiveDirectory: type: string description: The directory for archive files. example: /work/v2pdb/archive externalDirectory: type: string description: The directory for external files. example: /work/v2pdb/external tempDirectory: type: string description: The directory for temporary files. example: /work/v2pdb/temp scriptDirectory: type: string description: The directory for script files. example: /work/v2pdb/script useAbsolutePathForDataFiles: type: boolean description: Whether to use absolute path for data files (Oracle only). example: false discriminator: propertyName: class_type 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' OracleActiveInstance: type: object properties: instance_number: type: integer description: The number of this instance. minimum: 1 instance_name: description: The name of this instance. type: string host_name: type: string description: The reference to the cluster node which the instance is running on. EnableVDBParameters: type: object description: Parameters to enable a VDB. properties: attempt_start: type: boolean description: Whether to attempt a startup of the VDB after the enable. default: true container_mode: type: boolean description: Whether the database is running inside a container. ownership_spec: type: string description: The uid:gid string that NFS mounts should belong to. maxLength: 1024 discriminator: propertyName: class_type 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 OracleListener: properties: id: description: Id of this listener. type: string example: 1-ORACLE_NODE_LISTENER-11 name: description: Name of this listener. type: string example: my-listener type: description: Type of this listener. $ref: '#/components/schemas/OracleListenerTypeEnum' example: NODE protocol_addresses: description: The list of protocol addresses for this listener. type: array items: type: string example: - (ADDRESS=(PROTOCOL=tcp)(HOST=10.75.59.184)(PORT=4567)) - (ADDRESS=(PROTOCOL=ipc)(KEY=LISTENER)) client_endpoints: description: The list of client endpoints for this listener. type: array items: type: string example: - (ADDRESS=(PROTOCOL=tcp)(HOST=10.75.59.184)(PORT=4567)) is_discovered: description: Whether this listener was automatically discovered or not. type: boolean host_id: description: Id to the host this listener is associated with. type: string example: 1-UNIX_HOST-14 Error: type: object properties: message: type: string readOnly: true description: Message providing more detail about the error that occurred, if available. object_name: type: string readOnly: true description: Name of the object affected by the error. OracleAsmExportByLocationParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/OracleAsmLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object required: - location properties: location: type: string description: The SCN value in the snapshot to perform the export from this SCN location. minLength: 1 maxLength: 256 example: 112233 ExportByTimestampParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/FilesystemLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object required: - timeflow_id - timestamp properties: timeflow_id: description: The Timeflow ID. type: string example: 1-ORACLE_TIMEFLOW-2 timestamp: type: string format: date-time description: The timestamp at which to execute the operation. example: '2025-01-31T08:51:34.148000+00:00' RefreshVDBFromBookmarkParameters: allOf: - $ref: '#/components/schemas/DataPointFromBookmarkParameters' ExportDBTimeflowPointParameters: type: object properties: unique_name: type: string description: The unique name of the database. example: DBOMSRBBDC6C database_name: type: string description: The name of the database. example: DBOMSRBB repository_id: type: string description: The repository_id to use for this operation. example: 1-ORACLE_INSTALL-1 environment_user_ref: type: string description: The environment user reference. example: HOST_USER-10 tde_keystore_password: x-dct-toolkit-credential-field: true deprecated: true type: string description: The password for the Transparent Data Encryption keystore associated with this database. example: password tde_keystore_config_type: deprecated: true description: The TDE keystore configuration type of this database. $ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum' example: OKV oracle_instance_name: type: string description: SID of the exported database pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 15 example: DBOMSRBBDC6C instance_number: type: integer format: int32 description: The number of the instance. example: 1 instances: type: array items: $ref: '#/components/schemas/OracleRACDatabaseInstance' mount_base: type: string description: The base mount point to use for the NFS mounts for the temporary VDB. example: /tmp/provision config_params: description: Database configuration parameter overrides. type: object additionalProperties: true nullable: true example: param: value param2: value2 cdb_id: description: ID of an Oracle multitenant database this pluggable database belongs to. type: string example: CDOMLOSRB5A3 parent_tde_keystore_path: type: string description: Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. example: /work/tde/parent_keystore parent_tde_keystore_password: x-dct-toolkit-credential-field: true type: string description: The password of the keystore specified in parentTdeKeystorePath. example: password tde_exported_keyfile_secret: x-dct-toolkit-credential-field: true type: string description: Secret to be used while exporting and importing vPDB encryption keys. example: secret tde_key_identifier: type: string description: PDB database master encryption key id, as recorded in v$encryption_keys.key_id. example: Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA parent_pdb_tde_keystore_path: description: 'Path to a copy of the parent PDB''s Oracle transparent data encryption keystore on the target host. Required to export of PDB containing encrypted database files with isolated mode keystore.(Oracle Multitenant Only) ' type: string minLength: 1 maxLength: 512 example: /work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde parent_pdb_tde_keystore_password: x-dct-toolkit-credential-field: true description: The password of the parent PDB keystore. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 128 example: password target_pdb_tde_keystore_password: x-dct-toolkit-credential-field: true description: The password for the isolated mode TDE keystore of the target PDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 128 example: password crs_database_name: type: string description: The Oracle Clusterware database name. example: DBOMSR9051BF recover_database: type: boolean default: true description: If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. example: true file_mapping_rules: type: string description: Database file mapping rules. enable_cdc: type: boolean default: false description: Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). example: false recovery_model: type: string description: Recovery model of the database (MSSql Only). enum: - FULL - SIMPLE - BULK_LOGGED default: FULL example: FULL mirroring_state: type: string description: Recovery model of the database (MSSql Only). enum: - SUSPENDED - DISCONNECTED - SYNCHRONIZING - PENDING_FAILOVER - SYNCHRONIZED - NOT_SYNCHRONIZED - FAILOVER_POSSIBLE - NONE default: NONE example: SUSPENDED is_incremental_v2p: type: boolean description: Whether to enable incremental V2P (Virtual to Physical) export. When enabled, the export will be configured for incremental backups. example: false backup_frequency_minutes: type: integer format: int32 minimum: 10 default: 30 description: The frequency with which the incremental backup will be taken in minutes. example: 30 rman_channels_for_incremental_backup: type: integer format: int32 minimum: 1 maximum: 255 description: Number of data streams to connect to the database for incremental backup. default: 8 example: 4 rman_files_per_set_for_incremental_backup: type: integer format: int32 minimum: 1 maximum: 64 description: Number of data files to include in each RMAN backup set for incremental backup. default: 5 example: 8 rman_file_section_size_in_gb_for_incremental_backup: type: integer format: int32 minimum: 0 description: Number of GigaBytes in which RMAN will break large files to back them up in parallel for incremental backup. default: 0 example: 0 invoke_datapatch: type: boolean default: false description: Indicates whether to invoke Oracle's datapatch utility during post recovery step of exportFinalize. Requires Delphix engine version 2025.6.0.0 (API version 1.11.46) or later. example: false discriminator: propertyName: class_type RefreshVDBBySnapshotParameters: allOf: - $ref: '#/components/schemas/DataPointBySnapshotParameters' DisableVDBParameters: type: object description: Parameters to disable a VDB. properties: attempt_cleanup: type: boolean description: Whether to attempt a cleanup of the VDB before the disable. default: true container_mode: type: boolean description: Whether the database is running inside a container. discriminator: propertyName: class_type EngineStorageCapacityData: properties: engine_id: type: string description: ID of the engine. dataset_id: type: string description: ID of the dataset. captured_timestamp: type: string format: date-time description: Time at which this information was sampled. dataset_type: description: Type of the dataset. $ref: '#/components/schemas/EngineStorageDatasetType' dataset_name: type: string description: Name of the dataset. is_replica: type: boolean description: Flag to specify if this object is a replica. total_size: type: integer format: int64 description: Actual space used by the dataset. base_size: type: integer format: int64 description: Amount of space used for the active copy of the dataset. snapshot_size: type: integer format: int64 description: Amount of space used by snapshots. logs_size: type: integer format: int64 description: Amount of space used by logs. unvirtualized_size: type: integer format: int64 description: Unvirtualized space used by the dataset. current_timeflow_unvirtualized_size: type: integer format: int64 description: Unvirtualized space used by the current (active) TimeFlow. This is approximately equal to the space a VDB would take upon a virtual-to-physical (V2P) operation. timeflow_unvirtualized_size: type: integer format: int64 description: Unvirtualized space used by the TimeFlow. descendant_size: type: integer format: int64 description: Amount of space used for snapshots from which VDBs have been provisioned. policy_size: type: integer format: int64 description: Amount of space used for snapshots held by policy settings. manual_size: type: integer format: int64 description: Amount of space used for snapshots held by manual retention settings. unowned_snapshot_size: type: integer format: int64 description: Amount of space used for snapshots part of held space. ingested_size: type: integer format: int64 description: Amount of space ingested by the source. tags: description: The tags that are applied to dataset. type: array items: $ref: '#/components/schemas/Tag' discriminator: propertyName: class_type OracleTdeKeystoreConfigTypeEnum: type: string description: Oracle TDE keystore configuration type. enum: - FILE - OKV - HSM - OKV|FILE - FILE|OKV - HSM|FILE - FILE|HSM - OCI_VAULT - UNSET ClusterNodeInstance: type: object required: - node_reference - instance_number - instance_name properties: node_reference: type: string minLength: 1 maxLength: 256 minItems: 1 description: The cluster node id, name or addresses for this provision operation instance_number: type: integer description: The instance number for this provision operation instance_name: type: string minLength: 1 maxLength: 256 description: The instance name for this provision operation 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. type: string minLength: 1 pattern: .*\S.* example: 1-ORACLE_OKV_CLIENT-1 BookmarkDSources: description: dSource id and name associated with bookmark. type: object properties: dsource_id: description: The dSource id. type: string example: dsource-id-1 dsource_name: description: The dSource name. type: string example: dsource-name snapshot_id: description: The snapshot id. type: string example: 1-SNAP-1 timeflow_id: description: The timeflow id. type: string example: 1-ORACLE-TIMEFLOW-1 data_timestamp: description: The bookmark timestamp of the dSource. type: string format: date-time BaseProvisionVDBParameters: allOf: - $ref: '#/components/schemas/VirtualDatasetHooks' - type: object properties: target_group_id: type: string description: The ID of the group into which the VDB will be provisioned. This field must be explicitly set when marked as mandatory; otherwise, a group is selected randomly on the Engine. minLength: 1 maxLength: 256 example: group-123 name: type: string description: The unique name of the provisioned VDB within a group. This field must be explicitly set when marked as mandatory; otherwise, a name will be randomly generated. minLength: 1 maxLength: 256 example: my-test-vdb database_name: type: string description: The name of the database on the target environment. Defaults to the value of the name property. minLength: 1 maxLength: 256 example: my-test-database cdb_id: x-dct-toolkit-subcommand: oracle type: string description: The ID of the container database (CDB) to provision an Oracle Multitenant database into. This corresponds to a CDB or VCDB API object. When this is not set, a new vCDB will be provisioned. minLength: 1 maxLength: 256 example: ORACLE_SINGLE_CONFIG-376 cluster_node_ids: x-dct-toolkit-subcommand: oracle type: array items: type: string minLength: 1 maxLength: 256 minItems: 1 description: The cluster node ids, name or addresses for this provision operation (Oracle RAC Only). example: - ORACLE_CLUSTER_NODE-1 cluster_node_instances: x-dct-toolkit-subcommand: oracle type: array items: $ref: '#/components/schemas/ClusterNodeInstance' minItems: 1 description: The cluster node instances details for this provision operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids. example: - node_reference: ORACLE_CLUSTER_NODE-1 instance_number: 1 instance_name: cluster_instance1 okv_client_id: 1-ORACLE_OKV_CLIENT-1 truncate_log_on_checkpoint: x-dct-toolkit-subcommand: sybase type: boolean description: Whether to truncate log on checkpoint (ASE only). example: true os_username: x-dct-toolkit-subcommand: oracle type: string description: The name of the privileged user to run the provision operation (Oracle Only). minLength: 1 maxLength: 256 example: os-user-x os_password: x-dct-toolkit-credential-field: true x-dct-toolkit-subcommand: oracle type: string description: The password of the privileged user to run the provision operation (Oracle Only). minLength: 1 maxLength: 256 example: os-user-secret-password environment_id: type: string description: The ID of the target environment where to provision the VDB. If repository_id unambigously identifies a repository, this is unnecessary and ignored. Otherwise, a compatible repository is randomly selected on the environment. minLength: 1 maxLength: 256 example: environment-123 environment_user_id: type: string description: The environment user ID to use to connect to the target environment. minLength: 1 maxLength: 256 example: environment-user-123 repository_id: type: string description: The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation (Oracle home, database instance, ...). Setting this attribute implicitly determines the environment where to provision the VDB. minLength: 1 maxLength: 256 example: oracle-home-123 auto_select_repository: type: boolean description: Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id. example: true vdb_restart: type: boolean description: Indicates whether the Engine should automatically restart this virtual source when target host reboot is detected. example: true template_id: type: string description: The ID of the target VDB Template (Oracle and MSSql Only). minLength: 1 maxLength: 256 example: template-123 auxiliary_template_id: x-dct-toolkit-subcommand: oracle type: string description: The ID of the configuration template to apply to the auxiliary container database. This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set.(Oracle Only) minLength: 1 maxLength: 256 example: aux-template-123 file_mapping_rules: x-dct-toolkit-subcommand: oracle type: string description: Target VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order. minLength: 1 maxLength: 131072 example: '/datafile/dbdhcp3/oradata/dbdhcp3:/data /u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf' oracle_instance_name: x-dct-toolkit-subcommand: oracle type: string description: Target VDB SID name (Oracle Only). pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 15 example: dbdhcp2 unique_name: x-dct-toolkit-subcommand: oracle type: string description: Target VDB db_unique_name (Oracle Only). pattern: ^[a-zA-Z0-9_\$#]+$ minLength: 1 maxLength: 30 example: dbdhcp2 vcdb_name: x-dct-toolkit-subcommand: oracle type: string description: When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the name of the provisioned vCDB (Oracle Multitenant Only). pattern: ^[a-zA-Z0-9_]+$ minLength: 1 maxLength: 256 example: VCCD_6QQ vcdb_database_name: x-dct-toolkit-subcommand: oracle type: string description: When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only). minLength: 1 maxLength: 8 example: VCCD_6QQ mount_point: type: string description: Mount point for the VDB (Oracle, ASE, AppData). minLength: 1 maxLength: 256 example: /var/mnt open_reset_logs: x-dct-toolkit-subcommand: oracle type: boolean description: Whether to open the database after provision (Oracle Only). example: true snapshot_policy_id: type: string description: The ID of the snapshot policy for the VDB. minLength: 1 maxLength: 256 example: snapshot-123 retention_policy_id: type: string description: The ID of the retention policy for the VDB. minLength: 1 maxLength: 256 example: retention-policy-123 recovery_model: x-dct-toolkit-subcommand: mssql type: string description: Recovery model of the source database (MSSql Only). enum: - FULL - SIMPLE - BULK_LOGGED example: FULL pre_script: x-dct-toolkit-subcommand: mssql type: string description: PowerShell script or executable to run prior to provisioning (MSSql Only). minLength: 1 maxLength: 1024 example: C:\Program Files\Delphix\scripts\myscript.ps1 post_script: x-dct-toolkit-subcommand: mssql type: string description: PowerShell script or executable to run after provisioning (MSSql Only). minLength: 1 maxLength: 1024 example: C:\Program Files\Delphix\scripts\myscript.ps1 cdc_on_provision: x-dct-toolkit-subcommand: mssql type: boolean description: Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (MSSql Only). example: true online_log_size: x-dct-toolkit-subcommand: oracle description: Online log size in MB (Oracle Only). type: integer minimum: 4 example: 4 online_log_groups: x-dct-toolkit-subcommand: oracle description: Number of online log groups (Oracle Only). type: integer minimum: 2 example: 2 archive_log: x-dct-toolkit-subcommand: oracle description: Option to create a VDB in archivelog mode (Oracle Only). type: boolean example: true new_dbid: x-dct-toolkit-subcommand: oracle description: Option to generate a new DB ID for the created VDB (Oracle Only). type: boolean example: true masked: description: Indicates whether to mark this VDB as a masked VDB. type: boolean example: true listener_ids: x-dct-toolkit-subcommand: oracle description: The listener IDs for this provision operation (Oracle Only). type: array items: type: string minLength: 1 maxLength: 256 example: - listener-123 - listener-456 custom_env_vars: description: Environment variable to be set when the engine creates a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. type: object additionalProperties: type: string minLength: 1 maxLength: 4096 example: MY_ENV_VAR1: $ORACLE_HOME MY_ENV_VAR2: $CRS_HOME/after custom_env_files: description: Environment files to be sourced when the Engine creates a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. type: array items: type: string minLength: 1 maxLength: 4096 example: - /export/home/env_file_1 - /export/home/env_file_2 oracle_rac_custom_env_files: x-dct-toolkit-subcommand: oracle description: Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. type: array items: $ref: '#/components/schemas/OracleRacCustomEnvFile' example: - node_id: ORACLE_CLUSTER_NODE-1 path_parameters: /export/home/env_file_1 oracle_rac_custom_env_vars: x-dct-toolkit-subcommand: oracle description: Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. type: array items: $ref: '#/components/schemas/OracleRacCustomEnvVar' example: - node_id: ORACLE_CLUSTER_NODE-1 name: MY_ENV_VAR1 value: $CRS_HOME/after parentTdeKeystorePath: x-dct-toolkit-subcommand: oracle description: 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. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: /foo/bar/tde parent_tde_keystore_password: x-dct-toolkit-credential-field: true x-dct-toolkit-subcommand: oracle description: The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: password parent_pdb_tde_keystore_path: x-dct-toolkit-subcommand: oracle description: '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. (Oracle Multitenant Only) ' type: string minLength: 1 maxLength: 512 example: /work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde parent_pdb_tde_keystore_password: x-dct-toolkit-credential-field: true x-dct-toolkit-subcommand: oracle description: The password of the parent PDB keystore. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 128 example: password target_pdb_tde_keystore_password: x-dct-toolkit-credential-field: true x-dct-toolkit-subcommand: oracle description: The password for the isolated mode TDE keystore of the target virtual PDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 128 example: password tde_exported_key_file_secret: x-dct-toolkit-subcommand: oracle description: Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: secret tde_key_identifier: x-dct-toolkit-subcommand: oracle description: ID of the key created by Delphix. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 256 example: tde-indentifier target_vcdb_tde_keystore_path: x-dct-toolkit-subcommand: oracle description: Path to the keystore of the target vCDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: /foo/cdb/tde cdb_tde_keystore_password: x-dct-toolkit-credential-field: true x-dct-toolkit-subcommand: oracle description: The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: cdb-password vcdb_tde_key_identifier: x-dct-toolkit-subcommand: oracle description: ID of the key created by Delphix. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 256 example: vcdb-identifier tde_keystore_config_type: x-dct-toolkit-subcommand: oracle description: The TDE keystore configuration type of the target new vCDB. $ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum' example: OKV okv_client_id: x-dct-toolkit-subcommand: oracle description: The id of the OKV client used by the target new vCDB for TDE keystore access. If provided, it must include at least one non-whitespace character. type: string minLength: 1 pattern: .*\S.* example: 1-ORACLE_OKV_CLIENT-1 appdata_source_params: x-dct-toolkit-subcommand: appdata description: The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. type: object additionalProperties: true example: param: value additional_mount_points: x-dct-toolkit-subcommand: appdata description: Specifies additional locations on which to mount a subdirectory of an AppData container. type: array items: $ref: '#/components/schemas/AdditionalMountPoint' nullable: true example: - shared_path: / mount_path: /work environment_id: environment-123 appdata_config_params: x-dct-toolkit-subcommand: appdata description: The list of parameters specified by the source config schema in the toolkit type: object additionalProperties: true nullable: true example: option: value config_params: description: Database configuration parameter overrides. type: object additionalProperties: true nullable: true example: processes: 150 privileged_os_user: x-dct-toolkit-subcommand: postgres type: string description: This privileged unix username will be used to create the VDB. Leave this field blank if you do not want to use privilege elevation. The unix privileged username should begin with a letter or an underscore, followed by letters, digits, underscores, or dashes. They can end with a dollar sign (postgres only). pattern: ^$|^[a-zA-Z_][a-zA-Z0-9_\-]+[$]?$ maxLength: 32 postgres_port: x-dct-toolkit-subcommand: postgres type: integer description: Port number for Postgres target database (postgres only). minimum: 1 maximum: 65536 config_settings_stg: x-dct-toolkit-subcommand: postgres type: array description: Custom Database-Level config settings (postgres only). items: $ref: '#/components/schemas/ConfigSettingsStg' vcdb_restart: x-dct-toolkit-subcommand: oracle type: boolean description: Indicates whether the Engine should automatically restart this vCDB when target host reboot is detected. If vdb_restart property value is not explicitly set and vcdb_restart is set as false - the vdb_restart property is defaulted to false. example: true mssql_failover_drive_letter: x-dct-toolkit-subcommand: mssql type: string description: Base drive letter location for mount points. (MSSql Only). minLength: 1 maxLength: 1 tags: type: array maxItems: 1000 description: The tags to be created for VDB. items: $ref: '#/components/schemas/Tag' minItems: 1 invoke_datapatch: x-dct-toolkit-subcommand: oracle type: boolean description: Whether to invoke datapatch during provisioning (Oracle Only). example: false container_mode: x-dct-toolkit-subcommand: oracle type: boolean description: Whether the virtual database will be provisioned for a containerized environment, such as Linux containers. example: false mssql_ag_backup_location: x-dct-toolkit-subcommand: mssql type: string description: Shared backup location to be used for VDB provision on AG Cluster. example: shared_backup_location/location1 mssql_ag_backup_based: x-dct-toolkit-subcommand: mssql type: boolean description: 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 cache_priority: description: 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. type: string enum: - NORMAL - HIGH example: HIGH mssql_incremental_export_backup_frequency_minutes: x-dct-toolkit-subcommand: mssql type: integer description: Frequency in minutes for incremental export backups for VDBs. minimum: 10 example: 30 discriminator: propertyName: class_type TagsResponse: type: object properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' OracleClusterNodeInstance: description: An oracle cluster node instance. type: object properties: instance_name: description: The name of this instance. type: string instance_number: type: integer description: The number of this instance. source_id: type: string description: The id of Source this instance belongs to. ExportCleanupParameters: type: object description: Parameters to cleanup VDB created as part of the Incremental V2P properties: cleanup_target_physical_files: type: boolean description: Flag indicating whether to delete the database files already copied to target physical storage for export (V2P). default: false cleanup_target_container: type: boolean description: Flag indicating whether to delete the temporary virtual source created for export (V2P). default: false ProvisionVDBFromBookmarkParameters: allOf: - $ref: '#/components/schemas/BaseProvisionVDBParameters' - $ref: '#/components/schemas/DataPointFromBookmarkParameters' - type: object properties: make_current_account_owner: type: boolean default: true description: Whether the account provisioning this VDB must be configured as owner of the VDB. NfsVersionReasonEnum: type: string description: 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 UpdateVDBParameters: type: object description: Parameters to update a VDB. properties: name: type: string description: The unique name of the VDB within a group. minLength: 1 maxLength: 256 example: my-vdb description: description: The container description of this VDB. type: string example: Updated VDB description. db_username: type: string description: The username of the database user (Oracle, ASE Only). minLength: 1 maxLength: 256 example: db-username db_password: x-dct-toolkit-credential-field: true type: string description: The password of the database user (Oracle, ASE Only). minLength: 1 maxLength: 256 example: db-password validate_db_credentials: type: boolean default: true description: Whether db_username and db_password must be validated, if present, against the VDB. This must be set to false when credentials validation is not possible, for instance if the VDB is known to be disabled. example: true auto_restart: type: boolean description: Whether to enable VDB restart. environment_user_id: type: string description: The environment user ID to use to connect to the target environment. minLength: 1 maxLength: 256 example: environment-user-123 template_id: type: string description: The ID of the target VDB Template (Oracle and MSSql Only). maxLength: 256 example: template-123 listener_ids: description: The listener IDs for this provision operation (Oracle Only). type: array items: type: string minLength: 1 maxLength: 256 example: - listener-123 - listener-456 new_dbid: type: boolean description: Whether to enable new DBID for Oracle cdc_on_provision: type: boolean description: Whether to enable CDC on provision for MSSql pre_script: type: string description: Pre script for MSSql. minLength: 1 maxLength: 1024 post_script: type: string description: Post script for MSSql. minLength: 1 maxLength: 1024 hooks: $ref: '#/components/schemas/VirtualDatasetHooks' custom_env_vars: description: Environment variable to be set when the engine administers a VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled. type: object additionalProperties: type: string minLength: 1 maxLength: 4096 example: MY_ENV_VAR1: $ORACLE_HOME MY_ENV_VAR2: $CRS_HOME/after custom_env_files: description: Environment files to be sourced when the Engine administers a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled. type: array items: type: string minLength: 1 maxLength: 4096 example: - /export/home/env_file_1 - /export/home/env_file_2 oracle_rac_custom_env_files: description: Environment files to be sourced when the Engine administers an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled. type: array items: $ref: '#/components/schemas/OracleRacCustomEnvFile' example: - node_id: ORACLE_CLUSTER_NODE-1 path_parameters: /export/home/env_file_1 oracle_rac_custom_env_vars: description: Environment variable to be set when the engine administers an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VDB is disabled. type: array items: $ref: '#/components/schemas/OracleRacCustomEnvVar' example: - node_id: ORACLE_CLUSTER_NODE-1 name: MY_ENV_VAR1 value: $CRS_HOME/after parent_tde_keystore_path: description: 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. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: /foo/bar/tde parent_tde_keystore_password: x-dct-toolkit-credential-field: true description: The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: password tde_key_identifier: description: ID of the key created by Delphix. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 256 example: tde-indentifier target_vcdb_tde_keystore_path: description: Path to the keystore of the target vCDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: /foo/cdb/tde cdb_tde_keystore_password: x-dct-toolkit-credential-field: true description: The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 1024 example: cdb-password parent_pdb_tde_keystore_path: description: '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. (Oracle Multitenant Only) ' type: string minLength: 1 maxLength: 512 example: /work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde parent_pdb_tde_keystore_password: x-dct-toolkit-credential-field: true description: The password of the parent PDB keystore. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 128 example: password target_pdb_tde_keystore_password: x-dct-toolkit-credential-field: true description: The password for the isolated mode TDE keystore of the target virtual PDB. (Oracle Multitenant Only) type: string minLength: 1 maxLength: 128 example: password appdata_source_params: description: The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. type: object additionalProperties: true example: param: value additional_mount_points: description: Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled. type: array items: $ref: '#/components/schemas/AdditionalMountPoint' example: - shared_path: / mount_path: /work environment_id: environment-123 appdata_config_params: description: The parameters specified by the source config schema in the toolkit type: object additionalProperties: true example: option: value config_params: description: Database configuration parameter overrides. type: object additionalProperties: true example: processes: 150 mount_point: type: string description: Mount point for the VDB (AppData only), can only be updated while the VDB is disabled. example: /var/mnt 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 instances: type: array description: The instances of this RAC database. items: $ref: '#/components/schemas/OracleRACDatabaseInstance' example: - instance_name: instance1 instance_number: 1 node_reference: ORACLE_CLUSTER_NODE-1 invoke_datapatch: description: Indicates whether datapatch should be invoked. type: boolean mssql_ag_backup_location: type: string description: Shared backup location to be used for VDB provision on AG Cluster. example: shared_backup_location/location1 mssql_ag_backup_based: type: boolean description: 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 cache_priority: description: 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. type: string enum: - NORMAL - HIGH example: HIGH mssql_incremental_export_backup_frequency_minutes: type: integer description: Frequency in minutes for incremental export backups for VDBs. minimum: 10 example: 30 database_name: type: string description: The name of the database in the target environment (update not applicable for Oracle or AppData VDBs). minLength: 1 maxLength: 256 example: my-test-database ProvisionEmptyVDBParameters: required: - engine_id - repository_id allOf: - $ref: '#/components/schemas/BaseProvisionVDBParameters' - type: object properties: engine_id: type: string description: The ID of the Engine onto which to provision. minLength: 1 maxLength: 256 example: engine-123 repository_id: type: string description: The ID of the target repository where to provision the VDB. A repository typically corresponds to a database installation. Setting this attribute implicitly determines the environment where to provision the VDB. minLength: 1 maxLength: 256 example: Unstructured Files RollbackVDBByTimestampParameters: deprecated: true allOf: - $ref: '#/components/schemas/DataPointByTimestampParameters' MSSQLListenerTypeEnum: type: string enum: - MSSqlAvailabilityGroupListener - MSSqlFailoverClusterListener example: MSSqlAvailabilityGroupListener DataPointBySnapshotParameters: type: object properties: snapshot_id: type: string description: The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot. minLength: 1 maxLength: 256 discriminator: propertyName: class_type OracleListenerTypeEnum: type: string enum: - NODE - SCAN example: NODE OracleAsmLayoutParameters: type: object required: - default_data_diskgroup properties: default_data_diskgroup: type: string description: Default diskgroup for datafiles. example: +DATA redo_diskgroup: type: string description: Diskgroup for archive logs. Optional as it is not required for PDB databases. example: +REDO discriminator: propertyName: class_type RefreshVDBByLocationParameters: type: object description: Parameters to refresh by a database-specific identifier (SCN, LSN, etc). properties: location: type: string description: The database specific identifier for tracking transactions (SCN, LSN, etc). minLength: 1 maxLength: 256 example: '1234567' dataset_id: type: string description: ID of the dataset to refresh to, mutually exclusive with timeflow_id. minLength: 1 maxLength: 256 example: 123-CONTAINER_1 timeflow_id: type: string description: ID of the timeflow to refresh to, mutually exclusive with dataset_id. minLength: 1 maxLength: 256 example: timeflow_123 OracleVirtualIP: description: A virtual IP address. type: object properties: domain_name: description: The domain name for the VirtualIP. type: string minLength: 1 example: virtual.domain.com ip: description: The IP address for this VirtualIP. type: string format: ipv4 example: 192.168.0.1 discovered: description: Whether this VirtualIP was discovered. type: boolean example: true JobTaskEvent: properties: message_details: type: string ProvisionVDBByLocationDefaultsRequest: type: object properties: source_data_id: type: string description: The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. minLength: 1 maxLength: 256 example: source-123 engine_id: type: string description: The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. minLength: 1 maxLength: 256 example: engine-123 location: type: string description: The location to get the defaults from. minLength: 1 maxLength: 256 example: 112233 timeflow_id: type: string description: ID of the timeflow to provision from. minLength: 1 maxLength: 256 example: timeflow_123 DataPointFromBookmarkParameters: type: object required: - bookmark_id properties: bookmark_id: type: string description: The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB. minLength: 1 maxLength: 256 discriminator: propertyName: class_type Errors: description: Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request. type: array items: $ref: '#/components/schemas/Error' 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" ContainerizationStateEnum: type: string description: 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 VDB: description: A Delphix virtual database or dataset. type: object properties: id: description: The VDB object entity ID. type: string example: vdb-123 database_type: description: The database type of this VDB. type: string nullable: true example: Oracle name: description: The logical name of this VDB. type: string nullable: true example: prod01-copy01 description: description: The container description of this VDB. type: string database_name: type: string description: The name of the database on the target environment or in the database management system. example: prod01-copy01-dbname namespace_id: description: The namespace id of this VDB. type: string example: 1-NAMESPACE-1 namespace_name: description: The namespace name of this VDB. type: string example: test-engine-1 is_replica: description: Is this a replicated object. type: boolean example: true is_locked: description: Is this VDB locked. type: boolean example: true locked_by: description: The ID of the account that locked this VDB. type: integer format: int64 example: 1 locked_by_name: description: The name of the account that locked this VDB. type: string example: user-1 database_version: description: The database version of this VDB. type: string nullable: true example: 10.2.0.5.0 jdbc_connection_string: description: The JDBC connection URL for this VDB. type: string 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 size: description: The total size of this VDB, in bytes. type: integer format: int64 nullable: true example: 339292672 storage_size: description: The actual space used by this VDB, in bytes. type: integer format: int64 nullable: true example: 12345678 unvirtualized_space: description: The disk space, in bytes, that it would take to store the VDB without Delphix. type: integer format: int64 example: 109242677 engine_id: description: A reference to the Engine that this VDB belongs to. type: string example: engine-123 status: description: The runtime status of the VDB. 'Unknown' if all attempts to connect to the dataset failed. type: string nullable: true example: RUNNING masked: description: The VDB is masked or not. type: boolean nullable: true example: false content_type: description: The content type of the vdb. type: string nullable: true example: PDB parent_timeflow_timestamp: description: The timestamp for parent timeflow. type: string format: date-time nullable: true example: '2021-05-01T08:51:34.148Z' parent_timeflow_timezone: description: The timezone for parent timeflow. type: string nullable: true example: America/Los_Angeles environment_id: description: A reference to the Environment that hosts this VDB. type: string nullable: true example: environment-123 ip_address: description: The IP address of the VDB's host. type: string nullable: true example: 192.0.2.0 fqdn: description: The FQDN of the VDB's host. type: string nullable: true example: virtual-dbs.myhost.com parent_id: description: A reference to the parent dataset of this VDB. type: string nullable: true example: vdb-122 parent_dsource_id: description: A reference to the parent dSource of this VDB. type: string nullable: true example: dsource-id root_parent_id: description: A reference to the root parent dataset of this VDB which could be a VDB or a dSource. type: string nullable: true example: vdb-121 group_name: description: The name of the group containing this VDB. type: string nullable: true example: VDBs engine_name: description: Name of the Engine where this VDB is hosted type: string nullable: true example: engine-123-name cdb_id: description: A reference to the CDB or VCDB associated with this VDB. type: string nullable: true example: cdb-123 tags: type: array items: $ref: '#/components/schemas/Tag' creation_date: description: The date this VDB was created. type: string format: date-time nullable: true example: '2021-05-01T08:51:34.148Z' hooks: $ref: '#/components/schemas/VirtualDatasetHooks' appdata_source_params: description: The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. type: object additionalProperties: true nullable: true example: param: value param2: value2 template_id: description: A reference to the Database Template. type: string nullable: true example: DATABASE_TEMPLATE-1 template_name: description: Name of the Database Template. type: string nullable: true example: template-name config_params: description: Database configuration parameter overrides. type: object additionalProperties: true nullable: true example: param: value param2: value2 environment_user_ref: description: The environment user reference. type: string additional_mount_points: description: Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled. type: array items: $ref: '#/components/schemas/AdditionalMountPoint' nullable: true appdata_config_params: description: The parameters specified by the source config schema in the toolkit type: object nullable: true additionalProperties: true example: foo: bar mount_point: type: string description: Mount point for the VDB (Oracle, ASE, AppData). example: /var/mnt current_timeflow_id: type: string description: A reference to the currently active timeflow for this VDB. example: timeflow-456 previous_timeflow_id: type: string description: A reference to the previous timeflow for this VDB. example: timeflow-123 last_refreshed_date: description: The date this VDB was last refreshed. type: string format: date-time nullable: true example: '2023-04-15T02:11:14.248Z' vdb_restart: description: Indicates whether the Engine should automatically restart this vdb when target host reboot is detected. type: boolean example: true is_appdata: description: Indicates whether this VDB has an AppData database. type: boolean example: true logsync_enabled: x-internal: true description: True if LogSync is enabled for this VDB. type: boolean example: true exported_data_directory: description: ZFS exported data directory path. type: string example: domain0/oracle_db_container-30/oracle_timeflow-32/datafile vcdb_exported_data_directory: description: ZFS exported data directory path of the virtual CDB container (vCDB). type: string example: domain0/oracle_db_container-29/oracle_timeflow-31/datafile toolkit_id: description: The ID of the toolkit associated with this VDB. type: string example: toolkit-1 plugin_version: description: The version of the plugin associated with this VDB. type: string example: 1.0.0 nullable: true primary_object_id: description: The ID of the parent object from which replication was done. type: string example: 1-CONTAINER-1 primary_engine_id: description: The ID of the parent engine from which replication was done. type: string example: '1' primary_engine_name: description: The name of the parent engine from which replication was done. type: string example: source-engine replicas: description: The list of replicas replicated from this object. type: array items: $ref: '#/components/schemas/Replica' invoke_datapatch: description: Indicates whether datapatch should be invoked. type: boolean enabled: description: True if VDB is enabled false if VDB is disabled. type: boolean example: true node_listeners: description: The list of node listeners for this VDB. type: array items: type: string instance_name: description: The instance name name of this single instance VDB. type: string example: VDBSID instance_number: description: The instance number of this single instance VDB. 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 VDB. type: string example: 1-ORACLE_INSTALL-1 containerization_state: $ref: '#/components/schemas/ContainerizationStateEnum' example: NOT_CONTAINERIZED parent_tde_keystore_path: description: 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. type: string example: /work/tde/parent_keystore target_vcdb_tde_keystore_path: description: Path to the keystore of the target vCDB. type: string example: /work/tde/target_vcdb_keystore tde_key_identifier: description: ID of the key created by Delphix, as recorded in v$encryption_keys.key_id. type: string example: Ae5Eo6WB208lv+XJfXMTv8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAA parent_pdb_tde_keystore_path: description: '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. ' type: string example: /work/MYCDB/0FE1C5BBC29D9B20E06379CB6E0A1EFC/tde target_pdb_tde_keystore_path: description: Path of the virtual PDB's Oracle transparent data encryption keystore on the target host. type: string example: /work/TARCDB/3599C5958B31BEF2E063D4DD6E0A2692/tde recovery_model: description: Recovery model of the vdb database. type: string example: FULL cdc_on_provision: description: Whether to enable CDC on provision for MSSql. type: boolean example: true data_connection_id: description: The ID of the associated DataConnection. type: string example: data-connection-1 mssql_ag_backup_location: type: string description: Shared backup location to be used for VDB provision on AG Cluster. example: shared_backup_location/location1 mssql_ag_backup_based: type: boolean description: 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: description: Indicates the mssql replica sources constitutes in MSSQL AG virtual source. type: array items: $ref: '#/components/schemas/MssqlAgReplica' database_unique_name: description: The unique name of the database. type: string example: DBOMSRBBDC6C db_username: description: The user name of the database. type: string example: oracle archive_log_mode: x-internal: true description: True if LogSync is running in archive log mode for this VDB. type: boolean example: true new_db_id: description: Indicates whether Delphix will generate a new DBID during VDB provision or refresh. type: boolean example: true redo_log_groups: description: Number of Online Redo Log Groups. type: integer format: int32 example: 3 redo_log_size_in_mb: description: Online Redo Log size in MB. type: integer format: int32 example: 1024 custom_env_vars: type: array items: $ref: '#/components/schemas/OracleCustomEnvVar' active_instances: type: array items: $ref: '#/components/schemas/OracleActiveInstance' nfs_version: description: The NFS version that was last used to mount this source." type: integer format: int32 example: 3 nfs_version_reason: description: The reason why the source is being mounted with nfsVersion. $ref: '#/components/schemas/NfsVersionReasonEnum' example: DEFAULT nfs_encryption_enabled: description: Flag indicating whether the data transfer is encrypted or not. type: boolean example: true cache_priority: description: 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. type: string enum: - NORMAL - HIGH example: HIGH mssql_incremental_export_backup_frequency_minutes: description: Frequency in minutes for incremental export backups for VDBs. type: integer example: 30 recycle_bin: description: Indicates whether the VDB is in recycle bin or not. type: boolean default: false example: true recycle_days: description: Number of days to retain VDB in the recycle bin before it's permanently deleted. type: integer format: int32 example: 30 recycle_bin_date: description: The date this VDB was moved to recycle bin. type: string format: date-time nullable: true example: '2023-04-15T02:11:14.248Z' recycle_bin_account_id: description: The ID of the account that moved this VDB to recycle bin. type: integer nullable: true format: int64 example: 1 truncate_log_on_checkpoint: type: boolean description: True if configured to truncate log on checkpoint (ASE only). example: true durability_level: type: string description: SAP ASE database durability level (ASE only). example: FULL enum: - FULL - AT_SHUTDOWN - NO_RECOVERY Repository: properties: id: description: Entity id of the repository. type: string name: description: Name of the repository. type: string database_type: description: The database type of this repository. type: string allow_provisioning: description: Flag indicating whether the repository should be used for provisioning. type: boolean is_staging: description: Flag indicating whether this repository can be used by the Delphix Engine for internal processing. type: boolean oracle_base: description: The Oracle base where database binaries are located. type: string version: description: Version of the repository. type: string bits: description: 32 or 64 bits. type: integer install_group: description: Group name of the user that owns the install. type: string install_user: description: User name of the user that owns the install. type: string rac: description: Flag indicating whether the install supports Oracle RAC. type: boolean ports: description: The network ports for connecting to the database instance. type: array items: type: integer format: int64 port: description: The network port for connecting to the SQL Server instance. type: integer format: int64 dump_history_file: description: Fully qualified name of the dump history file. type: string page_size: description: Database page size for the SAP ASE instance. type: integer format: int64 owner: description: Account the database server instance is running as. type: string installation_path: description: Directory path where the installation is located. type: string fulltext_installed: description: This property determines if the full-text search and semantic search is installed or not. type: boolean internal_version: description: The internal version is tied to the data format of a database and is used to detect compatibility. type: integer format: int64 mssql_cluster_instances_name: description: MSSQL cluster instances name. type: array items: type: string mssql_cluster_instances_version: description: MSSQL cluster instances version. type: array items: type: string mssql_cluster_instances_owners: description: MSSQL cluster instance owners. type: array items: type: string mssql_cluster_instances_ports: description: MSSQL cluster instances ports. type: array items: type: integer format: int64 mssql_cluster_instances_server_names: description: MSSQL cluster instances server names. type: array items: type: string mssql_cluster_instances_nodes: description: MSSQL cluster instances nodes. type: array items: type: string installation_home: description: Directory where the installation home is located. type: string drive_letter: description: MSSQL failover cluster drive letter. type: array items: type: string discovered: description: Flag indicating whether the repository was automatically discovered. readOnly: true type: boolean mssql_listeners: description: The list of listeners belonging to this repository. type: array items: $ref: '#/components/schemas/MSSQLClusterListener' database_username: type: string description: The username of the ASE instance database. service_principal_name: type: string description: The Kerberos Service Principal Name (SPN) of the database. isql_path: type: string description: The path to the isql binary to use for this SAP ASE instance. ase_tls_enabled: description: True if SAP ASE instance is TLS/SSL enabled. type: boolean credential_type: description: The credential type used for this repository. type: string enum: - PasswordCredential - SystemKeyCredential - KeyPairCredential - KerberosCredential - CyberArkVaultCredential - HashiCorpVaultCredential - AzureVaultCredential toolkit_id: description: The ID of the toolkit associated with this repository(AppData only). type: string discriminator: propertyName: class_type ConfigSettingsStg: description: Custom Database-Level config settings. type: object properties: property_name: description: Name of the property. type: string pattern: ^$|^[_a-zA-Z0-9]*$ maxLength: 40 value: type: string description: Value of the property. pattern: ^$|^''$|^[/_.:%@'+!*a-zA-Z0-9\[\]\- ]*$ maxLength: 40 comment_property: type: boolean description: Select this option to comment out the provided property name in the configuration file. Bookmark: description: A Data Control Tower object that references points in time for one or more datasets. type: object properties: id: description: The Bookmark object entity ID. type: string readOnly: true example: bookmark-123 name: description: The user-defined name of this bookmark. type: string minLength: 1 maxLength: 256 example: my-bookmark-123 creation_date: description: The date and time that this bookmark was created. type: string format: date-time readOnly: true example: '2021-07-04T08:51:34.148000+00:00' data_timestamp: description: The timestamp for the data that the bookmark refers to. type: string format: date-time readOnly: true example: '2021-06-03T08:51:34.148000+00:00' timeflow_id: description: The timeflow for the snapshot that the bookmark was created of. example: 1-TIMEFLOW-1 type: string location: description: The location for the data that the bookmark refers to. type: string example: '200000' vdb_ids: description: The list of VDB IDs associated with this bookmark. type: array items: type: string example: - vdb-123 - vdb-456 dsource_ids: description: The list of dSource IDs associated with this bookmark. type: array items: type: string example: - dsource-123 - dsource-456 vdb_group_id: description: The ID of the VDB group on which bookmark is created. type: string example: vdb-group-123 vdb_group_name: description: The name of the VDB group on which bookmark is created. type: string example: my-vdb-group vdbs: description: The list of VDB IDs and VDB names associated with this bookmark. type: array items: $ref: '#/components/schemas/BookmarkVDBs' dsources: description: The list of dSource IDs and dSource names associated with this bookmark. type: array items: $ref: '#/components/schemas/BookmarkDSources' paas_databases: description: The list of PaaS Database IDs and PaaS Database names associated with this bookmark. type: array items: $ref: '#/components/schemas/BookmarkPaaSDatabases' paas_instances: description: The list of PaaS Instance IDs and PaaS Instance names associated with this bookmark. type: array items: $ref: '#/components/schemas/BookmarkPaaSInstances' retention: description: The retention policy for this bookmark, in days. A value of -1 indicates the bookmark should be kept forever. Deprecated in favor of expiration. type: integer format: int64 example: 365 deprecated: true expiration: description: The expiration for this bookmark. When unset, indicates the bookmark is kept forever except for bookmarks of replicated datasets. Expiration cannot be set for bookmarks of replicated datasets. type: string format: date example: '2021-07-04' status: description: A message with details about operation progress or state of this bookmark. type: string nullable: true readOnly: true example: RESTORED replicated_dataset: description: Whether this bookmark is created from a replicated dataset or not. type: boolean bookmark_source: description: Source of the bookmark, default is DCT. In case of self-service bookmarks, this value would be ENGINE. type: string enum: - DCT - ENGINE bookmark_status: description: Status of the bookmark. It can have INACTIVE value for engine bookmarks only. If this value is INACTIVE then ss_bookmark_errors would have the list of associated errors. type: string enum: - ACTIVE - INACTIVE - CREATING - DELETING ss_data_layout_id: description: Data-layout Id for engine-managed bookmarks. type: string ss_bookmark_reference: description: Engine reference of the self-service bookmark. type: string ss_bookmark_errors: description: List of errors if any, during bookmark creation in DCT from self-service. type: array items: type: string example: - No snapshots found for JS_BOOKMARK-1 at timestamp 2021-07-04T08:51:34.148 bookmark_type: description: Type of the bookmark, either PUBLIC or PRIVATE. type: string enum: - PUBLIC - PRIVATE default: PRIVATE example: PRIVATE namespace_id: description: The namespace id of this bookmark. type: string example: 1-NAMESPACE-1 namespace_name: description: The namespace name of this bookmark. type: string example: test-engine-1 is_replica: description: Is this a replicated bookmark. type: boolean example: true primary_object_id: description: Id of the parent bookmark from which this bookmark was replicated. type: string primary_engine_id: description: The ID of the parent engine from which replication was done. type: string primary_engine_name: description: The name of the parent engine from which replication was done. type: string primary_bookmark_expiration: description: The expiration for the primary bookmark. type: string format: date example: '2021-07-04' replicas: description: The list of replicas replicated from this object. type: array items: $ref: '#/components/schemas/Replica' tags: description: The tags to be created for this Bookmark. type: array items: $ref: '#/components/schemas/Tag' example: - key: key-1 value: value-1 - key: key-2 value: value-2 ExportFinalizeParameters: type: object description: Parameters to finalize export (V2P) from the VDB created as part of the Incremental V2P properties: force: type: boolean description: Whether to continue operation ignoring max_allowed_backups_pending_restore (MSSQL Only). default: false max_allowed_backups_pending_restore: type: integer description: The maximum number of pending backup restores at which export-finalize operation is allowed (MSSQL Only). default: 5 minimum: 1 OracleVerifyJdbcConnectionStringParams: type: object required: - database_username - database_password - jdbc_connection_string properties: database_username: type: string description: oracle database username. example: oracle database_password: x-dct-toolkit-credential-field: true type: string description: oracle database password. example: oracle jdbc_connection_string: type: string description: Oracle jdbc connection string to validate. example: jdbc:oracle:thin:@(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=10.110.219.71)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=CDOMLOSR25E9PDB1))) Snapshot: description: Virtualization Engine Snapshot of a dSource or VDB. type: object properties: id: description: The Snapshot ID. type: string example: snapshot-123 engine_id: description: The id of the engine the snapshot belongs to. type: string example: 1 namespace: description: Alternate namespace for this object, for replicated and restored snapshots. type: string nullable: true example: NAMESPACE-1 name: description: The snapshot's name. type: string example: '@2023-02-02T14:30:00.589' namespace_id: description: The namespace id of this snapshot. type: string example: 1-NAMESPACE-1 namespace_name: description: The namespace name of this snapshot. type: string example: test-engine-1 is_replica: description: Is this a replicated object. type: boolean example: true consistency: description: Indicates what type of recovery strategies must be invoked when provisioning from this snapshot. type: string enum: - CONSISTENT - INCONSISTENT - CRASH_CONSISTENT - PLUGGABLE example: CONSISTENT missing_non_logged_data: description: Indicates if a virtual database provisioned from this snapshot will be missing nologging changes. type: boolean example: false dataset_id: type: string description: The ID of the Snapshot's dSource or VDB. example: dataset-123 creation_time: description: The time when the snapshot was created. type: string format: date-time example: '2023-02-02T19:30:00.589Z' start_timestamp: description: 'The timestamp within the parent TimeFlow at which this snapshot was initiated. \ No recovery earlier than this point needs to be applied in order to provision a database from \ this snapshot. If start_timestamp equals timestamp, then no recovery needs to be \ applied in order to provision a database. ' type: string format: date-time example: '2021-05-01T08:51:34.148000+00:00' start_location: description: 'The database specific indentifier within the parent TimeFlow at which this snapshot was initiated. \ No recovery earlier than this point needs to be applied in order to provision a database from \ this snapshot. If start_location equals location, then no recovery needs to be \ applied in order to provision a database. ' type: string example: '1178883' timestamp: description: The logical time of the data contained in this Snapshot. type: string format: date-time example: '2021-05-01T08:51:34.148000+00:00' location: description: Database specific identifier for the data contained in this Snapshot, such as the Log Sequence Number (LSN) for MSsql databases, System Change Number (SCN) for Oracle databases. type: string example: '1178883' retention: description: Retention policy, in days. A value of -1 indicates the snapshot should be kept forever. Deprecated in favor of expiration and retain_forever. deprecated: true type: integer format: int64 example: -1 expiration: description: The expiration date of this snapshot. If this is unset and retain_forever is false, and the snapshot is not included in a Bookmark, the snapshot is subject to the retention policy of its dataset. type: string format: date example: '2021-07-04' retain_forever: description: Indicates that the snapshot is protected from retention, i.e it will be kept forever. If false, see expiration. type: boolean example: false effective_expiration: description: The effective expiration is that max of the snapshot expiration and the expiration of any Bookmark which includes this snapshot. type: string format: date example: '2021-07-04' effective_retain_forever: description: True if retain_forever is set or a Bookmark retains this snapshot forever. type: boolean example: false timeflow_id: description: The TimeFlow this snapshot was taken on. type: string example: 1-ORACLE_TIMEFLOW-1 timezone: description: Time zone of the source database at the time the snapshot was taken. type: string example: America/New_York,EST-0500 version: description: Version of database source repository at the time the snapshot was taken. type: string example: 11.2.0.4.0 nullable: true temporary: description: Indicates that this snapshot is in a transient state and should not be user visible. type: boolean example: false appdata_toolkit: description: The toolkit associated with this snapshot. type: string example: APPDATA_TOOLKIT-1 appdata_metadata: description: The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. type: string example: {} ase_db_encryption_key: description: Database encryption key present for this snapshot. type: string example: keyname mssql_internal_version: description: Internal version of the source database at the time the snapshot was taken. type: integer format: int32 example: 706 mssql_backup_set_uuid: description: UUID of the source database backup that was restored for this snapshot. type: string example: 54290b71-58cd-463d-bd62-7219d4c4d2d5 mssql_backup_software_type: description: Backup software used to restore the source database backup for this snapshot type: string enum: - AZURE_NATIVE - NATIVE - LITESPEED - REDGATE - NETBACKUP - COMMVAULT example: NATIVE mssql_backup_location_type: description: Backup software used to restore the source database backup for this snapshot type: string enum: - DISK - AZURE - BACKUP_SERVER example: BACKUP_SERVER mssql_empty_snapshot: description: True if the staging push dSource snapshot is empty. type: boolean example: true mssql_incremental_export_source_snapshot: description: True if this snapshot belongs to Incremental VDB and can be used for Incremental V2P. type: boolean example: false oracle_from_physical_standby_vdb: description: True if this snapshot was taken of a standby database. type: boolean example: false oracle_redo_log_size_in_bytes: description: Online redo log size in bytes when this snapshot was taken. type: integer format: int64 example: 314572800 tags: type: array items: $ref: '#/components/schemas/Tag' MssqlAgReplica: description: A replica MSSQL source that constitutes an MSSQL AG virtual source. type: object properties: name: description: The logical name of the replica source. type: string example: Rag1_FJ1 ag_replica_id: description: The AG Replica object entity ID. type: string example: 1-MSSQL_DB_CONTAINER-104 vdb_id: description: Reference to the AG virtual source. type: string example: 1-MSSQL_DB_CONTAINER-102 current_timeflow_id: description: A reference to the currently active timeflow for this AG Replica. type: string example: 1-MSSQL_TIMEFLOW-111 mount_point: description: The base mount point for the replica source iSCSI LUN mounts. type: string example: C:\Program Files\Delphix\DelphixConnector\ec2f5d5f-a2e0-3902-5097-62d348ae63a8-replica-30 exported_data_directory: description: ZFS exported data directory path. type: string example: domain0/mssql_db_container-358/mssql_timeflow-361/datafile repository_id: description: The repository id of this AG Replica. type: string example: 1-MSSQL_INSTANCE-116 environment_id: description: A reference to the Environment that hosts this AG Replica. type: string example: 1-WINDOWS_HOST_ENVIRONMENT-43 curr_timeflow_support_provision_without_backup: description: Indicates whether the database file can be used to provision without taking backups for current (active) timeflow of ths AG Replica. type: boolean example: false curr_timeflow_ag_replica_sync_status: description: Indicates the data-movement state for current (active) timeflow of ths AG Replica. type: string example: SYNCHRONIZED curr_timeflow_last_hardened_lsn: description: 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. type: string example: 34000000294400000 InPlaceExportParameters: allOf: - $ref: '#/components/schemas/FilesystemLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object properties: db_unique_name: type: string description: Unique name to be given to the database after it is converted to physical. maxLength: 30 example: DBOMSR9051BF pdb_name: type: string description: The name to be given to the PDB after it is exported in-place. maxLength: 30 example: CDOMLOTGACDBPDB operations_postV2P: type: boolean description: Indicates operations allowed on virtual source post V2P. default: false ExportFromBookmarkParameters: allOf: - $ref: '#/components/schemas/ExportDBTimeflowPointParameters' - $ref: '#/components/schemas/FilesystemLayoutParameters' - $ref: '#/components/schemas/BaseExportTransferStrategyParameters' - type: object required: - bookmark_id properties: bookmark_id: type: string description: The ID of the bookmark from which to execute the operation. minLength: 1 maxLength: 256 Job: description: An asynchronous task. type: object properties: id: description: The Job entity ID. type: string example: job-123 status: description: The status of the job. type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED example: RUNNING is_waiting_for_telemetry: description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated. type: boolean type: description: The type of job being done. type: string example: DB_REFRESH localized_type: description: The i18n translated type of job being done. type: string example: DB Refresh error_details: description: Details about the failure for FAILED jobs. type: string example: Unable to connect to the engine. warning_message: description: Warnings for the job. type: string example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.' target_id: description: A reference to the job's target. type: string example: vdb-123 target_name: description: A reference to the job's target name. type: string example: vdb start_time: description: The time the job started executing. type: string format: date-time example: '2022-01-02T05:11:24.148000+00:00' update_time: description: The time the job was last updated. type: string format: date-time example: '2022-01-02T06:11:24.148000+00:00' trace_id: description: traceId of the request which created this Job type: string engine_ids: description: IDs of the engines this Job is executing on. type: array items: type: string deprecated: true tags: type: array items: $ref: '#/components/schemas/Tag' engines: type: array items: $ref: '#/components/schemas/Engine' account_id: description: The ID of the account who initiated this job. type: integer example: 1 account_name: description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-. type: string example: User 1 compliance_node_id: description: The ID of the associated compliance node, if applicable. type: string nullable: true compliance_node_name: description: The name of the associated compliance node, if applicable. type: string nullable: true percent_complete: description: Completion percentage of the Job. type: integer minimum: 0 maximum: 100 example: '50' virtualization_tasks: deprecated: true type: array items: $ref: '#/components/schemas/VirtualizationTask' tasks: type: array items: $ref: '#/components/schemas/JobTask' execution_id: description: The ID of the associated masking execution, if any. type: string nullable: true result_type: description: The type of the job result. This is the type of the object present in the result. type: string result: description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property. type: object discriminator: propertyName: class_type PermissionEnum: description: Type of the permission on DCT object. type: string enum: - READ - UPDATE - DELETE - EXECUTE - CANCEL - MIGRATE - REFRESH - DISABLE - ENABLE - ABANDON - VALIDATE - START - STOP - SNAPSHOT - COPY - REMOVE_JOB - PASSWORD_RESET - UNDO_IMPORT - IMPORT - PROVISION_FROM_BOOKMARK - PROVISION - REFRESH_FROM_BOOKMARK - REFRESH_FROM_SNAPSHOT - REFRESH_FROM_TIMESTAMP - REFRESH_FROM_LOCATION - CREATE_ENVIRONMENT - CREATE_BOOKMARK - CREATE_VDBGROUP - MANAGE_TAGS - LINK - REPLICATE - REPLICATE_TO - CONVERT_AND_DROP - IMPORT_BOOKMARKS - FAILOVER - COMMIT_FAILOVER - FAILBACK - DISCARD - LOCK - UNLOCK - FORCE_UNLOCK - LOCK_FOR_OTHER_ACCOUNT - UPDATE_TIMEFLOW - SNAPSHOT_DELETE - SWITCH_TIMEFLOW - DELETE_TIMEFLOW - SNAPSHOT_UPDATE - IMPORT_ACCOUNTS - DETACH_SOURCE - ATTACH_SOURCE - RESOLVE - RESOLVE_ALL - RESOLVE_OR_IGNORE - API_KEY_RESET - API_KEY_DELETE - READ_STORAGE_CAPACITY_DATA - READ_DATASET_PERF_ANALYTICS - CREATE_TOOLKIT example: READ requestBodies: DeleteTags: description: The parameters to delete tags content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/DeleteTag' examples: delete_all_tags: description: Delete all tags for given object - No request body required summary: Delete all tags value: {} delete_tags_by_key: description: Delete all tags for given object with matching key summary: Delete tags by key value: key: key-1 delete_tags_by_key_value: description: Delete tag for given object with matching key and value summary: Delete a tag by key & value value: key: key-1 value: value-1 delete_multiple_tags_by_key_value: description: Delete tags for given list of tags with matching key and value summary: Delete multiple tags by key & value value: tags: - key: key-1 value: value-1 - key: key-2 value: value-2 SearchBody: x-skip-codegen-attr: description description: 'A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH ''12''` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS ''foo'') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' | | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. ' content: application/json: schema: $ref: '#/components/schemas/SearchBody' examples: nested: description: 'An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0. ' summary: Nested Object Comparison value: filter_expression: repositories CONTAINS {version eq '19.0.0'} relative: description: 'An example of a relative comparison testing that field1 has a value which is less than 123. ' summary: Relative comparison value: filter_expression: field1 LE 123 nil: description: 'An example of using nil to test for the absence of a value for field2. ' summary: Absence of an attribute value value: filter_expression: field2 EQ NIL non-nil: description: 'An example of using nil to test for the existence of a value for field2. ' summary: Existence of an attribute value value: filter_expression: field2 NE NIL contains: description: 'An example of using the ''CONTAINS'' operator to check if field2 contains the string ''foo''. If field2 is string valued then this is checking if ''foo'' is a substring of field2. If field2 is a list of strings then this is checking if ''foo'' is a member of the list. ' summary: Use of the CONTAINS operator value: filter_expression: field2 CONTAINS 'foo' in: description: 'An example of using the ''IN'' operator to check if field1 is an element of a list literal. ' summary: Use of the IN operator value: filter_expression: field1 IN [1, 2, 3] search: description: 'An example of using the ''SEARCH'' operator to retrieve all elements for which ''foo'' is a substring of a filterable attribute. ' summary: Use of the SEARCH operator value: filter_expression: SEARCH 'foo' parenthesis: description: 'An example of parenthesis being used to group operators & override operator precedence. ' summary: Overriding operator precedence value: filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar') ProvisionEmptyVDB: description: The parameters to provision an empty VDB. content: application/json: schema: $ref: '#/components/schemas/ProvisionEmptyVDBParameters' examples: appdata: description: 'The above request example is intended for AppData empty vdb ' summary: AppData empty VDB value: engine_id: '1' name: vdb_to_be_created target_group_id: Untitled repository_id: 1-APPDATA_REPOSITORY-292 mount_point: /home/oracle/tmp vdb_restart: true database_name: database_name environment_user_id: environment-user-123 pre_refresh: - name: pre_refresh_command command: echo "testing pre-refresh" shell: ps/bash post_refresh: - name: post_refresh_command command: echo "testing post_refresh" shell: ps/bash pre_rollback: - name: pre_rollback_command command: echo "testing pre_rollback" shell: ps/bash post_rollback: - name: post_rollback_command command: echo "testing post_rollback" shell: ps/bash configure_clone: - name: configure_clone_command command: echo "testing configure_clone" shell: ps/bash pre_snapshot: - name: pre_snapshot_command command: echo "testing pre_snapshot" shell: ps/bash post_snapshot: - name: post_snapshot_command command: echo "testing post_snapshot" shell: ps/bash pre_start: - name: pre_start_command command: echo "testing pre_start" shell: ps/bash post_start: - name: post_start_command command: echo "testing post_start" shell: ps/bash pre_stop: - name: pre_stop_command command: echo "testing pre_stop" shell: ps/bash post_stop: - name: post_stop_command command: echo "testing post_stop" shell: ps/bash snapshot_policy_id: test_snapshot_policy required: true OracleVerifyJdbcConnectionStringBody: description: The parameters to verify oracle jdbc connection string. content: application/json: schema: x-body-name: oracle_verify_jdbc_connection_parameters $ref: '#/components/schemas/OracleVerifyJdbcConnectionStringParams' ProvisionBySnapshot: description: The parameters to provision a VDB. content: application/json: schema: $ref: '#/components/schemas/ProvisionVDBBySnapshotParameters' examples: oracleminimum: description: 'The above request example is intended for Oracle Database without including optional properties ' summary: Oracle - Without Optionals value: auto_select_repository: true source_data_id: dsource-name tags: - key: key-1 value: value-1 - key: key-2 value: value-2 oracle_single_tenant: description: 'The above request example is intended for Oracle Single Tenant Database with all possible properties that can be set in request body. ' summary: Oracle - Single Tenant Request value: source_data_id: dsource-name engine_id: '1' target_group_id: group-Name name: vdb_to_be_created database_name: dbname_to_be_created os_username: os-user-x os_password: os-password-x environment_id: oracle-env-name environment_user_id: environment_user_name auto_select_repository: true cluster_node_ids: - ORACLE_CLUSTER_NODE-1 pre_refresh: - name: pre_refresh_command command: echo "testing pre-refresh" shell: bash post_refresh: - name: post_refresh_command command: echo "testing post_refresh" shell: bash pre_rollback: - name: pre_rollback_command command: echo "testing pre_rollback" shell: bash post_rollback: - name: post_rollback_command command: echo "testing post_rollback" shell: bash configure_clone: - name: configure_clone_command command: echo "testing configure_clone" shell: bash pre_snapshot: - name: pre_snapshot_command command: echo "testing pre_snapshot" shell: bash post_snapshot: - name: post_snapshot_command command: echo "testing post_snapshot" shell: bash pre_start: - name: pre_start_command command: echo "testing pre_start" shell: bash post_start: - name: post_start_command command: echo "testing post_start" shell: bash pre_stop: - name: pre_stop_command command: echo "testing pre_stop" shell: bash post_stop: - name: post_stop_command command: echo "testing post_stop" shell: bash vdb_restart: true template_id: template-1 auxiliary_template_id: aux-template-1 file_mapping_rules: '/datafile/dbdhcp3/oradata/dbdhcp3:/data /u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf' oracle_instance_name: dbdhcp2 unique_name: dbdhcp2 mount_point: /var/mnt open_reset_logs: true snapshot_policy_id: test_snapshot_policy retention_policy_id: test_retention_policy online_log_size: 4 online_log_groups: 2 archive_log: true new_dbid: true custom_env_vars: MY_ENV_VAR1: $ORACLE_HOME MY_ENV_VAR2: $CRS_HOME/after custom_env_files: - /export/home/env_file_1 snapshot_id: 1-oracle-snapshot-id tags: - key: key-1 value: value-1 - key: key-2 value: value-2 oracle_multitenant_db_with_existing_cdb: description: 'The above request example is intended for Oracle Multitenant Database with existing CDB. ' summary: Oracle - Multitenant with existing CDB value: source_data_id: dsource-name engine_id: '1' target_group_id: group-Name name: vdb_to_be_created database_name: dbname_to_be_created cdb_id: ORACLE_SINGLE_CONFIG-376 cluster_node_ids: - ORACLE_CLUSTER_NODE-1 os_username: os-user-x os_password: os-password-x environment_user_id: environment_user_name pre_refresh: - name: pre_refresh_command command: echo "testing pre-refresh" shell: bash post_refresh: - name: post_refresh_command command: echo "testing post_refresh" shell: bash pre_rollback: - name: pre_rollback_command command: echo "testing pre_rollback" shell: bash post_rollback: - name: post_rollback_command command: echo "testing post_rollback" shell: bash configure_clone: - name: configure_clone_command command: echo "testing configure_clone" shell: bash pre_snapshot: - name: pre_snapshot_command command: echo "testing pre_snapshot" shell: bash post_snapshot: - name: post_snapshot_command command: echo "testing post_snapshot" shell: bash pre_start: - name: pre_start_command command: echo "testing pre_start" shell: bash post_start: - name: post_start_command command: echo "testing post_start" shell: bash pre_stop: - name: pre_stop_command command: echo "testing pre_stop" shell: bash post_stop: - name: post_stop_command command: echo "testing post_stop" shell: bash vdb_restart: true file_mapping_rules: '/datafile/dbdhcp3/oradata/dbdhcp3:/data /u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf' mount_point: /var/mnt open_reset_logs: true snapshot_policy_id: test_snapshot_policy retention_policy_id: test_retention_policy online_log_size: 4 online_log_groups: 2 archive_log: true new_dbid: true custom_env_vars: MY_ENV_VAR1: $ORACLE_HOME MY_ENV_VAR2: $CRS_HOME/after custom_env_files: - /export/home/env_file_1 snapshot_id: 1-oracle-snapshot-id tags: - key: key-1 value: value-1 - key: key-2 value: value-2 parentTdeKeystorePath: /path/to/parent/tde/keystore parent_tde_keystore_password: password tde_exported_key_file_secret: secret parent_pdb_tde_keystore_path: /path/to/parent/pdb/tde/keystore parent_pdb_tde_keystore_password: password target_pdb_tde_keystore_password: password oracle_multitenant_db_with_new_vcdb: description: 'The above request example is intended for Oracle Multitenant Database with new vCDB. ' summary: Oracle - Multitenant with new vCDB value: source_data_id: dsource-name engine_id: '1' target_group_id: group-Name name: vdb_to_be_created database_name: dbname_to_be_created os_username: os-user-x os_password: os-password-x environment_id: oracle-env-name environment_user_id: environment_user_name auto_select_repository: true cluster_node_ids: - ORACLE_CLUSTER_NODE-1 pre_refresh: - name: pre_refresh_command command: echo "testing pre-refresh" shell: bash post_refresh: - name: post_refresh_command command: echo "testing post_refresh" shell: bash pre_rollback: - name: pre_rollback_command command: echo "testing pre_rollback" shell: bash post_rollback: - name: post_rollback_command command: echo "testing post_rollback" shell: bash configure_clone: - name: configure_clone_command command: echo "testing configure_clone" shell: bash pre_snapshot: - name: pre_snapshot_command command: echo "testing pre_snapshot" shell: bash post_snapshot: - name: post_snapshot_command command: echo "testing post_snapshot" shell: bash pre_start: - name: pre_start_command command: echo "testing pre_start" shell: bash post_start: - name: post_start_command command: echo "testing post_start" shell: bash pre_stop: - name: pre_stop_command command: echo "testing pre_stop" shell: bash post_stop: - name: post_stop_command command: echo "testing post_stop" shell: bash vdb_restart: true template_id: template-123 vcdb_name: VCCD_6QQ vcdb_database_name: VCCD_6QQ file_mapping_rules: '/datafile/dbdhcp3/oradata/dbdhcp3:/data /u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf' oracle_instance_name: dbdhcp2 unique_name: dbdhcp2 mount_point: /var/mnt open_reset_logs: true snapshot_policy_id: test_snapshot_policy retention_policy_id: test_retention_policy online_log_size: 4 online_log_groups: 2 archive_log: true new_dbid: true custom_env_vars: MY_ENV_VAR1: $ORACLE_HOME MY_ENV_VAR2: $CRS_HOME/after custom_env_files: - /export/home/env_file_1 snapshot_id: 1-oracle-snapshot-id tags: - key: key-1 value: value-1 - key: key-2 value: value-2 parentTdeKeystorePath: /path/to/parent/tde/keystore parent_tde_keystore_password: password tde_exported_key_file_secret: secret parent_pdb_tde_keystore_path: /path/to/parent/pdb/tde/keystore parent_pdb_tde_keystore_password: password target_pdb_tde_keystore_password: password cdb_tde_keystore_password: password target_vcdb_tde_keystore_path: /path/to/target/tde/keystore tde_keystore_config_type: HSM mssql: description: 'The above request example is intended for MS-SQL Database ' summary: MS-SQL Database value: source_data_id: dsource-name engine_id: '1' target_group_id: group-Name name: vdb_to_be_created database_name: dbname_to_be_created environment_id: mssql-env-name environment_user_id: environment-user-123 auto_select_repository: true pre_refresh: - name: pre_refresh_command command: echo "testing pre-refresh" shell: ps post_refresh: - name: post_refresh_command command: echo "testing post_refresh" shell: ps pre_rollback: - name: pre_rollback_command command: echo "testing pre_rollback" shell: ps post_rollback: - name: post_rollback_command command: echo "testing post_rollback" shell: ps configure_clone: - name: configure_clone_command command: echo "testing configure_clone" shell: ps pre_snapshot: - name: pre_snapshot_command command: echo "testing pre_snapshot" shell: ps post_snapshot: - name: post_snapshot_command command: echo "testing post_snapshot" shell: ps pre_start: - name: pre_start_command command: echo "testing pre_start" shell: ps post_start: - name: post_start_command command: echo "testing post_start" shell: ps pre_stop: - name: pre_stop_command command: echo "testing pre_stop" shell: ps post_stop: - name: post_stop_command command: echo "testing post_stop" shell: ps vdb_restart: true template_id: template-123 snapshot_policy_id: test_snapshot_policy retention_policy_id: test_retention_policy recovery_model: FULL pre_script: C:\Program Files\Delphix\scripts\myscript.ps1 post_script: C:\Program Files\Delphix\scripts\myscript.ps1 cdc_on_provision: true snapshot_id: 1-mssql-snapshot-id-1 tags: - key: key-1 value: value-1 - key: key-2 value: value-2 ase: description: 'The above request example is intended for Sybase Database ' summary: ASE Database value: source_data_id: dsource-name engine_id: '1' target_group_id: group-Name name: vdb_to_be_created database_name: dbname_to_be_created truncate_log_on_checkpoint: true environment_id: ase_env_name environment_user_id: environment_user_name auto_select_repository: true pre_refresh: - name: pre_refresh_command command: echo "testing pre-refresh" shell: bash post_refresh: - name: post_refresh_command command: echo "testing post_refresh" shell: bash pre_rollback: - name: pre_rollback_command command: echo "testing pre_rollback" shell: bash post_rollback: - name: post_rollback_command command: echo "testing post_rollback" shell: bash configure_clone: - name: configure_clone_command command: echo "testing configure_clone" shell: bash pre_snapshot: - name: pre_snapshot_command command: echo "testing pre_snapshot" shell: bash post_snapshot: - name: post_snapshot_command command: echo "testing post_snapshot" shell: bash pre_start: - name: pre_start_command command: echo "testing pre_start" shell: bash post_start: - name: post_start_command command: echo "testing post_start" shell: bash pre_stop: - name: pre_stop_command command: echo "testing pre_stop" shell: bash post_stop: - name: post_stop_command command: echo "testing post_stop" shell: bash vdb_restart: true mount_point: /var/mnt snapshot_policy_id: test_snapshot_policy retention_policy_id: test_retention_policy snapshot_id: snapshot-id tags: - key: key-1 value: value-1 - key: key-2 value: value-2 required: true parameters: limit: name: limit in: query description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. example: 50 schema: type: integer minimum: 1 maximum: 1000 default: 100 vdbsSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - database_name - -database_name - database_type - -database_type - name - -name - database_version - -database_version - size - -size - engine_id - -engine_id - status - -status - environment_id - -environment_id - ip_address - -ip_address - fqdn - -fqdn - parent_id - -parent_id - parent_dsource_id - -parent_dsource_id - group_name - -group_name - creation_date - -creation_date - last_refreshed_date - -last_refreshed_date - engine_name - -engine_name - storage_size - -storage_size - unvirtualized_space - -unvirtualized_space - locked_by - -locked_by - locked_by_name - -locked_by_name - primary_object_id - -primary_object_id - primary_engine_id - -primary_engine_id - primary_engine_name - -primary_engine_name - content_type - -content_type - exported_data_directory - -exported_data_directory - vcdb_exported_data_directory - -vcdb_exported_data_directory - invoke_datapatch - -invoke_datapatch - instance_name - -instance_name - instance_number - -instance_number - repository_id - -repository_id - containerization_state - -containerization_state - parent_tde_keystore_path - -parent_tde_keystore_path - target_vcdb_tde_keystore_path - -target_vcdb_tde_keystore_path - tde_key_identifier - -tde_key_identifier - parent_pdb_tde_keystore_path - target_pdb_tde_keystore_path - environment_user_ref - -environment_user_ref - recovery_model - -recovery_model - cdc_on_provision - -cdc_on_provision - data_connection_id - -data_connection_id - mssql_ag_backup_location - -mssql_ag_backup_location - mssql_ag_backup_based - -mssql_ag_backup_based - database_unique_name - -database_unique_name - db_username - -db_username - new_db_id - -new_db_id - redo_log_groups - -redo_log_groups - redo_log_size_in_mb - -redo_log_size_in_mb - toolkit_id - -toolkit_id - nfs_version - -nfs_version - nfs_version_reason - -nfs_version_reason - nfs_encryption_enabled - -nfs_encryption_enabled - description - -description - mssql_incremental_export_backup_frequency_minutes - -mssql_incremental_export_backup_frequency_minutes - truncate_log_on_checkpoint - -truncate_log_on_checkpoint - durability_level - -durability_level nullable: true example: name bookmarksSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - creation_date - -creation_date - vdb_ids - -vdb_ids - retention - -retention - expiration - -expiration - data_timestamp - -data_timestamp - timeflow_id - -timeflow_id - location - -location - vdb_group_name - -vdb_group_name - namespace_id - -namespace_id - namespace_name - -namespace_name - primary_object_id - -primary_object_id - primary_engine_id - -primary_engine_id - primary_engine_name - -primary_engine_name - primary_bookmark_expiration - -primary_bookmark_expiration nullable: true example: name vdbIdParam: in: path name: vdbId required: true schema: type: string minLength: 1 description: The ID of the VDB. permission: name: permission in: query description: Restrict the objects, which are allowed. example: READ schema: type: array items: $ref: '#/components/schemas/PermissionEnum' style: form explode: true cursor: name: cursor in: query description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. schema: type: string minLength: 1 maxLength: 4096 securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization