Skip to main content

Logging into and Connecting to the Masking API Client (KBA5754)




KBA# 5754

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases



This article aims to show how to access and login to the Masking API Client :




Before trying to logon to the Masking Engine API client, check that you can successfully connect to the Masking Engine via the Masking Admin GUI.

Connecting to the Masking Engine API client

  1. Bring up the API client on your browser, by entering the following URL into the address bar of your browser, replacing  
    <> with the name or IP address of your masking engine


    URL example:

    The Client front end then gets displayed:
  2. Scroll down and click on login. 

Screenshot 2022-03-01 at 09.49.40.png

3. Click Log in to the Masking Engine.

Screenshot 2022-03-01 at 09.51.35.png

4.  Provide the Parameters Value required for login.
    To save time typing the format of the value, click within the box under 
    'Example Value'. This action copies the contents under the Example Value into the Required field.

 Screenshot 2022-03-01 at 09.54.44.png

  - Type the username and password to be used by the login,and then click on  Screenshot 2022-03-01 at 09.55.08.png.

   A successful login returns with an Authorization string under the Response Body and a response code of 200.

 Screenshot 2022-03-01 at 09.56.20.png

5.  Copy the red-highlighted string within the double-quotes.

     In this example, it is  Screenshot 2022-03-01 at 10.02.58.png

6. You also need to authorize for further Client API activities during this session.
  Scroll up to the top of the screen and click on 7-a-click-on-Authorize-at-the-top-of-thepage.png.

 The API key authorization' popup will be displayed. 


7. Copy/paste or type the authorization string into the api_key field, then click Authorize.

    If you click on 'Authorize' again you will get an  indication that you are authorized as the Logout button has become available. 

Screenshot 2022-03-01 at 10.12.07.png

 -   You have now completed logging into the Masking API Client.

A short video of this procedure can also be found in the Delphix Community by navigating to the following URL: How to Login into the Masking API Client (A Video) .

Related Articles

The following articles may provide more information or related information to this article: