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 Compliance ›
  3. 2026.5 ›
  4. Delphix masking APIs ›
  5. API client

API client

  • 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
    • Licenses and notices
  • Getting started ›
    • Introduction to Delphix Masking
    • Supported connectors ›
      • CockroachDB connector
      • Db2 z/OS and iSeries connectors
      • Db2 LUW connector
      • Files connector
      • Microsoft SQL Server connector
      • Migrating from legacy generic connectors
      • MySQL / MariaDB connector
      • Mainframe dataset connector
      • Oracle connector
      • PostgreSQL connector
      • SAP ASE (Sybase) connector
      • Yugabyte connector
    • Installation ›
      • Prerequisites
      • Network connectivity requirements
      • First time setup ›
        • LDAP troubleshooting and recovery
      • AWS EC2 installation
      • Azure installation
      • Google Cloud Platform installation
      • Hyper-V installation
      • IBM Cloud Platform installation
      • KVM installation
      • OCI installation
      • VMware installation
      • Containerized masking installation ›
        • Resource requirements for containerized masking
        • Managing LDAP over TLS/SSL for containerized masking
        • Direct Kubernetes installation
        • Helm-Based installation
        • AWS ECS Fargate installation
        • OpenShift installation
    • Naming requirements
    • Graphical User Interface (GUI)
    • Managing application settings
    • Users and roles ›
      • Sample JSON ›
        • All privileges
        • Create new user
        • User update
    • Best practices ›
      • Best practices for Delphix data masking
      • Best practices for defining masking roles
    • Audit logs
    • Monitor Async Task Status
    • Kerberos configuration ›
      • Oracle and Kerberos
      • MSSQL Server and Kerberos
      • Sybase and Kerberos
    • Password vault configuration
    • Db2 connector license installation
    • Continuous Compliance Engine icon reference
    • Delphix masking terminology
    • Changing the IP address of the Delphix Engine
    • Stopping and starting the containerized Continuous Compliance Engine
    • Stopping, starting, and restarting the continuous compliance engine
    • Upgrading the Continuous Compliance Engine
    • Utilization
  • Preparing data ›
    • Database user permissions for executing masking and profiling job
    • Preparing Oracle database for profiling/masking
    • Preparing SQL server database for profiling and masking
    • Preparing Sybase database for profiling and masking
    • Preparing DB2 database for profiling and masking
  • Connecting data ›
    • Managing environments
    • Managing remote mounts for VM continuous compliance engines
    • Managing remote mounts for containerized masking
    • Managing SSL/TLS over JDBC for containerized masking
    • Managing connectors ›
      • Create, test, edit, and delete a connector
      • Authentication types
      • Mainframe MVS storage access
      • Amazon Simple Storage Service (S3) connector for files
      • Azure Blob Storage connector for files
    • Managing extended connectors
    • Managing file formats ›
      • Constructing file formats for upload
      • Working with file formats
      • Add, view, edit, and delete fields for file formats
      • File structure for masking ›
        • XML structure
        • JSON structure
        • Parquet structure
    • Managing record types and header/footer records
    • Managing rule sets
    • Managing inventories
    • Whole file masking
  • Identifying sensitive data ›
    • Discovering your sensitive data
    • Out of the box profiling settings
    • ASDD standard profile set
    • Standard profile set classifiers
    • Legacy profile set classifiers
    • Configuring profile sets
    • Managing domains
    • Managing classifiers
    • ASDD profile set import and export
    • Reporting profiling results
    • ASDD features and support
  • Securing sensitive data ›
    • Algorithms ›
      • Out of the box algorithm instances ›
        • dlpx-core:BR - Financial ID
        • Brazil CPF
        • Brazil CNPJ
        • dlpx-core: CM Alpha-Numeric
        • dlpx-core: CM Digits
        • dlpx-core: CM Numeric
        • Credit Card
        • Date Shift Discrete
        • Date Shift Fixed
        • Date Shift Variable
        • dlpx-core: Email SL
        • dlpx-core: Email Unique
        • dlpx-core: FirstName
        • dlpx-core: FullName
        • Japan Corporate Number
        • Japan Drivers License
        • Japan My Number
        • dlpx-core: LastName
        • dlpx-core:Lat_Long Coordinates
        • NullValueLookup
        • dlpx-core: Phone Unique
        • dlpx-core: Phone US
        • dlpx-core:Redact Digits-Zero
        • RepeatFirstDigit
        • Secure Lookup (Out of the box algorithm instances) ›
          • ABARoutingNumber SL
          • AccNoLookup
          • AddrLookup
          • AddrLine2Lookup
          • Age SL
          • BloodType SL
          • BusinessLegalEntityLookup
          • CommentLookup
          • Department SL
          • DrivingLicenseNoLookup
          • DummyHospitalNameLookup
          • EmailLookup
          • Ethnicity SL
          • FirstNameLookup
          • FullNMLookup
          • Gender SL
          • JobTitle SL
          • Language SL
          • LastCommaFirstLookup
          • LastNameLookup
          • MaritalStatus SL
          • MedicalGenericDrug SL
          • NationalOrigin SL
          • PoliticalOrientation SL
          • RandomValueLookup
          • ReligiousOrientation SL
          • SexualOrientation SL
          • SchoolNameLookup
          • SwiftCode SL
          • USCitiesLookup
          • USCountiesLookup
          • USstatecodesLookup
          • USstatesLookup
          • WebURLsLookup
        • dlpx-core:TimeRange
        • dlpx-core: IBAN
        • SecureShuffle
      • Algorithm frameworks ›
        • Binary Lookup (Algorithm Frameworks)
        • BR - Financial ID (Algorithm frameworks)
        • Character Mapping (Algorithm frameworks)
        • Character Replacement (Algorithm frameworks)
        • Checkdigit (Algorithm frameworks)
        • Data Cleansing (Algorithm frameworks)
        • Date Replacement (Algorithm frameworks)
        • Date Shift (Algorithm frameworks)
        • Dependent Date Shift (Algorithm frameworks)
        • Email (Algorithm frameworks)
        • Free Text Redaction (Algorithm frameworks)
        • Full Name (Algorithm frameworks)
        • Mapping (Algorithm frameworks) ›
          • Syncing mapping algorithms
          • Remote Mapping
        • Min Max Number (Algorithm frameworks)
        • Min Max Date (Algorithm frameworks)
        • Multi Column Address (Algorithm frameworks)
        • Multi Column Condition (Algorithm frameworks)
        • Name (Algorithm frameworks)
        • Numeric Expression (Algorithm frameworks)
        • Payment Card (Algorithm frameworks)
        • Regex Decompose (Algorithm frameworks)
        • Secure Lookup (Algorithm frameworks)
        • Segment Mapping (Algorithm frameworks)
        • String Algorithm Chain (Algorithm Frameworks)
        • Tokenization (Algorithm frameworks)
      • General UI for extended algorithms
    • Builtin Driver Supports ›
      • Built-in Oracle driver support plugin
      • Built-in MSSQL driver support plugin
      • Built-in PostgreSQL driver support plugin
      • Built-in DB2 LUW driver support plugin
      • Built-in DB2 z/OS driver support plugin
      • Built-in DB2 iSeries driver support plugin
      • Built-in CData Salesforce driver support plugin
      • Built-in Sybase driver support plugin
    • Managing jobs ›
      • Running and Stopping Jobs
      • Create, view, edit, delete, verify jobs
      • Managing profiling jobs
      • Performance logging for masking jobs
      • Job monitoring
  • Masked provisioning ›
    • Configuring virtualization service for masked provisioning
    • Provision masked VDBs
  • Managing multiple engines for masking ›
    • Introduction (Managing multiple engines for masking)
    • Sync concepts
    • Sync endpoints
    • Algorithm syncability
    • User workflow examples
    • Change log
  • Authoring extensible plugins ›
    • Introduction (Authoring extensible plugins)
    • General plugin structure ›
      • Introduction (General plugin structure)
      • Dependency management
      • Plugin Metadata
      • Versioning
    • Setting up your development environment
    • Algorithms (Authoring extensible plugins) ›
      • The MaskingAlgorithm Java interface
      • SDK Workflows (Algorithms) ›
        • Building the sample plugin (SDK workflows/Algorithms)
        • Creating a New Project (SDK workflows/Algorithms)
        • Service discovery (SDK workflows/Algorithms)
        • Running an Algorithm using the SDK tools (SDK workflows/Algorithms)
        • Installing multiple plugins onto the Delphix Masking engine (SDK workflows/Algorithms)
        • Retrieving information about installed plugins (SDK workflows/Algorithms)
      • Configurability ›
        • Making an algorithm configurable
        • Using an Algorithm Framework
        • Using Multi-Column Algorithms
      • Service interfaces (Algorithms) ›
        • Accessing Files
        • Accessing Database Servers (JDBC)
        • Algorithm chaining
        • Using cryptographic keys
        • Logging
      • Security considerations ›
        • Algorithm implementation
    • Driver supports ›
      • The DriverSupport Java interface
      • SDK workflows (Driver supports) ›
        • Building the sample plugin (SDK workflows/Driver supports)
        • Creating a new project (SDK workflows/Driver supports)
        • Service discovery (SDK workflows/Driver supports)
        • Executing a driver support task using the SDK (SDK workflows/Driver supports)
        • Retrieving information about installed plugins (SDK workflows/Driver supports)
      • Service Interface (Driver supports) ›
        • Accessing masking engine rulesets
        • Accessing database server (JDBC)
        • Logging (Service interfaces)
    • Managing plugins using the API client
    • Installing a plugin onto the Delphix masking engine
    • Secure plugin deployment
    • Terminology
  • Delphix masking APIs ›
    • API client ›
      • Continuous Compliance API client
      • Backwards compatibility API usage
      • API response escaping
    • API workflows ›
      • API calls for masking administration
      • API calls for managing algorithms ›
        • Configuring algorithms
        • Managing algorithm usage
        • Migrating algorithms
        • Binary lookup
        • Character mapping
        • Checkdigit
        • Data cleansing
        • Date replacement
        • Date shift
        • Dependent date shift
        • Email
        • Free text redaction
        • Full name
        • Mapping
        • Min Max
        • Name
        • Numeric expression
        • Payment card
        • Regex decompose
        • Secure lookup
        • Segment mapping
        • Tokenization
      • API calls for managing extended connectors ›
        • Installing a driver support plugin
        • Installing a JDBC driver
        • Add a property file
        • Creating an extended database connector
        • Managing masking job driver support tasks
      • API calls for ASDD profile set import and export
      • API calls for managing classifiers
      • API calls for managing profile set usage
      • API calls for searching and filtering
      • API calls for managing masking job driver support tasks
      • API calls for creating an inventory
      • API calls for creating and running masking jobs
      • API calls involving file upload and download
      • API call for generating support bundle
    • API examples ›
      • loginCredentials
      • helpers
      • apiHostInfo
      • Configure enclosure escape character
      • createApplication
      • createEnvironment
      • createInventory
      • create DatabaseConnector
      • create DatabaseRuleset
      • createMAv2WithRemoteMappings
      • getBillingUsage
      • getAuditLogs
      • getSyncableObjects
      • getSyncableObjectsExport
      • profileTypeExpressions
      • runMaskingJob
      • getDatabaseUsage
  • 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
    • Licenses and notices
  • Getting started ›
    • Introduction to Delphix Masking
    • Supported connectors ›
      • CockroachDB connector
      • Db2 z/OS and iSeries connectors
      • Db2 LUW connector
      • Files connector
      • Microsoft SQL Server connector
      • Migrating from legacy generic connectors
      • MySQL / MariaDB connector
      • Mainframe dataset connector
      • Oracle connector
      • PostgreSQL connector
      • SAP ASE (Sybase) connector
      • Yugabyte connector
    • Installation ›
      • Prerequisites
      • Network connectivity requirements
      • First time setup ›
        • LDAP troubleshooting and recovery
      • AWS EC2 installation
      • Azure installation
      • Google Cloud Platform installation
      • Hyper-V installation
      • IBM Cloud Platform installation
      • KVM installation
      • OCI installation
      • VMware installation
      • Containerized masking installation ›
        • Resource requirements for containerized masking
        • Managing LDAP over TLS/SSL for containerized masking
        • Direct Kubernetes installation
        • Helm-Based installation
        • AWS ECS Fargate installation
        • OpenShift installation
    • Naming requirements
    • Graphical User Interface (GUI)
    • Managing application settings
    • Users and roles ›
      • Sample JSON ›
        • All privileges
        • Create new user
        • User update
    • Best practices ›
      • Best practices for Delphix data masking
      • Best practices for defining masking roles
    • Audit logs
    • Monitor Async Task Status
    • Kerberos configuration ›
      • Oracle and Kerberos
      • MSSQL Server and Kerberos
      • Sybase and Kerberos
    • Password vault configuration
    • Db2 connector license installation
    • Continuous Compliance Engine icon reference
    • Delphix masking terminology
    • Changing the IP address of the Delphix Engine
    • Stopping and starting the containerized Continuous Compliance Engine
    • Stopping, starting, and restarting the continuous compliance engine
    • Upgrading the Continuous Compliance Engine
    • Utilization
  • Preparing data ›
    • Database user permissions for executing masking and profiling job
    • Preparing Oracle database for profiling/masking
    • Preparing SQL server database for profiling and masking
    • Preparing Sybase database for profiling and masking
    • Preparing DB2 database for profiling and masking
  • Connecting data ›
    • Managing environments
    • Managing remote mounts for VM continuous compliance engines
    • Managing remote mounts for containerized masking
    • Managing SSL/TLS over JDBC for containerized masking
    • Managing connectors ›
      • Create, test, edit, and delete a connector
      • Authentication types
      • Mainframe MVS storage access
      • Amazon Simple Storage Service (S3) connector for files
      • Azure Blob Storage connector for files
    • Managing extended connectors
    • Managing file formats ›
      • Constructing file formats for upload
      • Working with file formats
      • Add, view, edit, and delete fields for file formats
      • File structure for masking ›
        • XML structure
        • JSON structure
        • Parquet structure
    • Managing record types and header/footer records
    • Managing rule sets
    • Managing inventories
    • Whole file masking
  • Identifying sensitive data ›
    • Discovering your sensitive data
    • Out of the box profiling settings
    • ASDD standard profile set
    • Standard profile set classifiers
    • Legacy profile set classifiers
    • Configuring profile sets
    • Managing domains
    • Managing classifiers
    • ASDD profile set import and export
    • Reporting profiling results
    • ASDD features and support
  • Securing sensitive data ›
    • Algorithms ›
      • Out of the box algorithm instances ›
        • dlpx-core:BR - Financial ID
        • Brazil CPF
        • Brazil CNPJ
        • dlpx-core: CM Alpha-Numeric
        • dlpx-core: CM Digits
        • dlpx-core: CM Numeric
        • Credit Card
        • Date Shift Discrete
        • Date Shift Fixed
        • Date Shift Variable
        • dlpx-core: Email SL
        • dlpx-core: Email Unique
        • dlpx-core: FirstName
        • dlpx-core: FullName
        • Japan Corporate Number
        • Japan Drivers License
        • Japan My Number
        • dlpx-core: LastName
        • dlpx-core:Lat_Long Coordinates
        • NullValueLookup
        • dlpx-core: Phone Unique
        • dlpx-core: Phone US
        • dlpx-core:Redact Digits-Zero
        • RepeatFirstDigit
        • Secure Lookup (Out of the box algorithm instances) ›
          • ABARoutingNumber SL
          • AccNoLookup
          • AddrLookup
          • AddrLine2Lookup
          • Age SL
          • BloodType SL
          • BusinessLegalEntityLookup
          • CommentLookup
          • Department SL
          • DrivingLicenseNoLookup
          • DummyHospitalNameLookup
          • EmailLookup
          • Ethnicity SL
          • FirstNameLookup
          • FullNMLookup
          • Gender SL
          • JobTitle SL
          • Language SL
          • LastCommaFirstLookup
          • LastNameLookup
          • MaritalStatus SL
          • MedicalGenericDrug SL
          • NationalOrigin SL
          • PoliticalOrientation SL
          • RandomValueLookup
          • ReligiousOrientation SL
          • SexualOrientation SL
          • SchoolNameLookup
          • SwiftCode SL
          • USCitiesLookup
          • USCountiesLookup
          • USstatecodesLookup
          • USstatesLookup
          • WebURLsLookup
        • dlpx-core:TimeRange
        • dlpx-core: IBAN
        • SecureShuffle
      • Algorithm frameworks ›
        • Binary Lookup (Algorithm Frameworks)
        • BR - Financial ID (Algorithm frameworks)
        • Character Mapping (Algorithm frameworks)
        • Character Replacement (Algorithm frameworks)
        • Checkdigit (Algorithm frameworks)
        • Data Cleansing (Algorithm frameworks)
        • Date Replacement (Algorithm frameworks)
        • Date Shift (Algorithm frameworks)
        • Dependent Date Shift (Algorithm frameworks)
        • Email (Algorithm frameworks)
        • Free Text Redaction (Algorithm frameworks)
        • Full Name (Algorithm frameworks)
        • Mapping (Algorithm frameworks) ›
          • Syncing mapping algorithms
          • Remote Mapping
        • Min Max Number (Algorithm frameworks)
        • Min Max Date (Algorithm frameworks)
        • Multi Column Address (Algorithm frameworks)
        • Multi Column Condition (Algorithm frameworks)
        • Name (Algorithm frameworks)
        • Numeric Expression (Algorithm frameworks)
        • Payment Card (Algorithm frameworks)
        • Regex Decompose (Algorithm frameworks)
        • Secure Lookup (Algorithm frameworks)
        • Segment Mapping (Algorithm frameworks)
        • String Algorithm Chain (Algorithm Frameworks)
        • Tokenization (Algorithm frameworks)
      • General UI for extended algorithms
    • Builtin Driver Supports ›
      • Built-in Oracle driver support plugin
      • Built-in MSSQL driver support plugin
      • Built-in PostgreSQL driver support plugin
      • Built-in DB2 LUW driver support plugin
      • Built-in DB2 z/OS driver support plugin
      • Built-in DB2 iSeries driver support plugin
      • Built-in CData Salesforce driver support plugin
      • Built-in Sybase driver support plugin
    • Managing jobs ›
      • Running and Stopping Jobs
      • Create, view, edit, delete, verify jobs
      • Managing profiling jobs
      • Performance logging for masking jobs
      • Job monitoring
  • Masked provisioning ›
    • Configuring virtualization service for masked provisioning
    • Provision masked VDBs
  • Managing multiple engines for masking ›
    • Introduction (Managing multiple engines for masking)
    • Sync concepts
    • Sync endpoints
    • Algorithm syncability
    • User workflow examples
    • Change log
  • Authoring extensible plugins ›
    • Introduction (Authoring extensible plugins)
    • General plugin structure ›
      • Introduction (General plugin structure)
      • Dependency management
      • Plugin Metadata
      • Versioning
    • Setting up your development environment
    • Algorithms (Authoring extensible plugins) ›
      • The MaskingAlgorithm Java interface
      • SDK Workflows (Algorithms) ›
        • Building the sample plugin (SDK workflows/Algorithms)
        • Creating a New Project (SDK workflows/Algorithms)
        • Service discovery (SDK workflows/Algorithms)
        • Running an Algorithm using the SDK tools (SDK workflows/Algorithms)
        • Installing multiple plugins onto the Delphix Masking engine (SDK workflows/Algorithms)
        • Retrieving information about installed plugins (SDK workflows/Algorithms)
      • Configurability ›
        • Making an algorithm configurable
        • Using an Algorithm Framework
        • Using Multi-Column Algorithms
      • Service interfaces (Algorithms) ›
        • Accessing Files
        • Accessing Database Servers (JDBC)
        • Algorithm chaining
        • Using cryptographic keys
        • Logging
      • Security considerations ›
        • Algorithm implementation
    • Driver supports ›
      • The DriverSupport Java interface
      • SDK workflows (Driver supports) ›
        • Building the sample plugin (SDK workflows/Driver supports)
        • Creating a new project (SDK workflows/Driver supports)
        • Service discovery (SDK workflows/Driver supports)
        • Executing a driver support task using the SDK (SDK workflows/Driver supports)
        • Retrieving information about installed plugins (SDK workflows/Driver supports)
      • Service Interface (Driver supports) ›
        • Accessing masking engine rulesets
        • Accessing database server (JDBC)
        • Logging (Service interfaces)
    • Managing plugins using the API client
    • Installing a plugin onto the Delphix masking engine
    • Secure plugin deployment
    • Terminology
  • Delphix masking APIs ›
    • API client ›
      • Continuous Compliance API client
      • Backwards compatibility API usage
      • API response escaping
    • API workflows ›
      • API calls for masking administration
      • API calls for managing algorithms ›
        • Configuring algorithms
        • Managing algorithm usage
        • Migrating algorithms
        • Binary lookup
        • Character mapping
        • Checkdigit
        • Data cleansing
        • Date replacement
        • Date shift
        • Dependent date shift
        • Email
        • Free text redaction
        • Full name
        • Mapping
        • Min Max
        • Name
        • Numeric expression
        • Payment card
        • Regex decompose
        • Secure lookup
        • Segment mapping
        • Tokenization
      • API calls for managing extended connectors ›
        • Installing a driver support plugin
        • Installing a JDBC driver
        • Add a property file
        • Creating an extended database connector
        • Managing masking job driver support tasks
      • API calls for ASDD profile set import and export
      • API calls for managing classifiers
      • API calls for managing profile set usage
      • API calls for searching and filtering
      • API calls for managing masking job driver support tasks
      • API calls for creating an inventory
      • API calls for creating and running masking jobs
      • API calls involving file upload and download
      • API call for generating support bundle
    • API examples ›
      • loginCredentials
      • helpers
      • apiHostInfo
      • Configure enclosure escape character
      • createApplication
      • createEnvironment
      • createInventory
      • create DatabaseConnector
      • create DatabaseRuleset
      • createMAv2WithRemoteMappings
      • getBillingUsage
      • getAuditLogs
      • getSyncableObjects
      • getSyncableObjectsExport
      • profileTypeExpressions
      • runMaskingJob
      • getDatabaseUsage

This section covers the following topics:

  • Masking API client
  • Backwards compatibility API usage
  • API response escaping
Last updated
Apr 4, 2025

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