The DSources API from Delphix — 45 operation(s) for dsources.
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:
# --- truncated at 32 KB (266 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-dsources-api-openapi.yml