- Connectivity
- postChecks connectivity between an engine and a remote host machine on a given port.
- postTests the validity of the supplied database credentials, returning an error if unable to connect to the database.
- postChecks whether the specified NetBackup master server and client are able to communicate on the given environment.
- postTests whether the CommServe host is accessible from the given environment and Commvault agent.
- DataLayouts
- getList all data-layout (Self-Service Container/Template).
- postSearch for data-layouts.
- getGet a data-layout by ID.
- getGet tags for a data-layout.
- postCreate tags for a data-layout.
- postDelete tags for a data-layout.
- postConvert and drop engine bookmarks and vdb groups for the data-layout.
- postImport engine (self-service) accounts.
- Bookmarks
- getList all bookmarks.
- postCreate a bookmark at the current time.
- postSearch for bookmarks.
- getGet a bookmark by ID.
- delDelete a bookmark.
- patchUpdate a bookmark
- getList VDB Groups compatible with this bookmark.
- postSearch for VDB Groups compatible with this bookmark.
- getGet tags for a Bookmark.
- postCreate tags for a Bookmark.
- postDelete tags for a Bookmark.
- postImport engine bookmarks to DCT.
- Sources
- getList all sources.
- postCreate an Oracle Source.
- patchUpdate an Oracle source by ID.
- postVerify JDBC connection string for a source.
- postCreate a PostgreSQL source.
- postCreate an AppData source.
- patchUpdate a AppData source by ID.
- patchUpdate a PostgreSQL source by ID.
- postCreate an ASE source.
- patchUpdate an ASE source by ID.
- postSearch for Sources.
- getGet a source by ID.
- delDelete a source by ID.
- patchUpdate a Source.
- getGet tags for a Source.
- postCreate tags for a Source.
- getReturns a list of repositories that match the specified source.
- postDelete tags for a Source.
- StagingSources
- DSources
- getList all dSources.
- postLink Oracle database as dSource.
- postGet defaults for dSource linking.
- postDetaches an Oracle source from an Oracle database.
- postAttach an Oracle dSource to an Oracle database.
- postLink an Oracle staging push database as dSource.
- postGet defaults for a Oracle staging push dSource linking.
- patchUpdate values of an Oracle dSource
- postUpgrade the requested Oracle dSource installation and user.
- postUpgrade dSource
- postLink an ASE database as dSource.
- postGet defaults for an ASE dSource linking.
- patchUpdate values of an ASE dSource
- postLink an AppData database as dSource.
- postGet defaults for an AppData dSource linking.
- patchUpdate values of an AppData dSource
- postLink a MSSql database as dSource.
- postDetaches a linked source from a MSSql database.
- postAttaches a MSSql source to a previously detached dsource.
- postAttaches a MSSql staging push database to a previously detached dsource.
- postGet defaults for a MSSql dSource linking.
- postLink a MSSql staging push database as dSource.
- postGet defaults for a MSSql staging push dSource linking.
- postDelete the specified dSource.
- postSearch for dSources.
- getGet a dSource by ID.
- postEnable a dSource.
- postDisable a dSource.
- getReturns a list of compatible repositories for dSource upgrade.
- patchUpdate values of an MSSql dSource
- getList Snapshots for a dSource.
- postSnapshot a dSource.
- getGet deletion dependencies for a dSource.
- getGet tags for a dSource.
- postCreate tags for a dSource.
- postDelete tags for a dSource.
- postExport a dSource by a snapshot to an ASM file system
- postExport a dSource using snapshot to a physical file system
- postExport a dSource using SCN to an ASM file system
- postExport a dSource using bookmark to an ASM file system
- postExport a dSource using bookmark to physical file system
- postExport a dSource using timestamp to an ASM file system
- postExport a dSource using timestamp to a physical file system.
- postExport a dSource using timeflow location to a physical file system.
- KerberosConfig
- PasswordVaults
- Groups
- Toolkits
- VDBs
- getList all vdbs.
- postSearch for VDBs.
- getGet a VDB by ID.
- patchUpdate values of a VDB
- getList Snapshots for a VDB.
- postSnapshot a VDB.
- getList Bookmarks compatible with this VDB.
- postSearch Bookmarks compatible with this VDB.
- getGet deletion dependencies of a VDB.
- getGet tags for a VDB.
- postCreate tags for a VDB.
- postDelete tags for a VDB.
- postStart a VDB.
- postStop a VDB.
- postEnable a VDB.
- postDisable a VDB.
- postMigrate a VDB.
- getReturns a list of compatible repositories for vdb migration.
- postLock a VDB.
- postUnlock a VDB.
- postDelete a VDB.
- postRollback a VDB by timestamp.
- postRollback a VDB by snapshot.
- postRollback a VDB from a bookmark with only the same VDB.
- postRefresh a VDB by timestamp.
- postRefresh a VDB by snapshot.
- postRefresh a VDB from bookmark with a single VDB.
- postRefresh a VDB by location.
- postUndo the last refresh operation.
- postSwitches the current timeflow of a VDB.
- postUpgrade Oracle VDB
- postUpgrade VDB
- getReturns a list of compatible repositories for vdb upgrade.
- postVerify JDBC connection string for VDB.
- postProvision a new VDB by timestamp.
- postGet default provision parameters for provisioning a new VDB by timestamp.
- postProvision a new VDB by location.
- postGet default provision parameters for provisioning a new VDB by location.
- postProvision a new VDB by snapshot.
- postGet default provision parameters for provisioning a new VDB by snapshot.
- postProvision a new VDB from a bookmark with a single VDB.
- postGet default provision parameters for provisioning a new VDB from a bookmark.
- postProvision an empty VDB.
- postConvert a virtual database to a physical database on Oracle ASM file system.
- postConvert a virtual database to a physical database on physical file system.
- postExport a vdb using snapshot to an ASM file system
- postExport a vdb using SCN to an ASM file system
- postExport a vdb using timestamp to an ASM file system
- postExport a vdb using bookmark to physical file system
- postExport a vdb using bookmark to an ASM file system
- postExport a vdb using timestamp to a physical file system
- postExport a vdb using snapshot to a physical file system
- postExport a vdb using timeflow location to a physical file system
- VDBGroups
- getList all VDBGroups.
- postCreate a new VDB Group.
- postProvision a new VDB Group from a Bookmark.
- postSearch for VDB Groups.
- getGet a VDB Group by name.
- delDelete a VDBGoup.
- patchUpdate values of a VDB group.
- getGet latest snapshot of all the vdbs in VDB Group.
- postGet timestamp summary of all the vdbs in VDB Group.
- getGet tags for a VDB Group.
- postCreate tags for a VDB Group.
- postDelete tags for a VDB Group.
- postRefresh a VDB Group from bookmark.
- postRefresh a VDB Group from bookmark.
- postRefresh a VDB Group by snapshot.
- postRefresh a VDB Group by timestamp.
- postRollback a VDB Group from a bookmark.
- getList bookmarks compatible with this VDB Group.
- postSearch for bookmarks compatible with this VDB Group.
- postLock a VDB Group.
- postUnlock a VDB Group.
- postStart a VDB Group.
- postStop a VDB Group.
- postEnable a VDB Group.
- postDisable a VDB Group.
- Snapshots
- getRetrieve the list of snapshots.
- getGet a Snapshot by ID.
- delDelete a Snapshot.
- patchUpdate values of a Snapshot.
- postDelete a Snapshot.
- postUnset a Snapshot's expiration, removing expiration and retain_forever values for the snapshot.
- getGet tags for a Snapshot.
- postCreate tags for a Snapshot.
- postDelete tags for a Snapshot.
- postSearch snapshots.
- getGet the snapshots at this location for a dataset.
- getGet the snapshots at this timestamp for a dataset.
- getReturn the provisionable timeflow range based on a specific snapshot.
- getGet a runtime object of a snapshot by id
- getLists capacity metrics for all snapshots of dataset or the engine.
- getAPI to fetch the shared snapshot space.
- getGet deletion dependencies for a snapshot.
- Timeflows
- getRetrieve the list of timeflows.
- getGet a Timeflow by ID.
- delDelete a timeflow.
- patchUpdate values of a timeflow.
- getReturns the count of TimeFlow snapshots of the Timeflow aggregated by day.
- getGet tags for a Timeflow.
- postCreate tags for a Timeflow.
- postDelete tags for a Timeflow.
- postSearch timeflows.
- postRepair a Timeflow.
- Environments
- getList all environments.
- postCreate an environment.
- postGet compatible repositories corresponding to the snapshot.
- postGet compatible repositories corresponding to the timestamp.
- postGet compatible repositories corresponding to the bookmark.
- postGet compatible repositories corresponding to the location.
- delDelete a repository.
- patchUpdate a Repository.
- postCreate a repository.
- postCreate a new Host.
- delDelete a Host.
- patchUpdate a Host.
- getGet tags for an Environment.
- postCreate tags for an Environment.
- postDelete tags for an Environment.
- getReturns an environment by ID.
- delDelete an environment by ID.
- patchUpdate an environment by ID.
- postSearch for environments.
- postEnable a disabled environment.
- postDisable environment.
- postRefresh environment.
- getList environment users.
- postCreate environment user.
- putUpdate environment user.
- delDelete environment user.
- postSet primary environment user.
- postCreate Oracle listener.
- delDelete an Oracle listener.
- patchUpdate an Oracle listener.
- Management
- postValidate java path for the remote host machine.
- getReturns a list of registered engines.
- postRegister an engine.
- getReturns a registered engine by ID.
- putUpdate a registered engine.
- delUnregister an engine.
- patchUpdate a registered engine.
- getReturns the engine's auto tagging configuration.
- patchUpdate the engine's auto tagging configuration.
- getReturns a compliance engine's application settings.
- postSearch a compliance engine's application settings.
- postSearch for engines.
- getGet tags for a Engine.
- postCreate tags for an Engine.
- postDelete tags for an Engine.
- getReturns a list of configured Hashicorp vaults.
- postConfigure a new Hashicorp Vault
- postSearch for configured Hashicorp vaults.
- getGet a Hashicorp vault by id
- delDelete a Hashicorp vault by id
- getGet tags for a Hashicorp vault.
- postCreate tags for a Hashicorp vault.
- postDelete tags for a Hashicorp vault.
- getGet global properties.
- patchUpdate value of predefined properties.
- getGet api classification.
- putUpdate the api classification to new version.
- getReturns the SMTP configuration
- putUpdate SMTP Config.
- postValidate SMTP Config.
- getReturns configuration information about the metadata database which stores the product data.
- getReturns the LDAP configuration
- putUpdate LDAP Config.
- postValidate LDAP Config. Without username/password, DCT performs an anonymous bind against the LDAP server. If credentials are provided DCT validates that authentication and mapping of optional properties are actually working with provided credentials. LDAP search is only validated if search attributes are set.
- getReturns the SAML configuration
- putUpdate SAML Config.
- getReturns previous DCT Product Telemetry bundle upload events
- postTriggers a DCT Product Telemetry upload job immediately.
- getReturns the current web proxy configuration to use to connect to Delphix services.
- putUpdate the web proxy configuration to use to connect to Delphix services.
- getReturns True if Delphix services are reachable for product registration.
- getReturns the product registration status.
- getGenerates and returns a public key that can be used to register the product.
- postRegisters the product using a manually generated payload.
- postRegisters the product using the provided credentials.
- StorageUsage
- Reporting
- postSearch the saving storage summary report for virtualization engines.
- getGets the inventory report for virtualization engine VDBs.
- postSearch the inventory report for virtualization engine VDBs.
- getGets the usage report for virtualization engine dSources.
- postSearch the usage report for virtualization engine dSources.
- getGets the consumption report for virtualization engine dSources.
- postSearch the consumption report for virtualization engine DSources.
- getGet engine storage capacity data.
- postSearch engine storage capacity data.
- postSearch Dataset Performance analytics summary
- postGet Dataset Performance analytics
- getGets the audit log summary report.
- getGets the storage summary report for virtualization engines.
- postSearch the storage summary report for virtualization engines.
- getGets the report of API usage metrics over a given time period. This API returns at the most 10000 results in the response to protect against the server running out of memory. Users might not hit this limit with the default report without any 'apiUsageReportGroupByParam' param but can hit this limit if the groupBy is by too granular like by 'client_name' or 'user_agent' only. Hence it is advisable to use startDate and endDate to 'limit' the scope of the report.
- getList all report schedules.
- postCreate a new report schedule.
- postSearch for report schedules.
- getReturns a report schedule by ID.
- putUpdate a reporting schedule by ID.
- delDelete report schedule by ID.
- getGet tags for a report schedule.
- postCreate tags for a report schedule.
- postDelete tags for a report schedule.
- getGets the performance analytics report for engines.
- postSearch the performance analytic report for engines.
- postSearch the performance analytic trend data for engines.
- getReturns the DCT Product Information.
- DatabaseTemplates
- getRetrieve the list of database templates.
- postCreate a database template.
- getRetrieve a DatabaseTemplate by ID.
- delDelete a DatabaseTemplate by ID.
- patchUpdates a DatabaseTemplate by ID
- getGet tags for a DatabaseTemplate.
- postCreate tags for a DatabaseTemplate.
- postDelete tags for a DatabaseTemplate.
- postSearch DatabaseTemplates.
- postImports the database templates from an engine.
- postUndo an import of DatabaseTemplates on an Engine.
- CDBs
- getList all CDBs (Oracle only).
- postSearch for CDBs (Oracle only).
- getGet a CDB by ID (Oracle only).
- patchUpdate a CDB.
- patchUpdate a CDB.
- getGet tags for a CDB.
- postCreate tags for a CDB.
- postDelete tags for a CDB.
- postEnable a CDB.
- postDisable a CDB.
- getGet deletion dependencies of a CDB.
- postDelete a CDB.
- postUpgrade Oracle CDB
- postDetaches an Oracle CDB from an Oracle database.
- postAttach an Oracle CDB to an Oracle database.
- postVerify JDBC connection string for a CDB.
- StagingCdbs
- VCDBs
- getList all vCDBs (Oracle only).
- postSearch for vCDBs (Oracle only).
- getGet a CDB by ID (Oracle only).
- patchUpdate values of a VCDB
- getGet tags for a vCDB.
- postCreate tags for a vCDB.
- postDelete tags for a vCDB.
- postEnable a vCDB.
- postDisable a vCDB.
- getGet deletion dependencies of a vCDB.
- postDelete a vCDB.
- patchUpdate a VCDB.
- postStart a vCDB.
- postStop a vCDB.
- postUpgrade Oracle vCDB
- postVerify JDBC connection string for a vCDB.
- VirtualizationPolicies
- getFetch a list of all virtualization policies
- postCreate a VirtualizationPolicy.
- postSearch Virtualization Policies.
- postSearch Virtualization Policy Target Objects.
- getFetch a virtualization policy by Id.
- delDelete a VirtualizationPolicy.
- patchUpdate a VirtualizationPolicy.
- postConvert a virtualization policy to a DCT-managed policy.
- getGet tags for a VirtualizationPolicy.
- postCreate tags for a VirtualizationPolicy.
- postDelete tags for a VirtualizationPolicy.
- postApply a virtualization policy to the given list of objects.
- postUnapply a virtualization policy to the given list of objects.
- Replication
- getList all ReplicationProfiles.
- postCreate a ReplicationProfile.
- postSearch for ReplicationProfiles.
- postExecute a ReplicationProfile.
- getGet a ReplicationProfile by ID.
- delDelete a ReplicationProfile.
- patchUpdate a ReplicationProfile.
- getGet tags for a ReplicationProfile.
- postCreate tags for a ReplicationProfile.
- postDelete tags for a ReplicationProfile.
- postEnable tag replication for given ReplicationProfile.
- postDisable tag replication for given ReplicationProfile.
- VirtualizationJobs
- VirtualizationActions
- Namespace
- getList all namespaces.
- postSearch Namespaces.
- getGet a namespace.
- delDelete a Namespace.
- patchUpdate a Namespace.
- postInitiates failover for the given namespace.
- postCommits the failover of a given namespace and discards the failback state.
- postInitiates failback for the given namespace.
- postDiscards any partial receive state for the given namespace.
- VirtualizationAlerts
- VirtualizationFaults
- getFetch a list of all virtualization faults
- postSearch virtualization faults
- postMarks selected faults as resolved or ignored.
- postMarks all active faults of an engine that the user has permissions over as resolved.
- postMarks the fault as resolved. The Delphix engine will attempt to automatically detect cases where the fault has been resolved; but this is not always possible and may only occur on periodic intervals. In these cases, the user can proactively mark the fault resolved. This does not change the underlying disposition of the fault - if the problem is still present the system may immediately diagnose the same problem again. This should only be used to notify the system of resolution after the underlying problem has been resolved.
- HeldSpace
- HookTemplates
- Network Performance Tool
- File Mapping
- AiManagement
- AiGenerate
- getGet the details of all data generate operations
- postInitiate an operation that creates a list of data values using generative AI
- postSearch for the details of data generate operations
- getGet the details of a data generate operation
- getGet all values generated by a data generate operation
- getDownload all values generated by the operation in the specified format
- Jobs
- Accounts
- getReturns a list of Accounts
- postCreate a new Account
- postReset account API key.
- delDelete an API Key for an account
- postRegenerate api key for the self.
- getGet an Account by id
- putUpdate an Account
- delDelete an Account
- postEnable an Account.
- postDisable an Account.
- postChange Account Password.
- postReset Account Password.
- getGet tags for an Account.
- postCreate tags for an Account.
- postDelete tags for an Account.
- getReturns the list of effective UI profiles for an account. This can only be called for one's own account.
- getReturns the password policies
- patchUpdate password policies.
- postSearch for Accounts.
- License
- Login
- Tags
- getReturns a list of global tags
- postSearch for global tags.
- getGet a global tag by id
- getList specific usages of this global tag.
- postSearch specific usages of this global tag.
- getList instances of this global tag being used to scope an access group.
- postSearch instances of this global tag being used to scope an access group
- SamlLogin
- DataConnections
- getReturns a list of data connections.
- postSearch for data connections.
- getGet a data connection by id.
- patchUpdate a data connection.
- getGet tags for a data connection.
- postCreate tags for a data connection.
- postDelete tags for a data connection.
- getGet sub-connections for a data connection.
- postReassign a SubConnection to another DataConnection.
- postSearch for sub-connections for a data connections.
- Authorization
- getList all roles
- postCreate custom role
- getReturns role by ID.
- delDelete role by ID.
- patchUpdate a Role.
- postSearch for roles.
- postAdd permissions to a role.
- postRemove permissions from a role.
- getGet tags for a Role.
- postCreate tags for a role.
- postDelete tags for a Role.
- postAdd UI profiles to a role.
- postDelete UI profiles from a Role.
- getReturns permissions for given object.
- getReturns all of the possible permissions for all of the objects.
- getList all access groups.
- postCreate a new access group.
- postSearch for access groups.
- getReturns an Access group by ID.
- delDelete an Access group.
- patchUpdate an Access group.
- postAdd account tags to an Access group
- postRemove account tags from an access group.
- postAdd account ids to an Access group
- delRemove the account from the access group.
- postAdd scopes to an Access group
- getGet access group scope.
- delRemove the scope from the Access group.
- patchUpdate access group scope.
- postAdd object tags to the access group scope.
- postRemove tags from the access group scope.
- postAdd objects to the access group scope.
- postRemove objects from the access group scope.
- postAdd always allowed permissions for given object type.
- postRemove always allowed permissions for given object type.
Validate file mapping using snapshots
SecurityApiKeyAuth
Request
Responses
200
Database file mapping validation result by snapshot
post/file-mapping/validate-file-mapping-by-snapshot
Request samples
- Payload
application/json
{- "snapshot_ids": [
- "string"
], - "file_mapping_rules": "string"
}Response samples
- 200
application/json
{- "mapped_files": {
- "property1": "string",
- "property2": "string"
}
}Validate file mapping using location
SecurityApiKeyAuth
Request
Request Body schema: application/jsonrequired
Responses
200
Database file mapping validation result by location
post/file-mapping/validate-file-mapping-by-location
Request samples
- Payload
application/json
{- "source_data_id": "1-source-123",
- "locations": [
- "string"
], - "file_mapping_rules": "string"
}Response samples
- 200
application/json
{- "mapped_files": {
- "property1": "string",
- "property2": "string"
}
}Validate file mapping using timestamp
SecurityApiKeyAuth
Request
Request Body schema: application/jsonrequired
Responses
200
Database file mapping validation result by timestamp
post/file-mapping/validate-file-mapping-by-timestamp
Request samples
- Payload
application/json
{- "source_data_id": "1-source-123",
- "timestamps": [
- "2025-08-19T22:01:44.000Z"
], - "file_mapping_rules": "string"
}Response samples
- 200
application/json
{- "mapped_files": {
- "property1": "string",
- "property2": "string"
}
}Validate file mapping using bookmark
SecurityApiKeyAuth
Request
Responses
200
Database file mapping validation result by bookmark
post/file-mapping/validate-file-mapping-by-bookmark
Request samples
- Payload
application/json
{- "bookmark_ids": [
- "1-bookmark-123",
- "1-bookmark-456"
], - "file_mapping_rules": "string"
}Response samples
- 200
application/json
{- "mapped_files": {
- "property1": "string",
- "property2": "string"
}
}