Masking API Calls to Run a Masking Job
Delphix Masking / Masking API Calls to Run a Masking Job

A limited REST API exists for programmatic interaction with the Masking Engine. Only the following methods are supported. This REST API is deprecated and forward compatibility with future releases is not guaranteed.

The following procedure details the API calls to launch existing masking jobs created in the GUI.


The Masking Engine supports REST API calls over both HTTP (insecure) and HTTPS (secure). Use of the HTTPS protocol is recommended so that API arguments and results are transmitted securely and privately between the REST API client and the Masking Engine (e.g., username, password, etc.).


Limited Rest API Procedures

  1. Login User – GET dmsuite/apiV4/login?user={userID}&password={passwd}
    1. Returns authorization token in HTTP header that should be used in subsequent operations
  2. Get Application – GET /dmsuite/apiV4/applications
    1. Returns applications and environments associated to each application in response body – for example:

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <ApplicationsResponse>
      <ResponseStatus>
      <Status>SUCCESS</Status>
      </ResponseStatus>
      <Applications>
      <Application>
      <Name>demo</Name>
      <Link href="applications/demo" rel="details"/>
      <Environments>
      <Link href="environments/1" rel="SAP"/>
      </Environments>
      <Environments>
      <Link href="environments/37" rel="TEST"/>
      </Environments>
      </Application>
      </Applications>
      </ApplicationsResponse>

  3. Get Job – GET dmsuite/apiV4/applications/{applicationID}/jobs
    1. Returns jobs in response body – for example:

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <JobsResponse>
      <ResponseStatus>
      <Status>SUCCESS</Status>
      </ResponseStatus>
      <Jobs>
      <Profiles>
      <Profile>
      <Name>OracleProfile</Name>
      <Link rel="details" href="applications/demo/profilejobs/0"/>
      <Status>Succeeded</Status>
      </Profile>
      </Profiles>
      <Provisions/>
      <Maskings>
      <Masking>
      <Name>OracleMasking</Name>
      <Link rel="details" href="applications/demo/maskingjobs/1"/>
      <Status>Succeeded</Status>
      </Masking>
      </Maskings>
      <Certifys/>
      </Jobs>
      </JobsResponse>

  4. Run Job – POST dmsuite/apiV4/applications/{applicationID}/maskingjobs/{maskingjobID}/run
    1. Returns job launch status in response body - for example: 

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <MaskingsResponse>
      <ResponseStatus>
      <Status>SUCCESS</Status>
      </ResponseStatus>
      </MaskingsResponse>

    2. For on-the-fly masking, pass the target connector in the request body - environments/{environmentID}/connectors/{connectorId}?DataSource={Database,File,Mainframe}
  5. Get Job status - GET dmsuite/apiV4/applications/{applicationID}/maskingjobs/{maskingjobID}/results  
    1. Returns job run status in response body - for example: 

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <MaskingsResponse>
      <ResponseStatus>
      <Status>SUCCESS</Status>
      </ResponseStatus>
      <Maskings>
      <Masking>
      <Name>OracleMasking</Name>
      <Status>SUCCESS</Status>
      <StartTime>16:04:00</StartTime>
      <Duration>00:01:12</Duration>
      <PreviousDuration>00:01:13</PreviousDuration>
      <TablesTotal>1</TablesTotal>
      <TablesProcessed>1</TablesProcessed>
      <TablesRemaining>0</TablesRemaining>
      <RowsProcessed>25</RowsProcessed>
      <RowsRemaining>0</RowsRemaining>
      <UpdatesRunning>4</UpdatesRunning>
      <Respository>POSTGRESQL</Respository>
      <Links>
      <Link href="environments/1/connectors/1?DataSource=database" rel="SourceConnector"/>
      <Link href="applications/demo/inventorys/Oracle?environmentId=1" rel="Inventory"/>
      </Links>
      </Masking>
      </Maskings>
      </MaskingsResponse>

Related Links