Skip to main content

How to Migrate Algorithms, Domains(s), PROFILE_SET(s), PROFILE_EXPRESSION(s), and KEY to a Different Masking Engine Using the Masking API-Client (KBA5378)




KBA# 5378

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies

Major Release

All Sub Releases


How to Task

The following procedure provides steps on how to migrate algorithms, domain(s), PROFILE_SET(s), PROFILE_EXPRESSION(s), and the KEY to a different masking engine using the Masking API-Client.


The engine version must be 5.3 or higher for this procedure to work.

To complete the migration:

To migrate all algorithms and domains found on a masking engine, use the Syncing all Global Objects API found here Syncing all Global Objects.

If you want to migrate environments and masking jobs, please review:

  1. Log in to the API-client and authorize the connection.
    Please see:
  2. Navigate to sync and expand GET /syncable-objects.
  3. Set object_type to GLOBAL_OBJECT and press "Try it out!":
  4. Capture the following part of the response body:
          "objectIdentifier": {
            "id": "global"
          "objectType": "GLOBAL_OBJECT",
          "revisionHash": "25c3c4d45cb9da4e1fa51516bf2ee2f5d3d6b96f"
  5. Expand POST /export-async, enter the response body, and press "Try it out":

    This will begin generating a file on the masking engine that contains all of the algorithms and domains.
  6. In the Response Body, capture the export reference code (in the screenshot above it is EXPORT-ZXhwb3J0X2RvY3VtZW50X1ppZHZVWW83Lmpzb24=).

    The file generation can take several minutes depending on the number of algorithms and domains on the masking engine.

    The process can be checked under asyncTask- GET /async-tasks/{asyncTaskId}.
  7. Enter the asyncTaskId in the value section and press "Try it out!"
  8. Once the status is showing as SUCCEEDED the file is ready to be downloaded.

    The file is downloaded from the fileDownload section using GET /file-downloads/{fileDownloadId}.
  9. Enter the EXPORT id code from earlier into the fileDownloadId section and press "Try it out!":


    This will generate a download link for the file which can be downloaded to your computer.

    This file can then be uploaded to the new engine.
  10. On the new engine, login to the API-client and authorize the connection.
  11. After logging into the API-client, navigate to the sync - POST /import-async section.
  12. Here the file that was downloaded from the old engine can be uploaded in the file section:

    The upload can be checked under asyncTask, using the asyncTaskId. Once it shows SUCCEEDED the algorithms and domains will appear in the masking engine GUI.