How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Delphix DSources API

The DSources API from Delphix — 45 operation(s) for dsources.

Delphix DSources API is one of 60 APIs that Delphix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DSources. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 47 operations across 45 paths, and defines 84 schemas. It is described by OpenAPI 3.0.0, at version 3.28.0.

Requests are made against a single base URL, /dct/v3.

47 operations 45 paths 84 schemas 6 GET4 PATCH37 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.28.0
Base URL
https://help-api.delphix.com/dct/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Delphix DSources API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 47

Across 45 paths, the API surfaces 47 operations — 6 GET, 4 PATCH, 37 POST. Each is listed below with its method, path, parameters, and response codes.

DSources 47
GET
/dsources
List all dSources.
get_dsources 4 params → 200
POST
/dsources/oracle
Link Oracle database as dSource.
link_oracle_database body → 200
POST
/dsources/oracle/defaults
Get defaults for dSource linking.
get_oracle_dsource_linking_defaults body → 200
POST
/dsources/oracle/{dsourceId}/detachSource
Detaches an Oracle source from an Oracle database.
detach_oracle_dsource 1 param → 200
POST
/dsources/oracle/{dsourceId}/attachSource
Attach an Oracle dSource to an Oracle database.
attach_oracle_dsource 1 param body → 200
POST
/dsources/oracle/staging-push
Link an Oracle staging push database as dSource.
link_oracle_staging_push_database body → 200
POST
/dsources/oracle/staging-push/defaults
Get defaults for a Oracle staging push dSource linking.
get_oracle_staging_push_dsource_linking_defaults body → 200
PATCH
/dsources/oracle/{dsourceId}
Update values of an Oracle dSource
update_oracle_dsource_by_id 1 param body → 200
POST
/dsources/oracle/{dsourceId}/upgradedeprecated
Upgrade the requested Oracle dSource installation and user.
upgrade_oracle_dsource 1 param body → 200
POST
/dsources/{dsourceId}/upgrade
Upgrade dSource
upgrade_dsource 1 param body → 200
POST
/dsources/ase
Link an ASE database as dSource.
link_ase_database body → 200
POST
/dsources/ase/defaults
Get defaults for an ASE dSource linking.
get_ase_dsource_linking_defaults body → 200
PATCH
/dsources/ase/{dsourceId}
Update values of an ASE dSource
update_ase_dsource_by_id 1 param body → 200
POST
/dsources/ase/{dsourceId}/attachSource
Attaches an ASE source to a previously detached ASE dSource.
attach_ase_dsource 1 param body → 200
POST
/dsources/ase/{dsourceId}/detachSource
Detaches an ASE source from an ASE database.
detach_ase_dsource 1 param → 200
POST
/dsources/appdata
Link an AppData database as dSource.
link_appdata_database body → 200
POST
/dsources/appdata/defaults
Get defaults for an AppData dSource linking.
get_appdata_dsource_linking_defaults body → 200
PATCH
/dsources/appdata/{dsourceId}
Update values of an AppData dSource
update_appdata_dsource_by_id 1 param body → 200
POST
/dsources/mssql
Link a MSSql database as dSource.
link_mssql_database body → 200
POST
/dsources/mssql/{dsourceId}/detachSource
Detaches a linked source from a MSSql database.
detach_mssql_database 1 param → 200
POST
/dsources/mssql/{dsourceId}/attachSource
Attaches a MSSql source to a previously detached dsource.
attach_mssql_database 1 param body → 200
POST
/dsources/mssql/staging-push/{dsourceId}/attachSource
Attaches a MSSql staging push database to a previously detached dsource.
attach_mssql_staging_push_database 1 param body → 200
POST
/dsources/mssql/defaults
Get defaults for a MSSql dSource linking.
get_mssql_dsource_linking_defaults body → 200
POST
/dsources/mssql/staging-push
Link a MSSql staging push database as dSource.
link_mssql_staging_push_database body → 200
POST
/dsources/mssql/staging-push/defaults
Get defaults for a MSSql staging push dSource linking.
get_mssql_staging_push_dsource_linking_defaults body → 200
POST
/dsources/delete
Delete the specified dSource.
delete_dsource body → 200
POST
/dsources/search
Search for dSources.
search_dsources 4 params body → 200
GET
/dsources/{dsourceId}
Get a dSource by ID.
get_dsource_by_id 1 param → 200
POST
/dsources/{dsourceId}/enable
Enable a dSource.
enable_dsource 1 param body → 200
POST
/dsources/{dsourceId}/disable
Disable a dSource.
disable_dsource 1 param body → 200
GET
/dsources/{dsourceId}/upgrade_compatible_repositories
Returns a list of compatible repositories for dSource upgrade.
get_upgrade_compatible_repo_for_dsource 1 param → 200
PATCH
/dsources/mssql/{dsourceId}
Update values of an MSSql dSource
update_mssql_dsource_by_id 1 param body → 200
GET
/dsources/{dsourceId}/snapshots
List Snapshots for a dSource.
get_dsource_snapshots 3 params → 200
POST
/dsources/{dsourceId}/snapshots
Snapshot a dSource.
snapshot_dsource 1 param body → 200
GET
/dsources/{dsourceId}/deletion-dependencies
Get deletion dependencies for a dSource.
get_dsource_deletion_dependencies 1 param → 200
POST
/dsources/{dsourceId}/tags
Create tags for a dSource.
create_tags_dsource 1 param body → 201
GET
/dsources/{dsourceId}/tags
Get tags for a dSource.
get_tags_dsource 1 param → 200
POST
/dsources/{dsourceId}/tags/delete
Delete tags for a dSource.
delete_tags_dsource 1 param body → 204
POST
/dsources/{dsourceId}/asm-export-by-snapshot
Export a dSource by a snapshot to an ASM file system
export_dsource_to_asm_by_snapshot 1 param body → 200
POST
/dsources/{dsourceId}/export-by-snapshot
Export a dSource using snapshot to a physical file system
export_dsource_by_snapshot 1 param body → 200
POST
/dsources/{dsourceId}/asm-export-by-location
Export a dSource using SCN to an ASM file system
export_dsource_to_asm_by_location 1 param body → 200
POST
/dsources/{dsourceId}/asm-export-from-bookmark
Export a dSource using bookmark to an ASM file system
export_dsource_to_asm_by_bookmark 1 param body → 200
POST
/dsources/{dsourceId}/export-from-bookmark
Export a dSource using bookmark to physical file system
export_dsource_from_bookmark 1 param body → 200
POST
/dsources/{dsourceId}/asm-export-by-timestamp
Export a dSource using timestamp to an ASM file system
export_dsource_to_asm_by_timestamp 1 param body → 200
POST
/dsources/{dsourceId}/export-by-timestamp
Export a dSource using timestamp to a physical file system.
export_dsource_by_timestamp 1 param body → 200
POST
/dsources/{dsourceId}/export-by-location
Export a dSource using timeflow location to a physical file system.
export_dsource_by_location 1 param body → 200
POST
/dsources/{dsourceId}/purge-logs
Purge logs of a dSource (Oracle only).
purge_logs_of_dsource 1 param body → 200

Schemas 84

The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are DSource (104 properties), UpdateMSSQLDsourceParameters (40 properties), MSSQLDSourceAttachSourceParameters (38 properties), Host (37 properties). Each schema is shown below with its type and property counts.

DeletionDependenciesResponse
object
The deletion dependencies of a dataset.
1 property
NameValuePair
object
2 properties 2 required
LinkStagingPushDSourceDefaultRequest
object
1 property 1 required
PaginatedResponseMetadata
object
3 properties
OracleRACDatabaseInstance
object
4 properties 3 required
LinkDSourceDefaultRequest
object
1 property 1 required
DbVaultCredentials
object
10 properties
OracleAsmExportByTimestampParameters
VirtualizationTask
object
8 properties
OracleDSourceLinkSourceParameters
1 required
UpdateAppDataDSourceParameters
object
Parameters to update a dSource.
13 properties
DSourceSnapshotParameters
object
Parameters to snapshot a DSource.
13 properties
UpgradeDatabaseParameters
object
Parameters to upgrade a dSource/VDB.
3 properties 1 required
UpdateAseDSourceParameters
Parameters to update a dSource.
CredentialsEnvVariable
object
15 properties 1 required
Tag
object
2 properties 2 required
MSSQLDSourceStagingPushLinkSourceParameters
5 required
VirtualizationTaskEvent
object
1 property
Environment
object
A grouping of a single host or a cluster of hosts.
30 properties
Engine
object
2 properties
MSSQLDSourceLinkSourceParameters
1 required
OracleAttachDSourceParameters
TagsRequest
object
1 property 1 required
SourceOperation
object
5 properties
EnableDsourceParameters
object
The parameters to enable a dSource.
1 property
ASEDSourceAttachSourceParameters
5 required
Replica
object
4 properties
ListSnapshotsResponse
object
2 properties
BaseExportTransferStrategyParameters
object
2 properties
OracleAsmExportBySnapshotParameters
PurgeLogsParameters
object
3 properties 1 required
UpgradeOracleDatabaseParameters
object
Parameters to upgrade an Oracle dataset.
2 properties 2 required
Hook
object
7 properties
DeleteDSourceResponse
EngineStorageCapacityDependencyData
Engine storage capacity dependency data.
OracleAsmExportFromBookmarkParameters
Host
object
A physical/virtual server.
37 properties
AppDataDSourceLinkSourceParameters
3 required
OracleLogsyncModeTypeEnum
string
LogSync operation mode for this dSource.
EnvironmentUser
object
14 properties
PurgeLogsResponse
object
2 properties
EngineStorageDatasetType
string
Type of the dataset.
ExportByLocationParameters
ExportBySnapshotParameters
MSSQLClusterListener
object
4 properties
UpdateMSSQLDsourceParameters
object
Parameters to update a MSSql dSource.
40 properties
FilesystemLayoutParameters
object
8 properties
DeleteTag
object
3 properties
ASEDSourceLinkSourceParameters
2 required
JobTask
object
8 properties
OracleListener
object
7 properties
Error
object
2 properties
OracleLinkStagingPushDSourceDefaultRequest
object
2 properties 1 required
OracleAsmExportByLocationParameters
ExportByTimestampParameters
ExportDBTimeflowPointParameters
object
31 properties
EngineStorageCapacityData
object
19 properties
OracleTdeKeystoreConfigTypeEnum
string
Oracle TDE keystore configuration type.
DeleteDSourceRequest
object
5 properties 1 required
DSource
object
The Delphix storage-based copy of the source database including its history.
104 properties
TagsResponse
object
1 property
OracleClusterNodeInstance
object
An oracle cluster node instance.
3 properties
OracleAttachParameters
object
16 properties
UpdateOracleDsourceParameters
object
Parameters to update a dSource.
32 properties
OracleStagingPushDSourceLinkSourceParameters
2 required
MSSQLListenerTypeEnum
string
OracleListenerTypeEnum
string
TimeflowPoint
object
A unique point within an Oracle database TimeFlow.
3 properties
OracleAsmLayoutParameters
object
2 properties 1 required
OracleVirtualIP
object
A virtual IP address.
3 properties
JobTaskEvent
object
1 property
DisableDsourceParameters
object
1 property
Errors
array
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 p…
SearchBody
object
Search body.
1 property
LinkDSourceResponse
object
2 properties
DSourceHooks
object
DSource operation hooks.
5 properties
Repository
object
35 properties
MSSQLDSourceStagingPushAttachSourceParameters
object
9 properties 2 required
BaseDSourceLinkSourceParameters
object
11 properties
Snapshot
object
Virtualization Engine Snapshot of a dSource or VDB.
36 properties
MSSQLDSourceAttachSourceParameters
object
38 properties 2 required
ExportFromBookmarkParameters
Job
object
An asynchronous task.
25 properties
PermissionEnum
string
Type of the permission on DCT object.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

delphix-dsources-api-openapi.yml Raw ↑

Other APIs Delphix publishes across the network.

Delphix Algorithms API
Delphix Bookmarks API
Delphix CDB DSources API
Delphix CDBs API
Delphix Classifiers API
Delphix CloudAccounts API
Delphix ComplianceJobCollections API
Delphix ComplianceJobs API
Delphix ComplianceNodes API
Delphix Connectivity API
Delphix Connectors API
Delphix DatabaseTemplates API
Where this information came from

This is an independent, third-party profile of Delphix DSources API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.