openapi: 3.0.0 info: title: Delphix DCT Algorithms DSources 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: DSources paths: /dsources: get: summary: List all dSources. operationId: get_dsources tags: - DSources parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/dsourcesSortParam' - $ref: '#/components/parameters/permission' responses: '200': description: OK content: application/json: schema: type: object title: ListDSourcesResponse properties: items: type: array items: $ref: '#/components/schemas/DSource' errors: $ref: '#/components/schemas/Errors' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /dsources/oracle: post: summary: Link Oracle database as dSource. operationId: link_oracle_database tags: - DSources requestBody: x-body-name: linkDSourceBody $ref: '#/components/requestBodies/OracleLinkDSourceBody' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LinkDSourceResponse' /dsources/oracle/defaults: post: summary: Get defaults for dSource linking. operationId: get_oracle_dsource_linking_defaults tags: - DSources requestBody: content: application/json: schema: x-body-name: dSource_linking_defaults $ref: '#/components/schemas/LinkDSourceDefaultRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OracleDSourceLinkSourceParameters' /dsources/oracle/{dsourceId}/detachSource: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Detaches an Oracle source from an Oracle database. operationId: detach_oracle_dsource tags: - DSources responses: '200': description: OK content: application/json: schema: type: object title: DetachDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/oracle/{dsourceId}/attachSource: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Attach an Oracle dSource to an Oracle database. operationId: attach_oracle_dsource tags: - DSources requestBody: x-body-name: attachOracleDSourceBody $ref: '#/components/requestBodies/OracleAttachDSourceBody' responses: '200': description: OK content: application/json: schema: type: object title: AttachDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/oracle/staging-push: post: summary: Link an Oracle staging push database as dSource. operationId: link_oracle_staging_push_database tags: - DSources requestBody: x-body-name: linkStagingPushDSourceBody $ref: '#/components/requestBodies/OracleLinkStagingPushDSourceBody' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LinkDSourceResponse' /dsources/oracle/staging-push/defaults: post: summary: Get defaults for a Oracle staging push dSource linking. operationId: get_oracle_staging_push_dsource_linking_defaults tags: - DSources requestBody: content: application/json: schema: x-body-name: dSource_linking_staging_push_defaults $ref: '#/components/schemas/OracleLinkStagingPushDSourceDefaultRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OracleStagingPushDSourceLinkSourceParameters' /dsources/oracle/{dsourceId}: parameters: - $ref: '#/components/parameters/dsourceIdParam' patch: tags: - DSources summary: Update values of an Oracle dSource operationId: update_oracle_dsource_by_id requestBody: content: application/json: schema: x-body-name: update_oracle_dsource_parameter $ref: '#/components/schemas/UpdateOracleDsourceParameters' description: The new data to update an Oracle dSource. responses: '200': description: OK content: application/json: schema: type: object title: UpdateDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/oracle/{dsourceId}/upgrade: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: deprecated: true tags: - DSources description: This API is marked as deprecated in favour of generalized API '/dsources/{dsourceId}/upgrade' summary: Upgrade the requested Oracle dSource installation and user. operationId: upgrade_oracle_dsource requestBody: content: application/json: schema: x-body-name: upgrade_oracle_dsource_parameter $ref: '#/components/schemas/UpgradeOracleDatabaseParameters' description: The new data to upgrade an Oracle dSource. responses: '200': description: OK content: application/json: schema: type: object title: UpgradeDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/{dsourceId}/upgrade: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Upgrade dSource tags: - DSources operationId: upgrade_dsource requestBody: content: application/json: schema: x-body-name: upgrade_dsource_parameters $ref: '#/components/schemas/UpgradeDatabaseParameters' description: The new API to upgrade dSource responses: '200': description: OK content: application/json: schema: type: object title: UpgradeDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/ase: post: summary: Link an ASE database as dSource. operationId: link_ase_database tags: - DSources requestBody: x-body-name: linkDSourceBody $ref: '#/components/requestBodies/ASELinkDSourceBody' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LinkDSourceResponse' /dsources/ase/defaults: post: summary: Get defaults for an ASE dSource linking. operationId: get_ase_dsource_linking_defaults tags: - DSources requestBody: content: application/json: schema: x-body-name: dSource_linking_defaults $ref: '#/components/schemas/LinkDSourceDefaultRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ASEDSourceLinkSourceParameters' /dsources/ase/{dsourceId}: parameters: - $ref: '#/components/parameters/dsourceIdParam' patch: tags: - DSources summary: Update values of an ASE dSource operationId: update_ase_dsource_by_id requestBody: content: application/json: schema: x-body-name: update_ase_dsource_parameter $ref: '#/components/schemas/UpdateAseDSourceParameters' description: The new data to update an ASE dSource. responses: '200': description: OK content: application/json: schema: type: object title: UpdateDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/ase/{dsourceId}/attachSource: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Attaches an ASE source to a previously detached ASE dSource. operationId: attach_ase_dsource tags: - DSources requestBody: x-body-name: attachAseDSourceBody $ref: '#/components/requestBodies/ASEAttachDSourceBody' responses: '200': description: OK content: application/json: schema: type: object title: AttachDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/ase/{dsourceId}/detachSource: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Detaches an ASE source from an ASE database. operationId: detach_ase_dsource tags: - DSources responses: '200': description: OK content: application/json: schema: type: object title: DetachDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/appdata: post: summary: Link an AppData database as dSource. operationId: link_appdata_database tags: - DSources requestBody: x-body-name: linkAppDataBody $ref: '#/components/requestBodies/AppDataDSourceBody' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LinkDSourceResponse' /dsources/appdata/defaults: post: summary: Get defaults for an AppData dSource linking. operationId: get_appdata_dsource_linking_defaults tags: - DSources requestBody: content: application/json: schema: x-body-name: dSource_linking_defaults $ref: '#/components/schemas/LinkDSourceDefaultRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AppDataDSourceLinkSourceParameters' /dsources/appdata/{dsourceId}: parameters: - $ref: '#/components/parameters/dsourceIdParam' patch: tags: - DSources summary: Update values of an AppData dSource operationId: update_appdata_dsource_by_id requestBody: content: application/json: schema: x-body-name: update_appdata_dsource_parameter $ref: '#/components/schemas/UpdateAppDataDSourceParameters' description: The new data to update an AppData dSource. responses: '200': description: OK content: application/json: schema: type: object title: UpdateDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/mssql: post: summary: Link a MSSql database as dSource. operationId: link_mssql_database tags: - DSources requestBody: x-body-name: linkDSourceBody $ref: '#/components/requestBodies/MSSQLLinkDSourceBody' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LinkDSourceResponse' /dsources/mssql/{dsourceId}/detachSource: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Detaches a linked source from a MSSql database. operationId: detach_mssql_database tags: - DSources responses: '200': description: OK content: application/json: schema: type: object title: DetachDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/mssql/{dsourceId}/attachSource: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Attaches a MSSql source to a previously detached dsource. operationId: attach_mssql_database tags: - DSources requestBody: x-body-name: attachDsourceBody $ref: '#/components/requestBodies/MSSQLAttachDsourceBody' responses: '200': description: OK content: application/json: schema: type: object title: AttachDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/mssql/staging-push/{dsourceId}/attachSource: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Attaches a MSSql staging push database to a previously detached dsource. operationId: attach_mssql_staging_push_database tags: - DSources requestBody: x-body-name: attachStagingPushDsourceBody $ref: '#/components/requestBodies/MSSQLAttachStagingPushDSourceBody' responses: '200': description: OK content: application/json: schema: type: object title: attachStagingPushDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/mssql/defaults: post: summary: Get defaults for a MSSql dSource linking. operationId: get_mssql_dsource_linking_defaults tags: - DSources requestBody: content: application/json: schema: x-body-name: dSource_linking_defaults $ref: '#/components/schemas/LinkDSourceDefaultRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MSSQLDSourceLinkSourceParameters' /dsources/mssql/staging-push: post: summary: Link a MSSql staging push database as dSource. operationId: link_mssql_staging_push_database tags: - DSources requestBody: x-body-name: linkStagingPushDSourceBody $ref: '#/components/requestBodies/MSSQLLinkStagingPushDSourceBody' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LinkDSourceResponse' /dsources/mssql/staging-push/defaults: post: summary: Get defaults for a MSSql staging push dSource linking. operationId: get_mssql_staging_push_dsource_linking_defaults tags: - DSources requestBody: content: application/json: schema: x-body-name: dSource_linking_staging_push_defaults $ref: '#/components/schemas/LinkStagingPushDSourceDefaultRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MSSQLDSourceStagingPushLinkSourceParameters' /dsources/delete: post: summary: Delete the specified dSource. operationId: delete_dsource tags: - DSources requestBody: content: application/json: schema: x-body-name: delete_dsource_request $ref: '#/components/schemas/DeleteDSourceRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteDSourceResponse' /dsources/search: post: summary: Search for dSources. operationId: search_dsources tags: - DSources x-filterable: fields: id: type: string data_uuid: type: string database_type: type: string name: type: string description: type: string database_version: type: string content_type: type: string storage_size: type: integer plugin_version: type: string creation_date: type: string group_name: type: string enabled: type: boolean is_detached: type: boolean logsync_enabled: type: boolean logsync_mode: type: string logsync_interval: type: integer format: int64 exported_data_directory: type: string engine_id: type: string source_id: type: string staging_source_id: type: string status: type: string engine_name: type: string cdb_id: type: string current_timeflow_id: type: string previous_timeflow_id: type: string namespace_id: type: string namespace_name: type: string is_replica: type: boolean 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 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 sync_policy_id: type: string retention_policy_id: type: string replica_retention_policy_id: type: string quota_policy_id: type: string template_id: type: string allow_auto_staging_restart_on_host_reboot: type: boolean physical_standby: type: boolean validate_by_opening_db_in_read_only_mode: type: boolean mssql_sync_strategy_managed_type: type: string validated_sync_mode: type: string shared_backup_locations: type: array items: type: string backup_policy: type: string compression_enabled: type: boolean staging_database_name: type: string db_state: type: string encryption_key: type: string external_netbackup_config_master_name: type: string external_netbackup_config_source_client_name: type: string external_netbackup_config_params: type: string external_netbackup_config_templates: type: string external_commserve_host_name: type: string external_commvault_config_source_client_name: type: string external_commvault_config_staging_client_name: type: string external_commvault_config_params: type: string external_commvault_config_templates: type: string mssql_user_type: type: string domain_user_credential_type: type: string mssql_database_username: type: string mssql_user_environment_reference: type: string mssql_user_domain_username: type: string mssql_user_domain_vault_username: type: string mssql_user_domain_vault: type: string mssql_user_domain_hashicorp_vault_engine: type: string mssql_user_domain_hashicorp_vault_secret_path: type: string mssql_user_domain_hashicorp_vault_username_key: type: string mssql_user_domain_hashicorp_vault_secret_key: type: string mssql_user_domain_azure_vault_name: type: string mssql_user_domain_azure_vault_username_key: type: string mssql_user_domain_azure_vault_secret_key: type: string mssql_user_domain_cyberark_vault_query_string: type: string diagnose_no_logging_faults: type: boolean pre_provisioning_enabled: type: boolean backup_level_enabled: type: boolean rman_channels: type: integer format: int32 files_per_set: type: integer format: int32 check_logical: type: boolean encrypted_linking_enabled: type: boolean compressed_linking_enabled: type: boolean bandwidth_limit: type: integer format: int32 number_of_connections: type: integer format: int32 toolkit_id: type: string data_connection_id: type: string truncate_log_on_checkpoint: type: boolean durability_level: type: string load_backup_path: type: string validated_sync_enabled: type: boolean dump_history_file_enabled: type: boolean parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/dsourcesSortParam' - $ref: '#/components/parameters/permission' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchDSourcesResponse properties: items: type: array items: $ref: '#/components/schemas/DSource' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /dsources/{dsourceId}: parameters: - $ref: '#/components/parameters/dsourceIdParam' get: summary: Get a dSource by ID. operationId: get_dsource_by_id tags: - DSources responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DSource' /dsources/{dsourceId}/enable: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Enable a dSource. operationId: enable_dsource tags: - DSources requestBody: $ref: '#/components/requestBodies/EnableDsourceBody' responses: '200': description: OK content: application/json: schema: type: object title: EnableDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/{dsourceId}/disable: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Disable a dSource. operationId: disable_dsource tags: - DSources requestBody: $ref: '#/components/requestBodies/DisableDsourceBody' responses: '200': description: OK content: application/json: schema: type: object title: DisableDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/{dsourceId}/upgrade_compatible_repositories: parameters: - $ref: '#/components/parameters/dsourceIdParam' get: tags: - DSources summary: Returns a list of compatible repositories for dSource upgrade. operationId: get_upgrade_compatible_repo_for_dsource responses: '200': description: OK content: application/json: schema: type: object title: UpgradeCompatibleEnvironmentsResponse properties: items: type: array items: $ref: '#/components/schemas/Environment' /dsources/mssql/{dsourceId}: parameters: - $ref: '#/components/parameters/dsourceIdParam' patch: tags: - DSources summary: Update values of an MSSql dSource operationId: update_mssql_dsource_by_id requestBody: content: application/json: schema: x-body-name: update_mssql_dsource_parameter $ref: '#/components/schemas/UpdateMSSQLDsourceParameters' description: The new data to update an MSSql dSource. responses: '200': description: OK content: application/json: schema: type: object title: UpdateDsourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/{dsourceId}/snapshots: parameters: - $ref: '#/components/parameters/dsourceIdParam' get: summary: List Snapshots for a dSource. operationId: get_dsource_snapshots parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' tags: - DSources responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListSnapshotsResponse' post: summary: Snapshot a dSource. operationId: snapshot_dsource tags: - DSources requestBody: content: application/json: schema: x-body-name: dsource_tags $ref: '#/components/schemas/DSourceSnapshotParameters' examples: default_values: description: 'This request example does not set any property and will thus use the default behavior. ' summary: Using default Values value: {} oracle_custom: description: 'This request examples customizes the snapshot process for an Oracle dSource. ' summary: Oracle customized value: skip_space_check: true force_full_backup: dsource-name double_sync: true rman_rate_in_MB: 0 mssql_specific_backup: description: 'This request examples demonstrates how to specify a custom backup set UUID for an MSSql dSource. ' summary: MSSql specific backup value: mssql_backup_uuid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX sync_strategy: specific_backup ase_specific_backup: description: 'This request examples demonstrates how to specify a custom backup for an ASE dSource. ' summary: ASE specific backup value: ase_backup_files: - backup_file_stripe_1 - backup_file_stripe_2 sync_strategy: specific_backup description: Optional parameters to snapshot a DSource. required: false responses: '200': description: dSource snapshot initiated. content: application/json: schema: type: object title: SnapshotDSourceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /dsources/{dsourceId}/deletion-dependencies: parameters: - $ref: '#/components/parameters/dsourceIdParam' get: summary: Get deletion dependencies for a dSource. operationId: get_dsource_deletion_dependencies tags: - DSources responses: '200': description: Deletion dependencies of a dSource. content: application/json: schema: $ref: '#/components/schemas/DeletionDependenciesResponse' /dsources/{dsourceId}/tags: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: tags: - DSources summary: Create tags for a dSource. operationId: create_tags_dsource requestBody: content: application/json: schema: x-body-name: dsource_tags $ref: '#/components/schemas/TagsRequest' description: Tags information for DSource. required: true responses: '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/TagsResponse' get: tags: - DSources summary: Get tags for a dSource. operationId: get_tags_dsource responses: '200': description: Created content: application/json: schema: $ref: '#/components/schemas/TagsResponse' /dsources/{dsourceId}/tags/delete: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: tags: - DSources summary: Delete tags for a dSource. operationId: delete_tags_dsource requestBody: $ref: '#/components/requestBodies/DeleteTags' responses: '204': description: No Content /dsources/{dsourceId}/asm-export-by-snapshot: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource by a snapshot to an ASM file system tags: - DSources operationId: export_dsource_to_asm_by_snapshot requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportBySnapshotParameters' description: The parameters to export a dSource. required: true responses: '200': description: DSource 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. /dsources/{dsourceId}/export-by-snapshot: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource using snapshot to a physical file system tags: - DSources operationId: export_dsource_by_snapshot requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportBySnapshotParameters' description: The parameters to export a dSource. required: true responses: '200': description: dSource 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. /dsources/{dsourceId}/asm-export-by-location: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource using SCN to an ASM file system tags: - DSources operationId: export_dsource_to_asm_by_location requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportByLocationParameters' description: The parameters to export a dSource. required: true responses: '200': description: DSource 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. /dsources/{dsourceId}/asm-export-from-bookmark: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource using bookmark to an ASM file system tags: - DSources operationId: export_dsource_to_asm_by_bookmark requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportFromBookmarkParameters' description: The parameters to export a dSource. required: true responses: '200': description: DSource 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. /dsources/{dsourceId}/export-from-bookmark: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource using bookmark to physical file system tags: - DSources operationId: export_dsource_from_bookmark requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportFromBookmarkParameters' description: The parameters to export a dSource. required: true responses: '200': description: DSource 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. /dsources/{dsourceId}/asm-export-by-timestamp: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource using timestamp to an ASM file system tags: - DSources operationId: export_dsource_to_asm_by_timestamp requestBody: content: application/json: schema: $ref: '#/components/schemas/OracleAsmExportByTimestampParameters' description: The parameters to export a dSource. required: true responses: '200': description: DSource 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. /dsources/{dsourceId}/export-by-timestamp: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource using timestamp to a physical file system. tags: - DSources operationId: export_dsource_by_timestamp requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportByTimestampParameters' description: The parameters to export a dSource. required: true responses: '200': description: DSource 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. /dsources/{dsourceId}/export-by-location: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Export a dSource using timeflow location to a physical file system. tags: - DSources operationId: export_dsource_by_location requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportByLocationParameters' description: The parameters to export a dSource. required: true responses: '200': description: DSource 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. /dsources/{dsourceId}/purge-logs: parameters: - $ref: '#/components/parameters/dsourceIdParam' post: summary: Purge logs of a dSource (Oracle only). tags: - DSources operationId: purge_logs_of_dsource requestBody: content: application/json: schema: $ref: '#/components/schemas/PurgeLogsParameters' description: The parameters to purge logs of a dSource. required: true responses: '200': description: Purge logs initiated successfully. content: application/json: schema: $ref: '#/components/schemas/PurgeLogsResponse' 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' NameValuePair: type: object required: - var_name - var_value properties: var_name: type: string description: The name of the environment variable. minLength: 1 maxLength: 256 example: env-var-name-1 var_value: type: string description: The value of the environment variable. minLength: 1 maxLength: 256 example: env-var-value-1 LinkStagingPushDSourceDefaultRequest: required: - environment_id properties: environment_id: type: string description: The ID of the environment to be linked. 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 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 LinkDSourceDefaultRequest: required: - source_id properties: source_id: type: string description: The ID of the source to be linked. DbVaultCredentials: type: object properties: db_vault_username: type: string description: Delphix display name for the vault user. minLength: 1 maxLength: 256 example: my-vault db_vault: type: string description: The name or reference of the vault from which to read the database credentials. minLength: 1 maxLength: 256 example: vault1 db_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: key-vault/vault-secrets db_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: ase-db-cred db_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: user db_hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: upword db_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure-keyvault db_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: ase-db-cred-sa-user db_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: ase-db-cred-sa-password db_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 example: Safe=Test;Object=ase-db-cred 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' 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 OracleDSourceLinkSourceParameters: required: - source_id allOf: - $ref: '#/components/schemas/BaseDSourceLinkSourceParameters' - type: object properties: external_file_path: description: External file path. type: string minLength: 1 maxLength: 1024 environment_user_id: description: Id of the environment user to use for linking. type: string minLength: 1 maxLength: 256 backup_level_enabled: description: Boolean value indicates whether LEVEL-based incremental backups can be used on the source database. type: boolean rman_channels: description: Number of parallel channels to use. type: integer minimum: 1 maximum: 32 default: 2 files_per_set: description: Number of data files to include in each RMAN backup set. type: integer minimum: 1 maximum: 64 default: 5 check_logical: description: True if extended block checking should be used for this linked database. type: boolean default: false encrypted_linking_enabled: description: True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data. type: boolean default: false compressed_linking_enabled: description: True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network. type: boolean default: true bandwidth_limit: description: Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit. type: integer default: 0 number_of_connections: description: Total number of transport connections to use during SnapSync. type: integer default: 1 diagnose_no_logging_faults: description: If true, NOLOGGING operations on this container are treated as faults and cannot be resolved manually. type: boolean default: true pre_provisioning_enabled: description: If true, pre-provisioning will be performed after every sync. type: boolean default: false link_now: description: True if initial load should be done immediately. type: boolean default: false force_full_backup: description: Whether or not to take another full backup of the source database. type: boolean default: false double_sync: description: True if two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. type: boolean default: false rman_rate_in_MB: type: integer description: 'RMAN rate in megabytes to be used. This is the upper limit for bytes read so that RMAN does not consume excessive disk bandwidth and degrade online performance. (Oracle only) ' default: 0 skip_space_check: description: Skip check that tests if there is enough space available to store the database in the Delphix Engine. The Delphix Engine estimates how much space a database will occupy after compression and prevents SnapSync if insufficient space is available. This safeguard can be overridden using this option. This may be useful when linking highly compressible databases. type: boolean default: false do_not_resume: description: Indicates whether a fresh SnapSync must be started regardless if it was possible to resume the current SnapSync. If true, we will not resume but instead ignore previous progress and backup all datafiles even if already completed from previous failed SnapSync. This does not force a full backup, if an incremental was in progress this will start a new incremental snapshot. type: boolean default: false files_for_full_backup: description: List of datafiles to take a full backup of. This would be useful in situations where certain datafiles could not be backed up during previous SnapSync due to corruption or because they went offline. type: array items: type: integer log_sync_mode: description: LogSync operation mode for this database. type: string enum: - ARCHIVE_ONLY_MODE - ARCHIVE_REDO_MODE - UNDEFINED default: UNDEFINED log_sync_interval: description: Interval between LogSync requests, in seconds. type: integer default: 5 non_sys_username: type: string description: Non-SYS database user to access this database. Only required for username-password auth (Single tenant only). minLength: 1 maxLength: 256 example: oracle non_sys_password: x-dct-toolkit-credential-field: true type: string description: Password for non sys user authentication (Single tenant only). minLength: 1 maxLength: 256 example: oracle non_sys_vault_username: type: string description: Delphix display name for the non sys vault user(Single tenant only). minLength: 1 maxLength: 256 example: my-vault non_sys_vault: type: string description: The name or reference of the vault from which to read the database credentials (Single tenant only). minLength: 1 maxLength: 256 example: my-vault non_sys_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored (Single tenant only). minLength: 1 maxLength: 256 example: kv non_sys_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored (Single tenant only). minLength: 1 maxLength: 256 example: oracle-env non_sys_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store (Single tenant only). minLength: 1 maxLength: 256 example: username non_sys_hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store (Single tenant only). minLength: 1 maxLength: 256 example: secret non_sys_azure_vault_name: type: string description: Azure key vault name (Single tenant only). minLength: 1 maxLength: 256 example: azure_vault non_sys_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store (Single tenant only). minLength: 1 maxLength: 256 example: username non_sys_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store (Single tenant only). minLength: 1 maxLength: 256 example: secret non_sys_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault (Single tenant only). minLength: 1 maxLength: 256 example: Safe=Test;Folder=Test;Object=Test fallback_username: type: string description: The database fallback username. Optional if bequeath connections are enabled (to be used in case of bequeath connection failures). Only required for username-password auth. minLength: 1 maxLength: 256 example: oracle fallback_password: x-dct-toolkit-credential-field: true type: string description: Password for fallback username. minLength: 1 maxLength: 256 example: oracle fallback_vault_username: type: string description: Delphix display name for the fallback vault user. minLength: 1 maxLength: 256 example: my-vault fallback_vault: type: string description: The name or reference of the vault from which to read the database credentials. minLength: 1 maxLength: 256 example: my-vault fallback_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 example: kv fallback_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 example: oracle-env fallback_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username fallback_hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret fallback_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 example: azure_vault fallback_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 example: username fallback_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 example: secret fallback_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 ops_pre_log_sync: description: Operations to perform after syncing a created dSource and before running the LogSync. type: array items: $ref: '#/components/schemas/SourceOperation' UpdateAppDataDSourceParameters: type: object description: Parameters to update a dSource. properties: name: description: Name of the dSource and container to be updated. type: string minLength: 1 maxLength: 256 description: description: The notes/description for the dSource. type: string minLength: 1 maxLength: 1024 staging_environment: description: The environment used as an intermediate stage to pull data into Delphix [AppDataStaged only]. type: string example: 3-UNIX_HOST_ENVIRONMENT-7 staging_environment_user: description: The environment user used to access the staging environment [AppDataStaged only]. type: string example: HOST_USER-11 environment_user: type: string description: The OS user to use for linking. minLength: 1 maxLength: 256 example: HOST_USER-11 parameters: description: The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. type: object additionalProperties: true excludes: type: array description: List of subdirectories in the source to exclude when syncing data. These paths are relative to the root of the source directory. [AppDataDirect only] items: type: string minLength: 1 maxLength: 1024 follow_symlinks: type: array description: List of symlinks in the source to follow when syncing data. These paths are relative to the root of the source directory. All other symlinks are preserved. [AppDataDirect only] items: type: string minLength: 1 maxLength: 1024 sync_policy_id: type: string description: The ID of the SnapSync policy for the dSource. minLength: 1 maxLength: 256 example: snapshot-123 retention_policy_id: type: string description: The ID of the Retention policy for the dSource. minLength: 1 maxLength: 256 example: retention-policy-123 ops_pre_sync: deprecated: true description: Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. type: array items: $ref: '#/components/schemas/SourceOperation' ops_post_sync: deprecated: true description: Operations to perform after syncing a created dSource. type: array items: $ref: '#/components/schemas/SourceOperation' hooks: $ref: '#/components/schemas/DSourceHooks' DSourceSnapshotParameters: type: object description: Parameters to snapshot a DSource. properties: drop_and_recreate_devices: type: boolean description: 'If this parameter is set to true, older devices will be dropped and new devices created instead of trying to remap the devices. This might increase the space utilization on Delphix Engine. (ASE only) ' sync_strategy: type: string enum: - latest_backup - new_backup - specific_backup description: "Determines how the Delphix Engine will take a backup:\n* `latest_backup` - Use the most recent backup.\n* `new_backup` - Delphix will take a new backup of your source database.\n* `specific_backup` - Use a specific backup. Using this option requires setting\n `ase_backup_files` for ASE dSources or `mssql_backup_uuid` for MSSql dSources.\nDefault is `new_backup`.\n(ASE, MSSql only)\n" ase_backup_files: type: array items: type: string minLength: 1 maxLength: 4096 description: When using the `specific_backup` sync_strategy, determines the backup files. (ASE Only) mssql_backup_uuid: type: string minLength: 1 maxLength: 4096 description: When using the `specific_backup` sync_strategy, determines the Backup Set UUID. (MSSql only) compression_enabled: type: boolean description: When using the `new_backup` sync_strategy, determines if compression must be enabled. Defaults to the configuration of the ingestion strategy configured on the Delphix Engine for this dSource. (MSSql only) availability_group_backup_policy: type: string enum: - primary - secondary_only - prefer_secondary description: 'When using the `new_backup` sync_strategy for an MSSql Availability Group, determines the backup policy: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. (MSSql only) ' do_not_resume: type: boolean description: 'Indicates whether a fresh SnapSync must be started regardless if it was possible to resume the current SnapSync. If true, we will not resume but instead ignore previous progress and backup all datafiles even if already completed from previous failed SnapSync. This does not force a full backup, if an incremental was in progress this will start a new incremental snapshot. (Oracle only) ' double_sync: type: boolean description: 'Indicates whether two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. (Oracle only). ' force_full_backup: type: boolean description: Whether or not to take another full backup of the source database. (Oracle only) skip_space_check: type: boolean description: 'Skip check that tests if there is enough space available to store the database in the Delphix Engine. The Delphix Engine estimates how much space a database will occupy after compression and prevents SnapSync if insufficient space is available. This safeguard can be overridden using this option. This may be useful when linking highly compressible databases. (Oracle only) ' files_for_partial_full_backup: type: array minItems: 1 maxItems: 10000 items: type: integer format: int64 description: 'List of datafiles to take a full backup of. This would be useful in situations where certain datafiles could not be backed up during previous SnapSync due to corruption or because they went offline. (Oracle only) ' appdata_parameters: description: The list of parameters specified by the snapshotParametersDefinition schema in the toolkit (AppData only). type: object additionalProperties: true nullable: true example: resync: true rman_rate_in_MB: type: integer description: 'RMAN rate in megabytes to be used. This is the upper limit for bytes read so that RMAN does not consume excessive disk bandwidth and degrade online performance. (Oracle only) ' 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 UpdateAseDSourceParameters: description: Parameters to update a dSource. allOf: - $ref: '#/components/schemas/DbVaultCredentials' - type: object properties: name: description: Name of the dSource and container to be updated. type: string minLength: 1 maxLength: 256 description: description: The notes/description for the dSource. type: string minLength: 1 maxLength: 1024 staging_environment_id: description: The environment used as an intermediate stage to pull data into Delphix. type: string example: 3-UNIX_HOST_ENVIRONMENT-7 staging_environment_user_ref: description: Information about the host OS user on the staging environment to use for linking. type: string example: HOST_USER-11 staging_repository_id: description: The SAP ASE repository(instance) on the staging environment that we want to use for validated sync. type: string example: 3-ASE_INSTANCE-7 source_environment_user_ref: type: string description: The OS user to use for linking. minLength: 1 maxLength: 256 example: HOST_USER-11 sync_policy_id: type: string description: The ID of the SnapSync policy for the dSource. minLength: 1 maxLength: 256 example: snapshot-123 retention_policy_id: type: string description: The ID of the Retention policy for the dSource. minLength: 1 maxLength: 256 example: retention-policy-123 load_backup_path: description: Source database backup location. type: string minLength: 1 maxLength: 1024 example: /backup/path dump_history_file_enabled: description: Specifies if Dump History File is enabled for backup history detection. type: boolean example: true validated_sync_enabled: description: True if validated sync is enabled for this dSource. type: boolean example: true logsync_enabled: description: True if LogSync is enabled for this dSource. type: boolean example: true source_of_production_backup: type: string description: Denotes whether it's a remote backup server or staging backup server. enum: - STAGING - REMOTE example: REMOTE backup_server_name: description: Name of the Sybase Backup Server instance on the staging environment. type: string minLength: 1 maxLength: 1024 example: remote_server external_file_path: description: External file path on the source host. type: string minLength: 1 maxLength: 1024 example: /external/path backup_password: description: The password for the Sybase Backup Server user. type: string x-dct-toolkit-credential-field: true minLength: 1 maxLength: 1024 backup_host: description: The host environment of the remote Sybase Backup Server. type: string minLength: 1 maxLength: 1024 example: 1-UNIX_HOST_ENVIRONMENT-2 backup_host_user: description: The OS user for the remote Sybase Backup Server host. type: string minLength: 1 maxLength: 1024 example: HOST_USER-1 hooks: $ref: '#/components/schemas/DSourceHooks' db_username: description: The user name for the source DB user. type: string minLength: 1 maxLength: 1024 example: sa db_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 example: password db_use_kerberos_authentication: type: boolean description: Whether to use kerberos authentication. example: true 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 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 MSSQLDSourceStagingPushLinkSourceParameters: required: - name - staging_database_name - engine_id - ppt_repository - ppt_host_user allOf: - $ref: '#/components/schemas/BaseDSourceLinkSourceParameters' - type: object properties: engine_id: type: string description: The ID of the engine to link staging push database on. minLength: 1 maxLength: 256 encryption_key: description: The encryption key to use when restoring encrypted backups. type: string ppt_repository: description: Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. type: string minLength: 1 maxLength: 1024 ppt_host_user: description: Reference of the host OS user on the PPT host to use for linking. type: string minLength: 1 maxLength: 1024 staging_pre_script: description: A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 staging_post_script: description: A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 staging_database_name: description: The name of the database to create on the staging environment. This property is mutually exclusive to sync_strategy_managed_type type: string minLength: 1 maxLength: 1024 db_state: type: string enum: - RESTORING - ONLINE description: User provided db state that will be used to create staging push db. Default is RESTORING default: RESTORING VirtualizationTaskEvent: deprecated: true properties: message_details: type: string 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 MSSQLDSourceLinkSourceParameters: required: - source_id allOf: - $ref: '#/components/schemas/BaseDSourceLinkSourceParameters' - type: object properties: encryption_key: description: The encryption key to use when restoring encrypted backups. type: string sync_strategy: type: string enum: - latest_backup - new_backup - specific_backup - no_backup description: 'Determines how the Delphix Engine will take a backup: * `latest_backup` - Use the most recent backup. * `new_backup` - Delphix will take a new backup of your source database. * `specific_backup` - Use a specific backup. Using this option requires setting `ase_backup_files`. * `no_backup` - Use as input to sync MSSQL databases without a backup. Default is `new_backup`. ' default: new_backup mssql_backup_uuid: type: string minLength: 1 maxLength: 4096 description: When using the `specific_backup` sync_strategy, determines the Backup Set UUID. compression_enabled: type: boolean default: false description: When using the `new_backup` sync_strategy, determines if compression must be enabled. Defaults to the configuration of the ingestion strategy configured on the Delphix Engine for this dSource. availability_group_backup_policy: deprecated: true type: string enum: - primary - secondary_only - prefer_secondary description: 'When using the `new_backup` sync_strategy for an MSSql Availability Group, determines the backup policy: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. ' source_host_user: description: ID or user reference of the host OS user to use for linking. type: string minLength: 1 maxLength: 1024 ppt_repository: description: Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. type: string minLength: 1 maxLength: 1024 ppt_host_user: description: Reference of the host OS user on the PPT host to use for linking. type: string minLength: 1 maxLength: 1024 staging_pre_script: description: A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 staging_post_script: description: A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 sync_strategy_managed_type: type: string enum: - external - delphix - staging_push default: external description: 'MSSQL specific parameters for source based sync strategy.: * `external` - MSSQL specific parameters for externally managed source based sync strategy. * `delphix` - MSSQL specific parameters for delphix managed source based sync strategy. * `staging_push` - MSSQL specific parameters for staging push based sync strategy. ' mssql_user_environment_reference: description: Reference to the source environment user to use for linking. type: string minLength: 1 maxLength: 1024 mssql_user_domain_username: description: The username for the source DB user. type: string minLength: 1 maxLength: 1024 mssql_user_domain_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 mssql_user_domain_vault_username: type: string description: Delphix display name for the vault user. minLength: 1 maxLength: 256 example: my-vault mssql_user_domain_vault: type: string description: The name or reference of the vault from which to read the database credentials. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 mssql_database_username: description: The username for the source DB user. type: string minLength: 1 maxLength: 1024 mssql_database_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 delphix_managed_backup_compression_enabled: type: boolean description: Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected. default: false delphix_managed_backup_policy: type: string enum: - primary - secondary_only - prefer_secondary description: 'Specify which node of an availability group to run the copy-only full backup on: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. ' default: primary external_managed_validate_sync_mode: type: string enum: - TRANSACTION_LOG - FULL_OR_DIFFERENTIAL - FULL - NONE description: Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database default: TRANSACTION_LOG external_managed_shared_backup_locations: type: array description: Shared source database backup locations. items: type: string minLength: 1 maxLength: 4096 maxItems: 260 external_netbackup_config_master_name: type: string description: The master server name of this NetBackup configuration. minLength: 1 maxLength: 256 external_netbackup_config_source_client_name: type: string description: The source's client server name of this NetBackup configuration. minLength: 1 maxLength: 256 external_netbackup_config_params: description: NetBackup configuration parameter overrides. type: object additionalProperties: true external_netbackup_config_templates: type: string description: Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored. external_commserve_host_name: type: string description: The commserve host name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_source_client_name: type: string description: The source client name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_staging_client_name: type: string description: The staging client name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_params: description: Commvault configuration parameter overrides. type: object additionalProperties: true external_commvault_config_templates: type: string description: Optional config template selection for Commvault configurations. If set, configParams will be ignored. OracleAttachDSourceParameters: allOf: - $ref: '#/components/schemas/OracleAttachParameters' - type: object required: - source_id properties: source_id: description: Id of the source to attach. type: string minLength: 1 maxLength: 256 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 SourceOperation: properties: name: type: string minLength: 1 maxLength: 256 command: type: string minLength: 1 maxLength: 131072 shell: type: string enum: - bash - shell - expect - ps - psd default: bash credentials_env_vars: description: List of environment variables that will contain credentials for this operation. type: array items: $ref: '#/components/schemas/CredentialsEnvVariable' hook_template_id: description: ID of the hook template type: string EnableDsourceParameters: description: The parameters to enable a dSource. type: object properties: attempt_start: description: Whether to attempt a startup of the source after the enable. type: boolean default: true ASEDSourceAttachSourceParameters: required: - source_id - source_host_user - load_backup_path - staging_repository - staging_host_user allOf: - $ref: '#/components/schemas/DbVaultCredentials' - type: object properties: source_id: description: Id of the source to attach. type: string minLength: 1 maxLength: 256 source_host_user: description: ID or user reference of the host OS user to use for attaching. type: string minLength: 1 maxLength: 1024 mount_base: description: The base mount point to use for the NFS mounts. type: string minLength: 1 maxLength: 87 hooks: $ref: '#/components/schemas/DSourceHooks' db_username: description: Database user name for the source database. type: string minLength: 1 maxLength: 1024 db_password: x-dct-toolkit-credential-field: true type: string description: The password of the database user. minLength: 1 maxLength: 256 db_use_kerberos_authentication: type: boolean description: Whether to use kerberos authentication. example: true load_backup_path: description: Source database backup location. type: string minLength: 1 maxLength: 1024 staging_repository: type: string description: The SAP ASE instance on the staging environment that we want to use for validated sync. minLength: 1 maxLength: 1024 staging_host_user: type: string description: Information about the host OS user on the staging environment to use for attaching. minLength: 1 maxLength: 1024 validated_sync_mode: type: string description: Specifies the validated sync mode to synchronize the dSource with the source database. enum: - ENABLED - DISABLED default: ENABLED dump_history_file_enabled: type: boolean description: Specifies if Dump History File is enabled for backup history detection. default: false external_file_path: description: External file path. type: string minLength: 1 maxLength: 1024 dump_credentials: x-dct-toolkit-credential-field: true description: The password credential for the source DB user. type: string minLength: 1 maxLength: 1024 backup_server_name: description: Name of the Remote Sybase Backup Server instance. type: string minLength: 1 maxLength: 1024 example: remote_server_name backup_host: description: The host environment of the remote Sybase Backup Server. type: string minLength: 1 maxLength: 1024 example: 1-UNIX_HOST_ENVIRONMENT-2 backup_host_user: description: The OS user for the remote Sybase Backup Server host. type: string minLength: 1 maxLength: 1024 example: HOST_USER-2 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. PurgeLogsParameters: type: object required: - storage_space_to_reclaim properties: storage_space_to_reclaim: type: integer format: int64 minimum: 1 description: Amount of space in bytes to reclaim as part of purgeLogs process. example: 2048 dry_run: type: boolean default: true description: If this is set to true, this operation does not actually delete logs. It returns the affected snapshots and truncated timeline as if the logs were deleted. example: true delete_snapshot_logs: type: boolean default: false description: Delete expired logs which have been retained to make snapshots consistent. example: true 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 DeleteDSourceResponse: allOf: - $ref: '#/components/schemas/Job' - type: object properties: job: $ref: '#/components/schemas/Job' description: The initiated job. 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 AppDataDSourceLinkSourceParameters: required: - parameters - sync_parameters - environment_user allOf: - $ref: '#/components/schemas/BaseDSourceLinkSourceParameters' - type: object properties: link_type: description: 'The type of link to create. Default is AppDataDirect. * `AppDataDirect` - Represents the AppData specific parameters of a link request for a source directly replicated into the Delphix Engine. * `AppDataStaged` - Represents the AppData specific parameters of a link request for a source with a staging source. ' type: string enum: - AppDataDirect - AppDataStaged default: AppDataDirect staging_mount_base: description: The base mount point for the NFS mount on the staging environment [AppDataStaged only]. type: string maxLength: 256 staging_environment: description: The environment used as an intermediate stage to pull data into Delphix [AppDataStaged only]. type: string staging_environment_user: description: The environment user used to access the staging environment [AppDataStaged only]. type: string environment_user: type: string description: The OS user to use for linking. minLength: 1 maxLength: 256 excludes: type: array description: List of subdirectories in the source to exclude when syncing data. These paths are relative to the root of the source directory. [AppDataDirect only] items: type: string minLength: 1 maxLength: 1024 follow_symlinks: type: array description: List of symlinks in the source to follow when syncing data. These paths are relative to the root of the source directory. All other symlinks are preserved. [AppDataDirect only] items: type: string minLength: 1 maxLength: 1024 parameters: description: The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. type: object additionalProperties: true sync_parameters: description: The JSON payload conforming to the snapshot parameters definition in a LUA toolkit or platform plugin. type: object additionalProperties: true OracleLogsyncModeTypeEnum: type: string description: LogSync operation mode for this dSource. enum: - ARCHIVE_ONLY_MODE - ARCHIVE_REDO_MODE - UNDEFINED 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 PurgeLogsResponse: type: object properties: affected_snapshots: type: array description: List of snapshots which have been rendered unprovisionable because logs needed to make them consistent have been deleted. items: $ref: '#/components/schemas/Snapshot' truncate_point: description: TimeFlow point after the last snapshot beyond which TimeFlow will be lost as a result of purging logs. $ref: '#/components/schemas/TimeflowPoint' 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 UpdateMSSQLDsourceParameters: type: object description: Parameters to update a MSSql dSource. properties: name: type: string description: The unique name of the dSource within a group. minLength: 1 maxLength: 256 logsync_enabled: description: Enabled LogSync for this dSource. type: boolean encryption_key: x-dct-toolkit-credential-field: true description: The encryption key to use when restoring encrypted backups. type: string ppt_repository: description: Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. type: string minLength: 1 maxLength: 1024 ppt_host_user: description: Reference of the host OS user on the PPT host to use for linking. type: string minLength: 1 maxLength: 1024 sync_strategy_managed_type: type: string enum: - external - delphix - staging_push description: 'MSSQL specific parameters for source based sync strategy.: * `external` - MSSQL specific parameters for externally managed source based sync strategy. * `delphix` - MSSQL specific parameters for delphix managed source based sync strategy. * `staging_push` - MSSQL specific parameters for staging push based sync strategy. ' source_host_user: description: ID or user reference of the host OS user to use for linking. type: string minLength: 1 maxLength: 1024 mssql_user_environment_reference: description: Reference to the source environment user to use for linking. type: string minLength: 1 maxLength: 1024 mssql_user_domain_username: description: The username for the source DB user. type: string minLength: 1 maxLength: 1024 mssql_user_domain_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 mssql_user_domain_vault_username: type: string description: Delphix display name for the vault user. minLength: 1 maxLength: 256 example: my-vault mssql_user_domain_vault: type: string description: The name or reference of the vault from which to read the database credentials. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_secret_path: x-dct-toolkit-credential-field: true type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_secret_key: x-dct-toolkit-credential-field: true type: string description: Hashicorp vault key for the password in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_secret_key: x-dct-toolkit-credential-field: true type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 mssql_database_username: description: The username for the source DB user. type: string minLength: 1 maxLength: 1024 mssql_database_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 delphix_managed_backup_compression_enabled: type: boolean description: Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected. delphix_managed_backup_policy: type: string enum: - primary - secondary_only - prefer_secondary description: 'Specify which node of an availability group to run the copy-only full backup on: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. ' external_managed_validate_sync_mode: type: string enum: - TRANSACTION_LOG - FULL_OR_DIFFERENTIAL - FULL - NONE description: Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database external_managed_shared_backup_locations: type: array description: Shared source database backup locations. items: type: string minLength: 1 maxLength: 4096 maxItems: 260 disable_netbackup_config: type: boolean description: Disable NetBackup configuration. external_netbackup_config_master_name: type: string description: The master server name of this NetBackup configuration. minLength: 1 maxLength: 256 external_netbackup_config_source_client_name: type: string description: The source's client server name of this NetBackup configuration. minLength: 1 maxLength: 256 external_netbackup_config_params: description: NetBackup configuration parameter overrides. type: object additionalProperties: true external_netbackup_config_templates: type: string description: Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored. disable_commvault_config: type: boolean description: Disable Commvault configuration. external_commserve_host_name: type: string description: The commserve host name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_source_client_name: type: string description: The source client name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_staging_client_name: type: string description: The staging client name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_params: description: Commvault configuration parameter overrides. type: object additionalProperties: true external_commvault_config_templates: type: string description: Optional config template selection for Commvault configurations. If set, configParams will be ignored. hooks: $ref: '#/components/schemas/DSourceHooks' sync_policy_id: type: string description: The ID of the SnapSync policy for the dSource. minLength: 1 maxLength: 256 example: snapshot-123 retention_policy_id: type: string description: The ID of the Retention policy for the dSource. minLength: 1 maxLength: 256 example: retention-policy-123 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' ASEDSourceLinkSourceParameters: required: - load_backup_path - source_id allOf: - $ref: '#/components/schemas/BaseDSourceLinkSourceParameters' - $ref: '#/components/schemas/DbVaultCredentials' - type: object properties: external_file_path: description: External file path. type: string minLength: 1 maxLength: 1024 mount_base: description: The base mount point to use for the NFS mounts. type: string minLength: 1 maxLength: 87 load_backup_path: description: Source database backup location. type: string minLength: 1 maxLength: 1024 backup_server_name: description: Name of the backup server instance. type: string minLength: 1 maxLength: 1024 backup_host_user: description: OS user for the host where the backup server is located. type: string minLength: 1 maxLength: 1024 backup_host: description: Host environment where the backup server is located. type: string minLength: 1 maxLength: 1024 dump_credentials: x-dct-toolkit-credential-field: true description: The password credential for the source DB user. type: string minLength: 1 maxLength: 1024 source_host_user: description: ID or user reference of the host OS user to use for linking. type: string minLength: 1 maxLength: 1024 db_user: description: The user name for the source DB user. type: string minLength: 1 maxLength: 1024 db_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 db_use_kerberos_authentication: type: boolean description: Whether to use kerberos authentication. example: true staging_repository: type: string description: The SAP ASE instance on the staging environment that we want to use for validated sync. minLength: 1 maxLength: 1024 staging_host_user: type: string description: Information about the host OS user on the staging environment to use for linking. minLength: 1 maxLength: 1024 validated_sync_mode: type: string description: Information about the host OS user on the staging environment to use for linking. enum: - ENABLED - DISABLED default: ENABLED dump_history_file_enabled: type: boolean description: Specifies if Dump History File is enabled for backup history detection. default: false drop_and_recreate_devices: description: If this parameter is set to true, it will drop the older devices and create new devices during manual sync operations instead of trying to remap the devices. This might increase the space utilization on Delphix Engine. type: boolean default: false sync_strategy: type: string enum: - latest_backup - new_backup - specific_backup description: 'Determines how the Delphix Engine will take a backup: * `latest_backup` - Use the most recent backup. * `new_backup` - Delphix will take a new backup of your source database. * `specific_backup` - Use a specific backup. Using this option requires setting `ase_backup_files`. Default is `new_backup`. ' default: new_backup ase_backup_files: description: The location of the full backup of the source database to restore from. The backup should be present in the shared backup location for the source database. type: array items: type: string minLength: 1 maxLength: 256 pre_validated_sync: description: Operations to perform on the staging source before performing a validated sync. type: array items: $ref: '#/components/schemas/SourceOperation' post_validated_sync: description: Operations to perform on the staging source after performing a validated sync. type: array items: $ref: '#/components/schemas/SourceOperation' 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. OracleLinkStagingPushDSourceDefaultRequest: required: - environment_id properties: environment_id: type: string description: The ID of the environment to be linked. container_type: description: The container type of this database.If not provided the request would be considered for a PDB database. type: string enum: - ROOT_CDB - NON_CDB 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' 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 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 DeleteDSourceRequest: required: - dsource_id properties: dsource_id: description: Id of the dSource to delete. type: string minLength: 1 maxLength: 256 force: description: Flag indicating whether to continue the operation upon failures. type: boolean default: false oracle_username: type: string description: The name of the privileged user to run the delete operation as (Oracle only). minLength: 1 maxLength: 256 example: oracle-username oracle_password: x-dct-toolkit-credential-field: true type: string description: Password for privileged user (Oracle only). minLength: 1 maxLength: 256 example: oracle-password delete_all_dependent_vdbs: description: Flag indicating whether to delete all dependent VDBs before deleting the dSource. type: boolean default: false DSource: description: The Delphix storage-based copy of the source database including its history. type: object properties: id: description: The dSource object entity ID. type: string database_type: description: The database type of this dSource. type: string nullable: true name: description: The container name of this dSource. type: string nullable: true description: description: The container description of this dSource. type: string namespace_id: description: The namespace id of this dSource. type: string nullable: true namespace_name: description: The namespace name of this dSource. type: string nullable: true is_replica: description: Is this a replicated object. type: boolean nullable: true database_version: description: The database version of this dSource. type: string nullable: true content_type: description: The content type of the dSource. type: string nullable: true data_uuid: description: A universal ID that uniquely identifies the dSource database. type: string nullable: true storage_size: description: The actual space used by this dSource, in bytes. type: integer format: int64 nullable: true plugin_version: description: The version of the plugin associated with this source database. type: string nullable: true excludes: type: array description: List of subdirectories in the source to exclude when syncing data. These paths are relative to the root of the source directory. [AppDataDirect only] items: type: string minLength: 1 maxLength: 1024 follow_symlinks: type: array description: List of symlinks in the source to follow when syncing data. These paths are relative to the root of the source directory. All other symlinks are preserved. [AppDataDirect only] items: type: string minLength: 1 maxLength: 1024 creation_date: description: The date this dSource was created. type: string format: date-time nullable: true group_name: description: The name of the group containing this dSource. type: string nullable: true enabled: description: A value indicating whether this dSource is enabled. type: boolean nullable: true is_detached: description: A value indicating whether this dSource is detached. type: boolean nullable: true engine_id: description: A reference to the Engine that this dSource belongs to. type: string source_id: description: A reference to the Source associated with this dSource. type: string nullable: true staging_source_id: description: A reference to the Staging Source associated with this dSource. type: string nullable: true status: description: The runtime status of the dSource. 'Unknown' if all attempts to connect to the source failed. type: string nullable: true engine_name: description: Name of the Engine where this DSource is hosted type: string nullable: true cdb_id: description: A reference to the CDB associated with this dSource. type: string nullable: true current_timeflow_id: type: string description: A reference to the currently active timeflow for this dSource. example: timeflow-123 previous_timeflow_id: type: string description: A reference to the previous timeflow for this dSource. example: timeflow-123 is_appdata: description: Indicates whether this dSource has an AppData database. type: boolean example: true toolkit_id: description: The ID of the toolkit associated with this dSource(AppData only). type: string unvirtualized_space: description: This is the sum of unvirtualized space from the dependants VDBs of the dSource. type: integer format: int64 dependant_vdbs: description: The number of VDBs that are dependant on this dSource. This includes all VDB descendants that have this dSource as an ancestor. type: integer 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 appdata_config_params: description: The parameters specified by the source config schema in the toolkit type: object nullable: true additionalProperties: true example: foo: bar tags: type: array items: $ref: '#/components/schemas/Tag' primary_object_id: description: The ID of the parent object from which replication was done. 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 replicas: description: The list of replicas replicated from this object. type: array items: $ref: '#/components/schemas/Replica' hooks: $ref: '#/components/schemas/DSourceHooks' sync_policy_id: description: The id of the snapshot policy associated with this dSource. type: string retention_policy_id: description: The id of the retention policy associated with this dSource. type: string replica_retention_policy_id: description: The id of the replica retention policy associated with this dSource. type: string quota_policy_id: description: The id of the quota policy associated with this dSource. type: string logsync_enabled: description: True if LogSync is enabled for this dSource. type: boolean logsync_mode: description: LogSync operation mode for this dSource. $ref: '#/components/schemas/OracleLogsyncModeTypeEnum' logsync_interval: description: Interval between LogSync requests, in seconds. type: integer exported_data_directory: description: ZFS exported data directory path. type: string template_id: description: A reference to the Non Virtual Database Template. type: string nullable: true example: DATABASE_TEMPLATE-1 allow_auto_staging_restart_on_host_reboot: description: Indicates whether Delphix should automatically restart this staging database when staging host reboot is detected. type: boolean physical_standby: description: Indicates whether this staging database is configured as a physical standby. type: boolean validate_by_opening_db_in_read_only_mode: description: Indicates whether this staging database snapshot is validated by opening it in read-only mode. type: boolean mssql_sync_strategy_managed_type: type: string enum: - external - delphix - staging_push validated_sync_mode: description: Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database. type: string enum: - TRANSACTION_LOG - FULL_OR_DIFFERENTIAL - FULL - NONE shared_backup_locations: type: array description: Shared source database backup locations. items: type: string backup_policy: description: Specify which node of an availability group to run the copy-only full backup on type: string enum: - PRIMARY - SECONDARY_ONLY - PREFER_SECONDARY compression_enabled: description: Specify whether the backups taken should be compressed or uncompressed. type: boolean staging_database_name: description: The name of the staging database type: string db_state: description: User provided db state that is used to create staging push db type: string enum: - ONLINE - RESTORING encryption_key: x-dct-toolkit-credential-field: true description: The encryption key to use when restoring encrypted backups. type: string external_netbackup_config_master_name: type: string description: The master server name of this NetBackup configuration. external_netbackup_config_source_client_name: type: string description: The source's client server name of this NetBackup configuration. external_netbackup_config_params: description: NetBackup configuration parameter overrides. type: object additionalProperties: true external_netbackup_config_templates: type: string description: Optional config template selection for NetBackup configurations. external_commserve_host_name: type: string description: The commserve host name of this Commvault configuration. external_commvault_config_source_client_name: type: string description: The source client name of this Commvault configuration. external_commvault_config_staging_client_name: type: string description: The staging client name of this Commvault configuration. external_commvault_config_params: description: Commvault configuration parameter overrides. type: object additionalProperties: true external_commvault_config_templates: type: string description: Optional config template selection for Commvault configurations. mssql_user_type: type: string description: Database user type for Database authentication. enum: - DATABASE_USER - DOMAIN_USER - ENVIRONMENT_USER domain_user_credential_type: type: string description: credential types. enum: - PASSWORD - CYBERARK_VAULT - HASHICORP_VAULT - AZURE_VAULT mssql_database_username: type: string description: The database user name for database user type. mssql_user_environment_reference: type: string description: The name or reference of the environment user for environment user type. mssql_user_domain_username: type: string description: Domain User name for password credentials. mssql_user_domain_vault_username: type: string description: Delphix display name for the vault user. mssql_user_domain_vault: type: string description: The name or reference of the vault. mssql_user_domain_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. mssql_user_domain_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. mssql_user_domain_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. mssql_user_domain_hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store. mssql_user_domain_azure_vault_name: type: string description: Azure key vault name. mssql_user_domain_azure_vault_username_key: type: string description: Azure vault key in the key-value store. mssql_user_domain_azure_vault_secret_key: type: string description: Azure vault key in the key-value store. mssql_user_domain_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. diagnose_no_logging_faults: type: boolean description: If true, NOLOGGING operations on this container are treated as faults and cannot be resolved manually. Otherwise, these operations are ignored. pre_provisioning_enabled: type: boolean description: If true, pre-provisioning will be performed after every sync. backup_level_enabled: type: boolean description: Boolean value indicates whether LEVEL-based incremental backups can be used on the source db. rman_channels: type: integer format: int32 description: Number of parallel channels to use. files_per_set: type: integer format: int32 description: Number of data files to include in each RMAN backup set. check_logical: type: boolean description: True if extended block checking should be used for this linked database. encrypted_linking_enabled: type: boolean description: True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data. compressed_linking_enabled: type: boolean description: True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network. bandwidth_limit: type: integer format: int32 description: Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit. number_of_connections: type: integer format: int32 description: Total number of transport connections to use during SnapSync. data_connection_id: description: The ID of the associated DataConnection. type: string example: data-connection-1 truncate_log_on_checkpoint: type: boolean description: True if configured to truncate log on checkpoint (ASE only). durability_level: type: string description: SAP ASE database durability level (ASE only). enum: - FULL - AT_SHUTDOWN - NO_RECOVERY external_file_path: type: string description: ASE External file path. load_backup_path: type: string description: ASE Source database backup location. validated_sync_enabled: type: boolean description: True if ASE validated sync mode is set to ENABLED dump_history_file_enabled: type: boolean description: Specifies if Dump History File is enabled for backup history detection. source_of_production_backup: type: string description: Denotes whether it's a remote backup server or staging backup server. enum: - STAGING - REMOTE backup_password_set: type: boolean description: True if ASE dump is password protected. backup_server_name: type: string description: Name of the ASE backup server instance. backup_host: type: string description: Host environment where the ASE backup server is located. backup_host_user: type: string description: OS user for the host where the ASE backup server is located. example: id: dsource-123 database_type: Oracle name: prod01-main database_version: 10.2.0.5.0 data_uuid: 1734315df891991101eb96963535afa0 storage_size: 339292672 plugin_version: '1.0' creation_date: '2021-05-01T08:51:34.148000+00:00' group_name: DSources enabled: true is_detached: false engine_id: engine-123 source_id: source-123 staging_source_id: 2-ORACLE_SINGLE_CONFIG-13 status: RUNNING engine_name: engine-123-name cdb_id: cdb-123 is_appdata: true tags: - key: key1 value: value1 - key: key2 value: value2 primary_object_id: 1-CONTAINER-1 primary_engine_id: '1' primary_engine_name: source-engine replicas: - replica_id: replica-1 replica_engine_id: '1' replica_engine_name: replica-e1 - replica_id: replica-2 replica_engine_id: '2' replica_engine_name: replica-e2 hooks: pre_sync: - name: Print the current user command: whoami shell: bash element_id: '3' sync_policy_id: 1-POLICY_SNAPSHOT-1 retention_policy_id: 1-POLICY_RETENTION-1 replica_retention_policy_id: 1-POLICY_REPLICA_RETENTION-1 quota_policy_id: 1-POLICY_QUOTA-1 logsync_enabled: true exported_data_directory: domain0/oracle_db_container-30/oracle_timeflow-32/datafile template_id: DATABASE_TEMPLATE-1 mssql_user_type: DATABASE_USER domain_user_credential_type: PASSWORD mssql_database_username: mssql-user mssql_user_environment_reference: HOST-USER_1 mssql_user_domain_username: domain/user mssql_user_domain_vault_username: my-vault mssql_user_domain_vault: my-vault-1 mssql_user_domain_hashicorp_vault_engine: key_vault mssql_user_domain_hashicorp_vault_secret_path: mssql-env mssql_user_domain_hashicorp_vault_username_key: username mssql_user_domain_hashicorp_vault_secret_key: secret mssql_user_domain_azure_vault_name: azure_vault mssql_user_domain_azure_vault_username_key: username mssql_user_domain_azure_vault_secret_key: secret mssql_user_domain_cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test diagnose_no_logging_faults: true pre_provisioning_enabled: true backup_level_enabled: true rman_channels: 2 files_per_set: 5 check_logical: true encrypted_linking_enabled: false compressed_linking_enabled: false bandwidth_limit: 0 number_of_connections: 10 truncate_log_on_checkpoint: true durability_level: FULL 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. OracleAttachParameters: type: object properties: backup_level_enabled: description: Boolean value indicates whether LEVEL-based incremental backups can be used on the source database. type: boolean bandwidth_limit: description: Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit. type: integer default: 0 check_logical: description: True if extended block checking should be used for this linked database. type: boolean default: false compressed_linking_enabled: description: True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network. type: boolean default: true double_sync: description: True if two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. type: boolean default: false encrypted_linking_enabled: description: True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data. type: boolean default: false environment_user: description: Reference to the user that should be used in the host. type: string external_file_path: description: External file path. type: string maxLength: 1024 files_per_set: description: Number of data files to include in each RMAN backup set. type: integer minimum: 1 maximum: 64 default: 5 force: description: If true, attach will succeed even if the resetlogs of the new database does not match the resetlogs information of the original database. type: boolean default: false link_now: description: True if initial load should be done immediately. type: boolean default: false number_of_connections: description: Total number of transport connections to use during SnapSync. type: integer default: 1 operations: description: Operations to perform after syncing a created dSource and before running the LogSync. type: array items: $ref: '#/components/schemas/SourceOperation' oracle_fallback_user: type: string description: The database fallback username. Optional if bequeath connections are enabled (to be used in case of bequeath connection failures). Only required for username-password auth. minLength: 1 maxLength: 256 example: oracle oracle_fallback_credentials: x-dct-toolkit-credential-field: true type: string description: Password for fallback username. minLength: 1 maxLength: 256 example: oracle rman_channels: description: Number of parallel channels to use. type: integer minimum: 1 maximum: 32 default: 2 discriminator: propertyName: class_type UpdateOracleDsourceParameters: type: object description: Parameters to update a dSource. properties: name: type: string description: The unique name of the dSource within a group. minLength: 1 maxLength: 256 example: my-dsource description: type: string description: The description of the dSource. minLength: 1 maxLength: 256 example: my-dsource db_username: type: string description: The username of the database user. minLength: 1 maxLength: 256 example: db-username db_password: x-dct-toolkit-credential-field: true type: string description: The password of the database user. minLength: 1 maxLength: 256 example: db-password non_sys_username: type: string description: Non-SYS database user to access this database. Only required for username-password auth (Single tenant only). minLength: 1 maxLength: 256 example: oracle non_sys_password: x-dct-toolkit-credential-field: true type: string description: Password for non sys user authentication (Single tenant 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 dSource. This must be set to false when credentials validation is not possible, for instance if the dSource is known to be disabled. example: true 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 backup_level_enabled: type: boolean description: Boolean value indicates whether LEVEL-based incremental backups can be used on the source database. example: true rman_channels: description: Number of parallel channels to use. type: integer minimum: 1 maximum: 32 files_per_set: description: Number of data files to include in each RMAN backup set. type: integer minimum: 1 maximum: 64 check_logical: description: True if extended block checking should be used for this dSource. type: boolean encrypted_linking_enabled: description: True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data. type: boolean compressed_linking_enabled: description: True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network. type: boolean bandwidth_limit: description: Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit. type: integer number_of_connections: description: Total number of transport connections to use during SnapSync. type: integer validate_by_opening_db_in_read_only_mode: description: Whether the snaphots of this dSource's staging database will be validated by opening it in read-only mode. type: boolean pre_provisioning_enabled: description: Boolean flag indicating whether or not pre-provisioning is turned on for this dSource. type: boolean diagnose_no_logging_faults: description: If true, NOLOGGING operations on this dSource are treated as faults and cannot be resolved manually. type: boolean rac_max_instance_lag: description: Maximum number of log sequences to allow a RAC instance to lag before considering the instance offline. type: integer allow_auto_staging_restart_on_host_reboot: description: Allow auto restart of staging source on host reboot. type: boolean physical_standby: description: If true, convert this dSource's staging database to a physical standby. type: boolean external_file_path: description: External file path. type: string minLength: 1 maxLength: 1024 hooks: $ref: '#/components/schemas/DSourceHooks' custom_env_variables_pairs: description: An array of name value pair of environment variables. type: array items: $ref: '#/components/schemas/NameValuePair' custom_env_variables_paths: description: An array of strings 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. type: array items: type: string staging_database_config_params: description: Database configuration parameter overrides. type: object additionalProperties: true nullable: true template_id: type: string description: The template ID of the target Oracle Staging Push dSource. maxLength: 256 example: 70096a7-6655-4973-8464-682c41c932da logsync_enabled: type: boolean description: True if LogSync is enabled for this dSource. logsync_mode: description: LogSync operation mode for this dSource. $ref: '#/components/schemas/OracleLogsyncModeTypeEnum' logsync_interval: type: integer description: Interval between LogSync requests, in seconds. minimum: 5 repository: description: The repository Id where staging database will be created. type: string minLength: 1 maxLength: 1024 example: 1-ORACLE_INSTALL-2 OracleStagingPushDSourceLinkSourceParameters: required: - engine_id - database_name allOf: - $ref: '#/components/schemas/BaseDSourceLinkSourceParameters' - type: object properties: engine_id: description: The ID of the engine to link staging push database on. type: string minLength: 1 maxLength: 256 container_type: description: The container type of this database.If not provided the request would be considered as a PDB database. type: string enum: - ROOT_CDB - NON_CDB environment_user_id: description: Id of the environment user to use for linking. type: string minLength: 1 maxLength: 256 repository: description: The repository reference to link. type: string minLength: 1 maxLength: 1024 database_name: description: The name of the database. type: string minLength: 1 maxLength: 1024 database_unique_name: description: The unique name of the database. type: string minLength: 1 maxLength: 1024 sid: description: The name (sid) of the instance. type: string minLength: 1 maxLength: 1024 mount_base: description: The base mount point to use for the NFS mounts. type: string minLength: 1 maxLength: 1024 custom_env_variables_pairs: description: An array of name value pair of environment variables. type: array items: $ref: '#/components/schemas/NameValuePair' custom_env_variables_paths: description: An array of strings 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. type: array items: type: string auto_staging_restart: deprecated: true description: Boolean value indicates whether this staging database should automatically be restarted when staging host reboot is detected. type: boolean default: false allow_auto_staging_restart_on_host_reboot: description: Boolean value indicates whether this staging database should automatically be restarted when staging host reboot is detected. type: boolean physical_standby: description: Boolean value indicates whether this staging database will be configured as a physical standby. type: boolean default: false validate_snapshot_in_readonly: deprecated: true description: Boolean value indicates whether this staging database snapshot will be validated by opening it in read-only. type: boolean default: false validate_by_opening_db_in_read_only_mode: description: Boolean value indicates whether this staging database snapshot will be validated by opening it in read-only. type: boolean staging_database_templates: deprecated: true description: An array of name value pair of Oracle database configuration parameter overrides. This property is deprecated. Use staging_database_config_params instead. type: array items: $ref: '#/components/schemas/NameValuePair' staging_database_config_params: description: Oracle database configuration parameter overrides. If both staging_database_templates and staging_database_config_params are specified, staging_database_config_params will be used. type: object nullable: true example: processes: '150' additionalProperties: type: string staging_container_database_reference: description: Reference of the CDB source config. type: string minLength: 1 maxLength: 1024 ops_pre_log_sync: description: Operations to perform after syncing a created dSource and before running the LogSync. type: array items: $ref: '#/components/schemas/SourceOperation' tde_keystore_config_type: description: The TDE keystore configuration type of this database. $ref: '#/components/schemas/OracleTdeKeystoreConfigTypeEnum' example: OKV template_id: type: string description: The template ID of the target Oracle Staging Push dSource. minLength: 1 maxLength: 256 example: 70096a7-6655-4973-8464-682c41c932da MSSQLListenerTypeEnum: type: string enum: - MSSqlAvailabilityGroupListener - MSSqlFailoverClusterListener example: MSSqlAvailabilityGroupListener OracleListenerTypeEnum: type: string enum: - NODE - SCAN example: NODE TimeflowPoint: type: object description: A unique point within an Oracle database TimeFlow. properties: timestamp: type: string format: date-time description: The timestamp of the timeflow point. location: type: string description: The timeflow point location. timeflow: type: string description: Id of the timeflow. 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 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 DisableDsourceParameters: type: object properties: attempt_cleanup: description: Whether to attempt a cleanup of the database from the environment before the disable. type: boolean default: true 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" LinkDSourceResponse: properties: job: $ref: '#/components/schemas/Job' description: The initiated job. dsource_id: type: string description: The ID of the dSource. DSourceHooks: description: DSource operation hooks. type: object properties: ops_pre_sync: type: array maxItems: 100 description: The commands to execute before syncing with external data. items: $ref: '#/components/schemas/Hook' ops_pre_log_sync: type: array maxItems: 100 description: The commands to execute after syncing with external data and before running the LogSync. items: $ref: '#/components/schemas/Hook' ops_post_sync: type: array maxItems: 100 description: The commands to execute after syncing a linked source. items: $ref: '#/components/schemas/Hook' pre_validated_sync: type: array maxItems: 100 description: The commands to execute on the staging source before performing a validated sync. items: $ref: '#/components/schemas/Hook' post_validated_sync: type: array maxItems: 100 description: The commands to execute on the staging source after performing a validated sync. items: $ref: '#/components/schemas/Hook' 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 MSSQLDSourceStagingPushAttachSourceParameters: type: object required: - staging_database_name - ppt_repository properties: encryption_key: description: The encryption key to use when restoring encrypted backups. type: string ppt_repository: description: Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. type: string minLength: 1 maxLength: 1024 ppt_host_user: description: Reference of the host OS user on the PPT host to use for linking. type: string minLength: 1 maxLength: 1024 staging_pre_script: description: A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 staging_post_script: description: A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 staging_database_name: description: The name of the database to create on the staging environment. This property is mutually exclusive to sync_strategy_managed_type type: string minLength: 1 maxLength: 1024 db_state: type: string enum: - RESTORING - ONLINE description: User provided db state that will be used to create staging push db. Default is RESTORING default: RESTORING ops_pre_sync: description: Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. type: array items: $ref: '#/components/schemas/SourceOperation' ops_post_sync: description: Operations to perform after syncing a created dSource. type: array items: $ref: '#/components/schemas/SourceOperation' BaseDSourceLinkSourceParameters: properties: name: description: Name of the dSource to be created. type: string minLength: 1 maxLength: 256 source_id: description: Id of the source to link. type: string minLength: 1 maxLength: 256 group_id: description: Id of the dataset group where this dSource should belong to. type: string minLength: 1 maxLength: 256 description: description: The notes/description for the dSource. type: string minLength: 1 maxLength: 1024 log_sync_enabled: description: True if LogSync should run for this database. type: boolean default: false sync_policy_id: type: string description: The ID of the SnapSync policy for the dSource. minLength: 1 maxLength: 256 example: snapshot-123 retention_policy_id: type: string description: The ID of the Retention policy for the dSource. minLength: 1 maxLength: 256 example: retention-policy-123 make_current_account_owner: type: boolean default: true description: Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. tags: type: array maxItems: 1000 description: The tags to be created for dSource. items: $ref: '#/components/schemas/Tag' minItems: 1 ops_pre_sync: description: Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. type: array items: $ref: '#/components/schemas/SourceOperation' ops_post_sync: description: Operations to perform after syncing a created dSource. type: array items: $ref: '#/components/schemas/SourceOperation' discriminator: propertyName: class_type 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' MSSQLDSourceAttachSourceParameters: type: object required: - source_id - ppt_repository properties: source_id: description: Id of the source to link. type: string minLength: 1 maxLength: 256 ppt_repository: description: Id of the SQL instance on the PPT environment that we want to use for pre-provisioning. type: string minLength: 1 maxLength: 1024 sync_strategy_managed_type: type: string enum: - external - delphix default: external description: 'MSSQL specific parameters for source based sync strategy.: * `external` - MSSQL specific parameters for externally managed source based sync strategy. * `delphix` - MSSQL specific parameters for delphix managed source based sync strategy. ' mssql_user_environment_reference: description: Reference to the source environment user to use for linking. type: string minLength: 1 maxLength: 1024 mssql_user_domain_username: description: The username for the source DB user. type: string minLength: 1 maxLength: 1024 mssql_user_domain_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 mssql_user_domain_vault_username: type: string description: Delphix display name for the vault user. minLength: 1 maxLength: 256 example: my-vault mssql_user_domain_vault: type: string description: The name or reference of the vault from which to read the database credentials. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_engine: type: string description: Vault engine name where the credential is stored. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_secret_path: type: string description: Path in the vault engine where the credential is stored. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_username_key: type: string description: Hashicorp vault key for the username in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_hashicorp_vault_secret_key: type: string description: Hashicorp vault key for the password in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_name: type: string description: Azure key vault name. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_username_key: type: string description: Azure vault key for the username in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_azure_vault_secret_key: type: string description: Azure vault key for the password in the key-value store. minLength: 1 maxLength: 256 mssql_user_domain_cyberark_vault_query_string: type: string description: Query to find a credential in the CyberArk vault. minLength: 1 maxLength: 256 mssql_database_username: description: The username for the source DB user. type: string minLength: 1 maxLength: 1024 mssql_database_password: x-dct-toolkit-credential-field: true type: string description: Password for the database user. minLength: 1 maxLength: 256 delphix_managed_backup_compression_enabled: type: boolean description: Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected. default: false delphix_managed_backup_policy: type: string enum: - primary - secondary_only - prefer_secondary description: 'Specify which node of an availability group to run the copy-only full backup on: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. ' default: primary external_managed_validate_sync_mode: type: string enum: - TRANSACTION_LOG - FULL_OR_DIFFERENTIAL - FULL - NONE description: Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database default: TRANSACTION_LOG external_managed_shared_backup_locations: type: array description: Shared source database backup locations. items: type: string minLength: 1 maxLength: 4096 maxItems: 260 external_netbackup_config_master_name: type: string description: The master server name of this NetBackup configuration. minLength: 1 maxLength: 256 external_netbackup_config_source_client_name: type: string description: The source's client server name of this NetBackup configuration. minLength: 1 maxLength: 256 external_netbackup_config_params: description: NetBackup configuration parameter overrides. type: object additionalProperties: true external_netbackup_config_templates: type: string description: Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored. external_commserve_host_name: type: string description: The commserve host name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_source_client_name: type: string description: The source client name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_staging_client_name: type: string description: The staging client name of this Commvault configuration. minLength: 1 maxLength: 256 external_commvault_config_params: description: Commvault configuration parameter overrides. type: object additionalProperties: true external_commvault_config_templates: type: string description: Optional config template selection for Commvault configurations. If set, configParams will be ignored. encryption_key: description: The encryption key to use when restoring encrypted backups. type: string source_host_user: description: ID or user reference of the host OS user to use for linking. type: string minLength: 1 maxLength: 1024 ppt_host_user: description: Reference of the host OS user on the PPT host to use for linking. type: string minLength: 1 maxLength: 1024 staging_pre_script: description: A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 staging_post_script: description: A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. type: string minLength: 1 maxLength: 1024 ops_pre_sync: description: Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. type: array items: $ref: '#/components/schemas/SourceOperation' ops_post_sync: description: Operations to perform after syncing a created dSource. type: array items: $ref: '#/components/schemas/SourceOperation' 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 OracleAttachDSourceBody: description: The parameters to attach an Oracle dSource. required: true content: application/json: schema: x-body-name: OracleAttachDSourceParameters $ref: '#/components/schemas/OracleAttachDSourceParameters' MSSQLLinkDSourceBody: description: The parameters to link an MSSql dSource. required: true content: application/json: schema: x-body-name: linkMSSqlDSource $ref: '#/components/schemas/MSSQLDSourceLinkSourceParameters' examples: mssql_dsource_minimum_request: description: The above request example is intended for an MSSql Database linking without including optional properties summary: Minimal Request (Without Optionals) value: source_id: 1-SOURCE_CONFIG-1 ppt_repository: MSSQL_INSTANCE-1 ppt_host_user: HOST_USER-1 mssql_user_environment_reference: HOST_USER-1 mssql_dsource_full_request: description: The above request example is intended for an MSSql Database linking with all possible parameters. summary: Full Request value: name: DSOURCE-EXAMPLE-1 source_id: 1-SOURCE_CONFIG-1 group_id: 1-GROUP-1 encryption_key: KEY-1 sync_strategy: latest_backup mssql_backup_uuid: UUID-1 compression_enabled: false source_host_user: SOURCE_HOST_USER-1 ppt_repository: PPT_REPOSITORY-1 ppt_host_user: PPT_HOST_USER-1 staging_pre_script: staging_pre_script staging_post_script: staging_post_script sync_strategy_managed_type: external mssql_user_environment_reference: ENVIRONMENT-USER-1 mssql_user_domain_username: DOMAIN-USER-1 mssql_user_domain_password: DOMAIN-PASSWORD-1 mssql_user_domain_vault: DOMAIN-VAULT-1 mssql_user_domain_hashicorp_vault_engine: kv mssql_user_domain_hashicorp_vault_secret_path: mssql-env mssql_user_domain_hashicorp_vault_username_key: username mssql_user_domain_hashicorp_vault_secret_key: secret mssql_user_domain_azure_vault_name: azure_vault mssql_user_domain_azure_vault_username_key: username mssql_user_domain_azure_vault_secret_key: secret mssql_user_domain_cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test mssql_database_username: db-user mssql_database_password: password delphix_managed_backup_compression_enabled: false delphix_managed_backup_policy: primary external_managed_validate_sync_mode: TRANSACTION_LOG external_managed_shared_backup_locations: - shared_backup_location/location1 - shared_backup_location/location2 external_netbackup_config_master_name: master_name-1 external_netbackup_config_source_client_name: netbackup_config_source_client_name-1 external_netbackup_config_params: netbackup_config_params-1 external_netbackup_config_templates: external_netbackup_config_template-1 external_commserve_host_name: commserve_host_name-1 external_commvault_config_source_client_name: commvault_config_source_client_name-1 external_commvault_config_staging_client_name: commvault_config_staging_client_name-1 external_commvault_config_params: commvault_config_params-1 external_commvault_config_templates: commvault_config_template-1 tags: - key: key-1 value: value-1 ops_pre_sync: - name: pre-sync-op1 command: echo 'pre-sync' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post-sync-op command: echo 'post-sync-op' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test OracleLinkDSourceBody: description: The parameters to link an Oracle dSource. content: application/json: schema: x-body-name: linkOracleDSource $ref: '#/components/schemas/OracleDSourceLinkSourceParameters' examples: oracle_dsource_minimum_request: description: The above request example is intended for Oracle Database without including optional properties summary: Minimal Request (Without Optionals) value: source_id: 1-SOURCE_CONFIG-1 oracle_single_tenant_dsource_request: description: 'The above request example is intended for Oracle Database with all possible properties that can be set in request body. ' summary: Full Request value: name: DSOURCE-EXAMPLE-1 source_id: 1-SOURCE_CONFIG-1 group_id: 1-GROUP-1 environment_user_id: USER-1 description: Some description for dSource non_sys_username: non-sys-user (Single tenant only) non_sys_password: non-sys-password (Single tenant only) non_sys_vault: vault_name_or_reference (Single tenant only) non_sys_hashicorp_vault_engine: kv (Single tenant only) non_sys_hashicorp_vault_secret_path: oracle-env (Single tenant only) non_sys_hashicorp_vault_username_key: username (Single tenant only) non_sys_hashicorp_vault_secret_key: secret (Single tenant only) non_sys_azure_vault_name: azure_vault (Single tenant only) non_sys_azure_vault_username_key: username (Single tenant only) non_sys_azure_vault_secret_key: secret (Single tenant only) non_sys_cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test (Single tenant only) fallback_username: oracle-user fallback_password: oracle-password fallback_vault: my-vault fallback_hashicorp_vault_engine: kv fallback_hashicorp_vault_secret_path: oracle-env fallback_hashicorp_vault_username_key: username fallback_hashicorp_vault_secret_key: secret fallback_azure_vault_name: azure_vault fallback_azure_vault_username_key: username fallback_azure_vault_secret_key: secret fallback_cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test backup_level_enabled: true rman_channels: 2 files_per_set: 5 check_logical: false encrypted_linking_enabled: false compressed_linking_enabled: true bandwidth_limit: 0 number_of_connections: 1 diagnose_no_logging_faults: true pre_provisioning_enabled: false link_now: false force_full_backup: false double_sync: false rman_rate_in_MB: 0 skip_space_check: false do_not_resume: false files_for_full_backup: - 0 log_sync_mode: UNDEFINED log_sync_interval: 5 log_sync_enabled: false external_file_path: /user/file/path make_current_account_owner: true tags: - key: key-1 value: value-1 ops_pre_sync: - name: pre_sync_logs command: echo 'pre_sync_logs' shell: bash credentials_env_vars: - base_var_name: env_var_1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_pre_log_sync: - name: pre_log_sync_logs command: echo 'pre_log_sync_logs' shell: bash credentials_env_vars: - base_var_name: env_var_1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post_sync_hook command: echo 'post_sync_hook' shell: bash credentials_env_vars: - base_var_name: env1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test required: true 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') MSSQLAttachDsourceBody: description: The parameters to attach a MSSql dSource. content: application/json: schema: $ref: '#/components/schemas/MSSQLDSourceAttachSourceParameters' examples: mssql_attach_dsource_minimum_request: description: The above request example is intended for an MSSql Database attach operation without including optional properties summary: Minimal Request (Without Optionals) value: source_id: SOURCE_CONFIG-1 ppt_repository: MSSQL_INSTANCE-1 mssql_user_environment_reference: HOST_USER-1 mssql_attach_dsource_full_request: description: The above request example is intended for an MSSql Database attach operation with all possible parameters. summary: Full Request value: source_id: SOURCE_CONFIG-1 encryption_key: KEY-1 source_host_user: SOURCE_HOST_USER-1 ppt_repository: PPT_REPOSITORY-1 ppt_host_user: PPT_HOST_USER-1 staging_pre_script: staging_pre_script staging_post_script: staging_post_script sync_strategy_managed_type: external mssql_user_environment_reference: ENVIRONMENT-USER-1 mssql_user_domain_username: DOMAIN-USER-1 mssql_user_domain_password: DOMAIN-PASSWORD-1 mssql_user_domain_vault: DOMAIN-VAULT-1 mssql_user_domain_hashicorp_vault_engine: kv mssql_user_domain_hashicorp_vault_secret_path: mssql-env mssql_user_domain_hashicorp_vault_username_key: username mssql_user_domain_hashicorp_vault_secret_key: secret mssql_user_domain_azure_vault_name: azure_vault mssql_user_domain_azure_vault_username_key: username mssql_user_domain_azure_vault_secret_key: secret mssql_user_domain_cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test mssql_database_username: db-user mssql_database_password: password delphix_managed_backup_compression_enabled: false delphix_managed_backup_policy: primary external_managed_validate_sync_mode: TRANSACTION_LOG external_managed_shared_backup_locations: - shared_backup_location/location1 - shared_backup_location/location2 external_netbackup_config_master_name: master_name-1 external_netbackup_config_source_client_name: netbackup_config_source_client_name-1 external_netbackup_config_params: netbackup_config_params-1 external_netbackup_config_templates: external_netbackup_config_template-1 external_commserve_host_name: commserve_host_name-1 external_commvault_config_source_client_name: commvault_config_source_client_name-1 external_commvault_config_staging_client_name: commvault_config_staging_client_name-1 external_commvault_config_params: commvault_config_params-1 external_commvault_config_templates: commvault_config_template-1 ops_pre_sync: - name: pre-sync-op1 command: echo 'pre-sync' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: mssql-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post-sync-op command: echo 'post-sync-op' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: mssql-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test OracleLinkStagingPushDSourceBody: description: The parameters to link an Oracle dSource. content: application/json: schema: x-body-name: linkOracleStagingPushDSource $ref: '#/components/schemas/OracleStagingPushDSourceLinkSourceParameters' examples: oracle_dsource_staging_push_non_pdb_minimum_request: description: The above request example is intended for an Oracle staging push non PDB Database linking without including optional properties summary: Minimal Request Non PDB(Without Optionals) value: name: DSOURCE-1 engine_id: 1 container_type: NON_CDB environment_user_id: HOST_USER-1 repository: ORACLE_REPO-1 database_name: DB_NAME-1 database_unique_name: DB_UN_NAME-1 sid: SID-1 mount_base: /mount1 oracle_dsource_staging_push_non_pdb_full_request: description: The above request example is intended for a non pdb Oracle staging push Database linking with all optional properties summary: Full Request Non PDB value: name: DSOURCE-1 engine_id: 1 group_id: 1-GROUP-1 description: Some description for dSource log_sync_enabled: false make_current_account_owner: true container_type: NON_CDB environment_user_id: HOST_USER-1 repository: ORACLE_REPO-1 database_name: DB_NAME-1 database_unique_name: DB_UN_NAME-1 sid: SID-1 mount_base: /mount1 template_id: 70096a7-6655-4973-8464-682c41c932da custom_env_variables_pairs: - var_name: env_var-1 var_value: env_value-1 custom_env_variables_paths: - /root/path1 propety1 allow_auto_staging_restart_on_host_reboot: false physical_standby: false validate_by_opening_db_in_read_only_mode: false tags: - key: key-1 value: value-1 ops_pre_sync: - name: pre_sync_logs command: echo 'pre_sync_logs' shell: bash credentials_env_vars: - base_var_name: env_var_1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post_sync_hook command: echo 'post_sync_hook' shell: bash credentials_env_vars: - base_var_name: env1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test oracle_dsource_staging_push_pdb_minimum_request: description: The above request example is intended for an Oracle staging push non PDB Database linking without including optional properties summary: Minimal Request PDB(Without Optionals) value: name: DSOURCE-1 engine_id: 1 database_name: DB_NAME-1 staging_container_database_reference: CDB-1 oracle_dsource_staging_push_pdb_full_request: description: The above request example is intended for a pdb Oracle staging push Database linking with all optional properties summary: Full Request PDB value: name: DSOURCE-1 engine_id: 1 group_id: 1-GROUP-1 description: Some description for dSource log_sync_enabled: false make_current_account_owner: true database_name: PDB_NAME-1 staging_container_database_reference: CDB_1 custom_env_variables_pairs: - var_name: env_var-1 var_value: env_value-1 custom_env_variables_paths: _ /root/path1 propety1 allow_auto_staging_restart_on_host_reboot: false tags: - key: key-1 value: value-1 ops_pre_sync: - name: pre_sync_logs command: echo 'pre_sync_logs' shell: bash credentials_env_vars: - base_var_name: env_var_1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post_sync_hook command: echo 'post_sync_hook' shell: bash credentials_env_vars: - base_var_name: env1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test required: true ASELinkDSourceBody: description: The parameters to link an ASE dSource. required: true content: application/json: schema: x-body-name: linkASEDSource $ref: '#/components/schemas/ASEDSourceLinkSourceParameters' examples: ase_dsource_minimum_request: description: The above request example is intended for an ASE Database without including optional properties summary: Minimal Request (Without Optionals) value: source_id: ASE_CONFIG-1 db_user: db-user db_password: secret-password load_backup_path: /backup/path ase_dsource_full_request: description: The above request example is intended for an ASE Database linking with all possible parameters. summary: Full Request value: name: ASE-DSOURCE-NAME source_id: ASE_CONFIG-1 group_id: GROUP-1 description: This is a test description for ASE database log_sync_enabled: false external_file_path: /some/external/path make_current_account_owner: true mount_base: /mount/base load_backup_path: /backup/path backup_server_name: backup-server-name backup_host_user: USER-1 backup_host: host.backup.com dump_credentials: secret source_host_user: source-user db_user: db-user db_password: secret-password db_vault: vault-name db_hashicorp_vault_engine: kv db_hashicorp_vault_secret_path: oracle-env db_hashicorp_vault_username_key: username db_hashicorp_vault_secret_key: secret db_azure_vault_name: azure_vault db_azure_vault_username_key: username db_azure_vault_secret_key: secret db_cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test staging_repository: ASE_INSTANCE-1 staging_host_user: USER-2 validated_sync_mode: ENABLED dump_history_file_enabled: false drop_and_recreate_devices: false sync_strategy: specific_backup ase_backup_files: - backup/file/1 - backup/file/2 tags: - key: key-1 value: value-1 ops_pre_sync: - name: pre-sync-op1 command: echo 'pre-sync' shell: bash credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post-sync-op command: echo 'post-sync-op' shell: bash credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test pre_validated_sync: - name: pre-validate-sync command: echo 'pre-validate-sync' shell: bash credentials_env_vars: - base_var_name: base-var password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test post_validated_sync: - name: post-validate-sync command: echo 'post-validate-sync' shell: bash credentials_env_vars: - base_var_name: base-post-sync password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test MSSQLAttachStagingPushDSourceBody: description: The parameters to attach an MSSql dSource. required: true content: application/json: schema: x-body-name: attachMSSqlStagingPushDSource $ref: '#/components/schemas/MSSQLDSourceStagingPushAttachSourceParameters' examples: mssql_dsource_staging_push_attach_minimum_request: description: The above request example is intended for an MSSql staging push Database attach operation without including optional properties summary: Minimal Request (Without Optionals) value: ppt_repository: PPT_REPOSITORY-1 staging_database_name: staging_database-1 mssql_dsource_staging_push_attach_full_request: description: The above request example is intended for an MSSql staging push Database linking with all optional properties summary: Full Request value: encryption_key: KEY-1 ppt_repository: PPT_REPOSITORY-1 ppt_host_user: PPT_HOST_USER-1 staging_pre_script: staging_pre_script staging_post_script: staging_post_script staging_database_name: staging_database-1 db_state: RESTORING tags: - key: key-1 value: value-1 ops_pre_sync: - name: pre-sync-op command: echo 'pre-sync' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post-sync-op command: echo 'post-sync-op' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ASEAttachDSourceBody: description: The parameters to attach an ASE dSource. required: true content: application/json: schema: $ref: '#/components/schemas/ASEDSourceAttachSourceParameters' examples: ase_attach_dsource_minimum_request: description: Minimal request for an ASE dSource attach operation. summary: Minimal Request (Without Optionals) value: source_id: SOURCE_CONFIG-1 source_host_user: HOST_USER-1 load_backup_path: /backup/path staging_repository: ASE_INSTANCE-1 staging_host_user: HOST_USER-2 ase_attach_dsource_full_request: description: Full request for an ASE dSource attach operation with all possible parameters. summary: Full Request value: source_id: SOURCE_CONFIG-1 source_host_user: HOST_USER-1 external_file_path: /external/path mount_base: /mnt/provision dump_credentials: dump-password db_username: db-username db_password: db-password load_backup_path: /backup/path staging_repository: ASE_INSTANCE-1 staging_host_user: HOST_USER-2 validated_sync_mode: ENABLED dump_history_file_enabled: false backup_server_name: remote_server_name backup_host: 1-UNIX_HOST_ENVIRONMENT-2 backup_host_user: HOST_USER-2 MSSQLLinkStagingPushDSourceBody: description: The parameters to link an MSSql dSource. required: true content: application/json: schema: x-body-name: linkMSSqlStagingPushDSource $ref: '#/components/schemas/MSSQLDSourceStagingPushLinkSourceParameters' examples: mssql_dsource_staging_push_minimum_request: description: The above request example is intended for an MSSql staging push Database linking without including optional properties summary: Minimal Request (Without Optionals) value: name: DSOURCE-1 engine_id: 1 ppt_repository: PPT_REPOSITORY-1 ppt_host_user: PPT_HOST_USER-1 staging_database_name: staging_database-1 mssql_dsource_staging_push_full_request: description: The above request example is intended for an MSSql staging push Database linking with all optional properties summary: Full Request value: name: DSOURCE-1 group_id: 1-GROUP-1 description: MSSQL DSource description log_sync_enabled: false make_current_account_owner: true engine_id: 1 encryption_key: KEY-1 ppt_repository: PPT_REPOSITORY-1 ppt_host_user: PPT_HOST_USER-1 staging_pre_script: staging_pre_script staging_post_script: staging_post_script staging_database_name: staging_database-1 db_state: RESTORING tags: - key: key-1 value: value-1 ops_pre_sync: - name: pre-sync-op command: echo 'pre-sync' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test ops_post_sync: - name: post-sync-op command: echo 'post-sync-op' shell: ps credentials_env_vars: - base_var_name: base-var-1 password: password vault: my-vault hashicorp_vault_engine: kv hashicorp_vault_secret_path: oracle-env hashicorp_vault_username_key: username hashicorp_vault_secret_key: secret azure_vault_name: azure_vault azure_vault_username_key: username azure_vault_secret_key: secret cyberark_vault_query_string: Safe=Test;Folder=Test;Object=Test DisableDsourceBody: description: The parameters to disable a dSource. content: application/json: schema: $ref: '#/components/schemas/DisableDsourceParameters' AppDataDSourceBody: description: The parameters to link an AppData dSource. required: true content: application/json: schema: x-body-name: linkASEDSource $ref: '#/components/schemas/AppDataDSourceLinkSourceParameters' examples: appdata_dsource_minimum_request: description: The above request example is intended for a Postgres AppData linking summary: Minimal Request (Postgres) value: source_id: 1-APPDATA_STAGED_SOURCE_CONFIG-1 group_id: 1-GROUP-1 link_type: AppDataStaged staging_environment: 1-ENVIRONMENT-1 staging_mount_base: /mnt/staging environment_user: 1-ENVIRONMENT_USER-1 parameters: postgresPort: 5432, sync_parameters: resync: true EnableDsourceBody: description: The parameters to enable a dSource. content: application/json: schema: $ref: '#/components/schemas/EnableDsourceParameters' 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 dsourceIdParam: in: path name: dsourceId schema: type: string minLength: 1 required: true description: The ID of the dSource. 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 dsourcesSortParam: 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 - content_type - -content_type - database_type - -database_type - name - -name - database_version - -database_version - data_uuid - -data_uuid - storage_size - -storage_size - plugin_version - -plugin_version - creation_date - -creation_date - group_name - -group_name - enabled - -enabled - engine_id - -engine_id - source_id - -source_id - staging_source_id - -staging_source_id - status - -status - engine_name - -engine_name - primary_object_id - -primary_object_id - primary_engine_id - -primary_engine_id - primary_engine_name - -primary_engine_name - sync_policy_id - -sync_policy_id - retention_policy_id - -retention_policy_id - replica_retention_policy_id - -replica_retention_policy_id - quota_policy_id - -quota_policy_id - logsync_enabled - -logsync_enabled - logsync_mode - -logsync_mode - logsync_interval - -logsync_interval - exported_data_directory - -exported_data_directory - template_id - -template_id - allow_auto_staging_restart_on_host_reboot - -allow_auto_staging_restart_on_host_reboot - physical_standby - -physical_standby - validate_by_opening_db_in_read_only_mode - -validate_by_opening_db_in_read_only_mode - mssql_sync_strategy_managed_type - -mssql_sync_strategy_managed_type - validated_sync_mode - -validated_sync_mode - backup_policy - -backup_policy - compression_enabled - -compression_enabled - staging_database_name - -staging_database_name - db_state - -db_state - external_netbackup_config_master_name - -external_netbackup_config_master_name - external_netbackup_config_source_client_name - -external_netbackup_config_source_client_name - external_netbackup_config_templates - -external_netbackup_config_templates - external_commserve_host_name - -external_commserve_host_name - external_commvault_config_source_client_name - -external_commvault_config_source_client_name - external_commvault_config_staging_client_name - -external_commvault_config_staging_client_name - external_commvault_config_templates - -external_commvault_config_templates - mssql_user_type - -mssql_user_type - domain_user_credential_type - -domain_user_credential_type - mssql_database_username - -mssql_database_username - mssql_user_environment_reference - -mssql_user_environment_reference - mssql_user_domain_username - -mssql_user_domain_username - mssql_user_domain_vault_username - -mssql_user_domain_vault_username - mssql_user_domain_vault - -mssql_user_domain_vault - mssql_user_domain_hashicorp_vault_engine - -mssql_user_domain_hashicorp_vault_engine - mssql_user_domain_hashicorp_vault_secret_path - -mssql_user_domain_hashicorp_vault_secret_path - mssql_user_domain_hashicorp_vault_username_key - -mssql_user_domain_hashicorp_vault_username_key - mssql_user_domain_hashicorp_vault_secret_key - -mssql_user_domain_hashicorp_vault_secret_key - mssql_user_domain_azure_vault_name - -mssql_user_domain_azure_vault_name - mssql_user_domain_azure_vault_username_key - -mssql_user_domain_azure_vault_username_key - mssql_user_domain_azure_vault_secret_key - -mssql_user_domain_azure_vault_secret_key - mssql_user_domain_cyberark_vault_query_string - -mssql_user_domain_cyberark_vault_query_string - diagnose_no_logging_faults - -diagnose_no_logging_faults - pre_provisioning_enabled - -pre_provisioning_enabled - backup_level_enabled - -backup_level_enabled - rman_channels - -rman_channels - files_per_set - -files_per_set - check_logical - -check_logical - encrypted_linking_enabled - -encrypted_linking_enabled - compressed_linking_enabled - -compressed_linking_enabled - bandwidth_limit - -bandwidth_limit - number_of_connections - -number_of_connections - toolkit_id - -toolkit_id - description - -description - truncate_log_on_checkpoint - -truncate_log_on_checkpoint - durability_level - -durability_level nullable: true example: name 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