20.0.0
21.0.0
22.0.0
23.0.0
24.0.0
2025.1.0.0
21.0.0
Search
Connectivity
post
Checks connectivity between an engine and a remote host machine on a given port.
post
Tests the validity of the supplied database credentials, returning an error if unable to connect to the database.
post
Checks whether the specified NetBackup master server and client are able to communicate on the given environment.
post
Tests whether the CommServe host is accessible from the given environment and Commvault agent.
DataLayouts
get
List all data-layout (Self-Service Container/Template).
post
Search for data-layouts.
get
Get a data-layout by ID.
get
Get tags for a data-layout.
post
Create tags for a data-layout.
post
Delete tags for a data-layout.
post
Convert and drop engine bookmarks and vdb groups for the data-layout.
post
Import engine (self-service) accounts.
Bookmarks
get
List all bookmarks.
post
Create a bookmark at the current time.
post
Search for bookmarks.
get
Get a bookmark by ID.
del
Delete a bookmark.
patch
Update a bookmark
get
List VDB Groups compatible with this bookmark.
post
Search for VDB Groups compatible with this bookmark.
get
Get tags for a Bookmark.
post
Create tags for a Bookmark.
post
Delete tags for a Bookmark.
post
Import engine bookmarks to DCT.
Sources
get
List all sources.
post
Create an Oracle Source.
post
Create a PostgreSQL source.
patch
Update a PostgreSQL source by ID.
post
Search for Sources.
get
Get a source by ID.
del
Delete a source by ID.
get
Get tags for a Source.
post
Create tags for a Source.
get
Returns a list of repositories that match the specified source.
post
Delete tags for a Source.
StagingSources
get
List all staging sources.
post
Search for Staging Sources.
get
Get a staging source by ID.
get
Get tags for a Staging Source.
post
Create tags for a Staging Source.
post
Delete tags for a Staging Source.
DSources
get
List all dSources.
post
Link Oracle database as dSource.
post
Get defaults for dSource linking.
post
Detaches an Oracle source from an Oracle database.
post
Attach an Oracle dSource to an Oracle database.
post
Link an Oracle staging push database as dSource.
post
Get defaults for a Oracle staging push dSource linking.
patch
Update values of an Oracle dSource
post
Upgrade the requested Oracle dSource installation and user.
post
Link an ASE database as dSource.
post
Get defaults for an ASE dSource linking.
post
Link an AppData database as dSource.
post
Get defaults for an AppData dSource linking.
post
Link a MSSql database as dSource.
post
Detaches a linked source from a MSSql database.
post
Attaches a MSSql source to a previously detached dsource.
post
Attaches a MSSql staging push database to a previously detached dsource.
post
Get defaults for a MSSql dSource linking.
post
Link a MSSql staging push database as dSource.
post
Get defaults for a MSSql staging push dSource linking.
post
Delete the specified dSource.
post
Search for dSources.
get
Get a dSource by ID.
post
Enable a dSource.
post
Disable a dSource.
get
List Snapshots for a dSource.
post
Snapshot a dSource.
get
Get tags for a dSource.
post
Create tags for a dSource.
post
Delete tags for a dSource.
KerberosConfig
get
Get a kerberos config by ID or Name.
get
List all kerberos configs.
post
Search for Kerberos Configs.
PasswordVaults
get
List all password vaults.
post
Search for Password Vaults.
get
Get a password vault by ID or Name.
Groups
get
List all dataset groups.
post
Search for dataset groups.
get
Get a dataset group by ID or Name.
Toolkits
get
List all toolkits.
post
Search for toolkits.
get
Get Toolkit by ID.
get
Get tags for a Toolkit.
post
Create tags for a toolkit.
post
Delete tags for a Toolkit.
VDBs
get
List all vdbs.
post
Search for VDBs.
get
Get a VDB by ID.
patch
Update values of a VDB
get
List Snapshots for a VDB.
post
Snapshot a VDB.
get
List Bookmarks compatible with this VDB.
post
Search Bookmarks compatible with this VDB.
get
Get tags for a VDB.
post
Create tags for a VDB.
post
Delete tags for a VDB.
post
Start a VDB.
post
Stop a VDB.
post
Enable a VDB.
post
Disable a VDB.
post
Lock a VDB.
post
Unlock a VDB.
post
Delete a VDB.
post
Rollback a VDB by timestamp.
post
Rollback a VDB by snapshot.
post
Rollback a VDB from a bookmark with only the same VDB.
post
Refresh a VDB by timestamp.
post
Refresh a VDB by snapshot.
post
Refresh a VDB from bookmark with a single VDB.
post
Refresh a VDB by location.
post
Switches the current timeflow of a VDB.
post
Provision a new VDB by timestamp.
post
Get default provision parameters for provisioning a new VDB by timestamp.
post
Provision a new VDB by location.
post
Get default provision parameters for provisioning a new VDB by location.
post
Provision a new VDB by snapshot.
post
Get default provision parameters for provisioning a new VDB by snapshot.
post
Provision a new VDB from a bookmark with a single VDB.
post
Get default provision parameters for provisioning a new VDB from a bookmark.
VDBGroups
get
List all VDBGroups.
post
Create a new VDBGroup.
post
Provision a new VDB Group from a Bookmark.
post
Search for VDB Groups.
get
Get a VDBGroup by name.
del
Delete a VDBGoup.
patch
Update values of a VDB group.
get
Get latest snapshot of all the vdbs in VDBGroup.
get
Get tags for a VDB Group.
post
Create tags for a VDB Group.
post
Delete tags for a VDB Group.
post
Refresh a VDBGroup.
post
Refresh a VDBGroup by snapshot.
post
Refresh a VDBGroup by timestamp.
post
Rollback a VDBGroup.
get
List bookmarks compatible with this VDB Group.
post
Search for bookmarks compatible with this VDB Group.
post
Lock a VDB Group.
post
Unlock a VDB Group.
Snapshots
get
Retrieve the list of snapshots.
get
Get a Snapshot by ID.
del
Delete a Snapshot.
patch
Update values of a Snapshot.
post
Unset a Snapshot's expiration, removing expiration and retain_forever values for the snapshot.
get
Get tags for a Snapshot.
post
Create tags for a Snapshot.
post
Delete tags for a Snapshot.
post
Search snapshots.
get
Get the snapshots at this location for a dataset.
get
Get the snapshots at this timestamp for a dataset.
get
Return the provisionable timeflow range based on a specific snapshot.
Timeflows
get
Retrieve the list of timeflows.
get
Get a Timeflow by ID.
del
Delete a timeflow.
patch
Update values of a timeflow.
get
Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.
get
Get tags for a Timeflow.
post
Create tags for a Timeflow.
post
Delete tags for a Timeflow.
post
Search timeflows.
Environments
get
List all environments.
post
Create an environment.
post
Get compatible repositories corresponding to the snapshot.
post
Get compatible repositories corresponding to the timestamp.
post
Get compatible repositories corresponding to the bookmark.
post
Get compatible repositories corresponding to the location.
del
Delete a repository.
patch
Update a Repository.
post
Create a repository.
post
Create a new Host.
del
Delete a Host.
patch
Update a Host.
get
Get tags for an Environment.
post
Create tags for an Environment.
post
Delete tags for an Environment.
get
Returns an environment by ID.
del
Delete an environment by ID.
patch
Update an environment by ID.
post
Search for environments.
post
Enable a disabled environment.
post
Disable environment.
post
Refresh environment.
get
List environment users.
post
Create environment user.
put
Update environment user.
del
Delete environment user.
post
Set primary environment user.
post
Create Oracle listener.
del
Delete an Oracle listener.
patch
Update an Oracle listener.
Management
post
Validate java path for the remote host machine.
get
Returns a list of registered engines.
post
Register an engine.
get
Returns a registered engine by ID.
put
Update a registered engine.
del
Unregister an engine.
patch
Update a registered engine.
get
Returns the engine's auto tagging configuration.
patch
Update the engine's auto tagging configuration.
get
Returns a compliance engine's application settings.
post
Search a compliance engine's application settings.
post
Search for engines.
get
Get tags for a Engine.
post
Create tags for an Engine.
post
Delete tags for an Engine.
get
Returns a list of configured Hashicorp vaults.
post
Configure a new Hashicorp Vault
post
Search for configured Hashicorp vaults.
get
Get a Hashicorp vault by id
del
Delete a Hashicorp vault by id
get
Get tags for a Hashicorp vault.
post
Create tags for a Hashicorp vault.
post
Delete tags for a Hashicorp vault.
get
Get global properties.
patch
Update value of predefined properties.
get
Get api classification.
put
Update the api classification to new version.
get
Returns the SMTP configuration
put
Update SMTP Config.
post
Validate SMTP Config.
get
Returns configuration information about the metadata database which stores the product data.
get
Returns the LDAP configuration
put
Update LDAP Config.
post
Validate 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.
get
Returns the SAML configuration
put
Update SAML Config.
get
Returns previous bundle upload events
get
Returns the current web proxy configuration to use to connect to Delphix services.
put
Update the web proxy configuration to use to connect to Delphix services.
get
Returns True if Delphix services are reachable for product registration.
get
Returns the product registration status.
get
Generates and returns a public key that can be used to register the product.
post
Registers the product using a manually generated payload.
post
Registers the product using the provided credentials.
StorageUsage
get
Returns the aggregated historical storage usage of all registered engines over time, optionally with a projection of future storage usage.
get
Returns the historical storage usage by engine over time, optionally with a projection of future storage usage.
Reporting
post
Search the saving storage summary report for virtualization engines.
get
Gets the inventory report for virtualization engine VDBs.
post
Search the inventory report for virtualization engine VDBs.
get
Gets the usage report for virtualization engine dSources.
post
Search the usage report for virtualization engine dSources.
get
Gets the consumption report for virtualization engine dSources.
post
Search the consumption report for virtualization engine DSources.
get
Gets the audit log summary report.
get
Gets the storage summary report for virtualization engines.
post
Search the storage summary report for virtualization engines.
get
Gets 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.
get
List all report schedules.
post
Create a new report schedule.
post
Search for report schedules.
get
Returns a report schedule by ID.
put
Update a reporting schedule by ID.
del
Delete report schedule by ID.
get
Get tags for a report schedule.
post
Create tags for a report schedule.
post
Delete tags for a report schedule.
get
Gets the performance analytics report for engines.
post
Search the performance analytic report for engines.
post
Search the performance analytic trend data for engines.
get
Returns the DCT Product Information.
DatabaseTemplates
get
Retrieve the list of database templates.
post
Create a database template.
get
Retrieve a DatabaseTemplate by ID.
del
Delete a DatabaseTemplate by ID.
patch
Updates a DatabaseTemplate by ID
get
Get tags for a DatabaseTemplate.
post
Create tags for a DatabaseTemplate.
post
Delete tags for a DatabaseTemplate.
post
Search DatabaseTemplates.
post
Imports the database templates from an an engine.
post
Undo an import of DatabaseTemplates on an Engine.
CDBs
get
List all CDBs (Oracle only).
post
Search for CDBs (Oracle only).
get
Get a CDB by ID (Oracle only).
get
Get tags for a CDB.
post
Create tags for a CDB.
post
Delete tags for a CDB.
post
Enable a CDB.
post
Disable a CDB.
post
Delete a CDB.
post
Upgrade Oracle CDB
VCDBs
get
List all vCDBs (Oracle only).
post
Search for vCDBs (Oracle only).
get
Get a CDB by ID (Oracle only).
get
Get tags for a vCDB.
post
Create tags for a vCDB.
post
Delete tags for a vCDB.
post
Enable a vCDB.
post
Disable a vCDB.
post
Delete a vCDB.
post
Start a vCDB.
post
Stop a vCDB.
VirtualizationPolicies
get
Fetch a list of all virtualization policies
post
Search Virtualization Policies.
get
Fetch a virtualization policy by Id.
Replication
get
List all ReplicationProfiles.
post
Create a ReplicationProfile.
post
Search for ReplicationProfiles.
post
Execute a ReplicationProfile.
get
Get a ReplicationProfile by ID.
del
Delete a ReplicationProfile.
patch
Update a ReplicationProfile.
get
Get tags for a ReplicationProfile.
post
Create tags for a ReplicationProfile.
post
Delete tags for a ReplicationProfile.
post
Enable tag replication for given ReplicationProfile.
post
Disable tag replication for given ReplicationProfile.
VirtualizationJobs
get
Fetch a list of all virtualization jobs
post
Search virtualization jobs
VirtualizationActions
get
Fetch a list of all virtualization actions
post
Search virtualization actions
Namespace
get
List all namespaces.
post
Search Namespaces.
get
Get a namespace.
del
Delete a Namespace.
patch
Update a Namespace.
post
Initiates failover for the given namespace.
post
Commits the failover of a given namespace and discards the failback state.
post
Initiates failback for the given namespace.
post
Discards any partial receive state for the given namespace.
VirtualizationAlerts
get
Fetch a list of all virtualization alerts
post
Search virtualization alerts
VirtualizationFaults
get
Fetch a list of all virtualization faults
post
Search virtualization faults
post
Marks selected faults as resolved or ignored.
post
Marks all active faults of an engine that the user has permissions over as resolved.
post
Marks 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.
Jobs
get
List all jobs.
post
Search for jobs.
get
Returns a job by ID.
post
Abandons a job.
get
Get tags for a Job.
post
Create tags for a Job.
post
Delete tags for a Job.
Accounts
get
Returns a list of Accounts
post
Create a new Account
get
Get an Account by id
put
Update an Account
del
Delete an Account
post
Enable an Account.
post
Disable an Account.
post
Change Account Password.
post
Reset Account Password.
get
Get tags for an Account.
post
Create tags for an Account.
post
Delete tags for an Account.
get
Returns the password policies
patch
Update password policies.
post
Search for Accounts.
Login
post
Login to Account with Username and Password
post
Invalidates username/password and SSO login session.
post
Get Token Information
SamlLogin
get
Check if SAML is enabled
Authorization
get
List all roles
post
Create custom role
get
Returns role by ID.
del
Delete role by ID.
patch
Update a Role.
post
Search for roles.
post
Add permissions to a role.
post
Remove permissions from a role.
get
Get tags for a Role.
post
Create tags for a role.
post
Delete tags for a Role.
get
Returns permissions for given object.
get
Returns all of the possible permissions for all of the objects.
get
List all access groups.
post
Create a new access group.
post
Search for access groups.
get
Returns an Access group by ID.
del
Delete an Access group.
patch
Update an Access group.
post
Add account tags to an Access group
post
Remove account tags from an access group.
post
Add account ids to an Access group
del
Remove the account from the access group.
post
Add scopes to an Access group
get
Get access group scope.
del
Remove the scope from the Access group.
patch
Update access group scope.
post
Add object tags to the access group scope.
post
Remove tags from the access group scope.
post
Add objects to the access group scope.
post
Remove objects from the access group scope.
post
Add always allowed permissions for given object type.
post
Remove always allowed permissions for given object type.
SamlLogin
Check if SAML is enabled
Security
ApiKeyAuth
Responses
200
OK
get
/is-saml-enabled
Try it
Response samples
200
application/json
Copy
{
"enabled"
:
true
}
➔ Next to
Authorization