Skip to main content
Home

Main Menu System

Home
Perforce Developer Hub
  • Akana
    ALM
    BlazeMeter
    Delphix
    Gliffy
    HostAccess
    HydraExpress
    IMSL
    IPLM
    JRebel
    JViews
    Klocwork
    OpenLogic
    P4
    P4 Plan
    Perfecto
    Puppet
    PV-Wave
    QAC
    SourcePro
    Stingray
    TotalView
    Visualization
    Zend
  • Support Portal
  • Akana
    ALM
    BlazeMeter
    Delphix
    Gliffy
    HostAccess
    HydraExpress
    IMSL
    IPLM
    JRebel
    JViews
    Klocwork
    OpenLogic
    P4
    P4 Plan
    Perfecto
    Puppet
    PV-Wave
    QAC
    SourcePro
    Stingray
    TotalView
    Visualization
    Zend
  • Support Portal
  • Log a Case
  1. Delphix ›
  2. Continuous Data ›
  3. 2026.5 ›
  4. API guide ›
  5. Work with Delphix APIs ›
  6. API cookbook: tasks, workflows, and examples

API cookbook: tasks, workflows, and examples

  • Release notes ›
    • 2026.5 release notes
    • 2026.4 release notes
    • 2026.3 release notes
    • 2026.2 release notes
    • 2026.1 release notes
    • 2025.6 release notes
    • 2025.5 release notes
    • 2025.4 release notes
    • 2025.3 release notes
    • 2025.2 release notes
    • 2025.1 release notes
    • Previous releases ›
      • New features
      • Fixed issues
      • Known issues
      • Deprecated and end-of-life features
      • API changes ›
        • API changes in Delphix 29.0.0.0
        • API changes in Delphix 28.0.0.0
        • API changes in Delphix 27.0.0.0
        • API changes in Delphix 26.0.0.0
        • API changes in Delphix 25.0.0.0
        • API changes in Delphix 24.0.0.0
        • API changes in Delphix 23.0.0.0
        • API changes in Delphix 22.0.0.0
        • API changes in Delphix 21.0.0.0
        • API changes in Delphix 20.0.0.0
        • API changes in Delphix 19.0.0.0
        • API changes in Delphix 18.0.0.0
        • API Changes in Delphix 17.0.0.0
        • API Changes in Delphix 16.0.0.0
        • API Changes in Delphix 15.0.0.0
        • API Changes in Delphix 14.0.0.0
        • API Changes in Delphix 13.0.0.0
        • API Changes in Delphix 12.0.0.0
        • API changes in Delphix 11.0.0.0
        • API changes in Delphix 10.0.0.0
        • API changes in Delphix 9.0.0.0
        • API changes in Delphix 8.0.0.0
        • API changes in Delphix 7.0.0.0
        • API changes in Delphix 6.0.17.0
        • API changes in Delphix 6.0.16.0
        • API changes in Delphix 6.0.15.0
        • API changes in Delphix 6.0.14.0
        • API changes in Delphix 6.0.13.0
        • API changes in Delphix 6.0.12.0
        • API changes in Delphix 6.0.11.0
        • API changes in Delphix 6.0.10.0
        • API changes in Delphix 6.0.9.0
        • API changes in Delphix 6.0.8.0
        • API changes in Delphix 6.0.7.0
        • API changes in Delphix 6.0.6.0
        • API changes in Delphix 6.0.5.0
        • API changes in Delphix 6.0.4.0
        • API changes in Delphix 6.0.3.0
    • Support matrices ›
      • Installation and configuration support guidelines
      • Kerberos support matrix
      • Data source certifications
      • Select connector matrix
    • Upgrade matrix
    • Tested browsers and operating systems
    • Licenses and notices
  • Overview ›
    • Product information
    • Delphix glossary
    • Product icon reference
  • Deployment ›
    • Access Continuous Data
    • Standard deployment architecture
    • Installation and configuration checklist
    • Network connectivity requirements ›
      • Set up engine network access
    • Installation and initial system configuration ›
      • Initial setup ›
        • Azure object storage setup
        • AWS object storage setup
        • GCP object storage setup
        • OCI object storage setup
        • Other S3 compatible object storage setup
        • Update object storage endpoints
      • Customize system settings
    • Validate host deployment with HostChecker
    • VMware deployment
    • KVM deployment
    • Hyper-V deployment ›
      • Deploy in Hyper-V
    • AWS EC2 deployment ›
      • AWS deployment prerequisites
      • Deploy in AWS
      • AWS RDS Custom for Oracle and SQL Server
    • Microsoft Azure deployment ›
      • Azure deployment prerequisites
      • Deploy in Azure
      • Enable Azure accelerated networking
      • Create an engine on Azure with ACG for V6 instance families
    • GCP deployment ›
      • GCP deployment prerequisites
      • Deploy in GCP
    • OCI deployment ›
      • OCI deployment prerequisites
      • Deploy in OCI
    • IBM Cloud deployment ›
      • IBM Cloud deployment prerequisites
      • Deploy in IBM Cloud
    • Hotfix information
  • Configuration ›
    • Register your engine
    • Manage users and authentication ›
      • Users and groups ›
        • Assign group and object ownership
        • Add and delete groups
        • Manage system administrators
        • Manage Delphix users
        • Manage individual profiles
      • Authentication ›
        • Configure auto-authentication
        • Configure LDAP
        • Configure single sign-on
        • Configure and manage Kerberos ›
          • Kerberos implementation
          • SSH implementation
          • Kerberos requirements
          • Configure Kerberos during setup
          • Manage Kerberos environments
        • Configure OAuth2 authentication for API access
    • Manage networks and DNS ›
      • General network and connectivity requirements
      • Configure network performance ›
        • Optimal network architecture
        • Network operations with Delphix Session Protocol (DSP)
        • Test with Network Performance Tool ›
          • Test with Delphix Session Protocol from primary engines to replication engines
        • Monitor dataset performance
        • Network performance expectations and troubleshooting
      • Get Delphix Server ID and hostname
      • Configure multiple DNS domain names in DNS search list
      • Change the engine IP address
      • Change the engine hostname
      • Change the engine DNS server
      • Configure a second network interface
    • Configure NFSv4
    • Manage capacity and resources ›
      • Capacity and performance overview ›
        • Storage capacity screen
        • Delphix disk usage
        • Get historical capacity data with CLI
      • TRIM and UNMAP support for storage devices
      • Set quotas
      • Delete objects to increase capacity
      • Add, expand, or remove storage devices
      • Delphix storage migration ›
        • In-place block-to-object storage migration
      • Manage source data
      • Held space overview
    • Manage logs and monitoring ›
      • Configure SNMP
      • View action status
      • View jobs
      • System faults ›
        • View system faults
      • Access audit logs
      • Create support logs
      • Enable support access
      • Configure syslog ›
        • Syslog message severity
      • Support access audit logs
      • Diagnose connectivity errors
      • Configure SMTP email alerts
      • Manage Fluentd plugin service ›
        • Splunk integration ›
          • Configure Splunk
          • Search with Splunk
        • Create Fluentd plugins
    • Manage performance analytics ›
      • Performance analytics ›
        • Performance analytics tool overview
        • Performance analytics graphs
        • Performance analytics statistics reference
        • Performance analytics tool API reference
        • Case study: single statistics
        • Case study: multiple statistics
      • Configure storage performance ›
        • Optimal engine storage configuration
        • Test storage performance with CLI
        • Troubleshoot storage performance
      • Hypervisor and host performance architecture
      • Target host OS and database configuration
      • Block storage cache reports
    • Manage user-click analytics
    • Start, stop, or restart your engine
    • Privilege elevation profiles
  • Upgrade ›
    • Engine upgrade overview
    • Upgrade prerequisites
    • Download the upgrade image
    • Upload the upgrade image ›
      • Upgrade verification
      • Resolve upgrade checks
    • Apply the upgrade
    • Post upgrade
  • Security ›
    • Security principles
    • Product security ›
      • Product security overview
      • Software updates
      • Network security
      • Password vault support
      • Manage certificates ›
        • Configure network security settings ›
          • Manage certificates for remote connections
          • Manage certificates for replication
          • Manage certificates for throughput tests
          • Configure engine HTTP settings
          • Regenerate self-signed end-entity and CA certificates
        • Configure network settings ›
          • Configure customer-provided key pairs
          • Configure Delphix-provided key pairs
          • Configure host DSP
        • KeyStore settings
        • TrustStore settings
    • Replication security
    • Object security ›
      • Manage users
      • Source database security
      • Source and target host security
    • System configuration
    • Secure Boot
    • GUI security
    • Repave ›
      • Repave block storage engines
      • Repave Elastic Data engines (engines backed by object storage)
      • Repave for disaster recovery
    • Mask sensitive data
    • Audit log security
    • Support security ›
      • Delphix Operating System (DxOS)
    • Password policies
    • Additional security topics
  • Connectors (Datasets) ›
    • Getting started with connectors ›
      • Connectors overview
      • General architecture
      • Environment management ›
        • Adding and discovering an environment
        • Network requirements
        • Environment users
        • Delphix toolkit
        • Java Development Kit (JDK)
        • Data communication encryption
        • Environment operations
        • Validating host environments with HostChecker
        • Manually recovering a database after V2P
      • dSource management ›
        • dSource operations
      • Virtual database (VDB) management ›
        • VDB operations ›
          • Automatic VDB restart on target server after reboot
          • Cache Priority
      • Hook operations ›
        • Creating hook operations
        • Hook operations templates
        • Hook operations list
        • Enable and disable dSource hooks
      • Shell operations
      • Other operations
      • Policies ›
        • Default vs. Custom policies
        • Setting different policies for objects in a group
        • Create a custom policy
        • Policies and timezones
        • Configure retention on individual snapshots
      • Basic troubleshooting
    • Quick reference for supported connectors
    • SQL Server connector
    • Oracle connector
    • SAP ASE connector
    • Unstructured files (vFiles) connector
  • Best practices ›
    • Hypervisor host and VM guest best practices
    • Network configuration best practices
    • Data protection best practices
    • Source environment and database best practices
    • Target environment and database best practices ›
      • Receive Side Scaling (RSS) for Windows targets and staging targets
    • Staging environment and database best practices
    • Storage best practices
    • Validated sync best practices
  • Backup and recovery ›
    • Continuous Vault
    • Backup and recovery strategies ›
      • Backup and recovery requirements
      • Backup solution implementation
      • Deployment architecture
      • Map requirements to solutions
    • Replication ›
      • Replication overview
      • Forward Compatible Replication (FCR)
      • Replication concepts
      • Replication use cases
      • Configure replication
      • Controlled failovers
      • Uncontrolled failovers ›
        • Oracle environments and data sources
        • SAP ASE environments and data sources
        • SQL server environments and data sources
      • Manage replicated objects
      • Replicas and failover
      • Test-failover and failback
      • Provision from replicated data sources or VDBs
      • Offline replication (air gap)
      • Replication UI
    • Selective Data Distribution (SDD) ›
      • SDD overview
      • SDD use cases
      • SDD UI
      • SDD configuration
      • SDD and failover
  • CLI guide ›
    • CLI overview ›
      • Connect to the CLI
      • CLI contexts
      • Manage objects
      • Manage properties
      • Array properties
      • Untyped object properties
      • CLI automation
    • Delphix objects ›
      • Object type hierarchy
      • Object names and references
      • Databases and environments
      • Asynchronous jobs
    • Command reference ›
      • CLI help and display commands
      • CLI context commands
      • CLI object commands
      • CLI miscellaneous commands
      • CLI property commands
    • CLI cookbook: workflows, tasks, and examples ›
      • Authentication and users ›
        • Configure SAP ASE manual discovery
        • Change HTTP and HTTPS web connections
        • Replace the HTTPS (HTTP secure) certificate
        • Configure key-based SSH authentication for automation ›
          • Generate third-party SSH keys
        • Set up SSH key authentication for UNIX environment users
        • Configure SSH host verification for UNIX environments
        • Configure password policies
      • System administration ›
        • Set NFS version
        • Configure a second network interface
        • Remove IP addresses from network interfaces
        • Rotate Azure storage access keys
        • Add static routes
        • Get network routes to destinations
        • Change the default group name
        • Change user passwords
        • Grant non-admin users access to objects in replication namespaces
        • Get capacity information
        • View storage test results
        • Change engine IP address
        • CLI alert notifications ›
          • Create alert profiles
        • Get CPU performance information
        • Reboot the engine
        • Disable user-click analytics
        • Change API version
      • Hosts and environments ›
        • Add a UNIX host
        • Add SQL Server source environments
        • Set multiple addresses for target hosts
        • Change environment users
        • Create and edit privilege elevation profiles and profile scripts ›
          • Privilege elevation profiles and Delphix replication
        • Enable and configure environment permissions
        • Manage OKV clients
      • Source databases and dSources ›
        • Link Oracle staging push databases
        • Detach and attach SQL server dSources
        • Disabe LogSync for dSources
        • Enable Oracle validated sync
        • Link SQL Server databases loaded from specific full backups of source databases
        • Link SQL Server databases loaded from the last full backup of source databases
        • View SQL Server backup set metadata for snapshots
        • Link to single instance Oracle databases
        • List data source sizes
        • Detach and attach Oracle dSources
        • Change database user passwords
        • Change SAP ASE dSource staging databases
        • Detach and attach SAP ASE dSources
        • Link SAP ASE databases loaded from the last full backup of source databases
      • VDBs ›
        • Attach or detach PDBs
        • Attach, detach, or link CDBs
        • Change SGA parameters
        • Change the SID of Oracle RAC VDBs
        • Toggle new DBID generation upon refresh for Oracle VDBs
        • Create policies
        • Create VDB config templates
        • Get snapshots used to provision VDBs
        • Delete a CDB after migrating its vPDB
        • Refresh VDBs from specific snapshots
        • Migrate Oracle VDBs
        • Provision SAP ASE VDBs
        • Provision single instance non-multitenant Oracle VDBs
        • Provision SQL Server VDBs
        • Provision SQL Server AG VDBs
        • Provision VDBs from Timeflow bookmarks
        • Provision virtual PDBs to new virtual CDBs
        • Provision virtual PDBs in target CDBs
        • Provision TDE-enabled virtual PDBs to new virtual CDBs
        • Provision TDE-enabled vPDBs in target CDBs
        • Refresh VDBs from specific timepoints or latest
        • Refresh VDBs from related VDBs
        • Repair Timeflows
        • Roll back VDBs ›
          • Roll back or rewind to a snapshot from a VDB
          • Roll back or rewind to a snapshot with Timeflow
          • Roll back or rewind to a Timeflow bookmark
        • Roll forward VDBs
        • Take snapshots
        • Virtual to Physical (V2P) operation on single instance non-multitenant Oracle databases
        • Virtual to Physical (V2P) operation on single instance Oracle databases with datafiles on separate file systems
        • Virtual to Physical (V2P) operation on a non-multitenant virtual Oracle database to ASM or Physical Filesystem
        • Virtual to Physical (V2P) operation on a multitenant virtual pluggable Oracle database to ASM or Physical Filesystem
        • Virtual to Physical (V2P) operation from a snapshot or a Timeflow point of a multitenant pluggable Oracle database to ASM or Physical Filesystem
        • Virtual to Physical (V2P) operation from a snapshot or a Timeflow point of a non-multitenant Oracle database to ASM or Physical Filesystem
        • V2P on SQL Servers
        • Get VDB statuses
        • Provision virtual PDBs from non-multitenant source databases
        • Migrate virtual PDBs in virtual CDBs
        • Migrate vPDBs to different CDBs
        • Migrate a virtual CDB and its only virtual PDB to a new environment
        • Migrate Oracle RAC virtual PDBs in virtual CDBs
        • Locate and update tdeKeyIdentifier
        • Force refresh or rewind virtual PDBs
        • Start or stop cluster instances of Oracle RAC virtual databases
        • Update Oracle Isolated Mode TDE attributes of vPDBs
        • Finalize the Incremental V2P operation for Oracle VDBs or vPDBs
        • Clean up the V2P configuration for VDBs or vPDBs
        • Update okvClient for linked or virtual CDBs
      • Enable or disable features ›
        • Enable or disable MSSQL_EXPAND_VOLUME_BEYOND_63TB
      • Replication ›
        • Add replication specs
        • Delete replication specs
        • Fail over a namespace
        • Map replication specs to objects
        • Trigger immediate execution of replication specs
      • Hooks and hook templates ›
        • Change the hook template PowerShell version
      • Network performance ›
        • Run session protocol tests from primary engine to replication engine
        • Test network latency with CLI
        • Test network throughput with CLI
      • Kerberos CLI cookbook ›
        • Admin application configuration
        • System app configuration
  • API guide ›
    • API versions
    • API object model
    • API protocol
    • Translate CLI to API
    • Map GUI and CLI to API
    • Translate CLI to Python API
    • Add UNIX hosts with delphixpy Python API
    • Work with Delphix APIs ›
      • API introduction
      • API resources
      • API prerequisite knowledge
      • RESTFul API command line basics
      • API shell script programming language examples
      • JSON parsing
      • API use cases: commands and scripts ›
        • Continuous Compliance API use cases
        • Oracle API use cases
        • SQL server API use cases
      • API programming language examples
      • API timeflows
      • API cookbook: tasks, workflows, and examples ›
        • Create authenticated sessions
        • Get host environment details
        • List alerts and jobs
        • List dSources and VDBs
        • List snapshots
        • Provision Oracle VDBs
        • Refresh VDBs
        • Rewind VDBs
        • Stop and start VDBs
        • Upload upgrades
        • Kerberos API cookbook ›
          • ASEDBConfig
          • ASEhostEnvironmentParameters
          • SAP ASE instance
          • ASELinkData
          • EnvironmentUser
          • KerberosConfig
          • KerberosCredential
          • KerberosKDC
  • Release notes ›
    • 2026.5 release notes
    • 2026.4 release notes
    • 2026.3 release notes
    • 2026.2 release notes
    • 2026.1 release notes
    • 2025.6 release notes
    • 2025.5 release notes
    • 2025.4 release notes
    • 2025.3 release notes
    • 2025.2 release notes
    • 2025.1 release notes
    • Previous releases ›
      • New features
      • Fixed issues
      • Known issues
      • Deprecated and end-of-life features
      • API changes ›
        • API changes in Delphix 29.0.0.0
        • API changes in Delphix 28.0.0.0
        • API changes in Delphix 27.0.0.0
        • API changes in Delphix 26.0.0.0
        • API changes in Delphix 25.0.0.0
        • API changes in Delphix 24.0.0.0
        • API changes in Delphix 23.0.0.0
        • API changes in Delphix 22.0.0.0
        • API changes in Delphix 21.0.0.0
        • API changes in Delphix 20.0.0.0
        • API changes in Delphix 19.0.0.0
        • API changes in Delphix 18.0.0.0
        • API Changes in Delphix 17.0.0.0
        • API Changes in Delphix 16.0.0.0
        • API Changes in Delphix 15.0.0.0
        • API Changes in Delphix 14.0.0.0
        • API Changes in Delphix 13.0.0.0
        • API Changes in Delphix 12.0.0.0
        • API changes in Delphix 11.0.0.0
        • API changes in Delphix 10.0.0.0
        • API changes in Delphix 9.0.0.0
        • API changes in Delphix 8.0.0.0
        • API changes in Delphix 7.0.0.0
        • API changes in Delphix 6.0.17.0
        • API changes in Delphix 6.0.16.0
        • API changes in Delphix 6.0.15.0
        • API changes in Delphix 6.0.14.0
        • API changes in Delphix 6.0.13.0
        • API changes in Delphix 6.0.12.0
        • API changes in Delphix 6.0.11.0
        • API changes in Delphix 6.0.10.0
        • API changes in Delphix 6.0.9.0
        • API changes in Delphix 6.0.8.0
        • API changes in Delphix 6.0.7.0
        • API changes in Delphix 6.0.6.0
        • API changes in Delphix 6.0.5.0
        • API changes in Delphix 6.0.4.0
        • API changes in Delphix 6.0.3.0
    • Support matrices ›
      • Installation and configuration support guidelines
      • Kerberos support matrix
      • Data source certifications
      • Select connector matrix
    • Upgrade matrix
    • Tested browsers and operating systems
    • Licenses and notices
  • Overview ›
    • Product information
    • Delphix glossary
    • Product icon reference
  • Deployment ›
    • Access Continuous Data
    • Standard deployment architecture
    • Installation and configuration checklist
    • Network connectivity requirements ›
      • Set up engine network access
    • Installation and initial system configuration ›
      • Initial setup ›
        • Azure object storage setup
        • AWS object storage setup
        • GCP object storage setup
        • OCI object storage setup
        • Other S3 compatible object storage setup
        • Update object storage endpoints
      • Customize system settings
    • Validate host deployment with HostChecker
    • VMware deployment
    • KVM deployment
    • Hyper-V deployment ›
      • Deploy in Hyper-V
    • AWS EC2 deployment ›
      • AWS deployment prerequisites
      • Deploy in AWS
      • AWS RDS Custom for Oracle and SQL Server
    • Microsoft Azure deployment ›
      • Azure deployment prerequisites
      • Deploy in Azure
      • Enable Azure accelerated networking
      • Create an engine on Azure with ACG for V6 instance families
    • GCP deployment ›
      • GCP deployment prerequisites
      • Deploy in GCP
    • OCI deployment ›
      • OCI deployment prerequisites
      • Deploy in OCI
    • IBM Cloud deployment ›
      • IBM Cloud deployment prerequisites
      • Deploy in IBM Cloud
    • Hotfix information
  • Configuration ›
    • Register your engine
    • Manage users and authentication ›
      • Users and groups ›
        • Assign group and object ownership
        • Add and delete groups
        • Manage system administrators
        • Manage Delphix users
        • Manage individual profiles
      • Authentication ›
        • Configure auto-authentication
        • Configure LDAP
        • Configure single sign-on
        • Configure and manage Kerberos ›
          • Kerberos implementation
          • SSH implementation
          • Kerberos requirements
          • Configure Kerberos during setup
          • Manage Kerberos environments
        • Configure OAuth2 authentication for API access
    • Manage networks and DNS ›
      • General network and connectivity requirements
      • Configure network performance ›
        • Optimal network architecture
        • Network operations with Delphix Session Protocol (DSP)
        • Test with Network Performance Tool ›
          • Test with Delphix Session Protocol from primary engines to replication engines
        • Monitor dataset performance
        • Network performance expectations and troubleshooting
      • Get Delphix Server ID and hostname
      • Configure multiple DNS domain names in DNS search list
      • Change the engine IP address
      • Change the engine hostname
      • Change the engine DNS server
      • Configure a second network interface
    • Configure NFSv4
    • Manage capacity and resources ›
      • Capacity and performance overview ›
        • Storage capacity screen
        • Delphix disk usage
        • Get historical capacity data with CLI
      • TRIM and UNMAP support for storage devices
      • Set quotas
      • Delete objects to increase capacity
      • Add, expand, or remove storage devices
      • Delphix storage migration ›
        • In-place block-to-object storage migration
      • Manage source data
      • Held space overview
    • Manage logs and monitoring ›
      • Configure SNMP
      • View action status
      • View jobs
      • System faults ›
        • View system faults
      • Access audit logs
      • Create support logs
      • Enable support access
      • Configure syslog ›
        • Syslog message severity
      • Support access audit logs
      • Diagnose connectivity errors
      • Configure SMTP email alerts
      • Manage Fluentd plugin service ›
        • Splunk integration ›
          • Configure Splunk
          • Search with Splunk
        • Create Fluentd plugins
    • Manage performance analytics ›
      • Performance analytics ›
        • Performance analytics tool overview
        • Performance analytics graphs
        • Performance analytics statistics reference
        • Performance analytics tool API reference
        • Case study: single statistics
        • Case study: multiple statistics
      • Configure storage performance ›
        • Optimal engine storage configuration
        • Test storage performance with CLI
        • Troubleshoot storage performance
      • Hypervisor and host performance architecture
      • Target host OS and database configuration
      • Block storage cache reports
    • Manage user-click analytics
    • Start, stop, or restart your engine
    • Privilege elevation profiles
  • Upgrade ›
    • Engine upgrade overview
    • Upgrade prerequisites
    • Download the upgrade image
    • Upload the upgrade image ›
      • Upgrade verification
      • Resolve upgrade checks
    • Apply the upgrade
    • Post upgrade
  • Security ›
    • Security principles
    • Product security ›
      • Product security overview
      • Software updates
      • Network security
      • Password vault support
      • Manage certificates ›
        • Configure network security settings ›
          • Manage certificates for remote connections
          • Manage certificates for replication
          • Manage certificates for throughput tests
          • Configure engine HTTP settings
          • Regenerate self-signed end-entity and CA certificates
        • Configure network settings ›
          • Configure customer-provided key pairs
          • Configure Delphix-provided key pairs
          • Configure host DSP
        • KeyStore settings
        • TrustStore settings
    • Replication security
    • Object security ›
      • Manage users
      • Source database security
      • Source and target host security
    • System configuration
    • Secure Boot
    • GUI security
    • Repave ›
      • Repave block storage engines
      • Repave Elastic Data engines (engines backed by object storage)
      • Repave for disaster recovery
    • Mask sensitive data
    • Audit log security
    • Support security ›
      • Delphix Operating System (DxOS)
    • Password policies
    • Additional security topics
  • Connectors (Datasets) ›
    • Getting started with connectors ›
      • Connectors overview
      • General architecture
      • Environment management ›
        • Adding and discovering an environment
        • Network requirements
        • Environment users
        • Delphix toolkit
        • Java Development Kit (JDK)
        • Data communication encryption
        • Environment operations
        • Validating host environments with HostChecker
        • Manually recovering a database after V2P
      • dSource management ›
        • dSource operations
      • Virtual database (VDB) management ›
        • VDB operations ›
          • Automatic VDB restart on target server after reboot
          • Cache Priority
      • Hook operations ›
        • Creating hook operations
        • Hook operations templates
        • Hook operations list
        • Enable and disable dSource hooks
      • Shell operations
      • Other operations
      • Policies ›
        • Default vs. Custom policies
        • Setting different policies for objects in a group
        • Create a custom policy
        • Policies and timezones
        • Configure retention on individual snapshots
      • Basic troubleshooting
    • Quick reference for supported connectors
    • SQL Server connector
    • Oracle connector
    • SAP ASE connector
    • Unstructured files (vFiles) connector
  • Best practices ›
    • Hypervisor host and VM guest best practices
    • Network configuration best practices
    • Data protection best practices
    • Source environment and database best practices
    • Target environment and database best practices ›
      • Receive Side Scaling (RSS) for Windows targets and staging targets
    • Staging environment and database best practices
    • Storage best practices
    • Validated sync best practices
  • Backup and recovery ›
    • Continuous Vault
    • Backup and recovery strategies ›
      • Backup and recovery requirements
      • Backup solution implementation
      • Deployment architecture
      • Map requirements to solutions
    • Replication ›
      • Replication overview
      • Forward Compatible Replication (FCR)
      • Replication concepts
      • Replication use cases
      • Configure replication
      • Controlled failovers
      • Uncontrolled failovers ›
        • Oracle environments and data sources
        • SAP ASE environments and data sources
        • SQL server environments and data sources
      • Manage replicated objects
      • Replicas and failover
      • Test-failover and failback
      • Provision from replicated data sources or VDBs
      • Offline replication (air gap)
      • Replication UI
    • Selective Data Distribution (SDD) ›
      • SDD overview
      • SDD use cases
      • SDD UI
      • SDD configuration
      • SDD and failover
  • CLI guide ›
    • CLI overview ›
      • Connect to the CLI
      • CLI contexts
      • Manage objects
      • Manage properties
      • Array properties
      • Untyped object properties
      • CLI automation
    • Delphix objects ›
      • Object type hierarchy
      • Object names and references
      • Databases and environments
      • Asynchronous jobs
    • Command reference ›
      • CLI help and display commands
      • CLI context commands
      • CLI object commands
      • CLI miscellaneous commands
      • CLI property commands
    • CLI cookbook: workflows, tasks, and examples ›
      • Authentication and users ›
        • Configure SAP ASE manual discovery
        • Change HTTP and HTTPS web connections
        • Replace the HTTPS (HTTP secure) certificate
        • Configure key-based SSH authentication for automation ›
          • Generate third-party SSH keys
        • Set up SSH key authentication for UNIX environment users
        • Configure SSH host verification for UNIX environments
        • Configure password policies
      • System administration ›
        • Set NFS version
        • Configure a second network interface
        • Remove IP addresses from network interfaces
        • Rotate Azure storage access keys
        • Add static routes
        • Get network routes to destinations
        • Change the default group name
        • Change user passwords
        • Grant non-admin users access to objects in replication namespaces
        • Get capacity information
        • View storage test results
        • Change engine IP address
        • CLI alert notifications ›
          • Create alert profiles
        • Get CPU performance information
        • Reboot the engine
        • Disable user-click analytics
        • Change API version
      • Hosts and environments ›
        • Add a UNIX host
        • Add SQL Server source environments
        • Set multiple addresses for target hosts
        • Change environment users
        • Create and edit privilege elevation profiles and profile scripts ›
          • Privilege elevation profiles and Delphix replication
        • Enable and configure environment permissions
        • Manage OKV clients
      • Source databases and dSources ›
        • Link Oracle staging push databases
        • Detach and attach SQL server dSources
        • Disabe LogSync for dSources
        • Enable Oracle validated sync
        • Link SQL Server databases loaded from specific full backups of source databases
        • Link SQL Server databases loaded from the last full backup of source databases
        • View SQL Server backup set metadata for snapshots
        • Link to single instance Oracle databases
        • List data source sizes
        • Detach and attach Oracle dSources
        • Change database user passwords
        • Change SAP ASE dSource staging databases
        • Detach and attach SAP ASE dSources
        • Link SAP ASE databases loaded from the last full backup of source databases
      • VDBs ›
        • Attach or detach PDBs
        • Attach, detach, or link CDBs
        • Change SGA parameters
        • Change the SID of Oracle RAC VDBs
        • Toggle new DBID generation upon refresh for Oracle VDBs
        • Create policies
        • Create VDB config templates
        • Get snapshots used to provision VDBs
        • Delete a CDB after migrating its vPDB
        • Refresh VDBs from specific snapshots
        • Migrate Oracle VDBs
        • Provision SAP ASE VDBs
        • Provision single instance non-multitenant Oracle VDBs
        • Provision SQL Server VDBs
        • Provision SQL Server AG VDBs
        • Provision VDBs from Timeflow bookmarks
        • Provision virtual PDBs to new virtual CDBs
        • Provision virtual PDBs in target CDBs
        • Provision TDE-enabled virtual PDBs to new virtual CDBs
        • Provision TDE-enabled vPDBs in target CDBs
        • Refresh VDBs from specific timepoints or latest
        • Refresh VDBs from related VDBs
        • Repair Timeflows
        • Roll back VDBs ›
          • Roll back or rewind to a snapshot from a VDB
          • Roll back or rewind to a snapshot with Timeflow
          • Roll back or rewind to a Timeflow bookmark
        • Roll forward VDBs
        • Take snapshots
        • Virtual to Physical (V2P) operation on single instance non-multitenant Oracle databases
        • Virtual to Physical (V2P) operation on single instance Oracle databases with datafiles on separate file systems
        • Virtual to Physical (V2P) operation on a non-multitenant virtual Oracle database to ASM or Physical Filesystem
        • Virtual to Physical (V2P) operation on a multitenant virtual pluggable Oracle database to ASM or Physical Filesystem
        • Virtual to Physical (V2P) operation from a snapshot or a Timeflow point of a multitenant pluggable Oracle database to ASM or Physical Filesystem
        • Virtual to Physical (V2P) operation from a snapshot or a Timeflow point of a non-multitenant Oracle database to ASM or Physical Filesystem
        • V2P on SQL Servers
        • Get VDB statuses
        • Provision virtual PDBs from non-multitenant source databases
        • Migrate virtual PDBs in virtual CDBs
        • Migrate vPDBs to different CDBs
        • Migrate a virtual CDB and its only virtual PDB to a new environment
        • Migrate Oracle RAC virtual PDBs in virtual CDBs
        • Locate and update tdeKeyIdentifier
        • Force refresh or rewind virtual PDBs
        • Start or stop cluster instances of Oracle RAC virtual databases
        • Update Oracle Isolated Mode TDE attributes of vPDBs
        • Finalize the Incremental V2P operation for Oracle VDBs or vPDBs
        • Clean up the V2P configuration for VDBs or vPDBs
        • Update okvClient for linked or virtual CDBs
      • Enable or disable features ›
        • Enable or disable MSSQL_EXPAND_VOLUME_BEYOND_63TB
      • Replication ›
        • Add replication specs
        • Delete replication specs
        • Fail over a namespace
        • Map replication specs to objects
        • Trigger immediate execution of replication specs
      • Hooks and hook templates ›
        • Change the hook template PowerShell version
      • Network performance ›
        • Run session protocol tests from primary engine to replication engine
        • Test network latency with CLI
        • Test network throughput with CLI
      • Kerberos CLI cookbook ›
        • Admin application configuration
        • System app configuration
  • API guide ›
    • API versions
    • API object model
    • API protocol
    • Translate CLI to API
    • Map GUI and CLI to API
    • Translate CLI to Python API
    • Add UNIX hosts with delphixpy Python API
    • Work with Delphix APIs ›
      • API introduction
      • API resources
      • API prerequisite knowledge
      • RESTFul API command line basics
      • API shell script programming language examples
      • JSON parsing
      • API use cases: commands and scripts ›
        • Continuous Compliance API use cases
        • Oracle API use cases
        • SQL server API use cases
      • API programming language examples
      • API timeflows
      • API cookbook: tasks, workflows, and examples ›
        • Create authenticated sessions
        • Get host environment details
        • List alerts and jobs
        • List dSources and VDBs
        • List snapshots
        • Provision Oracle VDBs
        • Refresh VDBs
        • Rewind VDBs
        • Stop and start VDBs
        • Upload upgrades
        • Kerberos API cookbook ›
          • ASEDBConfig
          • ASEhostEnvironmentParameters
          • SAP ASE instance
          • ASELinkData
          • EnvironmentUser
          • KerberosConfig
          • KerberosCredential
          • KerberosKDC

These topics describe approaches to common tasks and workflows using the Delphix Engine API.

Create authenticated sessions

Get host environment details

List alerts and jobs

List dSources and VDBs

List snapshots

Provision Oracle VDBs

Refresh VDBs

Rewind VDBs

Stop and start VDBs

Upload upgrades

Kerberos API cookbook

Last updated
Oct 9, 2026

Footer

Developer Resources

  • All Documentation
  • Software End of Life Policy
  • Downloads

Support & Resources

  • Community
  • Training
  • Professional Services
Perforce Logo
© 2026 Perforce Software Inc. All Rights Reserved.
Privacy Policy | Terms of Use | Legal
Trust Center | Cookie Manager
Do Not Sell or Share My Personal Information
  • LinkedIn
  • Twitter
  • YouTube